From 3837cb42cf4484783b40579916237858010629d7 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Thu, 19 Feb 2015 00:32:59 -0500 Subject: [PATCH 1/4] [ci skip] add a section on deprecated plugins --- docs/plugins.md | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/docs/plugins.md b/docs/plugins.md index a4227afd5..27a17388a 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -114,6 +114,9 @@ Note: The following plugins have been supplied by our community and may not have | Plugin | Author | Compatibility | | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- | | [CouchDB](https://github.com/racehub/dokku-couchdb-plugin) | [RaceHub][] | Compatible with 0.2.0 | +| [Elasticsearch](https://github.com/robv/dokku-elasticsearch) | [robv][] | Not compatible with >= 0.3.0 (still uses /home/git) | +| [Elasticsearch](https://github.com/jezdez/dokku-elasticsearch-plugin) | [jezdez][] | Compatible with 0.2.0 to 0.3.13 | +| [Elasticsearch](https://github.com/blag/dokku-elasticsearch-plugin)1 | [blag][] | Compatible with 0.2.0 | | [MongoDB (single container)](https://github.com/jeffutter/dokku-mongodb-plugin) | [jeffutter][] | | | [RethinkDB](https://github.com/stuartpb/dokku-rethinkdb-plugin) | [stuartpb][] | 2014-02-22: targeting dokku @ [latest][217d00a]; will fail with Dokku earlier than [28de3ec][]. | | [RiakCS (single container)](https://github.com/jeffutter/dokku-riakcs-plugin) | [jeffutter][] | Incompatible with 0.2.0 (checked at [dccee02][]) | @@ -139,27 +142,22 @@ Note: The following plugins have been supplied by our community and may not have | Plugin | Author | Compatibility | | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- | | [app-url](https://github.com/mikecsh/dokku-app-url) | [mikecsh][] | Works with 0.2.0 | -| [Custom Domains](https://github.com/neam/dokku-custom-domains) | [motin][] | Compatible with 0.2.* | -| [Debug](https://github.com/heichblatt/dokku-debug) | [heichblatt][] | | | [Docker Direct](https://github.com/heichblatt/dokku-docker-direct) | [heichblatt][] | | | [Docker Options](https://github.com/dyson/dokku-docker-options) | [dyson][] | dokku >= [c77cbf1][] | | [Dokku Name](https://github.com/alex-sherwin/dokku-name) | [alex-sherwin][] | dokku >= [c77cbf1][] | -| [Dokku Registry](https://github.com/agco-adm/dokku-registry) | [agco-adm][] | | +| [Dokku Registry](https://github.com/agco-adm/dokku-registry)1 | [agco-adm][] | | | [git rev-parse HEAD in env](https://github.com/nornagon/dokku-git-rev) | [nornagon][] | Compatible with 0.2.0 | | [HTTP Auth Secure Apps](https://github.com/matto1990/dokku-secure-apps) | [matto1990][] | Works with v0.2.3 | | [Host Port binding](https://github.com/stuartpb/dokku-bind-port) | [stuartpb][] | dokku >= [c77cbf1][]. 2014-02-17: [a043e98][] targeting dokku @ [latest][217d00a] | | [Hostname](https://github.com/michaelshobbs/dokku-hostname) | [michaelshobbs][] | | | [Link Containers](https://github.com/rlaneve/dokku-link) | [rlaneve][] | dokku >= [c77cbf1][] | | [Multi-Buildpack](https://github.com/pauldub/dokku-multi-buildpack) | [pauldub][] | | -| [Multiple Domains](https://github.com/wmluke/dokku-domains-plugin)4 | [wmluke][] | Compatible with 0.2.0 | | [Nginx-Alt](https://github.com/mikexstudios/dokku-nginx-alt) | [mikexstudios][] | Works with v0.2.3 | | [Persistent Storage](https://github.com/dyson/dokku-persistent-storage) | [dyson][] | Requires dokku >= [c77cbf1][] | | [Ports](https://github.com/heichblatt/dokku-ports) | [heichblatt][] | | | [Pre-Deploy Tasks](https://github.com/michaelshobbs/dokku-app-predeploy-tasks) | [michaelshobbs][] | | -| [Rebuild application](https://github.com/scottatron/dokku-rebuild) | [scottatron][] | Compatible with 0.2.x | | [SSH Deployment Keys](https://github.com/cedricziel/dokku-deployment-keys)2 | [cedricziel][] | 2014-01-17: compatible with upstream/master | | [SSH Hostkeys](https://github.com/cedricziel/dokku-hostkeys-plugin)3 | [cedricziel][] | 2014-01-17: compatible with upstream/master | -| [Supply env vars to buildpacks](https://github.com/cameron-martin/dokku-build-env) | [cameron-martin][] | Works with v0.2.3 | | [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration) | [motin][] | Compatible with 0.3.1 | | [Volume (persistent storage)](https://github.com/ohardy/dokku-volume) | [ohardy][] | Compatible with 0.2.0 | @@ -168,15 +166,13 @@ Note: The following plugins have been supplied by our community and may not have [98332de]: https://github.com/dyson/dokku-persistent-storage/commit/98332de4b5b640610bee535f4d5260263074e18b [a043e98]: https://github.com/stuartpb/dokku-bind-port/commit/a043e9892f4815b6525c850131e09fd64db5c1fa +1 On Heroku similar functionality is offered by the [heroku-labs pipeline feature](https://devcenter.heroku.com/articles/labs-pipelines), which allows you to promote builds across multiple environments (staging -> production) + 2 Adds the possibility to add SSH deployment keys to receive private hosted packages 3 Adds the ability to add custom hosts to the containers known_hosts file to be able to ssh them easily (useful with deployment keys) -4 Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration) - -5 On Heroku similar functionality is offered by the [heroku-labs pipeline feature](https://devcenter.heroku.com/articles/labs-pipelines), which allows you to promote builds across multiple environments (staging -> production) - -### Other Add-ons +### Other Plugins | Plugin | Author | Compatibility | | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- | @@ -187,9 +183,6 @@ Note: The following plugins have been supplied by our community and may not have | [Bower install](https://github.com/alexanderbeletsky/dokku-bower-install) | [alexanderbeletsky][] | | | [Bower/Grunt](https://github.com/thrashr888/dokku-bower-grunt-build-plugin) | [thrashr888][] | | | [Bower/Gulp](https://github.com/gdi2290/dokku-bower-gulp-build-plugin) | [gdi2290][] | | -| [Elasticsearch](https://github.com/robv/dokku-elasticsearch) | [robv][] | Not compatible with >= 0.3.0 (still uses /home/git) | -| [Elasticsearch](https://github.com/jezdez/dokku-elasticsearch-plugin) | [jezdez][] | Compatible with 0.2.0 to 0.3.13 | -| [Elasticsearch](https://github.com/blag/dokku-elasticsearch-plugin)1 | [blag][] | Compatible with 0.2.0 | | [HipChat Notifications](https://github.com/cef/dokku-hipchat) | [cef][] | | | [Graphite/statsd](https://github.com/jlachowski/dokku-graphite-plugin) | [jlachowski][] | | | [APT](https://github.com/F4-Group/dokku-apt) | [F4-Group][] | | @@ -197,3 +190,20 @@ Note: The following plugins have been supplied by our community and may not have | [PrimeCache](https://github.com/darkpixel/dokku-prime-cache) | [darkpixel][] | | 1 Forked from [jezdez/dokku-elasticsearch-plugin](https://github.com/jezdez/dokku-elasticsearch-plugin): uses Elasticsearch 1.2 (instead of 0.90), doesn't depend on dokku-link, runs as elasticsearch user instead of root, and turns off multicast autodiscovery for use in a VPS environment. + +### Deprecated Plugins + +The following plugins have been removed as their functionality is now in Dokku Core. + +| Plugin | Author | In Dokku Since | +| ------------------------------------------------------------------------------------------------- | --------------------- | ------------------------- | +| [Custom Domains](https://github.com/neam/dokku-custom-domains) | [motin][] | v0.3.10 (domains plugin) | +| [Debug](https://github.com/heichblatt/dokku-debug) | [heichblatt][] | v0.3.9 (trace command) | +| [Multiple Domains](https://github.com/wmluke/dokku-domains-plugin)1 | [wmluke][] | v0.3.10 (domains plugin) | +| [Rebuild application](https://github.com/scottatron/dokku-rebuild) | [scottatron][] | v0.3.14 (ps plugin) | +| [Supply env vars to buildpacks](https://github.com/cameron-martin/dokku-build-env)2 | [cameron-martin][] | v0.3.9 (build-env plugin) | +| [user-env-compile](https://github.com/musicglue/dokku-user-env-compile)2 | [musicglue][] | v0.3.9 (build-env plugin) | +| [user-env-compile](https://github.com/motin/dokku-user-env-compile)2 | [motin][] | v0.3.9 (build-env plugin) | + +1 Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration) +2 Similar to the heroku-labs feature (see https://devcenter.heroku.com/articles/labs-user-env-compile) From 51d704c123cd556e26cc7d24e8552a14d7edaa97 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Thu, 19 Feb 2015 00:33:37 -0500 Subject: [PATCH 2/4] [ci skip] fix link to advanced installation docs --- docs/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index 47ee35112..c45ed4f7b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -30,4 +30,4 @@ For various reasons, certain hosting providers may have other steps that should As well, you may wish to customize your installation in some other fashion. or experiment with vagrant. The guides below should get you started: - [Vagrant Installation Notes](http://progrium.viewdocs.io/dokku/getting-started/install/vagrant) -- [Advanced Install Customization](http://progrium.viewdocs.io/dokku/getting-started/install/advanced) +- [Advanced Install Customization](http://progrium.viewdocs.io/dokku/advanced-installation) From 1cba586e9096b999d440885f35c02225d911fa03 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Thu, 19 Feb 2015 00:44:36 -0500 Subject: [PATCH 3/4] Add an entry for dokku-toolbelt --- docs/community/clients.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/community/clients.md b/docs/community/clients.md index c26ccd430..4b5228b64 100644 --- a/docs/community/clients.md +++ b/docs/community/clients.md @@ -20,6 +20,16 @@ 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): + +```shell +npm install -g dokku-toolbelt +``` + +See [documentation here](https://www.npmjs.com/package/dokku-toolbelt) 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): From c7bde60966ca259d37e180c710bbf0e8dd82529b Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Thu, 19 Feb 2015 00:53:52 -0500 Subject: [PATCH 4/4] [ci skip] add "Where To Get Help" section --- docs/getting-started/where-to-get-help.md | 25 +++++++++++++++++++++++ docs/index.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 docs/getting-started/where-to-get-help.md diff --git a/docs/getting-started/where-to-get-help.md b/docs/getting-started/where-to-get-help.md new file mode 100644 index 000000000..170299f18 --- /dev/null +++ b/docs/getting-started/where-to-get-help.md @@ -0,0 +1,25 @@ +# Where to Get Help + +If you’re stuck, there are a number of places you can get help: + +## The Official Dokku Website + +[http://progrium.viewdocs.io/dokku](http://progrium.viewdocs.io/dokku) + +The Official Dokku website is always a great place to visit. It features links to oft-used developer tools, community plugins, and guides on using dokku. + +## The IRC Channel + +IRC Channel on irc.freenode.net: + +- #dokku – General Discussion + +If you’re stumped, give us a holler in the Dokku IRC channel. Someone from the development team is usually there, especially during the daylight hours for North and South America users. We’d love to hear from you, whether you need some help, want to find users in your area, or would like to donate your brand new sports car. + +If [here](http://webchat.freenode.net/?channels=dokku) for a web-based client IRC client. + +## Stackoverflow + +http://stackoverflow.com/ + +Tag your questions with `dokku` to enable existing users of stackoverflow to find your questions. diff --git a/docs/index.md b/docs/index.md index 249e4a367..52f86918a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,7 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. - [Installation](http://progrium.viewdocs.io/dokku/installation) - [Upgrading](http://progrium.viewdocs.io/dokku/upgrading) - [Troubleshooting](http://progrium.viewdocs.io/dokku/troubleshooting) +- [Getting Help](http://progrium.viewdocs.io/dokku/getting-started/where-to-get-help) ### Deployment