Dokku commands can be run over SSH. Anywhere you would run
dokku <command>, just run
ssh -t email@example.com <command>
-t is used to request a pty. It is highly recommended to do so.
To avoid the need to type the
-t option each time, simply create/modify a section in the
.ssh/config on the client side, as follows:
Host dokku.me RequestTTY yes
Dokku also supports certain command line arguments that augment its behavior. If using these over SSH, you must use the form
ssh -t firstname.lastname@example.org -- <command>
in order to avoid SSH interpretting Dokku arguments for itself.
--quiet suppress output headers --trace enable DOKKU_TRACE for current execution only --force force flag. currently used in apps:destroy and other ":destroy" commands
You may optionally use the official client when connecting to the Dokku server.
Of all methods, this is the most official method of interacting with your Dokku installation. It is a bash script that interacts with a remote Dokku installation via
ssh. It is available in
contrib/dokku_client.sh in the root of the Dokku repository.
It can be installed either via the Homebrew package manager (macOS only), or manually.
To install, simply run the following command:
brew install dokku/repo/dokku
To install manually, simply clone the Dokku repository down and add the
dokku alias pointing at the script:
git clone email@example.com:dokku/dokku.git ~/.dokku # optional: make sure that the dokku_client.sh version matches your Dokku version cd ~/.dokku git checkout <tag/branch> # add the following to either your # .bashrc, .bash_profile, or .profile file alias dokku='$HOME/.dokku/contrib/dokku_client.sh'
Alternatively, if using another shell such as zsh, create an alias command which invokes the script using bash:
# zsh: add the following to either .zshenv or .zshrc alias dokku='bash $HOME/.dokku/contrib/dokku_client.sh' # fish: add the following to ~/.config/fish/config.fish alias dokku 'bash $HOME/.dokku/contrib/dokku_client.sh' # csh: add the following to .cshrc alias dokku 'bash $HOME/.dokku/contrib/dokku_client.sh'
All commands have the application name automatically set via the
--app flag on the remote server, and thus the app name does not need to be specified manually for core plugins.
The client supports several environment variables:
dokkugit remote): Used to interact with a specific remote server. Can be overriden via
22): Used to specify a port to connect to the Dokku server on.
It also supports several flags (all flags unspecified here are passed as is to the server):
--app: Override the remote app in use.
--trace: Enable trace mode.
--remote: Override the remote server.
--global: Unsets the "app" value. May not be supported for the specified command.
In addition, the following commands have special local side-effects:
--appflag is specified or detected from a
dokkugit remote, a random name is generated and used for the app.
dokkugit remote is set if not already set.
dokkugit remote if set.
Please refer to the community clients list for more details.