4139fb1d7f
# History ## 0.31.0 Install/update via the bootstrap script: ```shell wget -NP . https://dokku.com/install/v0.31.0/bootstrap.sh sudo DOKKU_TAG=v0.31.0 bash bootstrap.sh ``` See the [0.31.0 migration guide](/docs/appendices/0.31.0-migration-guide.md) for more information on migrating to 0.31.0. ### Backwards Compatibility Breaks - #6102: @josegonzalez Deprecate ARM as a build target - #6029: @josegonzalez Provide users the ability to override auto-detected port mappings ### Bug Fixes - #6110: @josegonzalez Correctly handle rebase when generating release notes for minor/major releases - #6081: @josegonzalez Use correct namespace for haproxy service state tracking - #6079: @josegonzalez Remove debugging code from builder-dockerfile plugin - #6078: @josegonzalez Use correct quoting in format template when fetching exposed image ports - #6070: @josegonzalez Do not write empty values for nginx container labels - #6014: @josegonzalez Automatically clear the git source-image property when changing deployment methodologies - #5985: @josegonzalez Mount the traefik data directory instead of the acme.json file when starting traefik - #5979: @josegonzalez Do not start proxy implementations during server restore if they weren't manually started via the :start command - #5973: @josegonzalez Remove all containers and images by label on app destroy ### New Features - #6100: @josegonzalez Add support for non-web healthchecks via app.json - #6098: @josegonzalez Upgrade traefik image from v2.8 to v2.10 - #6097: @josegonzalez Upgrade caddy image from 2.7 to 2.8 - #6082: @josegonzalez Add openresty proxy implementation - #6057: @josegonzalez Inject docker labels when nginx proxy implementation is in use - #6043: @josegonzalez Write auto-detected port mappings during a deploy - #6013: @josegonzalez Export environment variables during dockerfile builds for use with value-less --build-arg flags - #6007: @Firfi Add application/wasm to nginx.conf.sigil gzip - #5993: @josegonzalez Un-deprecate apps and config cli aliases - #5992: @josegonzalez Mount the vector data directory instead of the vector file - #5991: @josegonzalez Add the ability to execute a cron task on the fly - #5990: @josegonzalez Add json format output to cron:list command - #5989: @josegonzalez Skip scaled processes that are missing in the Procfile - #5978: @josegonzalez Export environment variables during dockerfile builds for use with value-less --build-arg flags - #5908: @josegonzalez Generate jobs for crontab in parallel - #5891: @josegonzalez Add support for specifying multiple networks on a given app ### Refactors - #6042: @josegonzalez Rename port-map property to port - #6021: @josegonzalez Simplify ports-configure codebase - #6018: @josegonzalez Move code that fetches raw tcp ports for dockerfile deploys to ports plugin - #6017: @josegonzalez Deprecate proxy-configure-ports plugin trigger in favor of ports-configure - #6011: @josegonzalez Use ports-get plugn trigger for fetching port mappings - #6010: @josegonzalez Use ports-clear plugn trigger to manage clearing the port map - #5988: @josegonzalez Move crontab writing code to scheduler-docker-local plugin - #5975: @josegonzalez Standardize on shorthand for redirecting all output to /dev/null - #5974: @josegonzalez Standardize on ls subcommand when interacting with the docker binary ### Documentation - #6116: @josegonzalez Remove extra newline in migration docs - #6099: @josegonzalez Clean up references in proxy plugins - #5987: @josegonzalez Clarify that a branch can be specified when updating a plugin ### Tests - #6103: @josegonzalez Timeout docker image builds in CI - #6101: @josegonzalez Make it possible to specify an alternative base domain for tests - #6095: @josegonzalez Remove assertion for unconsumed build arguments - #6094: @josegonzalez Correct assertion for dockerfile builds when a variable is eval'd - #6080: @josegonzalez Add assertions to various bats tests - #6076: @josegonzalez Use assert_output_not_exists instead of asserting output is empty string - #6075: @josegonzalez Use an alternative curl request to ensure requests go to the local nginx - #6074: @josegonzalez Fix issue where networks weren't being torn down during testing - #6012: @josegonzalez Use ports:report to get the list of port mappings - #5977: @josegonzalez Move all shellcheck disable definitions to .shellcheckrc - #5976: @josegonzalez Remove Stickler configuration ### Other - #6109: @josegonzalez Make heroku-22/jammy the default stack for cnb/herokuish builds - #6096: @josegonzalez Upgrade vector image from 0.23.x to 0.31.x - #6019: @josegonzalez Move code for fetching an available port to the ports plugin - #6015: @josegonzalez Move CHECKS file extraction to the beginning of the deploy - #5995: @josegonzalez Migrate the proxy port map from config variable to property system - #5986: @josegonzalez Move all port management code to standalone ports plugin - #5495: @josegonzalez Move herokuish app cache from the filesystem into a docker volume
8.4 KiB
Plugin Management
New as of 0.4.0
plugin:disable <name> # Disable an installed plugin (third-party only)
plugin:enable <name> # Enable a previously disabled plugin
plugin:install [--core|--git-url] [--committish branch|commit|tag] [--name custom-plugin-name] # Optionally download git-url (and pin to the specified branch/commit/tag) & run install trigger for active plugins (or only core ones)
plugin:installed <name> # Checks if a plugin is installed
plugin:install-dependencies [--core] # Run install-dependencies trigger for active plugins (or only core ones)
plugin:list # Print active plugins
plugin:trigger <args...>. # Trigger an arbitrary plugin hook
plugin:uninstall <name> # Uninstall a plugin (third-party only)
plugin:update [name [branch|commit|tag]] # Optionally update named plugin from git (and pin to the specified branch/commit/tag) & run update trigger for active plugins
# for 0.3.x
cd /var/lib/dokku/plugins
git clone <git url>
dokku plugins-install
These commands require
rootpermissions as theinstallandinstall-dependenciesplugin triggers may utilize commands such asapt-get. For non-core plugins, please inspect those plugins before running the following command asrootuser.
Usage
Listing Plugins
Installed plugins can be listed via the plugin:list command:
dokku plugin:list
plugn: dev
00_dokku-standard 0.31.0 enabled dokku core standard plugin
20_events 0.31.0 enabled dokku core events logging plugin
app-json 0.31.0 enabled dokku core app-json plugin
apps 0.31.0 enabled dokku core apps plugin
build-env 0.31.0 enabled dokku core build-env plugin
buildpacks 0.31.0 enabled dokku core buildpacks plugin
certs 0.31.0 enabled dokku core certificate management plugin
checks 0.31.0 enabled dokku core checks plugin
common 0.31.0 enabled dokku core common plugin
config 0.31.0 enabled dokku core config plugin
docker-options 0.31.0 enabled dokku core docker-options plugin
domains 0.31.0 enabled dokku core domains plugin
enter 0.31.0 enabled dokku core enter plugin
git 0.31.0 enabled dokku core git plugin
logs 0.31.0 enabled dokku core logs plugin
network 0.31.0 enabled dokku core network plugin
nginx-vhosts 0.31.0 enabled dokku core nginx-vhosts plugin
plugin 0.31.0 enabled dokku core plugin plugin
proxy 0.31.0 enabled dokku core proxy plugin
ps 0.31.0 enabled dokku core ps plugin
repo 0.31.0 enabled dokku core repo plugin
resource 0.31.0 enabled dokku core resource plugin
scheduler-docker-local 0.31.0 enabled dokku core scheduler-docker-local plugin
shell 0.31.0 enabled dokku core shell plugin
ssh-keys 0.31.0 enabled dokku core ssh-keys plugin
storage 0.31.0 enabled dokku core storage plugin
tags 0.31.0 enabled dokku core tags plugin
tar 0.31.0 enabled dokku core tar plugin
trace 0.31.0 enabled dokku core trace plugin
Warning: All plugin commands other than
plugin:listandplugin:helprequire sudo access and must be run directly from the Dokku server.
Checking if a plugin is installed
You can check if a plugin has been installed via the plugin:installed command:
dokku plugin:installed postgres
Installing a plugin
Note: Plugins installed in this method within a docker-based installation of Dokku do not persist across installs. Please see the plugin installation section of the docker-based installation docs for further details.
Installing a plugin is easy as well using the plugin:install command. This command will also trigger the install pluginhook on all existing plugins.
The most common usage is to install a plugin from a url. This url may be any of the following:
git: For git+ssh based plugin repository clones.ssh: For git+ssh based plugin repository clones.file: For copying plugins from a path on disk.https: For http based plugin repository clones.
Additionally, any urls with the extensions .tar.gz or .tgz are treated as Gzipped Tarballs for installation purposes and will be downloaded and extracted into place.
dokku plugin:install https://github.com/dokku/dokku-postgres.git
-----> Cloning plugin repo https://github.com/dokku/dokku-postgres.git to /var/lib/dokku/plugins/available/postgres
Cloning into 'postgres'...
remote: Counting objects: 646, done.
remote: Total 646 (delta 0), reused 0 (delta 0), pack-reused 646
Receiving objects: 100% (646/646), 134.24 KiB | 0 bytes/s, done.
Resolving deltas: 100% (406/406), done.
Checking connectivity... done.
-----> Plugin postgres enabled
For git-based plugin installation, a commit SHA-like object may be specified (tag/branch/commit sha) via the --committish argument and Dokku will attempt to install the specified commit object.
# where 2.0.0 is a potential git tag
dokku plugin:install https://github.com/dokku/dokku-postgres.git --committish 2.0.0
Plugin names are interpolated based on the repository name minus the dokku- prefix. If the plugin being installed has a name other than what matches the repository name - or another name is desired - the --name flag can be used to override this interpolation.
dokku plugin:install https://github.com/dokku/smoke-test-plugin.git --name smoke-test-plugin
The --core flag may also be indicated as the sole argument, though it is only for installation of core plugins, and thus not useful for end-user installations.
dokku plugin:install --core
Finally, all flags may be omitted to trigger the install procedures for both core and third-party plugins:
dokku plugin:install
Installing plugin dependencies
In some cases, plugins will have system-level dependencies. These are not automatically installed via plugin:install, and must be separately via the plugin:install-dependencies command. This will run through all the dependencies trigger for all plugins.
dokku plugin:install-dependencies
This command may also target just core plugins via the --core flag. This is usually only useful for source-based installs of Dokku.
dokku plugin:install-dependencies --core
Updating a plugin
An installed, third-party plugin can be updated can updated via the plugin:update command. This should be done after any upgrades of Dokku as there may be changes in the internal api that require an update of how the plugin interfaces with Dokku.
Please note that this command is only valid for plugin installs that were backed by a git-repository.
dokku plugin:update postgres
Plugin (postgres) updated
An optional commit SHA-like object may be specified.
dokku plugin:update postgres 2.0.0
Any future invocation of plugin:update will respect the previously specified SHA-like object. To follow a particular branch again, specify that branch:
dokku plugin:update postgres main
Uninstalling a plugin
Third party plugins can be uninstalled using the plugin:uninstall command:
dokku plugin:uninstall postgres
-----> Plugin postgres uninstalled
Disabling a plugin
Disabling a plugin can also be useful for debugging whether a third-party plugin is causing issues in a Dokku installation. Another common use case is for disabling core functionality for replacement with a third-party plugin.
dokku plugin:disable postgres
-----> Plugin postgres disabled
Enabling a plugin
Disabled plugins can be re-enabled via the plugin:enable command.
dokku plugin:enable postgres
-----> Plugin postgres enabled
Triggering a plugin trigger
The plugin:trigger can be used to call any internal plugin trigger. This may have unintended consequences, and thus should only be called for development or debugging purposes.
dokku plugin:trigger some-internal-trigger args-go-here