Improve This Doc
Getting Started Getting Started with Dokku Upgrading Dokku Uninstalling Dokku Troubleshooting Getting Help Commercial Dokku Pro Deployment Deploying an Application Application Management Application Logs Remote Commands User Management Zero Downtime Deploy Checks Builders Builder Management Cloud Native Buildpacks Herokuish Buildpacks Dockerfile Deployment Lambda Builder Null Builder Deployment Methods Git Deployment Configuration Environment Variables Domain Configuration SSL Configuration Interacting with Processes Entering Containers One-Off Tasks Process Management Scheduled Cron Tasks Network Management DNS Configuration Network Management Port Management Proxy Configuration Proxy Management Caddy Proxy Nginx Proxy Traefik Proxy Advanced Usage Backup and Recovery Deployment Tasks Docker Container Options Docker Registry Management Event Logs Persistent Storage Plugin Management Repository Management Resource Management Schedulers Scheduler Management Docker Local Kubernetes Nomad Null Scheduler Alternate Schedulers Development Plugin Creation Plugin Triggers Running Tests Release Process Continuous Integration GitHub Actions GitLab CI Generic Community Contributions Clients Plugins Community Tutorials Run on External Volume

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.

The easiest way to interact with Dokku remotely is by using the official client. Documented below are the various clients that you may wish to use.

Official Client

See the remote commands documentation for more information on how to install and use the official client.

(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.

(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.

  v: master
Versions
On GitHub
View
Edit