The Software Update Plugin allows receiving notifications about new releases of OctoPrint or installed plugins which registered with it and -- if properly configured -- also applying the found updates.
Out of the box the Software Update Plugin will be able to notify you of any updates that might be available for your OctoPrint installation or any plugins that registered themselves with it. In order to also be able to update your OctoPrint installation, you'll need to configure at least OctoPrint's checkout folder, and you also should configure the restart commands for OctoPrint and the whole server.
For configuring the plugin you'll need to go into OctoPrint's Settings Dialog, navigate to the Software Upda.. _section therein and once you are there click on the little wrench icon in the upper right corner.
The Software Update plugin configuration dialog
There you can adjust the following settings:
OctoPrint checkout folder: This should be the path to OctoPrint's git checkout folder (
/home/pi/OctoPrint
for OctoPi or manual installs following the Raspberry Pi setup guide). This must be set to allow updating from within OctoPrintNote
OctoPi releases 0.12.0 and later ship with this already setup for you.
Note
OctoPi 0.11.0 users: Please also take a look at the note at the very end of this FAQ entry. Due to a little issue in that OctoPi release 0.11.0 you might have to fix the URL your OctoPrint checkout is using for updating. This can easily be done by SSHing into your OctoPi instance and doing this:
cd ~/OctoPrint git remote set-url origin https://github.com/foosel/OctoPrint.git
- OctoPrint version tracking: Whether you want to track OctoPrint releases or every commit. Usually you want to select "Release" here which is also the default, unless you are a developer.
- OctoPrint Release Channel: The release channel of OctoPrint to track for updates. If you only want stable versions, select "Stable" here which is also the default. "Maintenance RCs" will also allow you to update to maintenance release candidates, "Devel RCs" will also allow you to update to development release candidates. If in doubt, leave it at "Stable". Read more about Release Channels here.
- Version cache TTL: The "time to live" of the cache OctoPrint will use to temporarily persist the version information for the various components registered with the plugin, so that they don't have to be queried from the internet every time you load the page. Defaults to 24h, you usually shouldn't need to change that value.
More settings are available by editing the correspondi.. _section in config.yaml <sec-bundledplugins-softwareupdate-configuration>
.
That restart commands for OctoPrint and the whole server can be configured under Settings > Server.
The functionality of the Software Update Plugin is also available on OctoPrint's command line interface under the plugins
sub command. It's is possible to check for updates via octoprint plugins softwareupdate:check
and to apply available updates via octoprint plugins softwareupdate:update
. Please the corresponding --help
pages on details:
$ octoprint plugins softwareupdate:check --help
Usage: octoprint plugins softwareupdate:check [OPTIONS] [TARGETS]...
Check for updates.
If any TARGETs are provided, only those components will be checked.
Examples:
- octoprint plugins softwareupdate:check
This will check all components for available updates,
utilizing cached version information.
- octoprint plugins softwareupdate:check --force
This will check all components for available updates,
ignoring any cached version information even if it's
still valid.
- octoprint plugins softwareupdate:check octoprint
This will only check OctoPrint itself for available
updates.
Options:
--force Ignore the cache for the update check
--help Show this message and exit.
$ octoprint plugins softwareupdate:update --help
Usage: octoprint plugins softwareupdate:update [OPTIONS] [TARGETS]...
Apply updates.
If any TARGETs are provided, only those components will be updated.
Examples:
- octoprint plugins softwareupdate:update
This will update all components with a pending update
that can be updated.
- octoprint plugins softwareupdate:update --force
This will force an update of all registered components
that can be updated, even if they don't have an updated
pending.
- octoprint plugins softwareupdate:update octoprint
This will only update OctoPrint and leave any further
components with pending updates at their current versions.
Options:
--force Update even if already up to date
--help Show this message and exit.
plugins:
softwareupdate:
# the time-to-live of the version cache, in minutes
cache_ttl: 60
# configured version check and update methods
checks:
# "octoprint" is reserved for OctoPrint
octoprint:
# this defines an version check that will check against releases
# published on OctoPrint's Github repository and an update method
# utilizing an (included) update script that will be run on
# OctoPrint's checkout folder
type: github_release
user: foosel
repo: OctoPrint
update_script: '{python} "/path/to/octoprint-update.py" --python="{python}" "{folder}" "{target}"'
update_folder: /path/to/octoprint/checkout/folder
# further checks may be define here
# pip command, if another one than the automatically detected one should be
# used - should normally NOT be necessary and hence set
pip_command: /path/to/pip
github_release
: Checks against releases published on Github. Additional config parameters:
user
: (mandatory) Github user the repository to check belongs torepo
: (mandatory) Github repository to checkprerelease
:True
orFalse
, defaultFalse
, set toTrue
to also include releases on Github marked as prerelease.release_branch
: Branch name to check againsttarget_comittish
field in Github release data - release will only be included if the values match. Defaults to being unset, in which case no match will be performed.release_compare
: Method to use to compare between current version information and release versions on Github. One ofpython
(version comparison usingpkg_resources.parse_version
, newer version detected if remote > current),semantic
(version comparison usingsemantic_version
package, newer version detected if remote > current) andunequal
(string comparison, newer version detected if remote != current).github_commit
: Checks against commits pushed to Github. Additional config parameters:
user
: (mandatory) Github user the repository to check belongs torepo
: (mandatory) Github repository to checkbranch
: Branch of the Github repository to check, defaults tomaster
if not set.current
: Current commit hash. Will be updated automatically.bitbucket_commit
: Checks against commits pushed to Bitbucket. Additional config parameters:
user
: (mandatory) Bitbucket user the repository to check belongs torepo
: (mandatory) Bitbucket repository to checkbranch
: Branch of the Bitbucket repository to check, defaults tomaster
if not set.current
: Current commit hash. Will be updated automatically.git_commit
: Checks a local git repository for new commits on its configured remote. Additional config parameters:
checkout_folder
: (mandatory) The full path to the folder with a valid git repository to check.command_line
: Uses a provided script to determine whether an update is available. Additional config parameters:
command
: (mandatory) The full path to the script to execute. The script is expected to return a0
return code if an update is available and to return the display name of the available version as the final and optionally the display name of the current version as the next to final line on stdout.python_checker
: Can only be specified by plugins through thehook <sec-bundledplugins-softwareupdate-hooks>
. Additional config parameters:
python_checker
: (mandatory) A python callable which returns version information and whether the current version is up-to-date or not, see below for details.
pip
: An URL to provide topip install
in order to perform the update. May contain a placeholder{target}
which will be the most recent version specifier as retrieved from the update check.update_script
: A script to execute in order to perform the update. May contain placeholders{target}
(for the most recent version specified as retrieved from the update check),{branch}
for the branch to switch to to access the release,{folder}
for the working directory of the script and{python}
for the python executable OctoPrint is running under. The working directory must be specified either by anupdate_folder
setting or if thegit_commit
check is used itscheckout_folder
setting.python_updater
: Can only be specified by plugins through thehook <sec-bundledplugins-softwareupdate-hooks>
. A python callable which performs the update, see below for details.
Example for a setup that allows "bleeding edge" updates of OctoPrint under OctoPi (the update_script
gets configured correctly automatically by the plugin itself):
plugins:
softwareupdate:
checks:
octoprint:
type: github_commit
user: foosel
repo: OctoPrint
branch: devel
update_folder: /home/pi/OctoPrint
Plugin installed via pip and hosted on Github under https://github.com/someUser/OctoPrint-SomePlugin
, only releases should be tracked:
plugins:
softwareupdate:
checks:
some_plugin:
type: github_release
user: someUser
repo: OctoPrint-SomePlugin
pip: 'https://github.com/someUser/OctoPrint-SomePlugin/archive/{target}.zip'
The same, but tracking all commits pushed to branch devel
(thus allowing "bleeding edge" updates):
plugins:
softwareupdate:
checks:
some_plugin:
type: github_commit
user: someUser
repo: OctoPrint-SomePlugin
branch: devel
pip: 'https://github.com/someUser/OctoPrint-SomePlugin/archive/{target}.zip'
version_checks
module of the Software Update plugin, allows reusing the bundled version check variants from plugins (e.g. wrapped in a python_checker
).
updaters
module of the Software Update plugin, allows reusing the bundled updater variants from plugins (e.g. wrapped in a python_updater
).
exceptions
module of the Software Update plugin.
util
module of the Software Update plugin.
The source of the Software Update plugin is bundled with OctoPrint and can be found in its source repository under src/octoprint/plugins/softwareupdate
.