From 5c5039a5337f6f04fa259e86f713086d72633718 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 18 Feb 2015 02:10:42 -0500 Subject: [PATCH] [ci skip] Add documentation for existing clients. Closes #977 --- docs/community/clients.md | 51 +++++++++++++++++++++++++++++++++++++++ docs/index.md | 2 +- 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/community/clients.md diff --git a/docs/community/clients.md b/docs/community/clients.md new file mode 100644 index 000000000..c26ccd430 --- /dev/null +++ b/docs/community/clients.md @@ -0,0 +1,51 @@ +# 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 various ways in which you can interact with your dokku installation. + +## (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: + +```shell +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. + +## (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): + +```shell +pip install dokku-client +``` + +See [documentation here](https://github.com/adamcharnock/dokku-client) 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): + +```shell +gem install dokku-cli +``` + +See [documentation here](https://github.com/SebastianSzturo/dokku-cli) 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): + +```shell +gem install dokku_client +``` + +See [documentation here](https://github.com/netguru/dokku_client) for more information. diff --git a/docs/index.md b/docs/index.md index 15bc97e7c..249e4a367 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,6 +19,7 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. ### Community Contributions +- [Clients](http://progrium.viewdocs.io/dokku/community/clients) - [Plugins](http://progrium.viewdocs.io/dokku/plugins) ### Development @@ -30,7 +31,6 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. * **Multi-host.** It runs on one host. If you need more, have a look at [Deis](http://deis.io/). * **Multitenancy.** Multi-app, and loosely multi-user based on SSH keys, but that's it. - * **Client app.** Given the constraints, running commands remotely via SSH is fine. ## Sponsors