cd9c2d7dbe
# History ## 0.11.0 ### Bug Fixes - #2998: @josegonzalez Fix issues in release process - #2993: @josegonzalez Add config_all alias for plugin usage - #2972: @buckle2000 Correct typo in docker-options:remove error output - #2964: @znz Remove unused variable - #2967: @znz Fix indentation in test file - #2963: @znz Correct typos in config plugin and remove potential infinite recursion issue - #2951: @josegonzalez Handle case where the app directory is a symlink - #2939: @znz Remove unnecessary lines - #2945: @znz Fix network plugin version - #2937: @michaelshobbs Strip restart flag from app_user_pre_deploy_trigger - #2931: @josegonzalez Upgrade git package for CI - #2928: @silverfix Do not overwrite the VHOST file during installation if it exists - #2926: @vtavernier Remove leading forward slash from app name in git-upload-pack ### New Features - #2985: @bitmand Build a custom dhparam file once for nginx and include it as default - #2974: @josegonzalez Upgrade to herokuish 0.3.33 - #2973: @josegonzalez Allow usage of git 2.13.0+ by unsetting GIT_QUARANTINE_PATH during git worktree usage - #2971: @miraculixx Add support for older virtualbox versions in official Dokku Vagrantfile - #2966: @znz Simplify internal config functions to reduce duplication - #2751: @alexquick Move config plugin to golang - #2938: @michaelshobbs Upgrade to golang 1.9.1 - #2736: @josegonzalez Implement Network Plugin - #2929: @michaelshobbs Add codacy config and coverage targets ### Documentation - #2935: @jcrben Document how to make herokuish optional during the bootstrap installation - #2982: @agorf Correct typo in user management docs - #2981: @agorf Correct typos in process management docs - #2969: @znz Correct comments on network triggers - #2965: @znz Remove spaces from config subcommand help output to mirror help output of other subcommands - #2954: @mrname Add vernemq community datastore plugin to docs - #2944: @axilleas Fix syntax typo in debian installation docs - #2932: @znz Update code comment to match documentation - #2933: @znz Fix version number for network binding documentation
4.3 KiB
4.3 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 tag|branch|commit|--name custom-plugin-name]] # Optionally download git-url (with custom tag/committish) & run install trigger for active plugins (or only core ones)
plugin:install-dependencies [--core] # Run install-dependencies trigger for active plugins (or only core ones)
plugin:list # Print active plugins
plugin:uninstall <name> # Uninstall a plugin (third-party only)
plugin:update [name [committish]] # Optionally update named plugin from git (with custom tag/committish) & 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
You can list all installed plugins using the plugin command:
dokku plugin
plugn: dev
00_dokku-standard 0.11.0 enabled dokku core standard plugin
20_events 0.11.0 enabled dokku core events logging plugin
apps 0.11.0 enabled dokku core apps plugin
build-env 0.11.0 enabled dokku core build-env plugin
certs 0.11.0 enabled dokku core certificate management plugin
checks 0.11.0 enabled dokku core checks plugin
common 0.11.0 enabled dokku core common plugin
config 0.11.0 enabled dokku core config plugin
docker-options 0.11.0 enabled dokku core docker-options plugin
domains 0.11.0 enabled dokku core domains plugin
enter 0.11.0 enabled dokku core enter plugin
git 0.11.0 enabled dokku core git plugin
logs 0.11.0 enabled dokku core logs plugin
named-containers 0.11.0 enabled dokku core named containers plugin
nginx-vhosts 0.11.0 enabled dokku core nginx-vhosts plugin
plugin 0.11.0 enabled dokku core plugin plugin
proxy 0.11.0 enabled dokku core proxy plugin
ps 0.11.0 enabled dokku core ps plugin
repo 0.11.0 enabled dokku core repo plugin
shell 0.11.0 enabled dokku core shell plugin
ssh-keys 0.11.0 enabled dokku core ssh-keys plugin
storage 0.11.0 enabled dokku core storage plugin
tags 0.11.0 enabled dokku core tags plugin
tar 0.11.0 enabled dokku core tar plugin
Installing a plugin is easy as well using the plugin:install command. This command will also trigger the install pluginhook on all existing plugins.
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
You can also uninstall a third-party plugin using the plugin:uninstall command:
dokku plugin:uninstall postgres
-----> Plugin postgres uninstalled
Enabling or disabling a plugin can also be useful in cases where you are debugging whether a third-party plugin is causing issues in your Dokku installation:
dokku plugin:disable postgres
-----> Plugin postgres disabled
dokku plugin:enable postgres
-----> Plugin postgres enabled
Finally, you can update an installed third-party plugin. 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.
dokku plugin:update postgres
Plugin (postgres) updated