# History ## 0.38.32 Install/update via the bootstrap script: ```shell wget -NP . https://dokku.com/install/v0.38.32/bootstrap.sh sudo DOKKU_TAG=v0.38.32 bash bootstrap.sh ``` ### Bug Fixes - #9189: @josegonzalez Release deploy locks on exit and honor apps:lock - #9128: @sean0407 Forward forced cleanup flag (#9127) - #9182: @josegonzalez Read alternate image tags from the retired container - #9180: @josegonzalez Clean up stale extracted files on deploy - #9176: @byjg Haproxy letsencrypt integration and upgrade EasyHAProxy to 6.5.1 - #9175: @josegonzalez Only clear the requested resource type - #9172: @josegonzalez Serialize concurrent property updates - #9169: @josegonzalez Accept all docker memory units in resource values - #9129: @josegonzalez Respect DOKKU_LIB_HOST_ROOT for storage bind mounts - #9130: @josegonzalez Preserve arguments such as --version and -n when running commands over SSH - #9148: @josegonzalez Do not retire an image that another app uses as its source image - #9131: @josegonzalez Keep the git source-image property in sync and harden the deploy lock - #9102: @josegonzalez Allow enabling nginx-vhosts when skipped at install ### New Features - #9190: @josegonzalez Add a whole-set form and clear for chart overrides - #9152: @Schlepptop Make nginx-proxy-http-version configurable per app or globally - #9104: @josegonzalez Allow cron-entries to set a per-entry MAILTO ### Documentation - #9132: @SatvikMishra08 Fix broken internal anchors and links - #9119: @fmtappendf Fix some typos in comment - #9116: @cevheri Add LibreDB Studio plugin to community plugin list ### Tests - #9186: @dependabot[bot] chore(deps): bump sass from 1.105.2 to 1.106.0 in /tests/apps/multi - #9187: @dependabot[bot] chore(deps-dev): bump heroku/heroku-buildpack-php from 297 to 298 in /tests/apps/php - #9181: @josegonzalez Pause the retire timer during source image test - #9170: @josegonzalez Fix pre-existing gofmt and markdown lint issues - #9155: @dependabot[bot] chore(deps): bump golang from 1.27.1 to 1.27.2 in /tests/apps/zombies-dockerfile-no-tini - #9163: @dependabot[bot] chore(deps): bump sass from 1.105.1 to 1.105.2 in /tests/apps/multi - #9161: @dependabot[bot] chore(deps): bump golang from 1.27.1 to 1.27.2 in /tests/apps/gogrpc - #9160: @dependabot[bot] chore(deps): bump golang from 1.27.1 to 1.27.2 in /tests/apps/go-fail-predeploy - #9159: @dependabot[bot] chore(deps): bump golang from 1.27.1 to 1.27.2 in /tests/apps/zombies-dockerfile-tini - #9158: @dependabot[bot] chore(deps): bump golang from 1.27.1 to 1.27.2 in /tests/apps/go-fail-postdeploy - #9150: @dependabot[bot] chore(deps): bump python from 3.15.0rc3-bookworm to 3.15.0-bookworm in /tests/apps/dockerfile-release - #9145: @dependabot[bot] chore(deps): bump djangorestframework from 3.18.1 to 3.18.3 in /tests/apps/dockerfile-release - #9144: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/nodejs-express-noprocfile - #9143: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/nodejs-express-noappjson - #9141: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/nodejs-express - #9140: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/gitsubmodules - #9139: @dependabot[bot] chore(deps): bump python from 3.15.0rc2-bookworm to 3.15.0rc3-bookworm in /tests/apps/dockerfile-release - #9138: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/dockerfile-procfile-bad - #9135: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/checks-root - #9134: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/dockerfile-procfile - #9133: @dependabot[bot] chore(deps): bump express from 5.2.1 to 5.3.0 in /tests/apps/dockerfile-app-json-formations - #9115: @dependabot[bot] chore(deps): bump django from 5.2.17 to 5.2.18 in /tests/apps/dockerfile-release - #9113: @dependabot[bot] chore(deps): bump source-map-js from 1.2.1 to 1.2.2 in /tests/apps/multi in the npm_and_yarn group across 1 directory - #9112: @dependabot[bot] chore(deps): bump proxy-addr from 2.0.7 to 2.0.8 in /tests/apps/checks-root in the npm_and_yarn group across 1 directory - #9110: @dependabot[bot] chore(deps): bump sass from 1.105.0 to 1.105.1 in /tests/apps/multi - #9109: @dependabot[bot] chore(deps): bump monolog/monolog from 3.12.0 to 3.12.1 in /tests/apps/php - #9106: @dependabot[bot] chore(deps): bump werkzeug from 3.1.8 to 3.1.9 in /tests/apps/python-flask - #9091: @dependabot[bot] chore(deps): bump sass from 1.104.1 to 1.105.0 in /tests/apps/multi - #9086: @dependabot[bot] chore(deps-dev): bump heroku/heroku-buildpack-php from 295 to 297 in /tests/apps/php ### Dependencies - #9184: @josegonzalez chore: group kubernetes dependency updates - #9183: @dokku-bot chore: bump herokuish to 0.11.21 - #9177: @dependabot[bot] chore(deps): bump timberio/vector from 0.59.0-debian to 0.60.0-debian in /plugins/logs - #9179: @dependabot[bot] chore(deps): bump github.com/traefik/traefik/v2 in /plugins/scheduler-k3s - #9178: @dependabot[bot] chore(deps): update markdown requirement from <3.12,>=3.11.1 to >=3.11.2,<3.12 in /docs/_build - #9173: @dokku-bot chore: bump herokuish to 0.11.20 - #9174: @dokku-bot chore: bump pack to 0.40.10 - #9164: @dependabot[bot] chore(deps): bump github.com/fluxcd/pkg/kustomize in /plugins/scheduler-k3s - #9166: @dependabot[bot] chore(deps): bump helm.sh/helm/v3 in /plugins/scheduler-k3s - #9157: @dependabot[bot] chore(deps): update markdown requirement from <3.12,>=3.11 to >=3.11.1,<3.12 in /docs/_build - #9156: @dependabot[bot] chore(deps): bump pymdown-extensions from 12.2 to 12.3 in /docs/_build - #9167: @dependabot[bot] chore(deps): bump python from 3.15.0rc3-alpine to 3.16.0a1-alpine in /docs/_build - #9165: @dependabot[bot] chore(deps): bump github.com/traefik/traefik/v2 in /plugins/scheduler-k3s - #9162: @dependabot[bot] chore(deps): bump traefik from v3.7.14 to v3.7.15 in /plugins/traefik-vhosts - #9149: @dependabot[bot] chore(deps): bump soupsieve from 2.10 to 3.0.3 in /docs/_build - #9146: @dependabot[bot] chore(deps): bump golang.org/x/crypto in /plugins/common - #9142: @dependabot[bot] chore(deps): bump pymdown-extensions from 12.1 to 12.2 in /docs/_build - #9137: @dependabot[bot] chore(deps): bump traefik from v3.7.13 to v3.7.14 in /plugins/traefik-vhosts - #9136: @dependabot[bot] chore(deps): bump timberio/vector from 0.58.0-debian to 0.59.0-debian in /plugins/logs - #9125: @dokku-bot chore: bump herokuish to 0.11.19 - #9123: @dependabot[bot] chore(deps): bump python from 3.15.0rc2-alpine to 3.15.0rc3-alpine in /docs/_build - #9124: @dependabot[bot] chore(deps): bump golang.org/x/sync in /plugins/common - #9121: @dependabot[bot] chore(deps): bump github.com/traefik/traefik/v2 in /plugins/scheduler-k3s - #9118: @dependabot[bot] chore(deps): bump zipp from 4.1.0 to 4.1.1 in /docs/_build - #9114: @dependabot[bot] chore(deps): bump markupsafe from 3.0.3 to 3.0.4 in /docs/_build - #9111: @dependabot[bot] chore(deps): bump sigs.k8s.io/kustomize/api in /plugins/scheduler-k3s - #9099: @dependabot[bot] chore(deps): bump k8s.io/kubernetes in /plugins/scheduler-k3s - #9098: @dependabot[bot] chore(deps): bump k8s.io/kubectl in /plugins/scheduler-k3s - #9094: @dependabot[bot] chore(deps): bump github.com/kedacore/keda/v2 in /plugins/scheduler-k3s - #9090: @dependabot[bot] chore(deps): bump soupsieve from 2.9.2 to 2.10 in /docs/_build - #9093: @dependabot[bot] chore(deps): bump github.com/go-openapi/jsonpointer in /plugins/scheduler-k3s - #9101: @dependabot[bot] chore(deps): bump dokku/openresty-docker-proxy from 0.12.1 to 0.13.0 in /plugins/openresty-vhosts - #9092: @dependabot[bot] chore(deps): bump github.com/onsi/gomega in /plugins/buildpacks - #9100: @dokku-bot chore: bump herokuish to 0.11.18 - #9097: @dependabot[bot] chore(deps): bump k8s.io/client-go in /plugins/scheduler-k3s - #9089: @dependabot[bot] chore(deps): bump pymdown-extensions from 12.0.1 to 12.1 in /docs/_build - #9088: @dependabot[bot] chore(deps): update markdown requirement from <3.11,>=3.10.3 to >=3.11,<3.12 in /docs/_build
261 lines
10 KiB
Markdown
261 lines
10 KiB
Markdown
# Plugin Management
|
|
|
|
> [!IMPORTANT]
|
|
> 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] [--skip-install-trigger] # 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 [--format stdout|json] # 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
|
|
```
|
|
|
|
```shell
|
|
# for 0.3.x
|
|
cd /var/lib/dokku/plugins
|
|
git clone <git url>
|
|
dokku plugins-install
|
|
```
|
|
|
|
> These commands require `root` permissions as the `install` and `install-dependencies` plugin triggers may utilize commands such as `apt-get`. For non-core plugins, please inspect those plugins before running the following command as `root` user.
|
|
|
|
## Usage
|
|
|
|
### Listing Plugins
|
|
|
|
Installed plugins can be listed via the `plugin:list` command:
|
|
|
|
```shell
|
|
dokku plugin:list
|
|
```
|
|
|
|
```
|
|
plugn: dev
|
|
00_dokku-standard 0.38.32 enabled dokku core standard plugin
|
|
20_events 0.38.32 enabled dokku core events logging plugin
|
|
app-json 0.38.32 enabled dokku core app-json plugin
|
|
apps 0.38.32 enabled dokku core apps plugin
|
|
build-env 0.38.32 enabled dokku core build-env plugin
|
|
buildpacks 0.38.32 enabled dokku core buildpacks plugin
|
|
certs 0.38.32 enabled dokku core certificate management plugin
|
|
checks 0.38.32 enabled dokku core checks plugin
|
|
common 0.38.32 enabled dokku core common plugin
|
|
config 0.38.32 enabled dokku core config plugin
|
|
docker-options 0.38.32 enabled dokku core docker-options plugin
|
|
domains 0.38.32 enabled dokku core domains plugin
|
|
enter 0.38.32 enabled dokku core enter plugin
|
|
git 0.38.32 enabled dokku core git plugin
|
|
logs 0.38.32 enabled dokku core logs plugin
|
|
network 0.38.32 enabled dokku core network plugin
|
|
nginx-vhosts 0.38.32 enabled dokku core nginx-vhosts plugin
|
|
plugin 0.38.32 enabled dokku core plugin plugin
|
|
proxy 0.38.32 enabled dokku core proxy plugin
|
|
ps 0.38.32 enabled dokku core ps plugin
|
|
repo 0.38.32 enabled dokku core repo plugin
|
|
resource 0.38.32 enabled dokku core resource plugin
|
|
scheduler-docker-local 0.38.32 enabled dokku core scheduler-docker-local plugin
|
|
shell 0.38.32 enabled dokku core shell plugin
|
|
ssh-keys 0.38.32 enabled dokku core ssh-keys plugin
|
|
storage 0.38.32 enabled dokku core storage plugin
|
|
tags 0.38.32 enabled dokku core tags plugin
|
|
tar 0.38.32 enabled dokku core tar plugin
|
|
trace 0.38.32 enabled dokku core trace plugin
|
|
```
|
|
|
|
The list can also be emitted as JSON via the `--format json` flag. In addition to the name, version, enabled state, and description shown in the default output, the JSON output includes whether a plugin is a core plugin and - for git-based third-party plugins - the install source (the git remote URL, the currently checked-out commit, and the followed branch). This is useful for tooling that reconstructs a server's set of installed plugins:
|
|
|
|
```shell
|
|
dokku plugin:list --format json
|
|
```
|
|
|
|
```json
|
|
[
|
|
{
|
|
"name": "apps",
|
|
"version": "0.38.32",
|
|
"enabled": true,
|
|
"core": true,
|
|
"description": "dokku core apps plugin",
|
|
"source_url": "",
|
|
"committish": "",
|
|
"branch": ""
|
|
},
|
|
{
|
|
"name": "postgres",
|
|
"version": "1.42.0",
|
|
"enabled": true,
|
|
"core": false,
|
|
"description": "dokku postgres service plugin",
|
|
"source_url": "https://github.com/dokku/dokku-postgres.git",
|
|
"committish": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
|
|
"branch": "master"
|
|
}
|
|
]
|
|
```
|
|
|
|
The `source_url`, `committish`, and `branch` fields are only populated for plugins installed from a git repository. They are empty for core plugins as well as for plugins installed from a tarball or a local `file://` path. When a plugin is pinned to a specific commit or tag (a detached checkout), the `branch` field is empty while `committish` still reports the exact commit.
|
|
|
|
> [!WARNING]
|
|
> All plugin commands other than `plugin:list` and `plugin:help` require 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:
|
|
|
|
```shell
|
|
dokku plugin:installed postgres
|
|
```
|
|
|
|
### Installing a plugin
|
|
|
|
> [!NOTE]
|
|
> Plugins installed in this method within a [docker-based installation](/docs/getting-started/install/docker.md) of Dokku do not persist across installs. Please see the [plugin installation section](/docs/getting-started/install/docker.md#plugin-installation) 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.
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
# 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.
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
dokku plugin:install --core
|
|
```
|
|
|
|
If installing plugins in a Dockerfile, you will want to skip the `install` trigger. This will be run on container boot.
|
|
|
|
```shell
|
|
dokku plugin:install https://github.com/dokku/smoke-test-plugin.git --name smoke-test-plugin --skip-install-trigger
|
|
```
|
|
|
|
Finally, all flags may be omitted to trigger the `install` procedures for both core and third-party plugins:
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
dokku plugin:update postgres
|
|
```
|
|
|
|
```
|
|
Plugin (postgres) updated
|
|
```
|
|
|
|
An optional commit SHA-like object may be specified.
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
dokku plugin:update postgres main
|
|
```
|
|
|
|
### Uninstalling a plugin
|
|
|
|
Third party plugins can be uninstalled using the `plugin:uninstall` command:
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
dokku plugin:disable postgres
|
|
```
|
|
|
|
```
|
|
-----> Plugin postgres disabled
|
|
```
|
|
|
|
### Enabling a plugin
|
|
|
|
Disabled plugins can be re-enabled via the `plugin:enable` command.
|
|
|
|
```shell
|
|
dokku plugin:enable postgres
|
|
```
|
|
|
|
```
|
|
-----> Plugin postgres enabled
|
|
```
|
|
|
|
Core plugins that were not enabled at install time - such as the nginx-vhosts plugin when the `dokku/nginx_enable` debconf option is set to `false` - can also be enabled this way. Run `dokku plugin:install --core` afterwards so the plugin's install trigger is executed.
|
|
|
|
### 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.
|
|
|
|
```shell
|
|
dokku plugin:trigger some-internal-trigger args-go-here
|
|
```
|