Files
dokku/docs/community/clients.md

3.2 KiB

Clients

Given the constraints, running dokku commands remotely via SSH is fine. For certain configurations, the extra complication of manually invoking ssh can be a burden.

While dokku does not yet have an official client, there are a multitude of ways in which you can interact with your dokku installation. The easiest is to use the bash client, though you may wish to use another.

(bash) dokku_client.sh

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.

To install, simply clone the dokku repository down and add the dokku alias pointing at the script:

git clone git@github.com:progrium/dokku.git ~/.dokku

# add the following to either your
# .bashrc, .bash_profile, or .profile file
alias dokku='$HOME/.dokku/contrib/dokku_client.sh'

Configure the DOKKU_HOST environment variable or run dokku from a repository with a git remote named dokku pointed at your dokku host in order to use the script as normal.

(nodejs) dokku-toolbelt

Dokku-toolbelt is a node-based cli wrapper that proxies requests to the dokku command running on remote hosts. You can install it via the following shell command (assuming you have nodejs and npm installed):

npm install -g dokku-toolbelt

See documentation here for more information.

(python) dokku-client

dokku-client is an extensible python-based cli wrapper for remote dokku hosts. You can install it via the following shell command (assuming you have python and pip installed):

pip install dokku-client

See documentation here for more information.

(ruby) Dokku CLI

Dokku CLI is a rubygem that acts as a client for your dokku installation. You can install it via the following shell command (assuming you have ruby and rubygems installed):

gem install dokku-cli

See documentation here for more information.

(ruby) DokkuClient

DokkuClient is another rubygem that acts as a client for your dokku installation with built-in support for certain external plugins. You can install it via the following shell command (assuming you have ruby and rubygems installed):

gem install dokku_client

See documentation here for more information.

(ruby) Dokkufy

Dokkufy is a rubygem that handles automation of certain tasks, such as dokku setup, plugin installation, etc. You can install it via the following shell command (assuming you have ruby and rubygems installed):

gem install dokkufy

See documentation here for more information.

(ruby) Dockland

Dockland is a rubygem that acts as a client for your dokku installation. You can install it via the following shell command (assuming you have ruby and rubygems installed):

gem install dockland

See documentation here for more information.