Release 0.5.0

- Drop tutum-agent, lxc-docker, docker.io apt package support
- Release a new herokuish version
- Fix release docs
- Upgrade sigil

.editorconfig

@@ -4,3 +4,13 @@ root = true
 insert_final_newline = true
 indent_style = space
 indent_size = 2
+
+[Makefile]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+
+[*.mk]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4

.gitignore

@@ -1,3 +1,6 @@
 .vagrant
 .DS_Store
 stack.tgz
+tmp
+*.deb
+.ruby-version

.s3cfg

@@ -1,38 +0,0 @@
-[default]
-access_key
-secret_key
-bucket_location = US
-cloudfront_host = cloudfront.amazonaws.com
-cloudfront_resource = /2010-07-15/distribution
-default_mime_type = binary/octet-stream
-delete_removed = False
-dry_run = False
-encoding = UTF-8
-encrypt = False
-follow_symlinks = False
-force = False
-get_continue = False
-gpg_command = None
-gpg_decrypt = %(gpg_command)s -d --verbose --no-use-agent --batch --yes --passphrase-fd %(passphrase_fd)s -o %(output_file)s %(input_file)s
-gpg_encrypt = %(gpg_command)s -c --verbose --no-use-agent --batch --yes --passphrase-fd %(passphrase_fd)s -o %(output_file)s %(input_file)s
-gpg_passphrase = 
-guess_mime_type = True
-host_base = s3.amazonaws.com
-host_bucket = %(bucket)s.s3.amazonaws.com
-human_readable_sizes = False
-list_md5 = False
-log_target_prefix = 
-preserve_attrs = True
-progress_meter = True
-proxy_host = 
-proxy_port = 0
-recursive = False
-recv_chunk = 4096
-reduced_redundancy = False
-send_chunk = 4096
-simpledb_host = sdb.amazonaws.com
-skip_existing = False
-socket_timeout = 300
-urlencoding_mode = normal
-use_https = False
-verbosity = WARNING

.travis.yml

@@ -1,16 +0,0 @@
----
-branches:
-  only:
-    - master
-script:
-  - echo "StrictHostKeyChecking=no" >> ~/.ssh/config
-  - export IP=$(curl -s http://dokku-ci.herokuapp.com/hosts | tail -1)
-  - git config --global user.email "travis-ci@exmaple.com"
-  - git config --global user.name "Travis CI"
-  - git checkout --orphan orphan HEAD
-  - git commit -am 'orphaned'
-  - git remote add runner ssh://test@$IP:2022/dokku
-  - sleep 8
-  - git push runner orphan:master
-notifications:
-  irc: "chat.freenode.net#dokku"

AUTHORS

@@ -1,19 +0,0 @@
-# If you're submitting a patch, please add your name here in alphabetical order as part of the patch.
-# This file lists all individuals having contributed content to the repository.
-#
-Alexander <iam.asm89@gmail.com>
-Alexander Beletsky <alexander.beletsky@gmail.com>
-Alexis Gavoty <kload@kload.fr>
-Felipe Coury <felipe.coury@gmail.com>
-Jeff Lindsay <progrium@gmail.com>
-Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>
-Leo Unbekandt <leo@unbekandt.eu>
-Ludovic Perrine <jazzzz@gmail.com>
-Luigi Maselli <grigio.org@gmail.com>
-Martin Weiss <kornnflake@gmail.com>
-Paul Lietar <paul@lietar.net>
-Rajiv Makhijani <rajiv@blue-tech.org>
-rhy-jot <rhy-jot@myeml.net>
-Richard North <rich.north@gmail.com>
-Sebastian Götte <github@jaseg.net>
-Silas Baronda <silas.baronda@gmail.com>

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dokku@josediazgonzalez.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,160 @@
+# How to contribute
+
+Dokku loves to welcome your contributions. There are several ways to help out:
+
+* Create an [issue](https://github.com/dokku/dokku/issues) on GitHub, if you
+  have found a bug
+* Write test cases for open bug issues
+* Write patches for open bug/feature issues, preferably with test cases
+  included
+* Contribute to the [documentation](http://dokku.viewdocs.io/dokku/)
+
+There are a few guidelines that we need contributors to follow so that we have
+a chance of keeping on top of things.
+
+## Topics
+
+* [Reporting Security Issues](#reporting-security-issues)
+* [Reporting Issues](#reporting-other-issues)
+* [Contributing](#contributing)
+  * [Making Changes](#making-changes)
+  * [Which branch to base the work](#which-branch-to-base-the-work)
+  * [Submitting Changes](#submitting-changes)
+  * [When will my change be merged?](#when-will-my-change-be-merged)
+  * [Test cases and codesniffs](#test-cases-and-codesniffs)
+* [Additional Resources](#additional-resources)
+
+## Reporting security issues
+
+The Dokku maintainers take security seriously. If you discover a security
+issue, please bring it to their attention right away!
+
+Please **DO NOT** file a public issue, instead send your report privately to
+[dokku@josediazgonzalez.com](mailto:dokku@josediazgonzalez.com),
+
+Security reports are greatly appreciated and we will publicly thank you for it.
+
+## Reporting other issues
+
+A great way to contribute to the project is to send a detailed report when you
+encounter an issue. We always appreciate a well-written, thorough bug report,
+and will thank you for it!
+
+Sometimes dokku is missing a feature you need. In some cases, those features can
+be found in pre-existing [plugins](http://dokku.viewdocs.io/dokku/plugins/),
+and we encourage our users to create and contribute such packages. From time to
+time, we will also pull plugins into the dokku core when the task they solve is
+a common one for our users.
+
+Check that [our issue database](https://github.com/dokku/dokku/issues)
+doesn't already include that problem or suggestion before submitting an issue.
+If you find a match, add a quick "+1" or "I have this problem too." Doing this
+helps prioritize the most common problems and requests.
+
+When reporting issues, please include your host OS (Ubuntu 14.04, Fedora 19,
+etc). Please include:
+
+* The output of `uname -a`.
+* The output of `free -m`
+* The output of `docker version`.
+* The output of `docker -D info`.
+* The output of `sigil -v`.
+* The output of `docker run --rm -ti gliderlabs/herokuish:latest herokuish version`
+* The output of `dokku version`.
+* The output of `dokku plugin`.
+
+Please also include the steps required to reproduce the problem if possible and
+applicable. This information will help us review and fix your issue faster.
+
+Our Issue Report Template is available [here](https://github.com/dokku/dokku/blob/master/ISSUE_TEMPLATE.md)
+
+## Contributing
+
+Before you contribute to the dokku project, there are a few things that you'll
+need to do
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Submit an [issue](https://github.com/dokku/dokku/issues), assuming one
+  does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub.
+
+### Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target an existing branch if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on master; `git checkout -b my_contribution origin/master`.
+    It is best to avoid working directly on the `master` branch. Doing so will
+    help avoid conflicts if you pull in updates from origin.
+* Make commits of logical units. Implementing a new function and calling it in
+  another file constitute a single logical unit of work.
+  * Before you make a pull request, squash your commits into logical units of work
+    using `git rebase -i` and `git push -f`.
+  * A majority of submissions should have a single commit, so if in doubt,
+    squash your commits down to one commit.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Use descriptive commit messages and reference the #issue number.
+* Core test cases should continue to pass. You can run tests locally or enable
+  [circle-ci](https://circleci.com/gh/dokku/dokku) for your fork, so all
+  tests and codesniffs will be executed.
+* Your work should apply the [Dokku coding standards](https://github.com/progrium/bashstyle)
+* Pull requests must be cleanly rebased on top of master without multiple branches
+  mixed into the PR.
+  * **Git tip**: If your PR no longer merges cleanly, use `rebase master` in your
+    feature branch to update your pull request rather than `merge master`.
+
+### Which branch to base the work
+
+All changes should be be based on the latest master commit.
+
+### Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the repository on github, with the correct target
+  branch.
+
+### When will my change be merged?
+
+Be patient! The dokku maintainers will review all pull requests and comment as
+quickly as possible. There may be some back and forth while the details of your
+pull request are discussed.
+
+In the unlikely event that your pull request does not get merged, the dokku
+maintainers will either provide an alternative patch or guide you towards a
+better solution to the problem at hand.
+
+During our pre-1.0 cycle, we will follow these general rules when merging pull
+requests:
+
+- bugfix (patch)
+- security (patch/minor)
+- minor feature (patch)
+- backwards incompatible change (minor)
+- major feature (minor)
+
+### Test cases and codesniffs
+
+Dokku tests require [bats](https://github.com/sstephenson/bats).
+To run the test cases locally use the following command:
+
+    make ci-dependencies
+    make unit-tests deploy-tests
+
+To run the shellcheck sniffs for Dokku coding standards:
+
+    make ci-dependencies
+    make lint
+
+The [testing docs](http://dokku.viewdocs.io/dokku/development/testing/)
+contains installation info for bats and shellcheck.
+
+# Additional Resources
+
+* [Dokku coding standards](https://github.com/progrium/bashstyle)
+* [Existing issues](https://github.com/dokku/dokku/issues)
+* [General GitHub documentation](https://help.github.com/)
+* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+* [#dokku IRC channel on freenode.org](https://webchat.freenode.net/?channels=dokku)

ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+Description of problem:
+
+
+Output of the following commands
+
+- `uname -a`:
+- `free -m`:
+- `docker version`:
+- `docker -D info`:
+- `sigil -v`:
+- `docker run -ti gliderlabs/herokuish:latest herokuish version`:
+- `dokku version`:
+- `dokku plugin`:
+- `docker inspect CONTAINER_ID` (if applicable):
+  (BEWARE: `docker inspect` will print environment variables for some commands, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXXX):
+- `cat /home/dokku/<app>/nginx.conf` (if applicable):
+- Link to the exact repository being deployed (if possible/applicable):
+- If a deploy is failing:
+  - Application name
+  - The type of application being deployed (node, php, python, ruby, etc.)
+  - Whether or not you have a `Dockerfile` in the root of your repository
+  - If using buildpacks, which custom buildpacks are in use
+  - If it exists, the contents of your `Procfile`.
+- Output of failing dokku commands after running `dokku trace on`
+  (BEWARE: `trace on` will print environment variables for some commands, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXXX):
+
+Environment details (AWS, VirtualBox, physical, etc.):
+
+How was dokku installed?:
+
+How reproducible:
+
+
+Steps to Reproduce:
+1.
+2.
+3.
+
+Actual Results:
+
+
+Expected Results:
+
+
+Additional info:

Makefile

@@ -1,10 +1,13 @@
 DOKKU_VERSION = master
 
-SSHCOMMAND_URL ?= https://raw.github.com/progrium/sshcommand/master/sshcommand
-PLUGINHOOK_URL ?= https://s3.amazonaws.com/progrium-pluginhook/pluginhook_0.1.0_amd64.deb
-STACK_URL ?= https://github.com/progrium/buildstep.git
-PREBUILT_STACK_URL ?= https://github.com/progrium/buildstep/releases/download/2014-03-08/2014-03-08_429d4a9deb.tar.gz
-DOKKU_ROOT ?= /home/dokku
+SSHCOMMAND_URL ?= https://raw.githubusercontent.com/dokku/sshcommand/master/sshcommand
+PLUGN_URL ?= https://github.com/dokku/plugn/releases/download/v0.2.1/plugn_0.2.1_linux_x86_64.tgz
+SIGIL_URL ?= https://github.com/gliderlabs/sigil/releases/download/v0.4.0/sigil_0.4.0_Linux_x86_64.tgz
+STACK_URL ?= https://github.com/gliderlabs/herokuish.git
+PREBUILT_STACK_URL ?= gliderlabs/herokuish:latest
+DOKKU_LIB_ROOT ?= /var/lib/dokku
+PLUGINS_PATH ?= ${DOKKU_LIB_ROOT}/plugins
+CORE_PLUGINS_PATH ?= ${DOKKU_LIB_ROOT}/core-plugins
 
 # If the first argument is "vagrant-dokku"...
 ifeq (vagrant-dokku,$(firstword $(MAKECMDGOALS)))
@@ -14,87 +17,136 @@ ifeq (vagrant-dokku,$(firstword $(MAKECMDGOALS)))
   $(eval $(RUN_ARGS):;@:)
 endif
 
-.PHONY: all install copyfiles version plugins dependencies sshcommand pluginhook docker aufs stack count dokku-installer vagrant-acl-add vagrant-dokku
+ifeq ($(CIRCLECI),true)
+	BUILD_STACK_TARGETS = circleci deps build
+else
+	BUILD_STACK_TARGETS = build-in-docker
+endif
+
+.PHONY: all apt-update install version copyfiles man-db plugins dependencies sshcommand plugn docker aufs stack count dokku-installer vagrant-acl-add vagrant-dokku
+
+include tests.mk
+include deb.mk
+include arch.mk
 
 all:
 	# Type "make install" to install.
 
-install: dependencies stack copyfiles plugin-dependencies plugins version
+install: dependencies version copyfiles plugin-dependencies plugins
 
-copyfiles: addman
+release: deb-all package_cloud packer
+
+package_cloud:
+	package_cloud push dokku/dokku/ubuntu/trusty herokuish*.deb
+	package_cloud push dokku/dokku/ubuntu/trusty sshcommand*.deb
+	package_cloud push dokku/dokku/ubuntu/trusty plugn*.deb
+	package_cloud push dokku/dokku/ubuntu/trusty dokku*.deb
+
+packer:
+	packer build contrib/packer.json
+
+copyfiles:
 	cp dokku /usr/local/bin/dokku
-	mkdir -p /var/lib/dokku/plugins
-	find /var/lib/dokku/plugins -mindepth 2 -maxdepth 2 -name '.core' -printf '%h\0' | xargs -0 rm -Rf
+	mkdir -p ${CORE_PLUGINS_PATH} ${PLUGINS_PATH}
+	rm -rf ${CORE_PLUGINS_PATH}/*
+	test -d ${CORE_PLUGINS_PATH}/enabled || PLUGIN_PATH=${CORE_PLUGINS_PATH} plugn init
+	test -d ${PLUGINS_PATH}/enabled || PLUGIN_PATH=${PLUGINS_PATH} plugn init
 	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do \
-	    rm -Rf /var/lib/dokku/plugins/$$plugin && \
-	    cp -R plugins/$$plugin /var/lib/dokku/plugins && \
-	    touch /var/lib/dokku/plugins/$$plugin/.core; \
-	    done
+		rm -Rf ${CORE_PLUGINS_PATH}/available/$$plugin && \
+		rm -Rf ${PLUGINS_PATH}/available/$$plugin && \
+		rm -rf ${CORE_PLUGINS_PATH}/$$plugin && \
+		rm -rf ${PLUGINS_PATH}/$$plugin && \
+		cp -R plugins/$$plugin ${CORE_PLUGINS_PATH}/available && \
+		ln -s ${CORE_PLUGINS_PATH}/available/$$plugin ${PLUGINS_PATH}/available; \
+		find /var/lib/dokku/ -xtype l -delete;\
+		PLUGIN_PATH=${CORE_PLUGINS_PATH} plugn enable $$plugin ;\
+		PLUGIN_PATH=${PLUGINS_PATH} plugn enable $$plugin ;\
+		done
+	chown dokku:dokku -R ${PLUGINS_PATH} ${CORE_PLUGINS_PATH}
+	$(MAKE) addman
 
 addman:
 	mkdir -p /usr/local/share/man/man1
-	cp dokku.1 /usr/local/share/man/man1/dokku.1
+	help2man -Nh help -v version -n "configure and get information from your dokku installation" -o /usr/local/share/man/man1/dokku.1 dokku
 	mandb
 
 version:
-	git describe --tags > ${DOKKU_ROOT}/VERSION  2> /dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ${DOKKU_ROOT}/VERSION
+	git describe --tags > ~dokku/VERSION  2> /dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ~dokku/VERSION
 
-plugin-dependencies: pluginhook
-	dokku plugins-install-dependencies
+plugin-dependencies: plugn
+	sudo -E dokku plugin:install-dependencies --core
 
-plugins: pluginhook docker
-	dokku plugins-install
+plugins: plugn docker
+	sudo -E dokku plugin:install --core
 
-dependencies: sshcommand pluginhook docker stack
+dependencies: apt-update sshcommand plugn docker help2man man-db sigil
+	$(MAKE) -e stack
+
+apt-update:
+	apt-get update
+
+help2man:
+	apt-get install -qq -y help2man
+
+man-db:
+	apt-get install -qq -y man-db
 
 sshcommand:
 	wget -qO /usr/local/bin/sshcommand ${SSHCOMMAND_URL}
 	chmod +x /usr/local/bin/sshcommand
 	sshcommand create dokku /usr/local/bin/dokku
 
-pluginhook:
-	wget -qO /tmp/pluginhook_0.1.0_amd64.deb ${PLUGINHOOK_URL}
-	dpkg -i /tmp/pluginhook_0.1.0_amd64.deb
+plugn:
+	wget -qO /tmp/plugn_latest.tgz ${PLUGN_URL}
+	tar xzf /tmp/plugn_latest.tgz -C /usr/local/bin
+
+sigil:
+	wget -qO /tmp/sigil_latest.tgz ${SIGIL_URL}
+	tar xzf /tmp/sigil_latest.tgz -C /usr/local/bin
 
 docker: aufs
 	apt-get install -qq -y curl
 	egrep -i "^docker" /etc/group || groupadd docker
 	usermod -aG docker dokku
-	curl --silent https://get.docker.io/gpg | apt-key add -
-	echo deb http://get.docker.io/ubuntu docker main > /etc/apt/sources.list.d/docker.list
-	apt-get update
+ifndef CI
+	wget -nv -O - https://get.docker.com/ | sh
 ifdef DOCKER_VERSION
-	apt-get install -qq -y lxc-docker-${DOCKER_VERSION}
-else
-	apt-get install -qq -y lxc-docker
+	apt-get install -qq -y docker-engine=${DOCKER_VERSION} || (apt-cache madison docker-engine ; exit 1)
 endif
 	sleep 2 # give docker a moment i guess
+endif
 
 aufs:
+ifndef CI
 	lsmod | grep aufs || modprobe aufs || apt-get install -qq -y linux-image-extra-`uname -r` > /dev/null
+endif
 
 stack:
-	@echo "Start building buildstep"
+ifeq ($(shell test -e /var/run/docker.sock && touch -c /var/run/docker.sock && echo $$?),0)
 ifdef BUILD_STACK
-	@docker images | grep progrium/buildstep || (git clone ${STACK_URL} /tmp/buildstep && docker build -t progrium/buildstep /tmp/buildstep && rm -rf /tmp/buildstep)
+	@echo "Start building herokuish from source"
+	docker images | grep gliderlabs/herokuish || (git clone ${STACK_URL} /tmp/herokuish && cd /tmp/herokuish && IMAGE_NAME=gliderlabs/herokuish BUILD_TAG=latest VERSION=master make -e ${BUILD_STACK_TARGETS} && rm -rf /tmp/herokuish)
 else
-	@docker images | grep progrium/buildstep || curl --silent -L ${PREBUILT_STACK_URL} | gunzip -cd | docker import - progrium/buildstep
+ifeq ($(shell echo ${PREBUILT_STACK_URL} | egrep -q 'http.*://|file://' && echo $$?),0)
+	@echo "Start importing herokuish from ${PREBUILT_STACK_URL}"
+	docker images | grep gliderlabs/herokuish || wget -nv -O - ${PREBUILT_STACK_URL} | gunzip -cd | docker import - gliderlabs/herokuish
+else
+	@echo "Start pulling herokuish from ${PREBUILT_STACK_URL}"
+	docker images | grep gliderlabs/herokuish || docker pull ${PREBUILT_STACK_URL}
+endif
+endif
 endif
 
 count:
 	@echo "Core lines:"
-	@cat dokku bootstrap.sh | wc -l
+	@cat dokku bootstrap.sh | sed 's/^$$//g' | wc -l
 	@echo "Plugin lines:"
-	@find plugins -type f | xargs cat | wc -l
+	@find plugins -type f -not -name .DS_Store | xargs cat | sed 's/^$$//g' | wc -l
 	@echo "Test lines:"
-	@find tests -type f | xargs cat | wc -l
+	@find tests -type f -not -name .DS_Store | xargs cat | sed 's/^$$//g' | wc -l
 
 dokku-installer:
-	test -f /var/lib/dokku/.dokku-installer-created || gem install rack -v 1.5.2 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || gem install rack-protection -v 1.5.3 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || gem install sinatra -v 1.4.5 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || gem install tilt -v 1.4.1 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || ruby /root/dokku/contrib/dokku-installer.rb onboot
+	test -f /var/lib/dokku/.dokku-installer-created || python contrib/dokku-installer.py onboot
 	test -f /var/lib/dokku/.dokku-installer-created || service dokku-installer start
 	test -f /var/lib/dokku/.dokku-installer-created || service nginx reload
 	test -f /var/lib/dokku/.dokku-installer-created || touch /var/lib/dokku/.dokku-installer-created

README.md

@@ -1,4 +1,4 @@
-# Dokku [![Build Status](https://travis-ci.org/progrium/dokku.png?branch=master)](https://travis-ci.org/progrium/dokku)
+# Dokku [![Build Status](https://img.shields.io/circleci/project/dokku/dokku/master.svg?style=flat-square "Build Status")](https://circleci.com/gh/dokku/dokku/tree/master) [![Ubuntu Package](https://img.shields.io/badge/package-ubuntu-brightgreen.svg?style=flat-square "Ubuntu Package")](https://packagecloud.io/dokku/dokku) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg?style=flat-square "IRC Freenode")](https://webchat.freenode.net/?channels=dokku) [![Slack Group](https://img.shields.io/badge/irc-slack-blue.svg?style=flat-square "Slack Group")](https://glider-slackin.herokuapp.com/) [![Documentation](https://img.shields.io/badge/docs-viewdocs-blue.svg?style=flat-square "Viewdocs")](http://dokku.viewdocs.io/dokku/) [![Gratipay](https://img.shields.io/gratipay/dokku.svg?style=flat-square)](https://gratipay.com/dokku/)
 
 Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. Sponsored by our friends at [Deis](http://deis.io/).
 
@@ -8,17 +8,28 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. S
 
 ## Installing
 
-To install the latest stable version of dokku, you can run the following bootstrapper command:
+To install the latest stable release, you can run the following commands as a user that has access to `sudo`:
 
-    $ wget -qO- https://raw.github.com/progrium/dokku/v0.3.2/bootstrap.sh | sudo DOKKU_TAG=v0.3.2 bash
+    wget https://raw.githubusercontent.com/dokku/dokku/v0.5.0/bootstrap.sh
+    sudo DOKKU_TAG=v0.5.0 bash bootstrap.sh
+
+### Upgrading
+
+[View the docs for upgrading](http://dokku.viewdocs.io/dokku/upgrading) from an older version of Dokku.
 
 ## Documentation
 
-Full documentation - including advanced installation docs - are available online at [docs](http://progrium.viewdocs.io/dokku/index)
+Full documentation - including advanced installation docs - are available online at [docs](http://dokku.viewdocs.io/dokku/)
 
 ## Support
 
-You can use [Github Issues](https://github.com/progrium/dokku/issues), check [Troubleshooting](https://github.com/progrium/dokku/wiki/Troubleshooting) on the wiki, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku)
+You can use [Github Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](http://dokku.viewdocs.io/dokku/troubleshooting) in the documentation, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku)
+
+## Contribution
+
+After checking [Github Issues](https://github.com/dokku/dokku/issues), the [Troubleshooting Guide](http://dokku.viewdocs.io/dokku/troubleshooting) or having a chat with us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku), feel free to fork and create a Pull Request.
+
+While we may not merge your PR as is, they serve to start conversations and improve the general dokku experience for all users.
 
 ## Sponsors
 
@@ -26,4 +37,4 @@ Dokku is currently sponsored by the enterprise grade, multi-host PaaS project [D
 
 ## License
 
-MIT
+[MIT License](https://github.com/dokku/dokku/blob/master/LICENSE) © Jeff Lindsay

SPONSORS

@@ -1 +1,2 @@
-Deis	http://deis.io
+Deis	       http://deis.io
+DigitalOcean https://www.digitalocean.com/

Vagrantfile

@@ -1,34 +1,102 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-BOX_NAME = ENV["BOX_NAME"] || "trusty"
-BOX_URI = ENV["BOX_URI"] || "https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box"
-BOX_MEMORY = ENV["BOX_MEMORY"] || "512"
+BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-14.04"
+BOX_CPUS = ENV["BOX_CPUS"] || "1"
+BOX_MEMORY = ENV["BOX_MEMORY"] || "1024"
 DOKKU_DOMAIN = ENV["DOKKU_DOMAIN"] || "dokku.me"
 DOKKU_IP = ENV["DOKKU_IP"] || "10.0.0.2"
+FORWARDED_PORT = (ENV["FORWARDED_PORT"] || '8080').to_i
 PREBUILT_STACK_URL = File.exist?("#{File.dirname(__FILE__)}/stack.tgz") ? 'file:///root/dokku/stack.tgz' : nil
+PUBLIC_KEY_PATH = "#{Dir.home}/.ssh/id_rsa.pub"
 
-make_cmd = "make install"
+make_cmd = "DEBIAN_FRONTEND=noninteractive make -e install"
 if PREBUILT_STACK_URL
   make_cmd = "PREBUILT_STACK_URL='#{PREBUILT_STACK_URL}' #{make_cmd}"
 end
 
 Vagrant::configure("2") do |config|
+  config.ssh.forward_agent = true
+
   config.vm.box = BOX_NAME
-  config.vm.box_url = BOX_URI
-  config.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
-  config.vm.network :forwarded_port, guest: 80, host: 8080
-  config.vm.hostname = "#{DOKKU_DOMAIN}"
-  config.vm.network :private_network, ip: DOKKU_IP
 
   config.vm.provider :virtualbox do |vb|
     vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
     # Ubuntu's Raring 64-bit cloud image is set to a 32-bit Ubuntu OS type by
     # default in Virtualbox and thus will not boot. Manually override that.
     vb.customize ["modifyvm", :id, "--ostype", "Ubuntu_64"]
+    vb.customize ["modifyvm", :id, "--cpus", BOX_CPUS]
     vb.customize ["modifyvm", :id, "--memory", BOX_MEMORY]
   end
 
-  config.vm.provision :shell, :inline => "apt-get -qq -y install git > /dev/null && cd /root/dokku && #{make_cmd}"
-  config.vm.provision :shell, :inline => "cd /root/dokku && make dokku-installer"
+  config.vm.provider :vmware_fusion do |v, override|
+    v.vmx["memsize"] = BOX_MEMORY
+  end
+
+  config.vm.define "empty", autostart: false
+
+  config.vm.define "dokku", primary: true do |vm|
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+
+    # Use the same nameserver as the host machine in order to avoid the "too many redirects" problem.
+    vm.vm.provider :virtualbox do |vb|
+      vb.customize ["modifyvm", :id, "--natdnshostresolver1", "off"]
+      vb.customize ["modifyvm", :id, "--natdnsproxy1", "off"]
+    end
+
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update > /dev/null && apt-get -qq -y install git > /dev/null && cd /root/dokku && #{make_cmd}"
+    vm.vm.provision :shell, :inline => "cd /root/dokku && make dokku-installer"
+    vm.vm.provision :shell do |s|
+      s.inline = <<-EOT
+        echo '"\e[5~": history-search-backward' > /root/.inputrc
+        echo '"\e[6~": history-search-forward' >> /root/.inputrc
+        echo 'set show-all-if-ambiguous on' >> /root/.inputrc
+        echo 'set completion-ignore-case on' >> /root/.inputrc
+      EOT
+    end
+  end
+
+  # For windows users. Sharing folder from windows creates problem with sym links and so, sync the repo instead from GOS.
+  config.vm.define "dokku-windows", autostart: false do |vm|
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update > /dev/null && apt-get -qq -y install git > /dev/null"
+    vm.vm.provision :shell, :inline => "cd /vagrant/ && export DOKKU_BRANCH=`git symbolic-ref -q --short HEAD 2>/dev/null` && export DOKKU_TAG=`git describe --tags --exact-match 2>/dev/null` && cd /root/ && cp /vagrant/bootstrap.sh ./ && bash bootstrap.sh"
+  end
+
+  config.vm.define "dokku-deb", autostart: false do |vm|
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+    vm.vm.provision :shell, :inline => "cd /root/dokku && make install-from-deb"
+  end
+
+  config.vm.define "build", autostart: false do |vm|
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update > /dev/null && apt-get -qq -y install git > /dev/null && cd /root/dokku && #{make_cmd}"
+    vm.vm.provision :shell, :inline => "cd /root/dokku && make deb-all"
+  end
+
+  config.vm.define "build-arch", autostart: false do |vm|
+    vm.vm.box = "bugyt/archlinux"
+    vm.vm.synced_folder File.dirname(__FILE__), "/dokku"
+    vm.vm.synced_folder "#{File.dirname(__FILE__)}/../dokku-arch", "/dokku-arch"
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+    vm.vm.provision :shell, :inline => "cd /dokku && make arch-all", privileged: false
+  end
+
+  if Pathname.new(PUBLIC_KEY_PATH).exist?
+    config.vm.provision :file, source: PUBLIC_KEY_PATH, destination: '/tmp/id_rsa.pub'
+    config.vm.provision :shell, :inline => "rm -f /root/.ssh/authorized_keys && mkdir -p /root/.ssh && sudo cp /tmp/id_rsa.pub /root/.ssh/authorized_keys"
+  end
 end

arch.mk

@@ -0,0 +1,28 @@
+.PHONY: arch-all arch-dokku
+
+arch-all: arch-dokku
+	echo "Done"
+
+arch-setup:
+	echo "-> Updating pacman repository and installing package helper"
+	sudo pacman -Sy
+	sudo pacman -S --needed --noconfirm pkgbuild-introspection
+
+	echo "-> Download, build and install cower (dependency of pacaur) and pacaur"
+	curl -so /tmp/cower.tar.gz https://aur.archlinux.org/cgit/aur.git/snapshot/cower.tar.gz
+	curl -so /tmp/pacaur.tar.gz https://aur.archlinux.org/cgit/aur.git/snapshot/pacaur.tar.gz
+	tar -xzf /tmp/cower.tar.gz -C /tmp
+	tar -xzf /tmp/pacaur.tar.gz -C /tmp
+	gpg --recv-key 1EB2638FF56C0C53
+	cd /tmp/cower; makepkg -sri --noconfirm
+	cd /tmp/pacaur; makepkg -sri --noconfirm
+
+	echo "-> Installing build requirements"
+	pacaur --noconfirm --noedit -S plugn
+
+arch-dokku: arch-setup
+	echo "-> Update package sums, create metadata file and test the build of the package"
+	git describe --tags > /tmp/VERSION
+	cat /tmp/VERSION | cut -d '-' -f 1 | cut -d 'v' -f 2 > /tmp/STABLE_VERSION
+	sed -i -e "s/pkgver=.*/pkgver=`cat /tmp/STABLE_VERSION`/" /dokku-arch/PKGBUILD
+	cd /dokku-arch; updpkgsums; mksrcinfo; makepkg -fd

bootstrap.sh

@@ -1,35 +1,129 @@
 #!/usr/bin/env bash
+set -eo pipefail; [[ $TRACE ]] && set -x
+
 # A script to bootstrap dokku.
 # It expects to be run on Ubuntu 14.04 via 'sudo'
+# If installing a tag higher than 0.3.13, it may install dokku via a package (so long as the package is higher than 0.3.13)
 # It checks out the dokku source code from Github into ~/dokku and then runs 'make install' from dokku source.
 
-set -eo pipefail
-export DEBIAN_FRONTEND=noninteractive
-export DOKKU_REPO=${DOKKU_REPO:-"https://github.com/progrium/dokku.git"}
+# We wrap this whole script in functions, so that we won't execute
+# until the entire script is downloaded.
+# That's good because it prevents our output overlapping with wget's.
+# It also means that we can't run a partially downloaded script.
 
-if ! command -v apt-get &>/dev/null
-then
-  echo "This installation script requires apt-get. For manual installation instructions, consult https://github.com/progrium/dokku ."
-  exit 1
-fi
+ensure-environment() {
+  echo "Preparing to install $DOKKU_TAG from $DOKKU_REPO..."
+  if ! command -v apt-get &>/dev/null; then
+    echo "This installation script requires apt-get. For manual installation instructions, consult http://dokku.viewdocs.io/dokku/advanced-installation/"
+    exit 1
+  fi
 
-apt-get update
-apt-get install -qq -y git make curl software-properties-common man-db
+  hostname -f > /dev/null 2>&1 || {
+    echo "This installation script requires that you have a hostname set for the instance. Please set a hostname for 127.0.0.1 in your /etc/hosts"
+    exit 1
+  }
+}
 
-[[ `lsb_release -sr` == "12.04" ]] && apt-get install -qq -y python-software-properties
+install-requirements() {
+  echo "--> Ensuring we have the proper dependencies"
+  apt-get update -qq > /dev/null
+  if [[ $(lsb_release -sr) == "12.04" ]]; then
+    apt-get -qq -y install python-software-properties
+  fi
+}
 
-cd ~ && test -d dokku || git clone $DOKKU_REPO
-cd dokku
-git fetch origin
+install-dokku() {
+  if [[ -n $DOKKU_BRANCH ]]; then
+    install-dokku-from-source "origin/$DOKKU_BRANCH"
+  elif [[ -n $DOKKU_TAG ]]; then
+    local DOKKU_SEMVER="${DOKKU_TAG//v}"
+    major=$(echo "$DOKKU_SEMVER" | awk '{split($0,a,"."); print a[1]}')
+    minor=$(echo "$DOKKU_SEMVER" | awk '{split($0,a,"."); print a[2]}')
+    patch=$(echo "$DOKKU_SEMVER" | awk '{split($0,a,"."); print a[3]}')
 
-if [[ -n $DOKKU_BRANCH ]]; then
-  git checkout origin/$DOKKU_BRANCH
-elif [[ -n $DOKKU_TAG ]]; then
-  git checkout $DOKKU_TAG
-fi
+    # 0.3.13 was the first version with a debian package
+    if [[ "$major" -eq "0" ]] && [[ "$minor" -eq "3" ]] && [[ "$patch" -ge "13" ]]; then
+      install-dokku-from-package "$DOKKU_SEMVER"
+      echo "--> Running post-install dependency installation"
+      dokku plugins-install-dependencies
+    # 0.4.0 implemented a `plugin` plugin
+    elif [[ "$major" -eq "0" ]] && [[ "$minor" -ge "4" ]] && [[ "$patch" -ge "0" ]]; then
+      install-dokku-from-package "$DOKKU_SEMVER"
+      echo "--> Running post-install dependency installation"
+      sudo -E dokku plugin:install-dependencies --core
+    else
+      install-dokku-from-source "$DOKKU_TAG"
+    fi
+  else
+    install-dokku-from-package
+    echo "--> Running post-install dependency installation"
+    sudo -E dokku plugin:install-dependencies --core
+  fi
+}
 
-make install
 
-echo
-echo "Almost done! For next steps on configuration:"
-echo "  https://github.com/progrium/dokku#configuring"
+install-dokku-from-source() {
+  local DOKKU_CHECKOUT="$1"
+  apt-get -qq -y install git make software-properties-common
+  cd /root
+  if [[ ! -d /root/dokku ]]; then
+    git clone "$DOKKU_REPO" /root/dokku
+  fi
+
+  cd /root/dokku
+  git fetch origin
+  [[ -n $DOKKU_CHECKOUT ]] && git checkout "$DOKKU_CHECKOUT"
+  make install
+}
+
+install-dokku-from-package() {
+  local DOKKU_CHECKOUT="$1"
+  local NO_INSTALL_RECOMMENDS=""
+
+  if [[ -n $DOKKU_DOCKERFILE ]]; then
+    NO_INSTALL_RECOMMENDS=" --no-install-recommends "
+  fi
+
+  echo "--> Initial apt-get update"
+  apt-get update -qq > /dev/null
+  apt-get -qq -y install apt-transport-https
+
+  echo "--> Installing docker"
+  if uname -r | grep -q linode; then
+    echo "--> NOTE: Using Linode? Docker might complain about missing AUFS support."
+    echo "    See http://dokku.viewdocs.io/dokku/getting-started/install/linode/"
+    echo "    Installation will continue in 10 seconds."
+    sleep 10
+  fi
+  wget -nv -O - https://get.docker.com/ | sh
+
+  echo "--> Installing dokku"
+  wget -nv -O - https://packagecloud.io/gpg.key | apt-key add -
+  echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ trusty main" | tee /etc/apt/sources.list.d/dokku.list
+  apt-get update -qq > /dev/null
+
+  [[ -n $DOKKU_VHOST_ENABLE ]]  && echo "dokku dokku/vhost_enable boolean $VHOST_ENABLE"         | sudo debconf-set-selections
+  [[ -n $DOKKU_WEB_CONFIG ]]    && echo "dokku dokku/web_config boolean $DOKKU_WEB_CONFIG"       | sudo debconf-set-selections
+  [[ -n $DOKKU_HOSTNAME ]]      && echo "dokku dokku/hostname string $DOKKU_HOSTNAME"            | sudo debconf-set-selections
+  [[ -n $DOKKU_SKIP_KEY_FILE ]] && echo "dokku dokku/skip_key_file boolean $DOKKU_SKIP_KEY_FILE" | sudo debconf-set-selections
+  [[ -n $DOKKU_KEY_FILE ]]      && echo "dokku dokku/key_file string $DOKKU_KEY_FILE"            | sudo debconf-set-selections
+
+  if [[ -n $DOKKU_CHECKOUT ]]; then
+    # shellcheck disable=SC2086
+    apt-get -qq -y $NO_INSTALL_RECOMMENDS install "dokku=$DOKKU_CHECKOUT"
+  else
+    # shellcheck disable=SC2086
+    apt-get -qq -y $NO_INSTALL_RECOMMENDS install dokku
+  fi
+}
+
+main() {
+  export DEBIAN_FRONTEND=noninteractive
+  export DOKKU_REPO=${DOKKU_REPO:-"https://github.com/dokku/dokku.git"}
+
+  ensure-environment
+  install-requirements
+  install-dokku
+}
+
+main "$@"

circle.yml

@@ -0,0 +1,18 @@
+machine:
+  pre:
+    - echo 'DOCKER_OPTS="-s btrfs -e lxc --userland-proxy=false"' | sudo tee -a /etc/default/docker
+    - sudo curl -L -o /usr/bin/docker 'https://s3-external-1.amazonaws.com/circle-downloads/docker-1.9.1-circleci-cp-workaround'
+    - sudo chmod 0755 /usr/bin/docker
+  services:
+    - docker
+dependencies:
+  cache_directories:
+    - "~/docker"
+  override:
+    - ./tests/ci/parallel_runner.sh setup: { timeout: 300 }
+    - echo "export DOKKU_SKIP_CLEANUP=true" > /home/dokku/.dokkurc/dokku_skip_cleanup
+  post:
+    - sudo -E make -e lint
+test:
+  override:
+    - ./tests/ci/parallel_runner.sh testing: { parallel: true, timeout: 3600 }

contrib/dokku-installer.py

@@ -0,0 +1,220 @@
+#!/usr/bin/env python2.7
+
+import cgi
+import json
+import os
+import SimpleHTTPServer
+import SocketServer
+import subprocess
+import sys
+import threading
+
+VERSION = 'v0.5.0'
+
+hostname = ''
+try:
+    command = "bash -c '[[ $(dig +short $HOSTNAME) ]] && echo $HOSTNAME || wget -q -O - icanhazip.com'"
+    hostname = subprocess.check_output(command, shell=True)
+    if ':' in hostname:
+        hostname = ''
+except subprocess.CalledProcessError:
+    pass
+
+key_file = os.getenv('KEY_FILE', '/root/.ssh/authorized_keys')
+
+admin_keys = []
+if os.path.isfile(key_file):
+    try:
+        command = "cat {0}".format(key_file)
+        admin_keys = subprocess.check_output(command, shell=True).strip().split("\n")
+    except subprocess.CalledProcessError:
+        pass
+
+
+def check_boot():
+    if 'onboot' not in sys.argv:
+        return
+    init_dir = os.getenv('INIT_DIR', '/etc/init')
+    systemd_dir = os.getenv('SYSTEMD_DIR', '/etc/systemd/system')
+    nginx_dir = os.getenv('NGINX_DIR', '/etc/nginx/conf.d')
+
+    if os.path.exists(init_dir):
+        with open('{0}/dokku-installer.conf'.format(init_dir), 'w') as f:
+            f.write("start on runlevel [2345]\n")
+            f.write("exec {0} selfdestruct\n".format(os.path.abspath(__file__)))
+    if os.path.exists(systemd_dir):
+        with open('{0}/dokku-installer.service'.format(systemd_dir), 'w') as f:
+            f.write("[Unit]\n")
+            f.write("Description=Dokku web-installer\n")
+            f.write("\n")
+            f.write("[Service]\n")
+            f.write("ExecStart={0} selfdestruct\n".format(os.path.abspath(__file__)))
+            f.write("\n")
+            f.write("[Install]\n")
+            f.write("WantedBy=multi-user.target\n")
+            f.write("WantedBy=graphical.target\n")
+    if os.path.exists(nginx_dir):
+        with open('{0}/dokku-installer.conf'.format(nginx_dir), 'w') as f:
+            f.write("upstream dokku-installer { server 127.0.0.1:2000; }\n")
+            f.write("server {\n")
+            f.write("  listen      80;\n")
+            f.write("  location    / {\n")
+            f.write("    proxy_pass  http://dokku-installer;\n")
+            f.write("  }\n")
+            f.write("}\n")
+
+    subprocess.call('rm -f /etc/nginx/sites-enabled/*', shell=True)
+    sys.exit(0)
+
+
+class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
+    def do_GET(self):
+        content = PAGE.replace('{VERSION}', VERSION)
+        content = content.replace('{HOSTNAME}', hostname)
+        content = content.replace('{ADMIN_KEYS}', "\n".join(admin_keys))
+        self.send_response(200)
+        self.end_headers()
+        self.wfile.write(content)
+
+    def do_POST(self):
+        if self.path not in ['/setup', '/setup/']:
+            return
+
+        params = cgi.FieldStorage(fp=self.rfile,
+                                  headers=self.headers,
+                                  environ={
+                                      'REQUEST_METHOD': 'POST',
+                                      'CONTENT_TYPE': self.headers['Content-Type']})
+
+        dokku_root = os.getenv('DOKKU_ROOT', '/home/dokku')
+        if 'vhost' in params and params['vhost'].value == 'true':
+            with open('{0}/VHOST'.format(dokku_root), 'w') as f:
+                f.write(params['hostname'].value)
+        else:
+            try:
+                os.remove('{0}/VHOST'.format(dokku_root))
+            except OSError:
+                pass
+        with open('{0}/HOSTNAME'.format(dokku_root), 'w') as f:
+            f.write(params['hostname'].value)
+
+
+        command = ['sshcommand', 'acl-add', 'dokku', 'admin']
+        for key in params['keys'].value.split("\n"):
+            proc = subprocess.Popen(command, stdin=subprocess.PIPE)
+            proc.stdin.write(key)
+            proc.stdin.close()
+            proc.wait()
+
+        if 'selfdestruct' in sys.argv:
+            DeleteInstallerThread()
+
+        self.send_response(200)
+        self.end_headers()
+        self.wfile.write(json.dumps({'status': 'ok'}))
+
+
+class DeleteInstallerThread(object):
+    def __init__(self, interval=1):
+        thread = threading.Thread(target=self.run, args=())
+        thread.daemon = True
+        thread.start()
+
+    def run(self):
+        command = "rm /etc/nginx/conf.d/dokku-installer.conf && /etc/init.d/nginx stop && /etc/init.d/nginx start"
+        try:
+            subprocess.call(command, shell=True)
+        except:
+            pass
+
+        command = "rm -f /etc/init/dokku-installer.conf /etc/systemd/system/dokku-installer.service && stop dokku-installer"
+        try:
+            subprocess.call(command, shell=True)
+        except:
+            pass
+
+
+def main():
+    check_boot()
+
+    port = int(os.getenv('PORT', 2000))
+    httpd = SocketServer.TCPServer(("", port), GetHandler)
+    print "Listening on 0.0.0.0:{0}, CTRL+C to stop".format(port)
+    httpd.serve_forever()
+
+
+PAGE = """
+<html>
+<head>
+  <title>Dokku Setup</title>
+  <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" />
+  <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+</head>
+<body>
+  <div class="container" style="width: 640px;">
+  <form id="form" role="form">
+    <h1>Dokku Setup <small>{VERSION}</small></h1>
+    <div class="form-group">
+      <h3><small style="text-transform: uppercase;">Admin Access</small></h3>
+      <label for="key">Public Key</label><br />
+      <textarea class="form-control" name="keys" rows="7" id="key">{ADMIN_KEYS}</textarea>
+    </div>
+    <div class="form-group">
+      <h3><small style="text-transform: uppercase;">Hostname Configuration</small></h3>
+      <div class="form-group">
+        <label for="hostname">Hostname</label>
+        <input class="form-control" type="text" id="hostname" name="hostname" value="{HOSTNAME}" />
+      </div>
+      <div class="checkbox">
+        <label><input id="vhost" name="vhost" type="checkbox" value="true"> Use <abbr title="Nginx will be run on port 80 and backend to your apps based on hostname">virtualhost naming</abbr> for apps</label>
+      </div>
+      <p>Your app URLs will look like:</p>
+      <pre id="example">http://hostname:port</pre>
+    </div>
+    <button type="button" onclick="setup()" class="btn btn-primary">Finish Setup</button> <span style="padding-left: 20px;" id="result"></span>
+  </form>
+  </div>
+  <div id="error-output"></div>
+  <script>
+    function setup() {
+      if ($.trim($("#key").val()) == "") {
+        alert("Your admin public key cannot be blank.")
+        return
+      }
+      if ($.trim($("#hostname").val()) == "") {
+        alert("Your hostname cannot be blank.")
+        return
+      }
+      data = $("#form").serialize()
+      $("input,textarea,button").prop("disabled", true);
+      $.post('/setup', data)
+        .done(function() {
+          $("#result").html("Success!")
+          window.location.href = "http://progrium.viewdocs.io/dokku/application-deployment";
+        })
+        .fail(function(data) {
+          $("#result").html("Something went wrong...")
+          $("#error-output").html(data.responseText)
+        });
+    }
+    function update() {
+      if ($("#vhost").is(":checked") && $("#hostname").val().match(/^(\d{1,3}\.){3}\d{1,3}$/)) {
+        alert("In order to use virtualhost naming, the hostname must not be an IP but a valid domain name.")
+        $("#vhost").prop('checked', false);
+      }
+      if ($("#vhost").is(':checked')) {
+        $("#example").html("http://&lt;app-name&gt;."+$("#hostname").val())
+      } else {
+        $("#example").html("http://"+$("#hostname").val()+":&lt;app-port&gt;")
+      }
+    }
+    $("#vhost").change(update);
+    $("#hostname").change(update);
+    update();
+  </script>
+</body>
+</html>
+"""
+
+if __name__ == "__main__":
+    main()

contrib/dokku-installer.rb

@@ -1,122 +0,0 @@
-#!/usr/bin/env ruby
-require "sinatra"
-require "open3"
-
-if ARGV[0] == "onboot"
-  File.open("/etc/init/dokku-installer.conf", "w") do |f|
-    f.puts "start on runlevel [2345]"
-    f.puts "exec #{File.absolute_path(__FILE__)} selfdestruct"
-  end
-  File.open("/etc/nginx/conf.d/dokku-installer.conf", "w") do |f|
-    f.puts "upstream dokku-installer { server 127.0.0.1:2000; }"
-    f.puts "server {"
-      f.puts "  listen      80;"
-      f.puts "  location    / {"
-      f.puts "    proxy_pass  http://dokku-installer;"
-      f.puts "  }"
-    f.puts "}"
-  end
-  `rm /etc/nginx/sites-enabled/*`
-  puts "Installed Upstart service and default Nginx virtualhost for installer to run on boot."
-  exit
-end
-
-version   = "v0.3.2"
-dokku_root  = ENV["DOKKU_ROOT"] || "/home/dokku"
-admin_key   = `cat /root/.ssh/authorized_keys`.split("\n").first
-hostname  = `bash -c '[[ $(dig +short $HOSTNAME) ]] && echo $HOSTNAME || curl icanhazip.com'`.strip
-template  = DATA.read
-
-set :port, 2000
-set :environment, :production
-disable :protection
-
-get "/" do
-  ERB.new(template).result binding
-end
-
-post "/setup" do
-  if params[:vhost] == "true"
-    File.open("#{dokku_root}/VHOST", "w") {|f| f.write params[:hostname] }
-  else
-    `rm #{dokku_root}/VHOST`
-  end
-  File.open("#{dokku_root}/HOSTNAME", "w") {|f| f.write params[:hostname] }
-  Open3.capture2("sshcommand acl-add dokku admin", :stdin_data => params[:key])
-  Thread.new {
-    `rm /etc/nginx/conf.d/dokku-installer.conf && /etc/init.d/nginx stop && /etc/init.d/nginx start`
-    `rm /etc/init/dokku-installer.conf && stop dokku-installer`
-  }.run if ARGV[0] == "selfdestruct"
-end
-
-__END__
-<html>
-<head>
-  <title>Dokku Setup</title>
-  <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" />
-  <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
-</head>
-<body>
-  <div class="container" style="width: 640px;">
-  <form id="form" role="form">
-    <h1>Dokku Setup <small><%= version %></small></h1>
-    <div class="form-group">
-      <h3><small style="text-transform: uppercase;">Admin Access</small></h3>
-      <label for="key">Public Key</label><br />
-      <textarea class="form-control" name="key" rows="7" id="key"><%= admin_key %></textarea>
-    </div>
-    <div class="form-group">
-      <h3><small style="text-transform: uppercase;">Hostname Configuration</small></h3>
-      <div class="form-group">
-        <label for="hostname">Hostname</label>
-        <input class="form-control" type="text" id="hostname" name="hostname" value="<%= hostname %>" />
-      </div>
-      <div class="checkbox">
-        <label><input id="vhost" name="vhost" type="checkbox" value="true"> Use <abbr title="Nginx will be run on port 80 and backend to your apps based on hostname">virtualhost naming</abbr> for apps</label>
-      </div>
-      <p>Your app URLs will look like:</p>
-      <pre id="example">http://hostname:port</pre>
-    </div>
-    <button type="button" onclick="setup()" class="btn btn-primary">Finish Setup</button> <span style="padding-left: 20px;" id="result"></span>
-  </form>
-  </div>
-  <div id="error-output"></div>
-  <script>
-    function setup() {
-      if ($.trim($("#key").val()) == "") {
-        alert("Your admin public key cannot be blank.")
-        return
-      }
-      if ($.trim($("#hostname").val()) == "") {
-        alert("Your hostname cannot be blank.")
-        return
-      }
-      data = $("#form").serialize()
-      $("input,textarea,button").prop("disabled", true);
-      $.post('/setup', data)
-        .done(function() {
-          $("#result").html("Success!")
-          window.location.href = "http://progrium.viewdocs.io/dokku/application-deployment";
-        })
-        .fail(function(data) {
-          $("#result").html("Something went wrong...")
-          $("#error-output").html(data.responseText)
-        });
-    }
-    function update() {
-      if ($("#vhost").is(":checked") && $("#hostname").val().match(/^(\d{1,3}\.){3}\d{1,3}$/)) {
-        alert("In order to use virtualhost naming, the hostname must not be an IP but a valid domain name.")
-        $("#vhost").prop('checked', false);
-      }
-      if ($("#vhost").is(':checked')) {
-        $("#example").html("http://&lt;app-name&gt;."+$("#hostname").val())
-      } else {
-        $("#example").html("http://"+$("#hostname").val()+":&lt;app-port&gt;")
-      }
-    }
-    $("#vhost").change(update);
-    $("#hostname").change(update);
-    update();
-  </script>
-</body>
-</html>

contrib/dokku_client.sh

@@ -0,0 +1,102 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+MOVES=(ABLE ABNORMA AGAIN AIREXPL ANG ANGER ASAIL ATTACK AURORA AWL BAN BAND BARE BEAT BEATED BELLY BIND BITE BLOC BLOOD BODY BOOK BREATH BUMP CAST CHAM CLAMP CLAP CLAW CLEAR CLI CLIP CLOUD CONTRO CONVY COOLHIT CRASH CRY CUT DESCRI D-FIGHT DIG DITCH DIV DOZ DRE DUL DU-PIN DYE EARTH EDU EG-BOMB EGG ELEGY ELE-HIT EMBODY EMPLI ENGL ERUPT EVENS EXPLOR EYES FALL FAST F-CAR F-DANCE FEARS F-FIGHT FIGHT FIR FIRE FIREHIT FLAME FLAP FLASH FLEW FORCE FRA FREEZE FROG G-BIRD GENKISS GIFT G-KISS G-MOUSE GRADE GROW HAMMER HARD HAT HATE H-BOMB HELL-R HEMP HINT HIT HU HUNT HYPNOSI INHA IRO IRONBAR IR-WING J-GUN KEE KICK KNIF KNIFE KNOCK LEVEL LIGH LIGHHIT LIGHT LIVE L-WALL MAD MAJUS MEL MELO MESS MILK MIMI MISS MIXING MOVE MUD NI-BED NOISY NOONLI NULL N-WAVE PAT PEACE PIN PLAN PLANE POIS POL POWDE POWE POWER PRIZE PROTECT PROUD RAGE RECOR REFLAC REFREC REGR RELIV RENEW R-FIGHT RING RKICK ROCK ROUND RUS RUSH SAND SAW SCISSOR SCRA SCRIPT SEEN SERVER SHADOW SHELL SHINE SHO SIGHT SIN SMALL SMELT SMOK SNAKE SNO SNOW SOU SO-WAVE SPAR SPEC SPID S-PIN SPRA STAM STARE STEA STONE STORM STRU STRUG STUDEN SUBS SUCID SUN-LIG SUNRIS SUPLY S-WAVE TAILS TANGL TASTE TELLI THANK TONKICK TOOTH TORL TRAIN TRIKICK TUNGE VOLT WA-GUN WATCH WAVE W-BOMB WFALL WFING WHIP WHIRL WIND WOLF WOOD WOR YUJA)
+NAMES=(SEED GRASS FLOWE SHAD CABR SNAKE GOLD COW GUIKI PEDAL DELAN B-FLY BIDE KEYU FORK LAP PIGE PIJIA CAML LAT BIRD BABOO VIV ABOKE PIKAQ RYE SAN BREAD LIDEL LIDE PIP PIKEX ROK JUGEN PUD BUDE ZHIB GELU GRAS FLOW LAFUL ATH BALA CORN MOLUF DESP DAKED MIMI BOLUX KODA GELUD MONK SUMOY GEDI WENDI NILEM NILE NILEC KEZI YONGL HUDE WANLI GELI GUAIL MADAQ WUCI WUCI MUJEF JELLY SICIB GELU NELUO BOLI JIALE YED YEDE CLO SCARE AOCO DEDE DEDEI BAWU JIUG BADEB BADEB HOLE BALUX GES FANT QUAR YIHE SWAB SLIPP CLU DEPOS BILIY YUANO SOME NO YELA EMPT ZECUN XIAHE BOLEL DEJI MACID XIHON XITO LUCK MENJI GELU DECI XIDE DASAJ DONGN RICUL MINXI BALIY ZENDA LUZEL HELE5 0FENB KAIL JIAND CARP JINDE LAPU MUDE YIFU LINLI SANDI HUSI JINC OUMU OUMUX CAP KUIZA PUD TIAO FRMAN CLAU SPARK DRAGO BOLIU GUAIL MIYOU MIY QIAOK BEIL MUKEI RIDED MADAM BAGEP CROC ALIGE OUDAL OUD DADA HEHE YEDEA NUXI NUXIN ROUY ALIAD STICK QIANG LAAND PIQI PI PUPI DEKE DEKEJ NADI NADIO MALI PEA ELECT FLOWE MAL MALI HUSHU NILEE YUZI POPOZ DUZI HEBA XIAN SHAN YEYEA WUY LUO KEFE HULA CROW YADEH MOW ANNAN SUONI KYLI HULU HUDEL YEHE GULAE YEHE BLU GELAN BOAT NIP POIT HELAK XINL BEAR LINB MAGEH MAGEJ WULI YIDE RIVE FISH AOGU DELIE MANTE KONMU DELU HELU HUAN HUMA DONGF JINCA HEDE DEFU LIBY JIAPA MEJI HELE BUHU MILK HABI THUN GARD DON YANGQ SANAQ BANQ LUJ PHIX SIEI EGG)
+
+random_number() {
+  [[ -n "$1" ]] && RANGE="$1"
+  if [[ -n "$RANGE" ]]; then
+    number=$RANDOM
+    let "number %= $RANGE"
+  else
+    number=$RANDOM
+  fi
+  echo $number
+}
+
+random_name() {
+ NUM1=$(random_number ${#MOVES[@]})
+ NUM2=$(random_number ${#MOVES[@]})
+ NUM3=$(random_number ${#NAMES[@]})
+
+ UPPER_APPNAME="${MOVES[${NUM1}]}-${MOVES[${NUM2}]}-${NAMES[${NUM3}]}"
+
+ [[ "$BASH_VERSION" =~ 4.* ]] && lower_appname=${UPPER_APPNAME,,}
+ [[ -z "$lower_appname" ]] && lower_appname=$(echo "$UPPER_APPNAME" | tr '[:upper:]' '[:lower:]')
+ echo "$lower_appname"
+}
+
+client_help_msg() {
+  echo "==> Configure the DOKKU_HOST environment variable or run $0 from a repository with a git remote named dokku"
+  echo "--> i.e. git remote add dokku dokku@<dokku-host>:<app-name>"
+  exit 20 # exit with specific status. only used in units tests for now
+}
+
+if [[ -z $DOKKU_HOST ]]; then
+  if [[ -d .git ]] || git rev-parse --git-dir > /dev/null 2>&1; then
+    DOKKU_HOST=$(git remote -v 2>/dev/null | grep -Ei "^dokku" | head -n 1 | cut -f1 -d' ' | cut -f2 -d '@' | cut -f1 -d':' 2>/dev/null || true)
+  else
+    client_help_msg
+  fi
+fi
+
+export DOKKU_PORT=${DOKKU_PORT:=22}
+
+if [[ ! -z $DOKKU_HOST ]]; then
+  _dokku() {
+    appname=""
+    if [[ -d .git ]] || git rev-parse --git-dir > /dev/null 2>&1; then
+      set +e
+      appname=$(git remote -v 2>/dev/null | grep -Ei "dokku@$DOKKU_HOST" | head -n 1 | cut -f2 -d'@' | cut -f1 -d' ' | cut -f2 -d':' 2>/dev/null)
+      set -e
+    else
+      echo "This is not a git repository"
+    fi
+
+    case "$1" in
+      apps:create)
+        if [[ -z "$2" ]]; then
+          appname=$(random_name)
+          counter=0
+          while ssh -p "$DOKKU_PORT" "dokku@$DOKKU_HOST" apps 2>/dev/null| grep -q "$appname"; do
+            if [[ $counter -ge 100 ]]; then
+              echo "Error: could not reasonably generate a new app name. try cleaning up some apps..."
+              ssh -p "$DOKKU_PORT" "dokku@$DOKKU_HOST" apps
+              exit 1
+            else
+              appname=$(random_name)
+              counter=$((counter+1))
+            fi
+          done
+        else
+          appname="$2"
+        fi
+        if git remote add dokku "dokku@$DOKKU_HOST:$appname"; then
+          echo "-----> Dokku remote added at $DOKKU_HOST"
+          echo "-----> Application name is $appname"
+        else
+          echo "!      Dokku remote not added! Do you already have a dokku remote?"
+          return
+        fi
+        git push dokku master
+        return $?
+        ;;
+    apps:destroy)
+      git remote remove dokku
+      ;;
+    esac
+
+    [[ -n "$@" ]] && [[ -n "$appname" ]] && app_arg="--app $appname"
+    # echo "ssh -o LogLevel=QUIET -p $DOKKU_PORT -t dokku@$DOKKU_HOST -- $app_arg $@"
+    # shellcheck disable=SC2068,SC2086
+    ssh -o LogLevel=QUIET -p $DOKKU_PORT -t dokku@$DOKKU_HOST -- $app_arg $@
+  }
+
+  if [[ "$0" == "dokku" ]] || [[ "$0" == *dokku_client.sh ]] || [[ "$0" == $(which dokku) ]]; then
+    _dokku "$@"
+    exit $?
+  fi
+else
+  client_help_msg
+fi

contrib/packer.json

@@ -0,0 +1,32 @@
+{
+  "builders": [
+    {
+      "type": "digitalocean",
+      "region": "nyc3",
+      "image": "ubuntu-14-04-x64"
+    }
+  ],
+  "provisioners": [
+    {
+      "type": "file",
+      "source": "deb.mk",
+      "destination": "/tmp/Makefile"
+    },
+    {
+      "type": "shell",
+      "inline": [
+        "echo '--> Waiting 30 seconds for core services to be available'",
+        "sleep 30",
+
+        "echo '--> Updating apt repositories'",
+        "sudo apt-get update -qq > /dev/null",
+
+        "echo '--> Installing make requirement'",
+        "sudo apt-get -qq -y install build-essential",
+
+        "cd /tmp && make install-from-deb",
+        "rm /root/.ssh/authorized_keys"
+      ]
+    }
+  ]
+}

deb.mk

@@ -0,0 +1,177 @@
+HEROKUISH_DESCRIPTION = 'Herokuish uses Docker and Buildpacks to build applications like Heroku'
+HEROKUISH_REPO_NAME ?= gliderlabs/herokuish
+HEROKUISH_VERSION ?= 0.3.9
+HEROKUISH_ARCHITECTURE = amd64
+HEROKUISH_PACKAGE_NAME = herokuish_$(HEROKUISH_VERSION)_$(HEROKUISH_ARCHITECTURE).deb
+
+DOKKU_DESCRIPTION = 'Docker powered mini-Heroku in around 100 lines of Bash'
+DOKKU_REPO_NAME ?= dokku/dokku
+DOKKU_ARCHITECTURE = amd64
+
+PLUGN_DESCRIPTION = 'Hook system that lets users extend your application with plugins'
+PLUGN_REPO_NAME ?= dokku/plugn
+PLUGN_VERSION ?= 0.2.1
+PLUGN_ARCHITECTURE = amd64
+PLUGN_PACKAGE_NAME = plugn_$(PLUGN_VERSION)_$(PLUGN_ARCHITECTURE).deb
+
+SSHCOMMAND_DESCRIPTION = 'Turn SSH into a thin client specifically for your app'
+SSHCOMMAND_REPO_NAME ?= dokku/sshcommand
+SSHCOMMAND_VERSION ?= 0.1.0
+SSHCOMMAND_ARCHITECTURE = amd64
+SSHCOMMAND_PACKAGE_NAME = sshcommand_$(SSHCOMMAND_VERSION)_$(SSHCOMMAND_ARCHITECTURE).deb
+
+SIGIL_DESCRIPTION = 'Standalone string interpolator and template processor'
+SIGIL_REPO_NAME ?= gliderlabs/sigil
+SIGIL_VERSION ?= 0.4.0
+SIGIL_ARCHITECTURE = amd64
+SIGIL_PACKAGE_NAME = sigil_$(SIGIL_VERSION)_$(SIGIL_ARCHITECTURE).deb
+
+GOROOT = /usr/local/go
+GOBIN = /usr/local/go/bin/go
+GOPATH = /home/vagrant/gocode
+GOTARBALL = go1.5.3.linux-amd64.tar.gz
+
+.PHONY: install-from-deb deb-all deb-herokuish deb-dokku deb-plugn deb-setup deb-sshcommand deb-sigil
+
+install-from-deb:
+	@echo "--> Initial apt-get update"
+	sudo apt-get update -qq > /dev/null
+	sudo apt-get install -qq -y apt-transport-https
+
+	@echo "--> Installing docker"
+	wget -nv -O - https://get.docker.com/ | sh
+
+	@echo "--> Installing dokku"
+	wget -nv -O - https://packagecloud.io/gpg.key | apt-key add -
+	@echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ trusty main" | sudo tee /etc/apt/sources.list.d/dokku.list
+	sudo apt-get update -qq > /dev/null
+	sudo DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true apt-get install -yy dokku
+
+golang:
+ifeq (,$(wildcard /tmp/$(GOTARBALL)))
+	@echo "-> Installing golang"
+	mkdir -p /tmp/build/usr/local/bin $(GOPATH)
+	sudo apt-get clean
+	sudo apt-get update -qq > /dev/null
+	sudo apt-get install -qq -y git mercurial > /dev/null 2>&1
+	sudo wget -nv -O /tmp/$(GOTARBALL) https://storage.googleapis.com/golang/$(GOTARBALL)
+	sudo tar -C /usr/local -xzf /tmp/$(GOTARBALL)
+endif
+
+deb-all: deb-herokuish deb-dokku deb-plugn deb-sshcommand deb-sigil
+	mv /tmp/*.deb .
+	@echo "Done"
+
+deb-setup:
+	@echo "-> Updating deb repository and installing build requirements"
+	sudo apt-get update -qq > /dev/null
+	sudo DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true apt-get install -qq -y gcc git ruby-dev ruby1.9.1 > /dev/null 2>&1
+	command -v fpm > /dev/null || sudo gem install fpm --no-ri --no-rdoc
+	ssh -o StrictHostKeyChecking=no git@github.com || true
+
+deb-herokuish: deb-setup
+	rm -rf /tmp/tmp /tmp/build $(HEROKUISH_PACKAGE_NAME)
+	mkdir -p /tmp/tmp /tmp/build
+
+	@echo "-> Creating deb files"
+	@echo "#!/usr/bin/env bash" >> /tmp/tmp/post-install
+	@echo "sleep 5" >> /tmp/tmp/post-install
+	@echo "count=\`sudo docker images | grep gliderlabs/herokuish | wc -l\`" >> /tmp/tmp/post-install
+	@echo 'if [ "$$count" -ne 0 ]; then' >> /tmp/tmp/post-install
+	@echo "  echo 'Removing old herokuish image'" >> /tmp/tmp/post-install
+	@echo "  sudo docker rmi gliderlabs/herokuish" >> /tmp/tmp/post-install
+	@echo "fi" >> /tmp/tmp/post-install
+	@echo "echo 'Importing herokuish into docker (around 5 minutes)'" >> /tmp/tmp/post-install
+	@echo "sudo docker build -t gliderlabs/herokuish /var/lib/herokuish 1> /dev/null" >> /tmp/tmp/post-install
+
+	@echo "-> Cloning repository"
+	git clone -q "https://github.com/$(HEROKUISH_REPO_NAME).git" /tmp/tmp/herokuish > /dev/null
+	rm -rf /tmp/tmp/herokuish/.git /tmp/tmp/herokuish/.gitignore
+
+	@echo "-> Copying files into place"
+	mkdir -p "/tmp/build/var/lib"
+	cp -rf /tmp/tmp/herokuish /tmp/build/var/lib/herokuish
+
+	@echo "-> Creating $(HEROKUISH_PACKAGE_NAME)"
+	sudo fpm -t deb -s dir -C /tmp/build -n herokuish -v $(HEROKUISH_VERSION) -a $(HEROKUISH_ARCHITECTURE) -p $(HEROKUISH_PACKAGE_NAME) --deb-pre-depends 'docker-engine-cs (>= 1.9.1) | docker-engine (>= 1.9.1)' --deb-pre-depends sudo --after-install /tmp/tmp/post-install --url "https://github.com/$(HEROKUISH_REPO_NAME)" --description $(HEROKUISH_DESCRIPTION) --license 'MIT License' .
+	mv *.deb /tmp
+
+deb-dokku: deb-setup
+	rm -rf /tmp/tmp /tmp/build dokku_*_$(DOKKU_ARCHITECTURE).deb
+	mkdir -p /tmp/tmp /tmp/build
+
+	cp -r debian /tmp/build/DEBIAN
+	mkdir -p /tmp/build/usr/local/bin
+	mkdir -p /tmp/build/var/lib/dokku/core-plugins/available
+	mkdir -p /tmp/build/usr/share/man/man1
+	mkdir -p /tmp/build/usr/share/dokku/contrib
+	mkdir -p /tmp/build/usr/share/doc/dokku
+
+	cp dokku /tmp/build/usr/local/bin
+	cp LICENSE /tmp/build/usr/share/doc/dokku/copyright
+	cp -r plugins/* /tmp/build/var/lib/dokku/core-plugins/available
+	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do touch /tmp/build/var/lib/dokku/core-plugins/available/$$plugin/.core; done
+	$(MAKE) help2man
+	$(MAKE) addman
+	cp /usr/local/share/man/man1/dokku.1 /tmp/build/usr/share/man/man1/dokku.1
+	gzip -9 /tmp/build/usr/share/man/man1/dokku.1
+	cp contrib/dokku-installer.py /tmp/build/usr/share/dokku/contrib
+	git describe --tags > /tmp/build/var/lib/dokku/VERSION
+	cat /tmp/build/var/lib/dokku/VERSION | cut -d '-' -f 1 | cut -d 'v' -f 2 > /tmp/build/var/lib/dokku/STABLE_VERSION
+	git rev-parse HEAD > /tmp/build/var/lib/dokku/GIT_REV
+	sed -i "s/^Version: .*/Version: `cat /tmp/build/var/lib/dokku/STABLE_VERSION`/g" /tmp/build/DEBIAN/control
+	dpkg-deb --build /tmp/build "/vagrant/dokku_`cat /tmp/build/var/lib/dokku/STABLE_VERSION`_$(DOKKU_ARCHITECTURE).deb"
+	mv *.deb /tmp
+
+deb-plugn: deb-setup golang
+	rm -rf /tmp/tmp /tmp/build $(PLUGN_PACKAGE_NAME)
+	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/local/bin
+
+	@echo "-> Cloning repository"
+	git clone -q "https://github.com/$(PLUGN_REPO_NAME).git" /tmp/tmp/plugn > /dev/null
+	rm -rf /tmp/tmp/plugn/.git /tmp/tmp/plugn/.gitignore
+
+	@echo "-> Copying files into place"
+	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH):/tmp/tmp/plugn && go get github.com/dokku/plugn
+	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH):/tmp/tmp/plugn && cd /home/vagrant/gocode/src/github.com/dokku/plugn && make deps
+	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH):/tmp/tmp/plugn && cd /home/vagrant/gocode/src/github.com/dokku/plugn && rm -f plugn && go build -o plugn
+	mv /home/vagrant/gocode/src/github.com/dokku/plugn/plugn /tmp/build/usr/local/bin/plugn
+
+	@echo "-> Creating $(PLUGN_PACKAGE_NAME)"
+	sudo fpm -t deb -s dir -C /tmp/build -n plugn -v $(PLUGN_VERSION) -a $(PLUGN_ARCHITECTURE) -p $(PLUGN_PACKAGE_NAME) --url "https://github.com/$(PLUGN_REPO_NAME)" --description $(PLUGN_DESCRIPTION) --license 'MIT License' .
+	mv *.deb /tmp
+
+deb-sshcommand: deb-setup
+	rm -rf /tmp/tmp /tmp/build $(SSHCOMMAND_PACKAGE_NAME)
+	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/local/bin
+
+	@echo "-> Cloning repository"
+	git clone -q "https://github.com/$(SSHCOMMAND_REPO_NAME).git" /tmp/tmp/sshcommand > /dev/null
+	rm -rf /tmp/tmp/sshcommand/.git /tmp/tmp/sshcommand/.gitignore
+
+	@echo "-> Copying files into place"
+	mkdir -p "/tmp/build/usr/local/bin"
+	cp /tmp/tmp/sshcommand/sshcommand /tmp/build/usr/local/bin/sshcommand
+	chmod +x /tmp/build/usr/local/bin/sshcommand
+
+	@echo "-> Creating $(SSHCOMMAND_PACKAGE_NAME)"
+	sudo fpm -t deb -s dir -C /tmp/build -n sshcommand -v $(SSHCOMMAND_VERSION) -a $(SSHCOMMAND_ARCHITECTURE) -p $(SSHCOMMAND_PACKAGE_NAME) --url "https://github.com/$(SSHCOMMAND_REPO_NAME)" --description $(SSHCOMMAND_DESCRIPTION) --license 'MIT License' .
+	mv *.deb /tmp
+
+deb-sigil: deb-setup golang
+	rm -rf /tmp/tmp /tmp/build $(SIGIL_PACKAGE_NAME)
+	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/local/bin
+
+	@echo "-> Cloning repository"
+	git clone -q "https://github.com/$(SIGIL_REPO_NAME).git" /tmp/tmp/sigil > /dev/null
+	rm -rf /tmp/tmp/sigil/.git /tmp/tmp/sigil/.gitignore
+
+	@echo "-> Copying files into place"
+	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH):/tmp/tmp/sigil && go get github.com/gliderlabs/sigil
+	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH):/tmp/tmp/sigil && cd /home/vagrant/gocode/src/github.com/gliderlabs/sigil && make deps
+	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH):/tmp/tmp/sigil && cd /home/vagrant/gocode/src/github.com/gliderlabs/sigil && rm -f sigil && go build -o sigil
+	mv /home/vagrant/gocode/src/github.com/gliderlabs/sigil/sigil /tmp/build/usr/local/bin/sigil
+
+	@echo "-> Creating $(SIGIL_PACKAGE_NAME)"
+	sudo fpm -t deb -s dir -C /tmp/build -n sigil -v $(SIGIL_VERSION) -a $(SIGIL_ARCHITECTURE) -p $(SIGIL_PACKAGE_NAME) --url "https://github.com/$(SIGIL_REPO_NAME)" --description $(SIGIL_DESCRIPTION) --license 'MIT License' .
+	mv *.deb /tmp

debian/config

@@ -0,0 +1,21 @@
+#!/bin/sh -e
+
+. /usr/share/debconf/confmodule
+
+readonly ACTION="${1:-configure}"
+readonly VERSION="${2:-dev}"
+
+db_input "high" "dokku/web_config" || true
+db_go || true
+
+db_get "dokku/web_config"
+if [ $RET = "true" ]; then
+    exit 0
+fi
+
+db_input "high" "dokku/hostname" || true
+db_input "high" "dokku/vhost_enable" || true
+if [ "$ACTION" != "reconfigure" ]; then
+  db_input "high" "dokku/key_file" || true
+fi
+db_go || true

debian/control

@@ -0,0 +1,11 @@
+Package: dokku
+Version: 0.5.0
+Section: web
+Priority: optional
+Architecture: amd64
+Depends: locales, git, make, curl, gcc, man-db, sshcommand, docker-engine-cs (>= 1.9.1) | docker-engine (>= 1.9.1), software-properties-common, python-software-properties
+Recommends: herokuish
+Pre-Depends: nginx (>= 1.4.6), dnsutils, apparmor, cgroupfs-mount | cgroup-lite, plugn, sudo, python2.7, debconf
+Maintainer: Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>
+Description: Docker-powered PaaS that helps build and manage the lifecycle of applications
+

debian/postinst

@@ -0,0 +1,102 @@
+#!/bin/bash
+set -eo pipefail; [[ $TRACE ]] && set -x
+
+. /usr/share/debconf/confmodule
+
+readonly DOKKU_ROOT="${DOKKU_ROOT:-/home/dokku}"
+readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
+
+case "$1" in
+  abort-upgrade|abort-remove|abort-deconfigure)
+    ;;
+
+  configure)
+    mandb
+    [ ! -x /usr/bin/docker.io ] || ln -sf /usr/bin/docker.io /usr/local/bin/docker
+    modprobe aufs || echo "WARNING: Restart server to finish installing dokku!"
+    sshcommand create dokku /usr/local/bin/dokku
+    egrep -i "^docker" /etc/group || groupadd docker
+    usermod -aG docker dokku
+
+    echo "Setting up plugin directories"
+    # should be replaced by `plugn init`
+    mkdir -p ${DOKKU_LIB_ROOT}/core-plugins/available ${DOKKU_LIB_ROOT}/plugins/available
+    mkdir -p ${DOKKU_LIB_ROOT}/core-plugins/enabled ${DOKKU_LIB_ROOT}/plugins/enabled
+    touch ${DOKKU_LIB_ROOT}/core-plugins/config.toml ${DOKKU_LIB_ROOT}/plugins/config.toml
+
+    echo "Migrating old plugins"
+    find ${DOKKU_LIB_ROOT}/plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read -r plugin; do
+      if [ "$plugin" = "available" ] || [ "$plugin" = "enabled" ]; then
+        continue
+      elif [ -f ${DOKKU_LIB_ROOT}/plugins/$plugin/.core ]; then
+        rm -rf ${DOKKU_LIB_ROOT}/plugins/$plugin
+      elif [ ! -d ${DOKKU_LIB_ROOT}/plugins/available/$plugin ]; then
+        mv ${DOKKU_LIB_ROOT}/plugins/$plugin ${DOKKU_LIB_ROOT}/plugins/available;
+      fi
+    done
+
+    echo "Enabling all core plugins"
+    find ${DOKKU_LIB_ROOT}/core-plugins/available -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read -r plugin; do
+      if [ ! -d ${DOKKU_LIB_ROOT}/plugins/available/$plugin ]; then
+        ln -s ${DOKKU_LIB_ROOT}/core-plugins/available/$plugin ${DOKKU_LIB_ROOT}/plugins/available/$plugin;
+        PLUGIN_PATH=${DOKKU_LIB_ROOT}/core-plugins plugn enable $plugin
+        PLUGIN_PATH=${DOKKU_LIB_ROOT}/plugins plugn enable $plugin
+      fi
+    done
+    chown dokku:dokku -R ${DOKKU_LIB_ROOT}/plugins ${DOKKU_LIB_ROOT}/core-plugins
+
+    echo "Install all core plugins"
+    dokku plugin:install --core
+
+    rm -f ${DOKKU_ROOT}/VERSION
+    cp ${DOKKU_LIB_ROOT}/STABLE_VERSION ${DOKKU_ROOT}/VERSION
+
+    if [[ -f /etc/nginx/conf.d/dokku-installer.conf ]]; then
+      echo "Setting up dokku-installer"
+      /usr/share/dokku/contrib/dokku-installer.py onboot
+
+      if command -v systemctl &>/dev/null; then
+        echo "Enabling dokku-installer"
+        systemctl enable dokku-installer
+      fi
+
+      installer_status="$(service dokku-installer status 2> /dev/null || true)"
+      if echo $installer_status | grep -Eq "(inactive|waiting)" > /dev/null; then
+        echo "Starting dokku-installer"
+        service dokku-installer start || echo "Unable to start dokku-installer"
+      fi
+    fi
+
+    db_get "dokku/web_config"
+    if [ "$RET" = "true" ]; then
+      db_stop
+      exit 0
+    fi
+
+    db_get "dokku/vhost_enable"
+    if [ "$RET" = "true" ]; then
+        db_get "dokku/hostname"
+        echo "$RET" > "${DOKKU_ROOT}/VHOST"
+    else
+        rm -f "${DOKKU_ROOT}/VHOST"
+    fi
+
+    db_get "dokku/hostname"
+    echo "$RET" > "${DOKKU_ROOT}/HOSTNAME"
+
+    if [ -z "${DEBCONF_RECONFIGURE}" ]; then
+      db_get "dokku/key_file"
+      if [ -f "$RET" ]; then
+        sshcommand acl-add dokku default < "$RET"
+      fi
+    fi
+    ;;
+
+  *)
+    echo "postinst called with unknown argument \`$1'" >&2
+    exit 1
+    ;;
+esac
+
+db_stop
+exit 0

debian/postrm

@@ -0,0 +1,45 @@
+#!/bin/bash
+set -eo pipefail; [[ $TRACE ]] && set -x
+
+readonly DOKKU_ROOT="${DOKKU_ROOT:-/home/dokku}"
+readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
+
+main() {
+  if [[ -f /etc/systemd/system/dokku-installer.conf ]] || [[ -f /etc/init/dokku-installer.conf ]]; then
+    service dokku-installer stop || true
+  fi
+
+  rm -f /etc/init/dokku-installer.conf
+  rm -f /etc/init/dokku-redeploy.conf
+  rm -f /etc/systemd/system/dokku-installer.conf
+  rm -f /etc/systemd/system/dokku-redeploy.service
+  rm -f /etc/update-motd.d/99-dokku
+
+  (nginx -t && service nginx reload) || true
+
+  if [[ "$1" == "purge" ]]; then
+    rm -f ${DOKKU_ROOT}/.dokkurc ${DOKKU_ROOT}/dokkurc ${DOKKU_ROOT}/tls
+    rm -f ${DOKKU_ROOT}/.ssh/authorized_keys ${DOKKU_ROOT}/.sshcommand
+    rm -f ${DOKKU_ROOT}/ENV ${DOKKU_ROOT}/HOSTNAME ${DOKKU_ROOT}/VERSION
+    rm -rf ${DOKKU_ROOT}/.cache
+    rm -rf ${DOKKU_LIB_ROOT}/core-plugins
+
+    rm -f ${DOKKU_LIB_ROOT}/plugins/config.toml
+    if [[ -d ${DOKKU_LIB_ROOT} ]]; then
+      find -L ${DOKKU_LIB_ROOT} -type l -delete
+      find ${DOKKU_LIB_ROOT} -type d -empty -delete
+    fi
+
+    if [[ -d ${DOKKU_ROOT} ]]; then
+      find -L ${DOKKU_ROOT} -type l -delete
+      find ${DOKKU_ROOT} -type d -empty -delete
+    fi
+
+    if [[ -e /usr/share/debconf/confmodule ]]; then
+      . /usr/share/debconf/confmodule
+      db_purge
+    fi
+  fi
+}
+
+main "$@"

debian/preinst

@@ -0,0 +1,54 @@
+#!/bin/bash
+set -eo pipefail; [[ $TRACE ]] && set -x
+
+. /usr/share/debconf/confmodule
+
+case "$1" in
+  install)
+    db_get "dokku/web_config"
+    if [ "$RET" = "true" ]; then
+      NGINX_CONF="/etc/nginx/conf.d/dokku-installer.conf"
+
+      rm -f $NGINX_CONF
+      touch $NGINX_CONF
+
+      {
+        echo 'upstream dokku-installer { server 127.0.0.1:2000; }'
+        echo 'server {'
+        echo '  listen      80;'
+        echo '  location    / {'
+        echo '    proxy_pass  http://dokku-installer;'
+        echo '  }'
+        echo '}'
+      } >> $NGINX_CONF
+
+      rm -f /etc/nginx/sites-enabled/*
+      service nginx reload || /etc/init.d/nginx reload
+      exit 0
+    fi
+
+    db_get "dokku/skip_key_file"
+    if [ -z "${DEBCONF_RECONFIGURE}" ] && [ "$RET" != "true" ]; then
+      db_get "dokku/key_file"
+      if [ ! -f "$RET" ]; then
+          echo "Error: keyfile '$RET' not found."
+          echo "       you can enter a new keyfile path when you restart the installation."
+          db_reset "dokku/key_file"
+          exit 1
+      fi
+    fi
+    ;;
+
+  upgrade)
+    ;;
+
+  abort-upgrade)
+    ;;
+
+  *)
+    echo "preinst called with unknown argument \`$1'" >&2
+    exit 1
+    ;;
+esac
+
+exit 0

debian/prerm

@@ -0,0 +1,55 @@
+#!/bin/bash
+set -eo pipefail; [[ $TRACE ]] && set -x
+
+readonly DOKKU_ROOT="${DOKKU_ROOT:-/home/dokku}"
+readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
+
+ps_backtrace() {
+  if [ $# -lt 1 ]; then
+    echo "Usage: $0 PID" > /dev/stderr
+    exit 1
+  fi
+
+  declare -i pid=$1;
+  ppid=0;
+  header_modifier="";
+  while : ; do
+    if [ $ppid -ne 0 ]; then
+      header_modifier=h;
+    fi;
+    ppid=$(ps -o ppid= $pid);
+    ps uww $header_modifier -p $pid;
+    if [ $pid -eq 1 ]; then
+      break;
+    fi;
+    pid=$ppid;
+  done;
+}
+
+main() {
+  # HACK: Ensure that we only delete data when purging dokku from the system
+  if ps_backtrace $BASHPID 2> /dev/null | grep dpkg | grep -- "--purge" > /dev/null; then
+    echo "Processing purge"
+
+    echo "Destroying deployed applications"
+    for app in $(DOKKU_QUIET_OUTPUT=1 dokku apps); do
+      dokku --force apps:destroy $app
+    done
+
+    # HACK: Only disable core plugins, as we don't know what data users store in non-core plugin directories
+    echo "Disabling all core plugins"
+    find ${DOKKU_LIB_ROOT}/core-plugins/available -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read -r plugin; do
+      if [ ! -d ${DOKKU_LIB_ROOT}/plugins/available/$plugin ]; then
+        rm ${DOKKU_LIB_ROOT}/plugins/available/$plugin;
+        PLUGIN_PATH=${DOKKU_LIB_ROOT}/core-plugins plugn disable $plugin
+        PLUGIN_PATH=${DOKKU_LIB_ROOT}/plugins plugn disable $plugin
+      fi
+    done
+  else
+    echo "Processing $1"
+  fi
+
+  dokku cleanup
+}
+
+main "$@"

debian/templates

@@ -0,0 +1,24 @@
+Template: dokku/web_config
+Description: Enable the web-based config page?
+Type: boolean
+Default: true
+
+Template: dokku/vhost_enable
+Description: Enable vhost-based deployments?
+Type: boolean
+Default: false
+
+Template: dokku/hostname
+Description: Hostname or IP for server:
+Type: string
+Default: dokku.me
+
+Template: dokku/skip_key_file
+Description: Skip key file requirement?
+Type: boolean
+Default: false
+
+Template: dokku/key_file
+Description: Keyfile for initial user:
+Type: string
+Default: /root/.ssh/id_rsa.pub

docs/advanced-installation.md

@@ -0,0 +1,75 @@
+# Advanced installation
+
+You can always install dokku straight from the latest - potentially unstable - master release via the following bash command:
+
+```shell
+wget -qO- https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh | sudo DOKKU_BRANCH=master bash
+```
+
+## Development
+
+If you plan on developing dokku, the easiest way to install from your own repository is cloning the repository and calling the install script. Example:
+
+```shell
+git clone https://github.com/yourusername/dokku.git
+cd dokku
+sudo make install
+```
+
+The `Makefile` allows source URLs to be overridden to include customizations from your own repositories. The `DOCKER_URL`, `PLUGN_URL`, `SSHCOMMAND_URL` and `STACK_URL` environment variables may be set to override the defaults (see the `Makefile` for how these apply). Example:
+
+```shell
+sudo SSHCOMMAND_URL=https://raw.githubusercontent.com/yourusername/sshcommand/master/sshcommand make install
+```
+
+## Bootstrap a server from your own repository
+
+The bootstrap script allows the dokku repository URL to be overridden to bootstrap a host from your own clone of dokku using the `DOKKU_REPO` environment variable. Example:
+
+```shell
+wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh
+chmod +x bootstrap.sh
+sudo DOKKU_REPO=https://github.com/yourusername/dokku.git DOKKU_BRANCH=master ./bootstrap.sh
+```
+
+## Custom herokuish build
+
+Dokku ships with a pre-built version of version of the [herokuish](https://github.com/gliderlabs/herokuish) component by default. If you want to build your own version you can specify that with an env variable.
+
+```shell
+git clone https://github.com/dokku/dokku.git
+cd dokku
+sudo BUILD_STACK=true STACK_URL=https://github.com/gliderlabs/herokuish.git make install
+```
+
+## Configuring
+
+Once dokku is installed, if you are not using the web-installer, you'll want to configure a the virtualhost setup as well as the push user. If you do not, your installation will be considered incomplete and you will not be able to deploy applications.
+
+Set up a domain and a wildcard domain pointing to that host. Make sure `/home/dokku/VHOST` is set to this domain. By default it's set to whatever hostname the host has. This file is only created if the hostname can be resolved by dig (`dig +short $(hostname -f)`). Otherwise you have to create the file manually and set it to your preferred domain. If this file still is not present when you push your app, dokku will publish the app with a port number (i.e. `http://example.com:49154` - note the missing subdomain).
+
+Follow the [user management documentation](/dokku/deployment/user-management) in order to add users to dokku.
+
+That's it!
+
+## VMs with less than 1GB of memory
+
+Having less than 1GB of system memory available for dokku and its containers, for example Digital Ocean's small 512MB machines, might result in unexpected errors, such as **! [remote rejected] master -> master (pre-receive hook declined)** during installation of NPM dependencies (https://github.com/npm/npm/issues/3867).
+
+To work around this issue, it might suffice to augment the linux swap file size to a maximum of twice the physical memory size.
+
+To resize the swap file of a 512MB machine to 1GB, follow these steps while in SSH within your machine:
+
+```shell
+cd /var
+touch swap.img
+chmod 600 swap.img
+
+dd if=/dev/zero of=/var/swap.img bs=1024k count=1000
+mkswap /var/swap.img
+swapon /var/swap.img
+free
+
+echo "/var/swap.img    none    swap    sw    0    0" >> /etc/fstab
+```
+Reference: https://www.digitalocean.com/community/tutorials/how-to-configure-virtual-memory-swap-file-on-a-vps

docs/appendices/0.5.0-migration-guide.md

@@ -0,0 +1,22 @@
+# 0.5.0 Migration Guide
+
+## nginx-vhosts
+
+- The nginx-vhosts template language is now [sigil](https://github.com/gliderlabs/sigil)
+  - No need to escape literal `$` characters (or other "bash-isms")
+  - Template variables are represented as {{ .VARIABLE_NAME }}
+  - A detailed list of template variables can be found [here](/dokku/nginx#available-template-variables)
+- A custom nginx-vhosts template must be named `nginx.conf.sigil`
+  - The default path for this custom template is the root of your repo (i.e. `/app` in the container or `WORKDIR` if defined in a dockerfile app)
+  - Dokku no longer looks for this file in `/home/dokku/myapp` on the dokku server
+  - Check out an example template [here](/dokku/nginx/)
+- Support for server-wide SSL certs have been dropped in favor of using the `certs` plugin
+  - `dokku certs:add myapp < certs.tar`
+- All domains for an SSL-enabled app will be redirected to https by default
+  - This can be overridden with a custom template
+- Replaced "magic" `NO_VHOST` variable with `domains:enable/disable`
+- Simplified zero downtime control
+  - `checks:enable/disable`
+## Dockerfile apps with multiple ports
+- Dockerfiles with multiple `EXPOSE` clauses will get all **tcp** ports proxied by default (nginx does not support proxying udp)
+  - UDP can be exposed by disabling the nginx proxy with `dokku proxy:disable myapp`

docs/application-deployment.md

@@ -1,90 +1,211 @@
-# Deploy an App
+# Deploying to Dokku
 
-Now you can deploy apps on your Dokku. Let's deploy the [Heroku Node.js sample app](https://github.com/heroku/node-js-sample). All you have to do is add a remote to name the app. It's created on-the-fly.
+## Deploy tutorial
 
-```
-$ cd node-js-sample
-$ git remote add progrium dokku@progriumapp.com:node-js-app
-$ git push progrium master
-Counting objects: 296, done.
-Delta compression using up to 4 threads.
-Compressing objects: 100% (254/254), done.
-Writing objects: 100% (296/296), 193.59 KiB, done.
-Total 296 (delta 25), reused 276 (delta 13)
------> Building node-js-app ...
-       Node.js app detected
------> Resolving engine versions
+Once Dokku has been configured with at least one user, applications can be deployed via a `git push` command. To quickly see Dokku deployment in action, you can use the Heroku Ruby on Rails example app.
 
-... blah blah blah ...
-
------> Application deployed:
-       http://node-js-app.progriumapp.com
+```shell
+# from your local machine
+git clone git@github.com:heroku/ruby-rails-sample.git
 ```
 
-You're done!
+### Create the app
 
-Dokku only supports deploying from its master branch, so if you'd like to deploy a different local branch use: ```git push progrium <local branch>:master```
+Create the application on the Dokku host. You will need to ssh onto the host to run this command.
 
-Right now Buildstep supports buildpacks for Node.js, Ruby, Python, [and more](https://github.com/progrium/buildstep#supported-buildpacks). It's not hard to add more, [go add more](https://github.com/progrium/buildstep#adding-buildpacks)!
-Please check the documentation for your particular build pack as you may need to include configuration files (such as a Procfile) in your project root.
-
-## Specifying a custom buildpack
-
-If buildpack detection isn't working well for you or you want to specify a custom buildpack for one repository you can create & commit a file in the root of your git repository named `.env` containing `export BUILDPACK_URL=<repository>` before pushing. This will tell buildstep to fetch the specified buildpack and use it instead of relying on the built-in buildpacks & their detection methods.
-
-## Default vhost
-
-You might notice the default vhost for Nginx will be one of the apps. If an app doesn't exist, it will use this vhost and it may be confusing for it to go to another app. You can create a default vhost using a configuration under `sites-enabled`. You just have to change one thing in the main nginx.conf:
-
-Swap both conf.d include line and the sites-enabled include line. From:
-```
-include /etc/nginx/conf.d/*.conf;
-include /etc/nginx/sites-enabled/*;
-```
-to
-```
-include /etc/nginx/sites-enabled/*;
-include /etc/nginx/conf.d/*.conf;
+```shell
+# on your dokku host
+dokku apps:create ruby-rails-sample
 ```
 
-Alternatively, you may push an app to your dokku host with a name like "00-default". As long as it lists first in `ls /home/dokku/*/nginx.conf | head`, it will be used as the default nginx vhost.
+### Create the backing services
+
+When you create a new app, Dokku by default *does not* provide any datastores such as MySQL or PostgreSQL. You will need to install plugins to handle that, but fortunately [Dokku has official plugins](/dokku/plugins/#official-plugins-beta) for common datastores. Our sample app requires a PostgreSQL service:
+
+```shell
+# on your dokku host
+# install the postgres plugin
+# plugin installation requires root, hence the user change
+sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git
+
+# create a postgres service with the name rails-database
+dokku postgres:create rails-database
+```
+
+> Each services may take a few moments to create.
+
+### Linking backing services to applications
+
+Once the service creation is complete, set the `POSTGRES_URL` environment variable by linking the service.
+
+```shell
+# on your dokku host
+# each official datastore offers a `link` method to link a service to any application
+dokku postgres:link rails-database ruby-rails-sample
+```
+
+> You can link a single service to multiple applications or use one service per application.
+
+### Deploy the app
+
+Now you can deploy the `ruby-rails-sample` app to your Dokku server. All you have to do is add a remote to name the app. Applications are created on-the-fly on the Dokku server.
+
+```shell
+# from your local machine
+git remote add dokku dokku@dokku.me:ruby-rails-sample
+git push dokku master
+```
+
+You should see output similar to the following:
+
+```
+Counting objects: 231, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (162/162), done.
+Writing objects: 100% (231/231), 36.96 KiB | 0 bytes/s, done.
+Total 231 (delta 93), reused 147 (delta 53)
+-----> Cleaning up...
+-----> Building ruby-rails-sample from herokuish...
+-----> Adding BUILD_ENV to build environment...
+-----> Ruby app detected
+-----> Compiling Ruby/Rails
+-----> Using Ruby version: ruby-2.2.1
+-----> Installing dependencies using 1.9.7
+       Running: bundle install --without development:test --path vendor/bundle --binstubs vendor/bundle/bin -j4 --deployment
+       Fetching gem metadata from https://rubygems.org/...........
+       Fetching version metadata from https://rubygems.org/...
+       Fetching dependency metadata from https://rubygems.org/..
+       Using rake 10.4.2
+
+...
+```
+
+When the deploy finishes, the application's URL will be shown.
+
+```shell
+=====> Application deployed:
+       http://ruby-rails-sample.dokku.me
+```
+
+Dokku supports deploying applications via [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) with [Herokuish](https://github.com/gliderlabs/herokuish#buildpacks) or using a project's [dockerfile](https://docs.docker.com/reference/builder/).
+
+### Removing a deployed app
+
+You can also remove an application from your Dokku installation. This will unlink all linked services and destroy any config related to the application. Note that linked services will retain their data for later use (or removal).
+
+```shell
+# on your dokku host
+# replace APP with the name of your application
+dokku apps:destroy APP
+```
+
+This will prompt you to verify the application's name before destroying it. You may also use the `--force` flag to circumvent this verification process:
+
+```shell
+# on your dokku host
+# replace APP with the name of your application
+dokku --force apps:destroy APP
+```
+
+### Renaming a deployed app
+
+> New as of 0.4.7
+
+You can rename a deployed app using the `apps:rename` CLI tool:
+
+```shell
+# on your dokku host
+dokku apps:rename OLD_NAME NEW_NAME
+```
+
+This will copy all of your app's contents into a new app directory with the name of your choice, delete your old app, then rebuild the new version of the app and deploy it. All of your config variables, including database urls, will be preserved.
+
+### Deploying non-master branch
+
+Dokku only supports deploying from its master branch, so if you'd like to deploy a different local branch use: ```git push dokku <local branch>:master```
+
+You can also support pushing multiple branches using the [receive-branch](/dokku/development/plugin-triggers/#receive-branch) plugin trigger in a custom plugin.
+
+### Skipping deployment
+
+If you only want to rebuild and tag a container, you can skip the deployment phase by setting `$DOKKU_SKIP_DEPLOY` to `true` by running:
+
+``` shell
+# on your dokku host
+dokku config:set ruby-rails-sample DOKKU_SKIP_DEPLOY=true
+```
+
+### Deploying with private git submodules
+
+Dokku uses git locally (i.e. not a docker image) to build its own copy of your app repo, including submodules. This is done as the `dokku` user. Therefore, in order to deploy private git submodules, you'll need to drop your deploy key in `/home/dokku/.ssh/` and potentially add github.com (or your VCS host key) into `/home/dokku/.ssh/known_hosts`. The following test should help confirm you've done it correctly.
+
+```shell
+# on your dokku host
+su - dokku
+ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
+ssh -T git@github.com
+```
+
+Note that if the buildpack or dockerfile build process require ssh key access for other reasons, the above may not always apply.
 
 ## Deploying to subdomains
 
 The name of remote repository is used as the name of application to be deployed, as for example above:
 
-    $ git remote add progrium git@progriumapp.com:node-js-app
-    $ git push progrium master
+    $ git remote add dokku dokku@dokku.me:ruby-rails-sample
+    $ git push dokku master
 
 Is deployed to,
 
     remote: -----> Application deployed:
-    remote:        http://node-js-app.progriumapp.com
+    remote:        http://ruby-rails-sample.dokku.me
 
-You can also specify fully qualified names, say `app.progrium.com`, as
+You can also specify fully qualified names, say `app.dokku.me`, as
 
-    $ git remote add progrium git@progriumapp.com:app.progrium.com
-    $ git push progrium master
+    $ git remote add dokku dokku@dokku.me:app.dokku.me
+    $ git push dokku master
 
 So, after deployment the application will be available at,
 
     remote: -----> Application deployed:
-    remote:        http://app.progrium.com
+    remote:        http://app.dokku.me
 
 This is in particular useful, then you want to deploy to root domain, as
 
-    $ git remote add progrium git@progriumapp.com:progrium.com
-    $ git push progrium master
+    $ git remote add dokku dokku@dokku.me:dokku.me
+    $ git push dokku master
 
     ... deployment ...
 
     remote: -----> Application deployed:
-    remote:        http://progrium.com
+    remote:        http://dokku.me
 
-# Removing a deployed app
+## Dokku/Docker Container Management Compatibility
 
-SSH onto the server, then execute:
+Dokku is, at its core, a docker container manager. Thus, it does not necessarily play well with other out-of-band processes interacting with the docker daemon. One thing to note as in [issue #1220](https://github.com/dokku/dokku/issues/1220), dokku executes a cleanup function prior to every deployment. 
 
-```bash
-dokku delete myapp
-```
+As of 0.5.x, this function removes all containers with the label `dokku` where the status is either `dead` or `exited`, as well as all `dangling` images. Previous versions would remove `dead` or `exited` containers, regardless of their label.
+
+### Adding deploy users
+
+See the [user management documentation](/dokku/deployment/user-management).
+
+## Default vhost
+
+See the [nginx documentation](/dokku/nginx/#default-site).
+
+## Dockerfile deployment
+
+See the [dockerfile documentation](/dokku/deployment/dockerfiles/).
+
+### Specifying a custom buildpack
+
+See the [buildpack documentation](/dokku/deployment/buildpacks/).
+
+## Image tagging
+
+See the [image tagging documentation](/dokku/deployment/images).
+
+## Zero downtime deploy
+
+See the [zero-downtime deploy documentation](/dokku/checks-examples/).

docs/assets/favicons/browserconfig.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+  <msapplication>
+    <tile>
+      <square70x70logo src="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/mstile-70x70.png"/>
+      <square150x150logo src="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/mstile-150x150.png"/>
+      <square310x310logo src="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/mstile-310x310.png"/>
+      <wide310x150logo src="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/mstile-310x150.png"/>
+      <TileColor>#da532c</TileColor>
+    </tile>
+  </msapplication>
+</browserconfig>

docs/assets/favicons/manifest.json

@@ -0,0 +1,41 @@
+{
+    "name": "Dokku",
+    "icons": [
+        {
+            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.5.0\/docs\/assets\/favicons\/android-chrome-36x36.png",
+            "sizes": "36x36",
+            "type": "image\/png",
+            "density": "0.75"
+        },
+        {
+            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.5.0\/docs\/assets\/favicons\/android-chrome-48x48.png",
+            "sizes": "48x48",
+            "type": "image\/png",
+            "density": "1.0"
+        },
+        {
+            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.5.0\/docs\/assets\/favicons\/android-chrome-72x72.png",
+            "sizes": "72x72",
+            "type": "image\/png",
+            "density": "1.5"
+        },
+        {
+            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.5.0\/docs\/assets\/favicons\/android-chrome-96x96.png",
+            "sizes": "96x96",
+            "type": "image\/png",
+            "density": "2.0"
+        },
+        {
+            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.5.0\/docs\/assets\/favicons\/android-chrome-144x144.png",
+            "sizes": "144x144",
+            "type": "image\/png",
+            "density": "3.0"
+        },
+        {
+            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.5.0\/docs\/assets\/favicons\/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image\/png",
+            "density": "4.0"
+        }
+    ]
+}

docs/assets/style.css

@@ -0,0 +1,492 @@
+body {
+  font-family: 'Open Sans', sans-serif;
+  font-weight: 400;
+  font-size: 12px;
+  padding-bottom: 40px;
+  color: #5a5a5a;
+  -webkit-font-smoothing: antialiased;
+}
+h1 {
+  color: #5a5a5a;
+  font-weight: 400;
+  line-height: 1.1;
+  margin-bottom: 12px;
+  margin-top: 12px;
+  text-rendering: optimizelegibility;
+}
+.header {
+  background-color: #2a8fbd;
+  padding: 22px 0;
+}
+.header .heading {
+  color: #fff;
+  font-size: 23px;
+  margin: 0;
+  padding: 0 0 0 1em;
+}
+.header a {
+  color: #fff;
+  background-position: center left;
+  display: block;
+  width: 100%;
+  height: 100%;
+  -webkit-background-size: contain;
+  -moz-background-size: contain;
+  background-size: contain;
+  background-repeat: no-repeat;
+}
+.header .navbar-brand a {
+  background-image: url(https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/dokku.png);
+  text-indent: 40px;
+}
+.blurb {
+  color: #424242;
+  background-color: #ededed;
+  background-image: url(https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/gplaypattern.png);
+  padding: 45px 0;
+  text-align: center;
+}
+.blurb p {
+  font-size: 17px;
+  font-weight: 300;
+  margin: 18px 0;
+  text-align: center;
+}
+.quickstart-code {
+  display: block;
+  line-height: 1.3em;
+  margin: 45px auto;
+  max-width: 750px;
+  padding: 0;
+}
+.quickstart-code .title {
+  background-color: #dfdfdf;
+  background-image: linear-gradient(top, #f7f7f7 0%, #dfdfdf 7%, #ccc 100%);
+  border-radius: 5px 5px 0 0;
+  box-shadow: 0 3px 0 rgba(0, 0, 0, 0.5);
+  color: #444;
+  display: block;
+  font-weight: 400;
+  font-size: 14px;
+  margin: 0 20px;
+  padding: 3px 0;
+  text-align: center;
+  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+}
+.quickstart-code .tabs {
+  background-color: #bcbcbc;
+  border-top: 1px solid #686868;
+  color: #444;
+  display: flex;
+  display: -webkit-flex;
+  font-weight: bold;
+  margin: 0 20px;
+  padding: 0;
+  text-align: center;
+  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+}
+.quickstart-code .tab {
+  border-right: 1px solid #686868;
+  cursor: pointer;
+  flex: 1;
+  -webkit-flex: 1;
+}
+.quickstart-code .tab-active {
+  background-color: #ededed;
+  border-radius: 0 0 5px 5px;
+  box-shadow: 0 1px 0 rgba(0, 0, 0, 0.5);
+}
+.quickstart-code .tab:last-of-type {
+  border-right: none;
+}
+.quickstart-code .shell {
+  background-color: #171717;
+  border-radius: 0 0 5px 5px;
+  border-top: 1px solid #bcbcbc;
+  box-shadow: 0 5px 30px rgba(0, 0, 0, 0.3);
+  display: none;
+  font-family: Menlo, Consolas, "Courier New", Courier, "Liberation Mono", monospace;
+  margin: 0 20px;
+  padding: 20px;
+  text-shadow: none;
+}
+.quickstart-code .shell-active {
+  display: block;
+}
+.quickstart-code .line {
+  display: block;
+  margin: 0;
+  padding: 0;
+}
+.quickstart-code .line span {
+  display: inline-block;
+}
+.quickstart-code .line .output {
+  color: #aaa;
+}
+.quickstart-code .path {
+  color: #2a8fbd;
+  content: '~';
+  user-select: none;
+}
+.quickstart-code .prompt {
+  color: #f90;
+  user-select: none;
+}
+.quickstart-code .command {
+  color: #ffc;
+}
+.alternate-instructions {
+  display: block;
+  line-height: 1.3em;
+  margin: 45px auto;
+  max-width: 750px;
+  padding: 0;
+  text-align: center;
+}
+.marketing .col-lg-4 {
+  margin-bottom: 20px;
+  text-align: center;
+}
+.marketing .col-lg-4 p {
+  margin-right: 10px;
+  margin-left: 10px;
+}
+.featurette-divider {
+  margin: 20px 0;
+}
+.featurette-heading {
+  font-weight: normal;
+  line-height: 1;
+  letter-spacing: -1px;
+}
+.featurette-heading .text-muted {
+  font-weight: 300;
+}
+.slack-channel {
+  background-color: #EEF1F7;
+  font-size: 16px;
+  font-weight: 300;
+  margin-bottom: 2.5em;
+  padding: 2.5em 0;
+  text-align: center
+}
+.slack-channel .inline-container {
+  display: inline-block;
+  margin-left: 0.5em
+}
+.list-group-item {
+  border: none;
+  font-weight: normal;
+  padding: .2rem .5rem;
+  color: #157577;
+}
+a.list-group-item {
+  color: #666
+}
+.list-group-item.disabled:first-child, .list-group-item.disabled:first-child:focus, .list-group-item.disabled:first-child:hover {
+  margin-top: 0;
+}
+.list-group-item.disabled, .list-group-item.disabled:focus, .list-group-item.disabled:hover {
+  background: none;
+  color: #bbb;
+  cursor: default;
+  font-weight: normal;
+  margin-bottom: 1em;
+  margin-top: 2em;
+  text-transform: uppercase;
+}
+.anchorjs-link {
+  color: #24cbce;
+}
+.markdown-body {
+  -webkit-font-smoothing: antialiased;
+  box-sizing: border-box;
+  color: rgb(71, 74, 84);
+  font-size: 14px;
+  font-weight: normal;
+  height: 20px;
+  line-height: 20px;
+  text-align: left;
+}
+.markdown-body h1 {
+  border-bottom: 1px solid #dfdfdf;
+  color: #444;
+  font-size: 24px;
+  padding-bottom: 1em;
+  margin-top: 0;
+  text-rendering: optimizelegibility;
+}
+.markdown-body h2 {
+  font-size: 17px;
+  font-weight: 700;
+  color: #555;
+  margin-top: 2em;
+  text-transform: uppercase;
+}
+.markdown-body h3 {
+  font-size: 15px;
+  font-weight: 700;
+  color: #555;
+  margin: 1em 0;
+}
+.markdown-body h4 {
+  font-size: 14px;
+  font-weight: 700;
+  color: #555;
+  margin: 1em 0;
+}
+.markdown-body h1 + h2 {
+  margin-top: 1em;
+}
+code {
+  padding: 0;
+  padding-top: 0.2em;
+  padding-bottom: 0.2em;
+  margin: 0;
+  font-size: 85%;
+  background-color: #fff;
+  background-color: rgba(0, 0, 0, 0.06);
+  color: #333;
+  -webkit-border-radius: 3px;
+  border-radius: 3px;
+  font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+}
+code:before {
+  letter-spacing: -0.2em;
+  content: "\00a0";
+}
+code:after {
+  letter-spacing: -0.2em;
+  content: "\00a0";
+}
+pre code:before, pre code:after {
+  letter-spacing: 0;
+  content: "";
+}
+pre {
+  display: block;
+  line-height: 1.428571429;
+  word-break: normal;
+  word-wrap: normal;
+  border: 1px solid #cccccc;
+  border-radius: 4px;
+  box-shadow: 0 0 0 3px #eee;
+  overflow: auto;
+  padding: 10px;
+  background-color: #fff;
+  color: #4d4d4c;
+  margin: 2em 0;
+}
+blockquote {
+  border-left: 4px solid #5bc0de;
+  background-color: #f4f8fa;
+  padding: 15px 15px 1px;
+  margin-bottom: 30px;
+}
+.new-as-of {
+  border-left: 4px solid #d1f2a5;
+  background-color: #effab4;
+}
+.not-yet-released {
+  border-left: 4px solid #ef5b58;
+  background-color: #f9ad76;
+}
+.fa:before {
+  -webkit-font-smoothing: antialiased
+}
+.clearfix {
+  *zoom: 1
+}
+.clearfix:before, .clearfix:after {
+  display: table;
+  content: ""
+}
+.clearfix:after {
+  clear: both
+}
+a .fa {
+  display: inline-block;
+  text-decoration: inherit
+}
+li .fa {
+  display: inline-block
+}
+li .fa-large:before, li .fa-large:before {
+  width: 1.875em
+}
+ul.fas {
+  list-style-type: none;
+  margin-left: 2em;
+  text-indent: -0.8em
+}
+ul.fas li .fa {
+  width: 0.8em
+}
+ul.fas li .fa-large:before, ul.fas li .fa-large:before {
+  vertical-align: baseline
+}
+.rst-versions {
+  position: fixed;
+  bottom: 0;
+  left: 0;
+  width: 300px;
+  color: #fcfcfc;
+  background: #15518d;
+  border-top: solid 10px #343131;
+  font-family: "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif;
+  z-index: 400
+}
+.rst-versions a {
+  color: #7c8e98;
+  text-decoration: none
+}
+.rst-versions .rst-badge-small {
+  display: none
+}
+.rst-versions .rst-current-version {
+  padding: 12px;
+  background-color: #2475c3;
+  display: block;
+  text-align: right;
+  cursor: pointer;
+  color: #d8edf8;
+  *zoom: 1
+}
+.rst-versions .rst-current-version:before, .rst-versions .rst-current-version:after {
+  display: table;
+  content: ""
+}
+.rst-versions .rst-current-version:after {
+  clear: both
+}
+.rst-versions .rst-current-version .fa {
+  color: #fcfcfc
+}
+.rst-versions .rst-current-version .fa-book {
+  float: left;
+  line-height: 30px
+}
+.rst-versions .rst-current-version .icon-book {
+  float: left
+}
+.rst-versions .rst-current-version.rst-out-of-date {
+  background-color: #E74C3C;
+  color: #fff
+}
+.rst-versions .rst-current-version.rst-active-old-version {
+  background-color: #F1C40F;
+  color: #000
+}
+.rst-versions.rst-badge {
+  border: none;
+  bottom: 20px;
+  display: block;
+  left: auto;
+  max-width: 300px;
+  right: 20px;
+  width: auto;
+}
+.rst-versions.rst-badge .icon-book {
+  float: none
+}
+.rst-versions.rst-badge .fa-book {
+  float: none
+}
+.rst-versions.rst-badge.shift-up .rst-current-version {
+  text-align: right
+}
+.rst-versions.rst-badge.shift-up .rst-current-version .fa-book {
+  float: left
+}
+.rst-versions.rst-badge.shift-up .rst-current-version .icon-book {
+  float: left
+}
+.rst-versions.rst-badge .rst-current-version {
+  width: auto;
+  height: 30px;
+  line-height: 30px;
+  padding: 0 6px;
+  display: block;
+  text-align: center
+}
+.rst-other-versions {
+  display: none;
+  padding: 12px;
+  text-align: left;
+}
+.shift-up .rst-other-versions {
+  display: block;
+}
+.rst-other-versions a {
+  border: 0;
+}
+.rst-other-versions hr {
+  display: block;
+  border: 0;
+  margin: 20px 0;
+  padding: 0;
+  border-top: solid 1px #d6edf9
+}
+.rst-other-versions dl {
+  margin: 0;
+}
+.rst-other-versions dd {
+  display: inline-block;
+  margin: 0
+}
+.rst-other-versions dd a {
+  display: inline-block;
+  padding: 6px;
+  color: #fcfcfc
+}
+.dev-warning, .outdated-warning {
+  position: absolute;
+  top: 0;
+  width: 100%;
+  padding: 8px 20px 8px;
+  -moz-box-sizing: border-box;
+  -webkit-box-sizing: border-box;
+  box-sizing: border-box;
+  background-image: -webkit-linear-gradient(-45deg, rgba(0, 0, 0, 0.04) 25%, transparent 25%, transparent 50%, rgba(0, 0, 0, 0.04) 50%, rgba(0, 0, 0, 0.04) 75%, transparent 75%, transparent);
+  background-image: -o-linear-gradient(-45deg, rgba(0, 0, 0, 0.04) 25%, transparent 25%, transparent 50%, rgba(0, 0, 0, 0.04) 50%, rgba(0, 0, 0, 0.04) 75%, transparent 75%, transparent);
+  background-image: -moz-linear-gradient(-45deg, rgba(0, 0, 0, 0.04) 25%, transparent 25%, transparent 50%, rgba(0, 0, 0, 0.04) 50%, rgba(0, 0, 0, 0.04) 75%, transparent 75%, transparent);
+  background-image: -ms-linear-gradient(-45deg, rgba(0, 0, 0, 0.04) 25%, transparent 25%, transparent 50%, rgba(0, 0, 0, 0.04) 50%, rgba(0, 0, 0, 0.04) 75%, transparent 75%, transparent);
+  background-image: linear-gradient(135deg, rgba(0, 0, 0, 0.04) 25%, transparent 25%, transparent 50%, rgba(0, 0, 0, 0.04) 50%, rgba(0, 0, 0, 0.04) 75%, transparent 75%, transparent);
+  font-family: "Roboto", Corbel, Avenir, "Lucida Grande", "Lucida Sans", sans-serif;
+  font-size: 14px;
+  text-align: center;
+  background-color: #ffe761;
+}
+@media screen and (max-width: 768px) {
+  .rst-versions {
+    width: 85%;
+    display: none
+  }
+  .rst-versions.shift {
+    display: block
+  }
+  img {
+    width: 100%;
+    height: auto
+  }
+}
+@media (min-width: 768px) {
+  .col-md-offset-right-2 {
+    margin-right: 20.666667%;
+  }
+  .quickstart-code shell {
+    font-size: 14px;
+  }
+  .quickstart-code {
+    line-height: 22px;
+  }
+  .featurette-heading {
+    font-size: 50px;
+  }
+}
+@media (min-width: 992px) {
+  .featurette-heading {
+    margin-top: 120px;
+  }
+}

docs/assets/versions.json

@@ -0,0 +1,7 @@
+{
+  "max-versions": [
+    "0.3.26",
+    "0.4.14",
+    "0.5.0"
+  ]
+}

docs/backup-recovery.md

@@ -0,0 +1,45 @@
+# Backup and Recovery
+
+> The backup plugin was deprecated in 0.4.x, below are backup recommendations for 0.5.x and later.
+
+## Backup and Migration Tutorial
+
+Because Dokku is git based, rebuilding a deployed app is as easy as pushing from git. You can push to a new server by updating the dokku remote in you local app's repo.
+
+```
+$ git remote rm dokku
+$ git remote add dokku dokku@[dokku.me:dokku.me]
+$ git push dokku [master]
+```
+## Databases
+
+Some plugins, like the official [dokku-postgres] plugin, have built-in commands that allow non-volatile data be exported and imported. 
+
+For [dokku-postgres], use:
+```
+dokku postgres:export [db_name] > [db_name].dump
+dokku postgres:import [db_name] < [db_name].dump
+```
+
+## Volumes and Static Assets
+
+Dokku doesn't enforce a [300mb] limit on apps, but it's best practice to keep binary assets outside of git. Since containers are considered volatile in Dokku, external stores like s3 or storage mounts should be used for non-volatile items like user uploads. The dokku storage core plugin can be used to mount local directories / volumes inside the docker container.
+
+```
+storage:list <app>, List bind mounts for app's container(s) (host:container)
+storage:mount <app> <host-dir:container-dir>, Create a new bind mount
+storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
+```
+
+## Disaster Recovery
+
+The best plan for disaster recovery is to always keep multiple (remote) copies of your local repo, static assets and periodic database dumps. In case of an emergency when your git repo and backups are completely lost, you can recover the last pushed copy from your remote dokku server (assuming you still have the ssh key).
+
+```
+mkdir [app-name] ; cd !$
+git init && git remote add dokku dokku@[dokku.me:app-name]
+git pull dokku/master && git checkout dokku/master
+```
+
+[dokku-postgres]: <https://github.com/dokku/dokku-postgres>
+[300mb]: <https://devcenter.heroku.com/articles/slug-compiler#slug-size>

docs/checks-examples.md

@@ -0,0 +1,279 @@
+# Zero Downtime Deploys
+
+> New as of 0.5.0
+
+```
+checks <app>                                                                                 Show zero-downtime status
+checks:disable <app>                                                                         Disable zero-downtime checks
+checks:enable <app>                                                                          Enable zero-downtime checks
+```
+
+Following a deploy, dokku will wait `10` seconds before routing traffic to the new container to give your application time to boot up. If the application is not running after this time, then the deploy is failed and your old container will continue serving traffic. You can modify this value globally or on a per-application basis:
+
+```shell
+dokku config:set --global DOKKU_DEFAULT_CHECKS_WAIT=30
+dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=30
+```
+
+You can also choose to skip checks completely on a per-application basis:
+
+```shell
+dokku checks:disable <app>
+```
+
+Dokku will wait `60` seconds before stopping the old container so that existing connections are given a chance to complete. You can modify this value globally or on a per-application basis:
+
+```shell
+dokku config:set --global DOKKU_WAIT_TO_RETIRE=120
+dokku config:set <app> DOKKU_WAIT_TO_RETIRE=120
+```
+
+> Note that during this time, multiple containers may be running on your server, which can be an issue for memory-hungry applications on memory-constrained servers.
+
+## Checks
+
+If your application needs a longer period to boot up - perhaps to load data into memory, or because of slow boot time - you may also use dokku's `checks` functionality to more precisely check whether an application can serve traffic or not.
+
+To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file should be plain text and may contain:
+
+  * Check instructions
+  * Settings (NAME=VALUE)
+  * Comments (lines starting with #)
+  * Empty lines
+
+> For dockerfile-based deploys, the file *must* be in `/app/CHECKS` within the container. `/app` is used by default as the root container directory for buildpack-based deploys.
+
+### Check Instructions
+
+The format of a check instruction is a path or relative URL, optionally followed by the expected content:
+
+```
+/about  Our Amazing Team
+```
+
+The `CHECKS` file can contain multiple checks:
+
+```
+/                       My Amazing App
+/stylesheets/index.css  .body
+/scripts/index.js       $(function()
+/images/logo.png
+```
+
+To check an application that supports multiple hostnames, use relative URLs that include the hostname:
+
+```
+//admin.example.com  Admin Dashboard
+//static.example.com/logo.png
+```
+
+You can also specify the protocol to explicitly check HTTPS requests:
+
+```
+https://admin.example.com  Admin Dashboard
+https://static.example.com/logo.png
+```
+
+### Check Settings
+
+The default behavior is to wait for `5` seconds before running the checks, to timeout the checks after `30` seconds, and to attempt the checks `5` times. If the checks fail `5` times, the deployment is considered failed and the old container will continue serving traffic.
+
+You can change the default behavior by setting `WAIT`, `TIMEOUT`, and `ATTEMPTS` to different values in the `CHECKS` file:
+
+```
+WAIT=30     # Wait 1/2 minute
+TIMEOUT=60  # Timeout after a minute
+ATTEMPTS=10 # Attempt checks 10 times
+
+/  My Amazing App
+```
+
+You can also override the default `WAIT`, `TIMEOUT`, and `ATTEMPTS` variables for the global dokku installation:
+
+```shell
+dokku config:set --global DOKKU_CHECKS_WAIT=30
+dokku config:set --global DOKKU_CHECKS_TIMEOUT=60
+dokku config:set --global DOKKU_CHECKS_ATTEMPTS=10
+```
+
+If your application runs multiple processes (a background worker configured in your `Procfile`, for example) and you have checks to ensure that your web application has booted up, you may want to disable the default check wait time for that application to avoid the `10` second wait per non-web process:
+
+```shell
+dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=0
+```
+
+## Example: Successful Rails Deployment
+
+In this example, a Rails application is successfully deployed to dokku. The initial round of checks fails while the server is starting, but once it starts they succeed and the deployment is successful. `WAIT` is set to `10` because our application takes a while to boot up. `ATTEMPTS` is set to `6`, but the third attempt succeeds.
+
+### CHECKS file
+
+````
+WAIT=10
+ATTEMPTS=6
+/check.txt  simple_check
+````
+
+For this check to work, we've added a line to `config/routes.rb` that simply returns a string:
+
+````
+get '/check.txt', to: proc {[200, {}, ['simple_check']]}
+````
+
+### Deploy Output
+
+> Note: The output has been trimmed for brevity
+
+````
+git push dokku master
+
+-----> Cleaning up...
+-----> Building myapp from herokuish...
+-----> Adding BUILD_ENV to build environment...
+-----> Ruby app detected
+-----> Compiling Ruby/Rails
+-----> Using Ruby version: ruby-2.0.0
+
+.....
+
+-----> Discovering process types
+       Procfile declares types -> web
+-----> Releasing myapp...
+-----> Deploying myapp...
+-----> Running pre-flight checks
+-----> Attempt 1/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/check.txt => "simple_check"
+ !
+curl: (7) Failed to connect to 172.17.0.155 port 5000: Connection refused
+ !    Check attempt 1/6 failed.
+-----> Attempt 2/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/check.txt => "simple_check"
+ !
+curl: (7) Failed to connect to 172.17.0.155 port 5000: Connection refused
+ !    Check attempt 2/6 failed.
+-----> Attempt 3/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/check.txt => "simple_check"
+-----> All checks successful!
+=====> myapp container output:
+       => Booting Thin
+       => Rails 4.2.0 application starting in production on http://0.0.0.0:5000
+       => Run `rails server -h` for more startup options
+       => Ctrl-C to shutdown server
+       Thin web server (v1.6.3 codename Protein Powder)
+       Maximum connections set to 1024
+       Listening on 0.0.0.0:5000, CTRL+C to stop
+=====> end myapp container output
+-----> Running post-deploy
+-----> Configuring myapp.dokku.example.com...
+-----> Creating http nginx.conf
+-----> Running nginx-pre-reload
+       Reloading nginx
+-----> Shutting down old container in 60 seconds
+=====> Application deployed:
+       http://myapp.dokku.example.com
+````
+
+## Example: Failing Rails Deployment
+
+In this example, a Rails application fails to deploy. The reason for the failure is that the postgres database connection fails. The initial checks will fail while we wait for the server to start up, just like in the above example. However, once the server does start accepting connections, we will see an error 500 due to the postgres database connection failure.
+
+Once the attempts have been exceeded, the deployment fails and we see the container output, which shows the Postgres connection errors.
+
+### CHECKS file
+
+````
+WAIT=10
+ATTEMPTS=6
+/
+````
+
+> The check to the root url '/' would normally access the database.
+
+### Deploy Output
+
+> Note: The output has been trimmed for brevity
+
+````
+git push dokku master
+
+-----> Cleaning up...
+-----> Building myapp from herokuish...
+-----> Adding BUILD_ENV to build environment...
+-----> Ruby app detected
+-----> Compiling Ruby/Rails
+-----> Using Ruby version: ruby-2.0.0
+
+.....
+
+Discovering process types
+Procfile declares types -> web
+Releasing myapp...
+Deploying myapp...
+Running pre-flight checks
+-----> Attempt 1/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/ => ""
+ !
+curl: (7) Failed to connect to 172.17.0.188 port 5000: Connection refused
+ !    Check attempt 1/6 failed.
+-----> Attempt 2/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/ => ""
+ !
+curl: (7) Failed to connect to 172.17.0.188 port 5000: Connection refused
+ !    Check attempt 2/6 failed.
+-----> Attempt 3/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/ => ""
+ !
+curl: (22) The requested URL returned error: 500 Internal Server Error
+ !    Check attempt 3/6 failed.
+-----> Attempt 4/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/ => ""
+ !
+curl: (22) The requested URL returned error: 500 Internal Server Error
+ !    Check attempt 4/6 failed.
+-----> Attempt 5/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/ => ""
+ !
+curl: (22) The requested URL returned error: 500 Internal Server Error
+ !    Check attempt 5/6 failed.
+-----> Attempt 6/6 Waiting for 10 seconds ...
+       CHECKS expected result:
+       http://localhost/ => ""
+ !
+curl: (22) The requested URL returned error: 500 Internal Server Error
+Could not start due to 1 failed checks.
+ !    Check attempt 6/6 failed.
+=====> myapp container output:
+       => Booting Thin
+       => Rails 4.2.0 application starting in production on http://0.0.0.0:5000
+       => Run `rails server -h` for more startup options
+       => Ctrl-C to shutdown server
+       Thin web server (v1.6.3 codename Protein Powder)
+       Maximum connections set to 1024
+       Listening on 0.0.0.0:5000, CTRL+C to stop
+       Started GET "/" for 172.17.42.1 at 2015-03-26 21:36:47 +0000
+         Is the server running on host "172.17.42.1" and accepting
+         TCP/IP connections on port 5431?
+       PG::ConnectionBad (could not connect to server: Connection refused
+         Is the server running on host "172.17.42.1" and accepting
+         TCP/IP connections on port 5431?
+       ):
+         vendor/bundle/ruby/2.0.0/gems/activerecord-4.2.0/lib/active_record/connection_adapters/postgresql_adapter.rb:651:in `initialize'
+         vendor/bundle/ruby/2.0.0/gems/activerecord-4.2.0/lib/active_record/connection_adapters/postgresql_adapter.rb:651:in `new'
+         vendor/bundle/ruby/2.0.0/gems/activerecord-4.2.0/lib/active_record/connection_adapters/postgresql_adapter.rb:651:in `connect'
+         vendor/bundle/ruby/2.0.0/gems/activerecord-4.2.0/lib/active_record/connection_adapters/postgresql_adapter.rb:242:in `initialize'
+         vendor/bundle/ruby/2.0.0/gems/activerecord-4.2.0/lib/active_record/connection_adapters/postgresql_adapter.rb:44:in `new'
+         vendor/bundle/ruby/2.0.0/gems/activerecord-4.2.0/lib/active_record/connection_adapters/postgresql_adapter.rb:44:in `postgresql_connection
+=====> end myapp container output
+/usr/local/bin/dokku: line 49: 23409 Killed                  dokku deploy "$APP"
+To dokku@dokku.example.com:myapp
+ ! [remote rejected] dokku -> master (pre-receive hook declined)
+error: failed to push some refs to 'dokku@dokku.example.com:myapp'
+````

docs/community/clients.md

@@ -0,0 +1,100 @@
+# 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, zsh, etc.) `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: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**:
+
+```shell
+# 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'
+```
+
+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.
+
+You can also configure a `DOKKU_PORT` environment variable if you are running ssh on a non-standard port. This defaults to `22`.
+
+## (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):
+
+```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.
+
+## (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):
+
+```shell
+gem install dokkufy
+```
+
+See [documentation here](https://github.com/cbetta/dokkufy) 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):
+
+```shell
+gem install dockland
+```
+
+See [documentation here](https://github.com/uetchy/dockland) for more information.

docs/components.md

@@ -1,8 +1,8 @@
 # Components
 
  * [Docker](https://github.com/dotcloud/docker) - Container runtime and manager
- * [Buildstep](https://github.com/progrium/buildstep) - Buildpack builder
- * [pluginhook](https://github.com/progrium/pluginhook) - Shell based plugins and hooks
- * [sshcommand](https://github.com/progrium/sshcommand) - Fixed commands over SSH
+ * [Herokuish](https://github.com/gliderlabs/herokuish) - Buildpack builder
+ * [plugn](https://github.com/dokku/plugn) - Shell based plugins and hooks
+ * [sshcommand](https://github.com/dokku/sshcommand) - Fixed commands over SSH
 
 Looking to keep codebase as simple and hackable as possible, so try to keep your line count down.

docs/configuration-management.md

@@ -1,14 +1,57 @@
-# Configuration management
+# Environment Variables
 
 Typically an application will require some configuration to run properly. Dokku supports application configuration via environment variables. Environment variables may contain private data, such as passwords or API keys, so it is not recommended to store them in your application's repository.
 
 The `config` plugin provides the following commands to manage your variables:
 
 ```
-config <app> - display the config vars for an app
-config:get <app> KEY - display a config value for an app
-config:set <app> KEY1=VALUE1 [KEY2=VALUE2 ...] - set one or more config vars
-config:unset <app> KEY1 [KEY2 ...] - unset one or more config vars
+config (<app>|--global)                                   Display all global or app-specific config vars
+config:get (<app>|--global) KEY                           Display a global or app-specific config value
+config:set (<app>|--global) KEY1=VALUE1 [KEY2=VALUE2 ...] Set one or more config vars
+config:unset (<app>|--global) KEY1 [KEY2 ...]             Unset one or more config vars
 ```
 
-The variables are by default available only at run time, i.e. not when the application is being built/compiled. However there are [plugins](http://progrium.viewdocs.io/dokku/plugins) that can change that.
+The variables are available both at run time and during the application build/compilation step for buildpack-based deploys. For security reasons - and as per [docker recommendations](https://github.com/docker/docker/issues/13490) - Dockerfile-based deploys have variables available *only* during runtime, as noted in [this issue](https://github.com/dokku/dokku/issues/1860).
+
+> Note: Global `ENV` files are sourced before app-specific `ENV` files. This means that app-specific variables will take precedence over global variables. Configuring your global `ENV` file is manual, and should be considered potentially dangerous as configuration applies to all applications.
+
+You can set multiple environment variables at once:
+
+```shell
+dokku config:set node-js-app ENV=prod COMPILE_ASSETS=1
+```
+
+When setting variables with whitespaces, you need to escape them:
+
+```shell
+dokku config:set node-js-app KEY=\"VAL\ WITH\ SPACES\"
+```
+
+When setting or unsetting environment variables, you may wish to avoid an application restart. This is useful when developing plugins or when setting multiple environment variables in a scripted manner. To do so, use the `--no-restart` flag:
+
+```shell
+dokku config:set --no-restart node-js-app ENV=prod
+```
+
+If you wish to have the variables output in an `eval`-compatible form, you can use the `--export` flag:
+
+```shell
+dokku config node-js-app --export
+# outputs variables in the form:
+#
+#   export ENV='prod'
+#   export COMPILE_ASSETS='1'
+
+# source in all the node-js-app app environment variables
+eval $(dokku config node-js-app --export)
+```
+
+You can also output the variables in a single-line for usage in command-line utilities with the `--shell` flag:
+
+```shell
+dokku config node-js-app --shell
+
+# outputs variables in the form:
+#
+#   ENV='prod' COMPILE_ASSETS='1'
+```

docs/deployment/buildpacks.md

@@ -0,0 +1,77 @@
+# Buildpack Deployment
+
+Dokku normally defaults to using [heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) for deployment, though this may be overridden by committing a valid `Dockerfile` to the root of your repository and pushing the repository to your Dokku installation. To avoid this automatic `Dockerfile` deployment detection, you may do one of the following:
+
+- Use `dokku config:set` to set the `BUILDPACK_URL` environment variable.
+- Add `BUILDPACK_URL` to a committed `.env` file in the root of your repository.
+- Create a `.buildpacks` file in the root of your repository.
+
+## Specifying a custom buildpack
+
+In certain cases you may want to specify a custom buildpack. While dokku uses herokuish to support all the [official heroku buildpacks](https://github.com/gliderlabs/herokuish#buildpacks), it is possible that the buildpack detection does not work well for your application. As well, you may wish to use a custom buildpack to handle specific application logic.
+
+To use a specific buildpack, you can run the following dokku command:
+
+```shell
+# replace APP with the name of your application
+# replace REPOSITORY_URL with your buildpack's url
+dokku config:set APP BUILDPACK_URL=REPOSITORY_URL
+
+# example: using a specific ruby buildpack version
+dokku config:set APP BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-ruby.git#v142
+```
+
+Please check the documentation for your particular buildpack as you may need to include configuration files (such as a Procfile) in your project root.
+
+## Using multiple buildpacks
+
+You can only set a single buildpack using the `BUILDPACK_URL`, though there may be times when you wish to use multiple buildpacks. To do so, simply create a `.buildpacks` file in the base of your repository. This file should list all the buildpacks, one-per-line. For instance, if you wish to use both the `nodejs` and `ruby` buildpacks, your `.buildpacks` file should contain the following:
+
+```shell
+https://github.com/heroku/heroku-buildpack-nodejs.git#v87
+https://github.com/heroku/heroku-buildpack-ruby.git#v142
+```
+
+> Always remember to pin your buildpack versions when using the multi-buildpacks method, or you may find deploys changing your deployed environment.
+
+You may also choose to set just a single buildpack in this file, though that is up to you.
+
+Please check the documentation for your particular buildpack(s) as you may need to include configuration files (such as a Procfile) in your project root.
+
+## Using a specific buildpack version
+
+As Dokku pins all buildpacks via herokuish releases, there may be occasions where a local buildpack version is out of date. If you wish to use a more recent version of the buildpack, you may use any of the above methods to specify a buildpack **without** the git sha attached like so:
+
+```shell
+# using the latest nodejs buildpack
+# replace APP with the name of your application
+dokku config:set APP BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-nodejs
+```
+
+You may also wish to use a **specific** version of a buildpack, which is also simple
+
+```shell
+# using v87 of the nodejs buildpack
+# replace APP with the name of your application
+dokku config:set APP BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-nodejs#v87
+```
+
+## Clearing buildpack cache
+
+Building containers with buildpacks currently results in a persistent `cache` directory between deploys. If you need to clear this cache directory for any reason, you may do so by running the following shell command:
+
+```shell
+# replace APP with the name of your application
+sudo rm -rf /home/dokku/APP/cache/*
+```
+
+### Curl Build Timeouts
+
+Certain buildpacks may time out in retrieving dependencies via curl. This can happen when your network connection is poor or if there is significant network congestion. You may see a message similar to `gzip: stdin: unexpected end of file` after a curl command.
+
+If you see output similar this when deploying , you may need to override the curl timeouts to increase the length of time allotted to those tasks. You can do so via the `config` plugin:
+
+```shell
+dokku config:set --global CURL_TIMEOUT=600
+dokku config:set --global CURL_CONNECT_TIMEOUT=30
+```

docs/deployment/deployment-tasks.md

@@ -0,0 +1,57 @@
+# Deployment Tasks
+
+> New as of 0.5.0
+
+Sometimes you need to run a command on at deployment time, but before an app is completely deployed.
+Common use cases include:
+
+* Checking a database is initialised
+* Running database migrations
+* Any commands required to set up the server (e.g. something like a Django `collectstatic`)
+
+## `app.json` and `scripts.dokku`
+
+Dokku accomplishes this by using an `app.json` file. We (mostly) use the same format as Heroku's [app.json](https://devcenter.heroku.com/articles/app-json-schema).
+However, dokku currently only supports the nodes `scripts.dokku.predeploy` and `scripts.dokku.postdeploy`.
+Simply place an `app.json` file in the root of your repository or for dockerfile apps, `ADD` it to /app.
+>NOTE: postdeploy changes are *NOT* committed to the app image.
+
+### Example app.json
+
+```
+{
+  "name": "barebones nodejs",
+  "description": "A barebones Node.js app using Express 4.",
+  "keywords": [
+    "nodejs",
+    "express"
+  ],
+  "repository": "https://github.com/michaelshobbs/node-js-sample",
+  "scripts": {
+    "dokku": {
+      "predeploy": "touch /app/predeploy.test",
+      "postdeploy": "curl https://some.external.api.service.com/deployment?state=succuss"
+    }
+  },
+  "env": {
+    "SECRET_TOKEN": {
+      "description": "A secret key for verifying the integrity of signed cookies.",
+      "value": "secret"
+    },
+    "WEB_CONCURRENCY": {
+      "description": "The number of processes to run.",
+      "generator": "echo 5"
+    }
+  },
+  "image": "gliderlabs/herokuish",
+  "addons": [
+    "dokku-postgres",
+    "dokku-redis"
+  ],
+  "buildpacks": [
+    {
+      "url": "https://github.com/heroku/heroku-buildpack-nodejs"
+    }
+  ]
+}
+```

docs/deployment/dockerfiles.md

@@ -0,0 +1,73 @@
+# Dockerfile Deployment
+
+> New as of 0.3.15
+
+While Dokku normally defaults to using [heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) for deployment, you can also use docker's native `Dockerfile` system to define a container.
+
+To use a dockerfiles for deployment, commit a valid `Dockerfile` to the root of your repository and push the repository to your Dokku installation. If this file is detected, Dokku will default to using it to construct containers **except** in the following two cases:
+
+- The application has a `BUILDPACK_URL` environment variable set via the `dokku config:set` command or in a committed `.env` file. In this case, Dokku will use your specified buildpack.
+- The application has a `.buildpacks` file in the root of the repository. In this case, Dokku will use your specified buildpack(s).
+
+## Exposed ports
+
+By default, Dokku will extract the first `EXPOSE` tcp port and use said port with nginx to proxy your app to that port. For applications that have multiple ports exposed, you may override this port via the following command:
+
+```shell
+# replace APP with the name of your application
+dokku config:set APP DOKKU_DOCKERFILE_PORT=8000
+```
+
+Dokku will not expose other ports on your application without a [custom docker-option](/dokku/docker-options/).
+
+If you do not have a port explicitly exposed, Dokku will automatically expose port `5000` for your application.
+
+## Customizing the run command
+
+By default no arguments are passed to `docker run` when deploying the container and the `CMD` or `ENTRYPOINT` defined in the `Dockerfile` are executed. You can take advantage of docker ability of overriding the `CMD` or passing parameters to your `ENTRYPOINT` setting `$DOKKU_DOCKERFILE_START_CMD`. Let's say for example you are deploying a base nodejs image, with the following `ENTRYPOINT`:
+
+```
+ENTRYPOINT ["node"]
+```
+
+You can do:
+
+```
+dokku config:set APP DOKKU_DOCKERFILE_START_CMD="--harmony server.js"
+```
+
+To tell docker what to run.
+
+Setting `$DOKKU_DOCKERFILE_CACHE_BUILD` to `true` or `false` will enable or disable docker's image layer cache. Lastly, for more granular build control, you may also pass any `docker build` option to `docker`, by setting `$DOKKU_DOCKER_BUILD_OPTS`.
+
+### Procfiles and Multiple Processes
+
+> New as of 0.5.0
+
+You can also customize the run command using a `Procfile`, much like you would on Heroku or
+with a buildpack deployed app. The `Procfile` should contain one or more lines defining [process
+types and associated commands](https://devcenter.heroku.com/articles/procfile#declaring-process-types).
+When you deploy your app a Docker image will be built, the `Procfile` will be extracted from the image
+(it must be in the folder defined in your `Dockerfile` as `WORKDIR` or `/app`) and the commands
+in it will be passed to `docker run` to start your process(es). Here's an example `Procfile`:
+
+```
+web: bin/run-prod.sh
+worker: bin/run-worker.sh
+```
+
+And `Dockerfile`:
+
+```
+FROM debian:jessie
+WORKDIR /app
+COPY . ./
+CMD ["bin/run-dev.sh"]
+```
+
+When you deploy this app the `web` process will automatically be scaled to 1 and your Docker container
+will be started basically using the command `docker run bin/run-prod.sh`. If you want to also run
+a worker container for this app, you can run `dokku ps:scale worker=1` and a new container will be
+started by running `docker run bin/run-worker.sh` (the actual `docker run` commands are a bit more
+complex, but this is the basic idea). If you use an `ENTRYPOINT` in your `Dockerfile`, the lines
+in your `Procfile` will be passed as arguments to the `ENTRYPOINT` script instead of being executed.

docs/deployment/images.md

@@ -0,0 +1,57 @@
+# Image Tagging
+
+> New as of 0.4.0
+
+The dokku tags plugin allows you to add docker image tags to the currently deployed app image for versioning and subsequent deployment.
+
+```
+tags <app>                                       List all app image tags
+tags:create <app> <tag>                          Add tag to latest running app image
+tags:deploy <app> <tag>                          Deploy tagged app image
+tags:destroy <app> <tag>                         Remove app image tag
+```
+
+Example:
+
+```
+root@dokku:~# dokku tags node-js-app
+=====> Image tags for dokku/node-js-app
+REPOSITORY          TAG                 IMAGE ID            CREATED              VIRTUAL SIZE
+dokku/node-js-app   latest              936a42f25901        About a minute ago   1.025 GB
+
+root@dokku:~# dokku tags:create node-js-app v0.9.0
+=====> Added v0.9.0 tag to dokku/node-js-app
+
+root@dokku:~# dokku tags node-js-app
+=====> Image tags for dokku/node-js-app
+REPOSITORY          TAG                 IMAGE ID            CREATED              VIRTUAL SIZE
+dokku/node-js-app   latest              936a42f25901        About a minute ago   1.025 GB
+dokku/node-js-app   v0.9.0              936a42f25901        About a minute ago   1.025 GB
+
+root@dokku:~# dokku tags:deploy node-js-app v0.9.0
+-----> Releasing node-js-app (dokku/node-js-app:v0.9.0)...
+-----> Deploying node-js-app (dokku/node-js-app:v0.9.0)...
+-----> Running pre-flight checks
+       For more efficient zero downtime deployments, create a file CHECKS.
+       See http://dokku.viewdocs.io/dokku/checks-examples.md for examples
+       CHECKS file not found in container: Running simple container check...
+-----> Waiting for 10 seconds ...
+-----> Default container check successful!
+=====> node-js-app container output:
+       Detected 512 MB available memory, 512 MB limit per process (WEB_MEMORY)
+       Recommending WEB_CONCURRENCY=1
+       > node-js-app@0.1.0 start /app
+       > node index.js
+       Node app is running at localhost:5000
+=====> end node-js-app container output
+-----> Running post-deploy
+-----> Configuring node-js-app.dokku.me...
+-----> Creating http nginx.conf
+-----> Running nginx-pre-reload
+       Reloading nginx
+-----> Shutting down old containers in 60 seconds
+=====> 025eec3fa3b442fded90933d58d8ed8422901f0449f5ea0c23d00515af5d3137
+=====> Application deployed:
+       http://node-js-app.dokku.me
+
+```

docs/deployment/one-off-processes.md

@@ -0,0 +1,149 @@
+# One-off Processes and Cron
+
+Sometimes you need to either inspect running containers or run a one-off command under an application. In those cases, Dokku makes it easy to either connect to a running container or run a fresh container.
+
+## Run a command in an app environment
+
+```
+run <app> <cmd>                                  Run a command in the environment of an application
+```
+
+The `run` command can be used to run a one-off process for a specific command. This will start a new container and run the desired command within that container. Note that this container will be stay around even after command completes. The container will be the same container as was used to start the currently deployed application.
+
+```shell
+# runs `ls -lah` in the `/app` directory of the application `node-js-app`
+dokku run node-js-app ls -lah
+```
+
+If you want to remove the container after a command has started, you can run the following command:
+
+```shell
+# keep `run` containers around
+dokku config:set --global DOKKU_RM_CONTAINER=1
+
+# revert the above setting and keep containers around
+dokku config:unset --global DOKKU_RM_CONTAINER
+```
+
+You may also use the `--rm-container` or `--rm` dokku flags to remove the containers automatically:
+
+```shell
+dokku --rm-container run node-js-app ls -lah
+dokku --rm run node-js-app ls -lah
+```
+
+### Using `run` for cron tasks
+
+You can always use a one-off container to run an application task:
+
+```shell
+dokku --rm run node-js-app some-command
+dokku --rm-container run node-js-app some-command
+```
+
+For tasks that should not be interrupted, run is the **preferred** method of handling cron tasks, as the container will continue running even during a deploy or scaling event. The trade-off is that there will be an increase in memory usage if there are multiple concurrent tasks running.
+
+## Entering existing containers
+
+> New as of 0.4.0
+
+```
+enter <app>  [<container-type> || --container-id <container-id>]   Connect to a specific app container
+```
+
+The `enter` command can be used to enter a running container. The following variations of the command exist:
+
+```shell
+dokku enter node-js-app web
+dokku enter node-js-app web.1
+dokku enter node-js-app --container-id ID
+```
+
+By default, it runs a `/bin/bash`, but can also be used to run a custom command:
+
+```shell
+# just echo hi
+dokku enter node-js-app web echo hi
+
+# run a long-running command, as one might for a cron task
+dokku enter node-js-app web python script/background-worker.py
+```
+
+### Using `enter` for cron tasks
+
+Your procfile can have the following entry:
+
+```
+cron: while true; do sleep 10; done
+```
+
+With the `cron` process scaled to `1`:
+
+```shell
+dokku ps:scale node-js-app cron=1
+```
+
+You can now run all your commands in that container:
+
+```shell
+dokku enter api cron some-command
+```
+
+Note that you can also run multiple commands at the same time to reduce memory usage, though that may result in polluting the container environment.
+
+For tasks that will properly resume, you **should** use the above method, as running tasks will be interrupted during deploys and scaling events, and subsequent commands will always run with the latest container. Note that if you scale the cron container down, this may interrupt proper running of the task.
+
+## General Cron Recommendations
+
+Regularly scheduled tasks can be a bit of a pain with dokku. The following are general recommendations to follow to help ensure successful task runs.
+
+- Use the dokku user's crontab
+  - If you do not, dokku will attempt to execute with sudo dokku, and your cron run with fail with `sudo: no tty present and no askpass program specified`
+- Add a `MAILTO` environment variable to ship cron emails to yourself.
+- Add a `PATH` environment variable or specify the full path to binaries on the host.
+- Add a `SHELL` environment variable to specify bash when running commands.
+- Keep your cron tasks in time-sorted order.
+- Keep your server time in UTC so you don't need to translate daylight saving's time when reading the cronfile.
+- Run tasks at the lowest traffic times if possible.
+- Use cron to **trigger** jobs, not run them. Use a real queuing system such as rabbitmq to actually process jobs.
+- Try to keep tasks quiet so that mails only send on errors.
+- Do not silence standard error or standard out. If you silence the former, you will miss failures. Silencing the latter means you should actually make application changes to handle log levels.
+- Use a service such as [Dead Man's Snitch](https://deadmanssnitch.com) to verify that cron tasks completed successfully.
+- Add lots of comments to your cronfile, including what a task is doing, so that you don't spend time deciphering the file later.
+- Place your cronfiles in a pattern such as `/etc/cron.d/APP`.
+- Do not use non-ascii characters in your cronfile names. Cron is finicky.
+- Remember to have trailing newlines in your cronfile! Cron is finicky.
+
+The following is a sample cronfile that you can use for your applications:
+
+```
+# server cron jobs
+MAILTO="mail@example.com"
+PATH=/usr/local/bin:/usr/bin:/bin
+SHELL=/bin/bash
+
+# m   h   dom mon dow   username command
+# *   *   *   *   *     dokku    command to be executed
+# -   -   -   -   -
+# |   |   |   |   |
+# |   |   |   |   +----- day of week (0 - 6) (Sunday=0)
+# |   |   |   +------- month (1 - 12)
+# |   |   +--------- day of month (1 - 31)
+# |   +----------- hour (0 - 23)
+# +----------- min (0 - 59)
+
+### HIGH TRAFFIC TIME IS B/W 00:00 - 04:00 AND 14:00 - 23:59
+### RUN YOUR TASKS FROM 04:00 - 14:00
+### KEEP SORTED IN TIME ORDER
+
+### PLACE ALL CRON TASKS BELOW
+
+# removes unresponsive users from the subscriber list to decrease bounce rates
+0 0 * * * dokku dokku --rm run node-js-app some-command
+
+# sends out our email alerts to users
+0 1 * * * dokku dokku ps:scale node-js-app cron=1 && dokku enter node-js-app cron some-other-command && dokku ps:scale node-js-app cron=0
+
+### PLACE ALL CRON TASKS ABOVE, DO NOT REMOVE THE WHITESPACE AFTER THIS LINE
+
+```

docs/deployment/ssl-configuration.md

@@ -0,0 +1,146 @@
+# SSL Configuration
+
+> New as of 0.4.0
+
+Dokku supports SSL/TLS certificate inspection and CSR/Self-signed certificate generation via the `certs` plugin. Note that whenever SSL/TLS support is enabled SPDY is also enabled.
+
+```
+certs:add <app> CRT KEY                          Add an ssl endpoint to an app. Can also import from a tarball on stdin.
+certs:generate <app> DOMAIN                      Generate a key and certificate signing request (and self-signed certificate)
+certs:info <app>                                 Show certificate information for an ssl endpoint.
+certs:remove <app>                               Remove an SSL Endpoint from an app.
+certs:update <app> CRT KEY                       Update an SSL Endpoint on an app. Can also import from a tarball on stdin
+
+# for 0.3.x
+dokku nginx:import-ssl <app> < certs.tar
+```
+
+## Per-application certificate management
+
+Dokku provides built-in support for managing SSL certificates on a per-application basis. SSL is managed via nginx outside of application containers, and as such can be updated on-the-fly without rebuilding containers. At this time, applications only support a single SSL certificate at a time. To support multiple domains for a single application, wildcard certificate usage is encouraged.
+
+### Certificate setting
+
+The `certs:add` command can be used to push a `tar` containing a certificate `.crt` and `.key` file to a single application. The command should correctly handle cases where the `.crt` and `.key` are not named properly or are nested in a subdirectory of said `tar` file. You can import it as follows:
+
+```shell
+tar cvf cert-key.tar server.crt server.key
+# replace APP with the name of your application
+dokku certs:add <app> < cert-key.tar
+```
+
+> Note: If your `.crt` file came alongside a `.ca-bundle`, you'll want to concatenate those into a single `.crt` file before adding it to the `.tar`.
+
+```shell
+cat yourdomain_com.crt yourdomain_com.ca-bundle > server.crt
+```
+
+### Certificate generation
+
+> Note: Using this method will create a self-signed certificate, which is only recommended for development or staging use, not production environments.
+
+The `certs:generate` command will walk you through the correct `openssl` commands to create a key, csr and a self-signed cert for a given app/domain. We automatically put the self-signed cert in place as well as add the specified domain to the application configuration.
+
+If you decide to obtain a CA signed certficate, you can import that certificate using the aformentioned `dokku certs:add` command.
+
+### Certificate information
+
+The `certs:info` command will simply inspect the install SSL cert and print out details. NOTE: The server-wide certificate will be inspect if installed and no app-specific certificate exists.
+
+```
+root@dokku:~/dokku# dokku certs:info node-js-app
+-----> Fetching SSL Endpoint info for node-js-app...
+-----> Certificate details:
+=====> Common Name(s):
+=====>    test.dokku.me
+=====> Expires At: Aug 24 23:32:59 2016 GMT
+=====> Issuer: C=US, ST=California, L=San Francisco, O=dokku.me, CN=test.dokku.me
+=====> Starts At: Aug 25 23:32:59 2015 GMT
+=====> Subject: C=US; ST=California; L=San Francisco; O=dokku.me; CN=test.dokku.me
+=====> SSL certificate is self signed.
+```
+
+### Certificate removal
+
+The `certs:remove` command only works on app-specific certificates. It will `rm` the app-specific tls directory, rebuild the nginx configuration, and reload nginx.
+
+## Global Certification
+
+Global certificate management is a manual process. To enable TLS connections for all your applications at once you will need a wildcard TLS certificate.
+
+To enable TLS across all apps, you can run the following commands:
+
+```shell
+mkdir -p /home/dokku/tls
+cp server.crt /home/dokku/tls/server.crt
+cp server.key /home/dokku/tls/server.key
+```
+
+Next, you will want to enable the certificates by editing `/etc/nginx/conf.d/dokku.conf` and uncommenting these two lines (remove the `#`):
+
+```
+ssl_certificate /home/dokku/tls/server.crt;
+ssl_certificate_key /home/dokku/tls/server.key;
+```
+
+The settings will take affect at the next deploy. If you would like to propagate the change to all apps immediately, you can also run the following command:
+
+```shell
+dokku ps:restartall
+```
+
+Once TLS is enabled, the application will be accessible by `https://` (redirection from `http://` is applied as well).
+
+> Note: TLS will not be enabled unless the application's VHOST matches the certificate's name. (i.e. if you have a cert for `*.example.com` TLS won't be enabled for `something.example.org` or `example.net`)
+
+## HSTS Header
+
+The [HSTS header](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) is an HTTP header that can inform browsers that all requests to a given site should be made via HTTPS. dokku does not, by default, enable this header. It is thus left up to you, the user, to enable it for your site.
+
+Beware that if you enable the header and a subsequent deploy of your application results in an HTTP deploy (for whatever reason), the way the header works means that a browser will not attempt to request the HTTP version of your site if the HTTPS version fails.
+
+## Running behind a load balancer
+
+Your application has access to the HTTP headers `X-Forwarded-Proto`, `X-Forwarded-For` and `X-Forwarded-Port`. These headers indicate the protocol of the original request (HTTP or HTTPS), the port number, and the IP address of the client making the request, respectively. The default configuration is for Nginx to set these headers.
+
+If your server runs behind an HTTP/S load balancer, then Nginx will see all requests as coming from the load balancer. If your load balancer sets the `X-Forwarded-` headers, you can tell Nginx to pass these headers from load balancer to your application by using the following [nginx custom template](/dokku/nginx/#customizing-the-nginx-configuration)
+
+```shell
+server {
+  listen      [::]:{{ .NGINX_PORT }};
+  listen      {{ .NGINX_PORT }};
+  server_name {{ .NOSSL_SERVER_NAME }};
+  access_log  /var/log/nginx/{{ .APP }}-access.log;
+  error_log   /var/log/nginx/{{ .APP }}-error.log;
+
+  # set a custom header for requests
+  add_header X-Served-By www-ec2-01;
+
+  location    / {
+    proxy_pass  http://{{ .APP }};
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+    proxy_set_header Host $http_host;
+    proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
+    proxy_set_header X-Forwarded-For $http_x_forwarded_for;
+    proxy_set_header X-Forwarded-Port $http_x_forwarded_port;
+    proxy_set_header X-Request-Start $msec;
+  }
+  include {{ .DOKKU_ROOT }}/{{ .APP }}/nginx.conf.d/*.conf;
+
+  upstream {{ .APP }} {
+  {{ range .DOKKU_APP_LISTENERS | split " " }}
+    server {{ . }};
+  {{ end }}
+  }
+}
+```
+
+Only use this option if:
+1. All requests are terminated at the load balancer, and forwarded to Nginx
+2. The load balancer is configured to send the `X-Forwarded-` headers (this may be off by default)
+
+If it's possible to make HTTP/S requests directly to Nginx, bypassing the load balancer, or if the load balancer is not configured to set these headers, then it becomes possible for a client to set these headers to arbitrary values.
+
+This could result in security issue, for example, if your application looks at the value of the `X-Forwarded-Proto` to determine if the request was made over HTTPS.

docs/deployment/user-management.md

@@ -0,0 +1,48 @@
+# User Management
+
+While it is possible to use password-based authorization to push to Dokku, it is preferable to use key-based authentication for security.
+
+Users in dokku are managed via the `~/dokku/.ssh/authorized_keys` file. While you *can* manually edit this file, it is **highly** recommended that you follow the below steps to manage users on a dokku server.
+
+## SSHCommand
+
+Dokku uses the [`sshcommand`](https://github.com/dokku/sshcommand) utility to manage ssh keys for the dokku user. The following is the usage output for sshcommand.
+
+```
+sshcommand create <user> <command>              # creates a user forced to run command when SSH connects
+sshcommand acl-add <user> <ssh-key-name>        # adds named SSH key to user from STDIN
+sshcommand acl-remove <user> <ssh-key-name>     # removes SSH key by name
+sshcommand help                                 # displays the usage help message
+```
+
+In dokku's case, the `<user>` section is *always* `dokku`, as this is the system user that the dokku binary performs all it's actions. Keys are given unique names, which can be used in conjunction with the [user-auth](/dokku/development/plugin-triggers/#user-auth) plugin trigger to handle command authorization.
+
+## Adding deploy users
+
+You can add your public key to the dokku user's `~/dokku/.ssh/authorized_keys` file with the following command:
+
+```shell
+# from your local machine
+# replace dokku.me with your domain name or the host's IP
+# replace root with your server's root user
+# USER is the username you use to refer to this particular key
+cat ~/.ssh/id_rsa.pub | ssh root@dokku.me "sudo sshcommand acl-add dokku USER"
+```
+
+At it's base, the `sshcommand` *must* be run under a user with sudo access, as it sets keys for the dokku user.
+
+For instance, if you stored your public key at `~/.ssh/id_rsa.pub-open` and are deploying to EC2 where the default root-enabled user is `ubuntu`, you can run the following command to add your key under the `superuser` username:
+
+```
+cat ~/.ssh/id_rsa.pub-open | ssh ubuntu@dokku.me "sudo sshcommand acl-add dokku superuser"
+```
+
+If you are using the vagrant installation, you can also use the `make vagrant-acl-add` target to add your public key to dokku (it will use your host username as the `USER`):
+
+```
+cat ~/.ssh/id_rsa.pub | make vagrant-acl-add
+```
+
+## Scoping commands to specific users
+
+See the [user auth plugin trigger documentation](/dokku/development/plugin-triggers/#user-auth).

docs/development/plugin-creation.md

@@ -0,0 +1,157 @@
+# Plugin Creation
+
+If you create your own plugin:
+
+1. Take a look at the plugins shipped with dokku and hack away!
+2. Check out the [list of triggers](/dokku/development/plugin-triggers) your plugin can implement.
+3. Upload your plugin to github with a repository name in form of `dokku-<name>` (e.g. `dokku-mariadb`)
+4. Edit [this page](/dokku/plugins) and add a link to it.
+5. Subscribe to the [dokku development blog](http://progrium.com) to be notified about API changes and releases
+
+
+### Sample plugin
+The below plugin is a dummy `dokku hello` plugin.
+
+hello/subcommands/default
+
+```shell
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+hello_main_cmd() {
+  declare desc="prints Hello \$APP"
+  local cmd="hello"
+  # Support --app/$DOKKU_APP_NAME flag
+  # Use the following lines to reorder args into "$cmd $DOKKU_APP_NAME $@""
+  local argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  [[ ! -z $DOKKU_APP_NAME ]] && set -- $DOKKU_APP_NAME $@
+  set -- $cmd $@
+  ##
+
+  [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+  verify_app_name "$2"
+  local APP="$2";
+
+  echo "Hello $APP"
+}
+
+hello_main_cmd "$@"
+```
+
+hello/subcommands/world
+
+```shell
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+hello_world_cmd() {
+  declare desc="prints Hello World"
+  local cmd="hello:world"
+  # Support --app/$DOKKU_APP_NAME flag
+  # Use the following lines to reorder args into "$cmd $DOKKU_APP_NAME $@""
+  local argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  [[ ! -z $DOKKU_APP_NAME ]] && set -- $DOKKU_APP_NAME $@
+  set -- $cmd $@
+  ##
+
+  [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+  verify_app_name "$2"
+  local APP="$2";
+
+  echo "Hello world"
+}
+
+hello_world_cmd "$@"
+```
+
+hello/commands
+
+```shell
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+case "$1" in
+  help | hello:help)
+    help_content_func () {
+      declare desc="return help_content string"
+      cat<<help_content
+    hello <app>, Says "Hello <app>"
+    hello:world, Says "Hello world"
+help_content
+    }
+
+    if [[ $1 = "hello:help" ]] ; then
+        echo -e 'Usage: dokku hello[:world] [<app>]'
+        echo ''
+        echo 'Say Hello World.'
+        echo ''
+        echo 'Example:'
+        echo ''
+        echo '$ dokku hello:world'
+        echo 'Hello world'
+        echo ''
+        echo 'Additional commands:'
+        help_content_func | sort | column -c2 -t -s,
+    else
+        help_content_func
+    fi
+    ;;
+
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
+esac
+```
+
+Each plugin requires a `plugin.toml` descriptor file with the following required fields:
+
+```shell
+[plugin]
+description = "dokku hello plugin"
+version = "0.1.0"
+[plugin.config]
+```
+
+A few notes:
+
+- You should always support `DOKKU_TRACE` as specified on the 2nd line of the plugin.
+- If your command requires that an application exists, ensure you check for it's existence in the manner prescribed above.
+- A `help` command is required, though it is allowed to be empty. Also, the command syntax will need to separated by `, ` in order to maintain columnar output alignment.
+- Commands *should* be namespaced.
+- As of 0.3.3, a catch-all should be implemented which exits with a `DOKKU_NOT_IMPLEMENTED_EXIT` code. This allows dokku to output a `command not found` message.
+- Be sure you want the "set -eo pipefail" option. Look at the following example :
+
+    ```shell
+    IMAGE=$(docker images | grep "user/repo" | awk '{print $3}')
+    if [[ -z $IMAGE ]]; then
+        dokku_log_fail "user/repo image not found... Did you run 'dokku plugin:install'?"
+    fi
+    ```
+
+  In the case where the "user/repo" is not installed, dokku exits just before the awk command,
+  you will never see the message printed with echo. You just want "set -e" in this case.
+
+  Here is the documentation of the 'set -eo pipefail' option:
+  ```
+  help set
+    Options:
+      -e  Exit immediately if a command exits with a non-zero status.
+      -o option-name
+          pipefail     the return value of a pipeline is the status of
+                       the last command to exit with a non-zero status,
+                       or zero if no command exited with a non-zero status
+  ```
+- As some plugins require access to set app config settings and do not want/require the default Heroku-style behavior of a restart, we have the following "internal" commands that provide this functionality :
+
+  ```shell
+  dokku config:set --no-restart APP KEY1=VALUE1 [KEY2=VALUE2 ...]
+  dokku config:unset --no-restart APP KEY1 [KEY2 ...]
+  ```
+- From time to time you may want to allow other plugins access to (some of) your plugin's functionality. You can expose this by including a `functions` file in your plugin for others to source. Consider all functions in that file to be publicly accessible by other plugins. Any functions not wished to be made "public" should reside within your plugin trigger or commands files.
+- As of 0.4.0, we allow image tagging and deployment of said tagged images. Therefore, hard-coding of `$IMAGE` as `dokku/$APP` is no longer sufficient. Instead, for non `pre/post-build-*` plugins, use `get_running_image_tag()` & `get_app_image_name()` as sourced from common/functions. See the [plugin triggers](/dokku/development/plugin-triggers) doc for examples.
+- As of 0.5.0, we use container labels to help cleanup intermediate containers with `dokku cleanup`. If manually calling `docker run`, include `$DOKKU_GLOBAL_RUN_ARGS`. This will ensure you intermediate containers labeled correctly.

docs/development/plugin-triggers.md

@@ -0,0 +1,741 @@
+# Plugin triggers
+
+[Plugin triggers](https://github.com/dokku/plugn) (formerly [pluginhooks](https://github.com/progrium/pluginhook)) are a good way to jack into existing dokku infrastructure. You can use them to modify the output of various dokku commands or override internal configuration.
+
+Plugin triggers are simply scripts that are executed by the system. You can use any language you want, so long as the script:
+
+- Is executable
+- Has the proper language requirements installed
+
+For instance, if you wanted to write a plugin trigger in PHP, you would need to have `php` installed and available on the CLI prior to plugin trigger invocation.
+
+The following is an example for the `nginx-hostname` plugin trigger. It reverses the hostname that is provided to nginx during deploys. If you created an executable file named `nginx-hostname` with the following code in your plugin trigger, it would be invoked by dokku during the normal app deployment process:
+
+```shell
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1"; SUBDOMAIN="$2"; VHOST="$3"
+
+NEW_SUBDOMAIN=`echo $SUBDOMAIN | rev`
+echo "$NEW_SUBDOMAIN.$VHOST"
+```
+
+## Available plugin triggers
+
+There are a number of plugin-related triggers. These can be optionally implemented by plugins and allow integration into the standard dokku setup/teardown process.
+
+The following plugin triggers describe those available to a dokku installation. As well, there is an example for each trigger that you can use as templates for your own plugin development.
+
+> The example plugin trigger code is not guaranteed to be implemented as in within dokkku, and are merely simplified examples. Please look at the dokku source for larger, more in-depth examples.
+
+### `install`
+
+- Description: Used to setup any files/configuration for a plugin.
+- Invoked by: `dokku plugin:install`.
+- Arguments: None
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Sets the hostname of the dokku server
+# based on the output of `hostname -f`
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+if [[ ! -f  "$DOKKU_ROOT/HOSTNAME" ]]; then
+  hostname -f > $DOKKU_ROOT/HOSTNAME
+fi
+```
+
+### `dependencies`
+
+- Description: Used to install system-level dependencies. Invoked by `plugin:install-dependencies`.
+- Invoked by: `dokku plugin:install-dependencies`
+- Arguments: None
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Installs nginx for the current plugin
+# Supports both opensuse and ubuntu
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+export DEBIAN_FRONTEND=noninteractive
+
+case "$DOKKU_DISTRO" in
+  debian|ubuntu)
+    apt-get install --force-yes -qq -y nginx
+    ;;
+
+  opensuse)
+    zypper -q in -y nginx
+    ;;
+esac
+```
+
+### `update`
+
+- Description: Can be used to run plugin updates on a regular interval. You can schedule the invoker in a cron-task to ensure your system gets regular updates.
+- Invoked by: `dokku plugin:update`.
+- Arguments: None
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Update the herokuish image from git source
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+cd /root/dokku
+sudo BUILD_STACK=true make install
+```
+
+### `comands help` and `commands <PLUGIN_NAME>:help`
+
+- Description: Your plugin should implement a `help` command in your `commands` file to take advantage of this plugin trigger. `commands help` is used by `dokku help` to aggregate all plugins abbreviated `help` output. Implementing  `<PLUGIN_NAME>:help` in your `commands` file gives users looking for help, a more detailed output. 'commands help' must be implemented inside the `commands` plugin file. It's recommended that `PLUGIN_NAME:help` be added to the commands file to ensure consistency among community plugins and give you a new avenue to share rich help content with your user.
+- Invoked by: `dokku help` and `commands <PLUGIN_NAME>:help`
+- Arguments: None
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Outputs help for the derp plugin
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+case "$1" in
+  help | hello:help)
+    help_content_func () {
+      declare desc="return help_content string"
+      cat<<help_content
+    hello <app>, Says "Hello <app>"
+    hello:world, Says "Hello world"
+help_content
+    }
+
+    if [[ $1 = "hello:help" ]] ; then
+        echo -e 'Usage: dokku hello[:world] [<app>]'
+        echo ''
+        echo 'Say Hello World.'
+        echo ''
+        echo 'Example:'
+        echo ''
+        echo '$ dokku hello:world'
+        echo 'Hello world'
+        echo ''
+        echo 'Additional commands:'
+        help_content_func | sort | column -c2 -t -s,
+    else
+        help_content_func
+    fi
+    ;;
+
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
+esac
+```
+
+### `pre-build-buildpack`
+
+- Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to applications using buildpacks.
+- Invoked by: `dokku build`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `post-build-buildpack`
+
+- Description: Allows you to run commands after the build image is create for a given app. Only applies to applications using buildpacks.
+- Invoked by: `dokku build`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `pre-build-dockerfile`
+
+- Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to applications using a dockerfile.
+- Invoked by: `dokku build`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `post-build-dockerfile`
+
+- Description: Allows you to run commands after the build image is create for a given app. Only applies to applications using a dockerfile.
+- Invoked by: `dokku build`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `pre-release-buildpack`
+
+- Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to applications using buildpacks.
+- Invoked by: `dokku release`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Installs the graphicsmagick package into the container
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+dokku_log_info1" Installing GraphicsMagick..."
+
+CMD="cat > gm && \
+  dpkg -s graphicsmagick > /dev/null 2>&1 || \
+  (apt-get update && apt-get install -y graphicsmagick && apt-get clean)"
+
+ID=$(docker run $DOKKU_GLOBAL_RUN_ARGS -i -a stdin $IMAGE /bin/bash -c "$CMD")
+test $(docker wait $ID) -eq 0
+docker commit $ID $IMAGE > /dev/null
+```
+
+### `post-release-buildpack`
+
+- Description: Allows you to run commands after environment variables are set for the release step of the deploy. Only applies to applications using buildpacks.
+- Invoked by: `dokku release`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Installs a package specified by the `CONTAINER_PACKAGE` env var
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+dokku_log_info1" Installing $CONTAINER_PACKAGE..."
+
+CMD="cat > gm && \
+  dpkg -s CONTAINER_PACKAGE > /dev/null 2>&1 || \
+  (apt-get update && apt-get install -y CONTAINER_PACKAGE && apt-get clean)"
+
+ID=$(docker run $DOKKU_GLOBAL_RUN_ARGS -i -a stdin $IMAGE /bin/bash -c "$CMD")
+test $(docker wait $ID) -eq 0
+docker commit $ID $IMAGE > /dev/null
+```
+
+### `pre-release-dockerfile`
+
+- Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to applications using a dockerfile.
+- Invoked by: `dokku release`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+# TODO
+```
+
+### `post-release-dockerfile`
+
+- Description: Allows you to run commands after environment variables are set for the release step of the deploy. Only applies to applications using a dockerfile.
+- Invoked by: `dokku release`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+# TODO
+```
+
+### `check-deploy`
+
+- Description: Allows you to run checks on a deploy before dokku allows the container to handle requests.
+- Invoked by: `dokku deploy`
+- Arguments: `$CONTAINER_ID $APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Disables deploys of containers based on whether the
+# `DOKKU_DISABLE_DEPLOY` env var is set to `true` for an app
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_AVAILABLE_PATH/config/functions"
+
+CONTAINERID="$1"; APP="$2"; PORT="$3" ; HOSTNAME="${4:-localhost}"
+
+eval "$(config_export app $APP)"
+DOKKU_DISABLE_DEPLOY="${DOKKU_DISABLE_DEPLOY:-false}"
+
+if [[ "$DOKKU_DISABLE_DEPLOY" = "true" ]]; then
+  echo -e "\033[31m\033[1mDeploys disabled, sorry.\033[0m"
+  exit 1
+fi
+```
+
+### `pre-deploy`
+
+- Description: Allows the running of code before the container's process is started.
+- Invoked by: `dokku deploy`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Runs gulp in our container
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+dokku_log_info1 "Running gulp"
+id=$(docker run $DOKKU_GLOBAL_RUN_ARGS -d $IMAGE /bin/bash -c "cd /app && gulp default")
+test $(docker wait $id) -eq 0
+docker commit $id $IMAGE > /dev/null
+dokku_log_info1 "Building UI Complete"
+```
+
+### `post-create`
+
+- Description: Can be used to run commands after an application is created.
+- Invoked by: `dokku apps:create`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Runs a command to ensure that an app
+# has a postgres database when it is starting
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1";
+POSTGRES="$1"
+
+dokku postgres:create $POSTGRES
+dokku postgres:link $POSTGRES $APP
+```
+
+### `post-deploy`
+
+- Description: Allows running of commands after a deploy has completed. Dokku core currently uses this to switch traffic on nginx.
+- Invoked by: `dokku deploy`
+- Arguments: `$APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Notify an external service that a successful deploy has occurred.
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+curl "http://httpstat.us/200"
+```
+
+### `pre-delete`
+
+- Description: Can be used to run commands before an app is deleted.
+- Invoked by: `dokku apps:destroy`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Clears out the gulp asset build cache for applications
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+APP="$1"; GULP_CACHE_DIR="$DOKKU_ROOT/$APP/gulp"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+if [[ -d $GULP_CACHE_DIR ]]; then
+  docker run $DOKKU_GLOBAL_RUN_ARGS --rm -v "$GULP_CACHE_DIR:/gulp" "$IMAGE" find /gulp -depth -mindepth 1 -maxdepth 1 -exec rm -Rf {} \; || true
+fi
+```
+
+### `post-delete`
+
+- Description: Can be used to run commands after an application is deleted.
+- Invoked by: `dokku apps:destroy`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Runs a command to ensure that an app's
+# postgres installation is removed
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1";
+
+dokku postgres:destroy $APP
+```
+
+### `post-stop`
+
+- Description: Can be used to run commands after an application is manually stopped
+- Invoked by: `dokku ps:stop`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Marks an application as manually stopped
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1";
+
+dokku config:set --no-restart $APP MANUALLY_STOPPED=1
+```
+
+### `docker-args-build`
+
+- Description:
+- Invoked by: `dokku build`
+- Arguments: `$APP $IMAGE_SOURCE_TYPE`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `docker-args-deploy`
+
+- Description:
+- Invoked by: `dokku deploy`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+# TODO
+```
+
+### `docker-args-run`
+
+- Description:
+- Invoked by: `dokku run`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+# TODO
+```
+
+### `bind-external-ip`
+
+- Description: Allows you to disable binding to the external box ip
+- Invoked by: `dokku deploy`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Force always binding to the docker ip, no matter
+# what the settings are for a given app.
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+echo false
+```
+
+### `post-domains-update`
+
+- Description: Allows you to run commands once the domain for an application has been updated. It also sends in the command that has been used. This can be "add", "clear" or "remove". The third argument will be the optional list of domains
+- Invoked by: `dokku domains:add`, `dokku domains:clear`, `dokku domains:remove`
+- Arguments: `$APP` `action name` `domains`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Reloads haproxy for our imaginary haproxy plugin
+# that replaces the nginx-vhosts plugin
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+sudo service haproxy reload
+```
+
+### `git-pre-pull`
+
+- Description:
+- Invoked by: `dokku git-upload-pack`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `git-post-pull`
+
+- Description:
+- Invoked by: `dokku git-upload-pack`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
+### `nginx-hostname`
+
+- Description: Allows you to customize the hostname for a given application.
+- Invoked by: `dokku domains:setup`
+- Arguments: `$APP $SUBDOMAIN $VHOST`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Reverses the hostname for the application
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1"; SUBDOMAIN="$2"; VHOST="$3"
+
+NEW_SUBDOMAIN=`echo $SUBDOMAIN | rev`
+echo "$NEW_SUBDOMAIN.$VHOST"
+```
+
+### `nginx-pre-reload`
+
+- Description: Run before nginx reloads hosts
+- Invoked by: `dokku nginx:build-config`
+- Arguments: `$APP $INTERNAL_PORT $INTERNAL_IP_ADDRESS`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Runs a check against all nginx conf files
+# to ensure they are valid
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+nginx -t
+```
+
+### `pre-receive-app`
+
+- Description: Allows you to customize the contents of an application directory before they are processed for deployment. The `IMAGE_SOURCE_TYPE` can be any of `[herokuish, dockerfile]`
+- Invoked by: `dokku git-hook`, `dokku tar-build-locked`
+- Arguments: `$APP $IMAGE_SOURCE_TYPE $TMP_WORK_DIR $REV`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Adds a file called `dokku-is-awesome` to the repository
+# the contents will be the application name
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1"; IMAGE_SOURCE_TYPE="$2"; TMP_WORK_DIR="$3"; REV="$4"
+
+echo "$APP" > "$TMP_WORK_DIR/dokku-is-awesome"
+```
+
+### `receive-app`
+
+- Description: Allows you to customize what occurs when an app is received. Normally just triggers an application build.
+- Invoked by: `dokku git-hook`, `dokku ps:rebuild`
+- Arguments: `$APP $REV`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# For our imaginary mercurial plugin, triggers a rebuild
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1"; REV="$2"
+
+dokku hg-build $APP $REV
+```
+
+### `receive-branch`
+
+- Description: Allows you to customize what occurs when a specific branch is received. Can be used to add support for specific branch names
+- Invoked by: `dokku git-hook`, `dokku ps:rebuild`
+- Arguments: `$APP $REV $REFNAME`
+- Example:
+
+```shell
+#!/bin/bash
+# Gives dokku the ability to support multiple branches for a given service
+# Allowing you to have multiple staging environments on a per-branch basis
+
+reference_app=$1
+refname=$3
+newrev=$2
+APP=${refname/*\//}.$reference_app
+
+if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
+  REFERENCE_REPO="$DOKKU_ROOT/$reference_app
+  git clone --bare --shared --reference "$REFERENCE_REPO" "$REFERENCE_REPO" "$DOKKU_ROOT/$APP" > /dev/null
+fi
+plugn trigger receive-app $APP $newrev
+```
+
+### `tags-create`
+
+- Description: Allows you to run commands once a tag for an application image has been added
+- Invoked by: `dokku tags:create`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Upload an application image to docker hub
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+
+IMAGE_ID=$(docker inspect --format '{{ .Id }}' $IMAGE)
+docker tag -f $IMAGE_ID $DOCKER_HUB_USER/$APP:$IMAGE_TAG
+docker push $DOCKER_HUB_USER/$APP:$IMAGE_TAG
+```
+
+### `tags-destroy`
+
+- Description: Allows you to run commands once a tag for an application image has been removed
+- Invoked by: `dokku tags:destroy`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Remove an image tag from docker hub
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+APP="$1"; IMAGE_TAG="$2"
+
+some code to remove a docker hub tag because it's not implemented in the CLI....
+```
+
+### `retire-container-failed`
+
+- Description: Allows you to run commands if/when retiring old containers has failed
+- Invoked by: `dokku deploy`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Send an email when a container failed to retire
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+APP="$1"; HOSTNAME=$(hostname -s)
+
+mail -s "$APP containers on $HOSTNAME failed to retire" ops@example.com
+```
+
+### `user-auth`
+
+This is a special plugin trigger that is executed on *every* command run. As dokku sometimes internally invokes the `dokku` command, special care should be taken to properly handle internal command redirects.
+
+Note that the trigger should exit as follows:
+
+- `0` to continue running as normal
+- `1` to halt execution of the command
+
+The `SSH_USER` is the original ssh user. If you are running remote commands, this user will typically be `dokku`, and as such should not be trusted when checking permissions. If you are connected via ssh as a different user who then invokes `dokku`, the value of this variable will be that user's name (`root`, `myuser`, etc.).
+
+The `SSH_NAME` is the `NAME` variable set via the `sshcommand acl-add` command. If you have set a user via the `dokku-installer`, this value will be set to `admin`. For installs via debian package, this value *may* be `default`. For reference, the following command can be run as the root user to specify a specific `NAME` for a given ssh key:
+
+```shell
+sshcommand acl-add dokku NAME < $PATH_TO_SSH_KEY
+```
+
+Note that the `NAME` value is set at the first ssh key match. If an ssh key is set in the `/home/dokku/.ssh/authorized_keys` multiple times, the first match will decide the value.
+
+- Description: Allows you to deny access to a dokku command by either ssh user or associated ssh-command NAME user.
+- Invoked by `dokku`
+- Arguments: `$SSH_USER $SSH_NAME $DOKKU_COMMAND`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+# Allow root/admin users to do everything
+# Deny plugin access to default users
+# Allow access to all other commands
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+SSH_USER=$1
+SSH_NAME=$2
+shift 2
+[[ "$SSH_USER" == "root" ]] && exit 0
+[[ "$SSH_NAME" == "admin" ]] && exit 0
+[[ "$SSH_NAME" == "default" && $1 == plugin:* ]] && exit 1
+exit 0
+```

docs/development/release-process.md

@@ -0,0 +1,124 @@
+# Release Process
+
+Dokku is released in intervals *at most* three weeks apart, though may be released much quicker.
+
+To propose a release, the following tasks need to be performed:
+
+- Update all blockquote references of `not yet released and only available in master` to point to release version.
+- The installable version must be changed in the `contrib/dokku-installer.py` file.
+- The installable version must be changed in the `debian/control` file.
+- The installable version must be changed in the `docs/home.html` file
+- The installable version must be changed in the `docs/index.md` file
+- The installable version must be changed in the `docs/installation.md` file.
+- The installable version must be changed in the `docs/template.html` file.
+- The installable version must be changed in the `README.md` file.
+- The embedded css should be cleared in the `docs/template.html` file.
+- The versioned links should be updated in the `docs/assets/favicons/browserconfig.xml` file.
+- The versioned links should be updated in the `docs/assets/favicons/manifest.json` file.
+- The versioned links should be updated in the `docs/assets/style.css` file.
+- The versioned links should be updated in the `docs/home.html` file.
+- The versioned links should be updated in the `docs/template.html` file.
+- The versioned links should be updated or added to the `docs/assets/versions.json` file.
+- A list of changes must be made in the `HISTORY.md`.
+- A tag must be created locally with your release version
+- Debian packages *must* be created via `vagrant up build`
+- The packages should be uploaded to packagecloud.io
+- All changes are pushed to master and the tag should be turned into a release which will contain the changelog.
+- ArchLinux package description *must* be updated via `vagrant up build-arch` (needs to be done after the tag is pushed to GitHub, because it is based on that)
+
+## Versioning
+
+Dokku follows semver standards. As we are not yet at a stable release, breaking changes will require *only* a minor release, while all other changes only require a patch release. Once we hit stable, breaking changes will require a major release.
+
+Tags should be created via the following method:
+
+```shell
+git tag v0.9.9
+```
+
+At the moment, tags need not be signed, though that may change in the future.
+
+## Debian Packages
+
+The `build` target in the dokku `Vagrantfile` creates debian packages for dokku at a point in time. The version will be based upon the latest local tag - you may create your own, internal tags/releases if that is so desired.
+
+Debian package information is held in the `debian` directory of the dokku project.
+
+For the public project, releases should be pushed to packagecloud.io *after* a tag is created but *before* said tag is pushed to github. The following may be the release workflow:
+
+
+```shell
+git tag v0.9.9
+vagrant up build
+export PACKAGECLOUD_TOKEN=SOME_TOKEN
+package_cloud push dokku/dokku/ubuntu/trusty dokku_0.9.9_amd64.deb
+```
+
+If new versions of other packages were created, these should also be pushed at this time.
+
+> If you are a maintainer and need the PACKAGECLOUD_TOKEN in order to make a release, please contact @josegonzalez to get this information.
+
+## ArchLinux Packages
+
+ArchLinux packages are not really build, because all that is needed for an Arch User Repo (AUR) package is the description of how to build the package. To make this process as easy as possible there is a vagrant box called `build-arch` that updates the version of this build description (a file called `PKGBUILD`), then runs some helper scripts to fill all additional information and does test if the package could be build. Then only those changes need to be pushed to the AUR repo and an updated version of the package is ready for usage for our ArchLinux users. For detailed information see the section below.
+
+The workflow looks like this:
+
+```shell
+# having dokku-arch in ../dokku-arch
+vagrant up build-arch
+# wait for "==> build-arch: ==> Finished making: dokku 0.5.0-2 (Mon Feb 22 23:20:37 CET 2016)"
+cd ../dokku-arch
+git add PKGBUILD .SRCINFO
+git commit -m 'Update to dokku 0.9.9'
+git push aur master
+```
+
+> If you are a maintainer and need access to the AUR repositories in order to make a release, please contact @morrisjobke or @josegonzalez to get this co-maintainership.
+
+## Changelog format
+
+The `HISTORY.md` should be added to based on the changes made since the previous release. This can be done by reviewing all merged pull requests to the master branch on github. The format is as follows:
+
+```
+## 0.9.9
+
+Some description concerning major changes in this release, or potential incompatibilities.
+
+### New Features
+
+- #SOME_ID: @pull-request-creator Description
+
+### Bug Fixes
+
+- #SOME_ID: @pull-request-creator Description
+
+### Docs Changes
+
+- #SOME_ID: @pull-request-creator Description
+```
+
+## Detailed information for ArchLinux packages
+
+All of the information to build the ArchLinux package is in the AUR git repository (see [dokku AUR page](https://aur.archlinux.org/packages/dokku/)). The release of a AUR package only consists of pushing the package information into the AUR git repo. Then users could use that information to build the package on their machines.
+
+To update the package clone the repository and adjust the files in the repository. Then a helper script - `updpkgsums` - to update the SHA sum could  be called (check against the original SHA sum). Another helper script - `mksrcinfo` - needs to be called to update the meta information of the package in a file called `.SRCINFO`. The next step builds the package locally for verification - `makepkg`. As last step commit your changes and push the commit.
+
+* dependencies are defined in the `depends` attribute in `PKGBUILD`
+* build steps during package build time are defined in the `package()` method in `PKGBUILD`
+* steps that should be executed during install/update/remove time are defined in the file `dokku.install`
+* detailed information about all attributes in `PKGBUILD` could be found in the [ArchLinux wiki](https://wiki.archlinux.org/index.php/PKGBUILD)
+* detailed information about the AUR workflow could be found in the [AUR article](https://wiki.archlinux.org/index.php/Arch_User_Repository) in the ArchLinux wiki
+
+That is the usual workflow:
+
+```shell
+updpkgsums # update sha sums - compare them with the original ones
+mksrcinfo # update package metadata for AUR
+makepkg # test package builds
+git add PKGBUILD .SRCINFO
+git commit -m 'Update to dokku 0.9.9'
+git push
+```
+
+> If there is something unclear simply ask @morrisjobke for help.

docs/development/testing.md

@@ -0,0 +1,36 @@
+# Dokku test suite
+
+Dokku now has a full test suite to assist in quick iterating development. These tests include a linter using [shellcheck](https://github.com/koalaman/shellcheck), functional unit tests using the [bats testing framework](https://github.com/sstephenson/bats), and a deployment suite of example apps that use the most popular languages and frameworks.
+
+Bats tests can be found here:
+  ```
+  tests/unit/*.bats
+  ```
+
+Example apps can be found here:
+  ```
+  tests/apps/
+  ```
+
+### Executing tests locally
+
+- Setup dokku in a [vagrant vm](/dokku/getting-started/install/vagrant)
+- Test setup and execution
+
+  ```shell
+  $ vagrant ssh
+  $ sudo su -
+  $ cd ~/dokku
+  $ make ci-dependencies setup-deploy-tests
+  $ make test  # execute the entire test suite (linter, bats tests, and app deployment tests)
+  $
+  $ make lint copyfiles # run linter & update vagrant dokku install from local git clone
+  $ make unit-tests  # execute all bats tests
+  $ make deploy-tests  # execute all app deployment tests
+  ```
+- Additionally you may run a specific app deployment tests with a target similar to:
+
+  ```shell
+  $ make deploy-test-nodejs-express
+  ```
+- For a full list of test make targets check out `tests.mk` in the root of the dokku repository.

docs/dns.md

@@ -1,52 +1,52 @@
-# Overview
+# DNS Configuration
 
-This is a work in progress.
+> Note: This is a work in progress.
 
-## DNS Versions
+### DNS Versions
 
 There are many different DNS servers 'in the wild'.  Some of the popular ones on Linux are BIND, dnsmasq, and pdns.  Windows has its own built-in DNS server as well as Unbound, Posadis, and more.  A full list of DNS packages can be found on Wikipedia under [Comparison of DNS Server Software](http://en.wikipedia.org/wiki/Comparison_of_DNS_server_software).  In addition to the various DNS packages, there are tens of thousands of [Managed DNS Providers](http://en.wikipedia.org/wiki/List_of_managed_DNS_providers) out that all have different DNS interfaces.
 
-## Focus
+### Focus
 
 Because there are so many different DNS server packages out there as well as a tremendous number of Managed DNS Providers, we will focus on the concepts of DNS as well as providing examples in the 'BIND' format so you can adapt the information to your own server package or managed DNS provider.
 
-## Assumptions
+### Assumptions
 
 * We assume you have a passing familiarity with DNS.  If not, you can read an [in-depth article](http://www.diaryofaninja.com/blog/2012/03/03/devops-dns-for-developers-ndash-now-therersquos-no-excuse-not-to-know) on DNS.  But basically you need to know that DNS changes names (like example.tld) into addresses (like 127.0.0.1)
 * We assume you already have a domain name registered and pointed to your favorite Managed DNS Provider or have your own BIND DNS server running.
-* You have a server on the internet and are about to follow the instructions in the [README](https://github.com/progrium/dokku/blob/master/README.md) to get dokku installed.  Don't do the install just yet though.
+* You have a server on the internet and are about to follow the instructions in the [README](https://github.com/dokku/dokku/blob/master/README.md) to get dokku installed.  Don't do the install just yet though.
 
 
-## HELP!
+### HELP!
 
-Don't be afraid to ask if you need help.  Create a [new issue](https://github.com/progrium/dokku/issues) and someone will be glad to assist you.
+Don't be afraid to ask if you need help.  Create a [new issue](https://github.com/dokku/dokku/issues) and someone will be glad to assist you.
 
 
 # Getting started
 
-For the examples, we will use the domain name 'example.tld' and the IP address '127.0.0.1'.
+For the examples, we will use the domain name `example.tld` and the IP address `127.0.0.1`.
 
-Dokku uses a DNS to differentiate between apps on your dokku-powered server.  If you are using the domain 'example.tld', and you have two apps 'myapp1' and 'myapp2', dokku will make them available at 'myapp1.example.tld' and 'myapp2.example.tld'.
+Dokku uses DNS to differentiate between apps on your dokku-powered server.  If you are using the domain `example.tld`, and you have two apps `myapp1` and `myapp2`, dokku will make them available at `myapp1.example.tld` and `myapp2.example.tld`.
 
-To get started, you need to know the IP address of your dokku server.  Connect in to it and run 'ifconfig' or 'ip addr' to see the IP address.
+To get started, you need to know the IP address of your dokku server.  Connect to it and run `ifconfig` or `ip addr` to see the IP address.
 
 # Caching
 
-Please remember that DNS relies heavily on _caching_.  Changes you make to DNS could take anywhere from a few seconds to a few *days* to 'propagate'.  If you tried surfing to example.tld, then changed the IP address in DNS, it could be a while before your computer picks up on the changes.
+Please remember that DNS relies heavily on _caching_.  Changes you make to DNS could take anywhere from a few seconds to a few *days* to propagate.  If you tried surfing to example.tld, then changed the IP address in DNS, it could be a while before your computer picks up on the changes.
 
 ## The two methods
 
-Now you have to make a decision about your domain.  Do you want everything and anything at example.tld to go to your dokku server, or would you rather use a 'sub domain' for your dokku server?
+Now you have to make a decision about your domain.  Do you want everything and anything at `example.tld` to go to your dokku server, or would you rather use a 'sub domain' for your dokku server?
 
-In other words, do you want your applications on your dokku server accessible via myapp.example.tld or via myapp.myserver.example.tld?
+In other words, do you want your applications on your dokku server accessible via `myapp.example.tld` or via `myapp.myserver.example.tld`?
 
 ### Using a sub-domain (myapp.myserver.example.tld)
 
-Using a sub-domain is easy.  When you set up your server, you probably gave it a name like myserver.example.tld.
+Using a sub-domain is easy.  When you set up your server, you probably gave it a name like `myserver.example.tld`.
 
-Go in to your Managed DNS provider and create an 'A' record named 'myserver' and put in the IP address you got from your server a few moments ago.
+Go in to your Managed DNS provider and create an `A` record named `myserver` and put in the IP address you got from your server a few moments ago.
 
-Hopefully your managed DNS provider also supports wildcards.  Create a second 'A' record named '*.myserver' along with the IP address you got from your server a few moments ago.
+Hopefully your managed DNS provider also supports wildcards.  Create a second `A` record named `*.myserver` along with the IP address you got from your server a few moments ago.
 
 If you are using BIND, your zone file will look similar to this:
 
@@ -55,28 +55,25 @@ $ORIGIN example.tld
 $TTL 5m
 
 myserver         IN      A       127.0.0.1
-*.myserver         IN      A       127.0.0.1
+*.myserver       IN      A       127.0.0.1
 ```
 
 You can verify your changes in Linux by trying one or more of the following commands:
 
-* host myserver.example.tld
-
-* dig -t A myserver.example.tld
-
-* nslookup myserver.example.tld
+* `host myserver.example.tld`
+* `dig -t A myserver.example.tld`
+* `nslookup myserver.example.tld`
 
 Now is a good time to remind you that the answers you get MAY BE CACHED.
 
-If everything is working correctly, you should also be able to query for any other name 'under' myserver.example.tld and get back the IP address of your server.  Try:
+If everything is working correctly, you should also be able to query for any other name under `myserver.example.tld` and get back the IP address of your server.  Try:
 
-* host test.myserver.example.tld
+* `host test.myserver.example.tld`
+* `host xyzzy.myserver.example.tld`
 
-* host xyzzy.myserver.example.tld
+If they all return your IP address, you have set DNS up properly for dokku.  You should also be able to `ssh root@myserver.example.tld` and access your server.
 
-If they all return your IP address, you have set DNS up properly for dokku.  You should also be able to 'ssh root@myserver.example.tld' and access your server.
-
-Proceed with the setup instructions in the [README](https://github.com/progrium/dokku/blob/master/README.md)
+Proceed with the setup instructions in the [README](https://github.com/dokku/dokku/blob/master/README.md)
 
 ### Using the root of your domain (myapp.example.tld)
 
@@ -84,5 +81,5 @@ This section is a work in progress.  It is incomplete.
 
 Using the 'root' of your domain is nearly identical to the previous example.
 
-* hostname is under example.tld, still needs A record
-* Need to modify /home/dokku/HOSTNAME and /home/dokku/VHOST
+* hostname is under `example.tld`, still needs `A` record
+* Need to modify `/home/dokku/HOSTNAME` and `/home/dokku/VHOST`

docs/docker-options.md

@@ -0,0 +1,77 @@
+# Docker Container Options
+
+> New as of 0.3.17
+
+Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases
+
+```
+docker-options <app> [phase(s)]                  Display app's Docker options for all phases (or comma separated phase list)
+docker-options:add <app> <phase(s)> OPTION       Add Docker option to app for phase (comma-separated phase list)
+docker-options:remove <app> <phase(s)> OPTION    Remove Docker option from app for phase (comma-separated phase list)
+```
+
+> When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so:
+>
+> ```
+> dokku docker-options:add myapp deploy,run "-v /home/dokku/logs/myapp:/app/logs"
+> ```
+
+## About Dokku phases
+
+Dokku deploys your application in multiple "phases" and the `docker-options` plugin allows you to pass arguments to their underlying docker container:
+
+- `build`: the container that executes the appropriate buildpack
+- `deploy`: the container that executes your running/deployed application
+- `run`: the container that executes any arbitrary command via `dokku run myapp`
+
+## Examples
+
+### Add Docker options
+
+Add some options for the deployed/running app and when executing [`dokku run`](deployment/one-off-processes/):
+
+```shell
+# Mount a host volume in a Docker container: "-v /host/path:/container/path"
+dokku docker-options:add myapp deploy "-v /home/dokku/logs/myapp:/app/logs"
+dokku docker-options:add myapp run "-v /home/dokku/logs/myapp:/app/logs"
+```
+
+> Note: When [mounting a host directory](https://docs.docker.com/engine/reference/run/#volume-shared-filesystems) in a Dokku app you should first create that directory as user `dokku` and then mount the directory under `/app` in the container using `docker-options` as above. Otherwise the app will lack write permission in the directory.
+
+### Output Docker options
+
+```shell
+dokku docker-options myapp
+# Deploy options:
+#    -v /home/dokku/logs/myapp:/app/logs
+# Run options:
+#    -v /home/dokku/logs/myapp:/app/logs
+```
+
+### Remove a Docker option
+
+```shell
+dokku docker-options:remove myapp run "-v /home/dokku/logs/myapp:/app/logs"
+```
+
+## Advanced usage
+
+In your applications folder `/home/dokku/app_name` create a file called `DOCKER_OPTIONS_RUN` (or `DOCKER_OPTIONS_BUILD` or `DOCKER_OPTIONS_DEPLOY`).
+
+Inside this file list one Docker option per line. For example:
+
+```shell
+--link container_name:alias
+-v /host/path:/container/path
+-v /another/container/path
+```
+
+The above example will result in the following options being passed to Docker during `dokku run`:
+
+```shell
+--link container_name:alias -v /host/path:/container/path -v /another/container/path
+```
+
+You may also include comments (lines beginning with a #) and blank lines in the DOCKER_OPTIONS file.
+
+Move information on Docker options can be found here: http://docs.docker.io/en/latest/reference/run/ .

docs/dokku-events-logs.md

@@ -0,0 +1,72 @@
+# Dokku Event Logs
+
+> New as of 0.3.21
+
+Docker provides an _events_ command to show system's real time events. Likewise, Dokku can record events as syslog entries and also provides a plugin to display the last ones.
+
+```
+events [-t]                                      Show the last events (-t follows)
+events:list                                      List logged events
+events:on                                        Enable events logger
+events:off                                       Disable events logger
+```
+
+## Usage
+
+Enable the plugin:
+
+```
+$ dokku events:on
+Enabling dokku events logger
+```
+
+Dokku will then write log entries to ``/var/log/syslog`` as well as a Dokku-specific logs sub-directory ``/var/log/dokku/events.log``, which can be easily displayed with the command `dokku events`:
+
+```
+Jul  3 16:09:48 dokku.me dokku[127630]: INVOKED: pre-release-buildpack( pythonapp )
+Jul  3 16:10:02 dokku.me dokku[128095]: INVOKED: docker-args-run( rubyapp )
+Jul  3 16:10:02 dokku.me dokku[128114]: INVOKED: docker-args-run( nhl )
+Jul  3 16:10:03 dokku.me dokku[128136]: INVOKED: post-release-buildpack( pythonapp )
+Jul  3 16:10:03 dokku.me dokku[128195]: INVOKED: pre-deploy( pythonapp )
+Jul  3 16:10:23 dokku.me dokku[129253]: INVOKED: docker-args-deploy( pythonapp )
+Jul  3 16:10:24 dokku.me dokku[129337]: INVOKED: bind-external-ip( pythonapp )
+Jul  3 16:10:24 dokku.me dokku[129451]: INVOKED: check-deploy( pythonapp 6274ced0d4be11af4490cd18abaf77cdd593f025133f403d984e80d86a39acec web 5000 10.0.16.80 )
+Jul  3 16:10:35 dokku.me dokku[129561]: INVOKED: docker-args-deploy( pythonapp )
+Jul  3 16:10:35 dokku.me dokku[129649]: INVOKED: bind-external-ip( pythonapp )
+Jul  3 16:10:36 dokku.me dokku[129760]: INVOKED: check-deploy( pythonapp ac88a56ee4161ff37e4b92d1498c3eadc91f0aa7c8b81b44fc077e2a51d54cc0 worker )
+Jul  3 16:10:46 dokku.me dokku[129851]: INVOKED: post-deploy( pythonapp )
+Jul  3 16:10:46 dokku.me dokku[129945]: INVOKED: nginx-pre-reload( pythonapp )
+Jul  3 16:15:02 dokku.me dokku[130397]: INVOKED: docker-args-run( goapp )
+Jul  3 16:21:02 dokku.me dokku[130796]: INVOKED: docker-args-run( rubyapp )
+Jul  3 16:30:02 dokku.me dokku[131384]: INVOKED: docker-args-run( rubyapp )
+```
+
+You can list all events that are currently being recorded via `dokku events:list`:
+```
+=====> Events currently logged
+docker-args-build
+pre-delete
+post-deploy
+receive-app
+pre-release-buildpack
+nginx-pre-reload
+docker-args-deploy
+post-build-buildpack
+post-domains-update
+post-release-dockerfile
+check-deploy
+git-pre-pull
+git-post-pull
+nginx-hostname
+bind-external-ip
+pre-deploy
+post-delete
+dependencies
+pre-build-buildpack
+docker-args-run
+pre-build-dockerfile
+post-release-buildpack
+post-build-dockerfile
+pre-release-dockerfile
+update
+```

docs/dokku-storage.md

@@ -0,0 +1,46 @@
+# Dokku Core Storage Plugin
+
+> New as of 0.5.0
+
+The preferred method to mount external containers to a dokku managed container, is to use the dokku storage plugin.
+
+
+```shell
+storage:list <app>, List bind mounts for app's container(s) (host:container)
+storage:mount <app> <host-dir:container-dir>, Create a new bind mount
+storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
+```
+
+## Ideology and Background
+
+The storage plugin requires explicit paths on the host side. This is intentional to ensure that new users avoid running into unexpected results with implicit paths that may not exist (a feature deprecate in [Docker 1.9.0](https://github.com/docker/docker/releases/tag/v1.9.0])). The container directory is created for the mount point in the container. Any existing directory contents are not accessible after a mount is added to the container. Dokku creates a new directory `/var/lib/dokku/data/storage` during installation, it's the general consensus that new users should use this directory. Mounts are only available at run and deploy times, you must redeploy (restart) an app to mount or unmount to an existing app's container.
+
+## Usage
+
+This example demonstrates how to mount the recommended directory to `/storage` inside the container:
+```
+$ dokku storage:mount app-name /var/lib/dokku/data/storage:/storage
+```
+Dokku will then mount the shared contents of`/var/lib/dokku/storage` to `/storage` inside the container.
+
+## Use Cases
+
+### Persistent storage
+
+Dokku is powered by Docker containers, which recommends in their [best practices](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#containers-should-be-ephemeral) that containers be treated as ephemeral. In order to manage persistent storage for web applications, like user uploads or large binary assets like images, a directory outside the container should be mounted.
+
+### Shared storage between containers
+
+When scaling your app, you may require a common location to access shared assets between containers, a storage mount can be used in this situation.
+
+### Shared storage across environments
+
+Your app may be used in a cluster that requires containers or resources not running on the same host access your data. Mounting a shared file service (like S3FS or EFS) inside your container will give you great flexibility.
+
+### Backing up
+
+Your app may have services that are running in memory and need to be backed up locally (like a key store). Mount a non ephemeral storage mount will allow backups that are not lost when the app is shut down.
+
+## Docker-Options Note
+
+The storage plugins is compatible with storage mounts created with the docker-options. The storage plugin will only list mounts from the deploy phase.

docs/getting-started/install/azure.md

@@ -0,0 +1,11 @@
+# Microsoft Azure
+
+- If you don't already have one [generate an SSH key pair](https://help.github.com/articles/generating-ssh-keys/).
+
+- Go to the [dokku on azure deployment page](https://github.com/azure/azure-quickstart-templates/tree/master/dokku-vm) and click **Deploy to Azure**.
+
+- You'll be prompted to enter a few parameters, including a unique storage account name and a unique name for the sub-domain used for your public IP address. For the `sshKeyData` parameter, copy and paste the contents of the **public** key file you just created. After a few minutes the Dokku instance will be deployed.
+
+- In your browser of choice, navigate to `http://[[dnsNameForPublicIP]].[[location]].cloudapp.azure.com`. Where `[[dnsNameForPublicIP]]` and `[[location]]` are template parameters you used to deploy the template.
+
+- Finish your dokku setup like you normally would by creating a **new** public/private key pair for your deployments using `ssh-keygen` (don't use the same one as you created in the first step). You should select 'Use Virtual Host Naming' and set the `Hostname` to a **public dns name** that you own such as one you would purchase from [namecheap](http://namecheap.com). Alternatively thanks to [xip.io]( http://xip.io/) you can just use yourAzurePublicIP.xip.io for free. For example, if your public IP is `44.44.44.44` then you would set it to `44.44.44.44.xip.io`.

docs/getting-started/install/debian.md

@@ -0,0 +1,41 @@
+# Debian Package Installation Notes
+
+As of 0.3.18, dokku defaults to being installed via debian package. While certain hosts may require extra work to get running, you may optionally wish to automate the installation of dokku without the use of our `bootstrap.sh` bash script. The following are the steps run by said script:
+
+```shell
+# install prerequisites
+sudo apt-get update -qq > /dev/null
+sudo apt-get install -qq -y apt-transport-https
+
+# install docker
+wget -nv -O - https://get.docker.com/ | sh
+
+# install dokku
+wget -nv -O - https://packagecloud.io/gpg.key | apt-key add -
+echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ trusty main" | sudo tee /etc/apt/sources.list.d/dokku.list
+sudo apt-get update -qq > /dev/null
+sudo apt-get install dokku
+sudo dokku plugin:install-dependencies --core
+```
+
+## Unattended installation
+
+In case you want to perform an unattended installation of dokku, this is made possible through [debconf](https://en.wikipedia.org/wiki/Debconf_%28software_package%29), which allows you to configure a package before installing it.
+
+You can set any of the below options through the `debconf-set-selections` command, for example to enable vhost-based deployments:
+
+```bash
+echo "dokku dokku/vhost_enable boolean true" | sudo debconf-set-selections
+```
+
+After setting the desired options, proceed with the installation as described above.
+
+### debconf options
+
+| Name               | Type    | Default               | Description                                                              |
+| ------------------ | ------- | --------------------- | ------------------------------------------------------------------------ |
+| dokku/web_config   | boolean | true                  | Use web-based config for below options                                   |
+| dokku/vhost_enable | boolean | false                 | Use vhost-based deployments (e.g. <app>.dokku.me)                        |
+| dokku/hostname     | string  | dokku.me              | Hostname, used as vhost domain and for showing app URL after deploy      |
+| dokku/skip_key_file| boolean | false                 | Don't check for the existence of the dokku/key_file. Warning: This setting this to true, will require you to manually add an SSH key later on. |
+| dokku/key_file     | string  | /root/.ssh/id_rsa.pub | SSH key to add to the Dokku user (Will be ignored on `dpkg-reconfigure`) |

docs/getting-started/install/digitalocean.md

@@ -0,0 +1,7 @@
+# Digital Ocean
+
+On Digital Ocean, there is a pre-made image that can be run for Dokku. You can choose to run this image on any sized droplet, though larger droplets will allow you to run larger applications.
+
+When choosing your Droplet configuration, please disable IPv6 on the droplet. There are known issues with IPv6 on Digital Ocean and Docker, and many have been reported to the Dokku issue tracker.
+
+If you would like to run Dokku on an IPv6 Digital Ocean Droplet, please consult [this guide](https://jeffloughridge.wordpress.com/2015/01/17/native-ipv6-functionality-in-docker/) for modifying Docker to run under the Digital Ocean IPv6 configuration.

docs/getting-started/install/linode.md

@@ -0,0 +1,39 @@
+# Installing on Linode
+
+When installing Dokku on a Linode server, you'll likely see an error during Docker installation:
+
+> Warning: current kernel is not supported by the linux-image-extra-virtual package.  We have no AUFS support.  Consider installing the packages linux-image-virtual kernel and linux-image-extra-virtual for AUFS support.
+
+After 10 seconds, the installation will continue as normal.
+
+This warning is the result of Linode using its own kernel, which does not support AUFS, instead of using the kernel supplied by Ubuntu. If you ignore the warning, Docker will fall back to using the DeviceMapper storage backend and Dokku will work normally. However, AUFS is better tested and will perform better.
+
+If you would like to use AUFS, follow the steps below to install Ubuntu's kernel and configure your server to boot it instead of Linode's.
+
+## Preparing your Linode for AUFS
+
+__Warning__: These steps will delete *everything* on your Linode.
+
+1. Open your server's dashboard in the [Linode Manager](https://manager.linode.com/).
+
+2. Make sure your Linode is [using KVM](https://www.linode.com/docs/platform/kvm#how-to-enable-kvm), not Xen, for virtualization.
+
+3. In the "Rebuild" tab, select "Ubuntu 14.04 LTS", set a root password, and rebuild.
+
+4. Once your Linode has been created, click "Boot" and wait for it to complete.
+
+5. SSH into your Linode as root and run the following commands:
+
+        apt-get update
+        apt-get -qq upgrade
+        apt-get -qq install linux-image-virtual linux-image-extra-virtual
+
+6. When prompted, install Grub onto the first hard drive.
+
+7. Back in your server's dashboard, click "Edit" on its Configuration Profile
+
+8. Change the "Kernel" option to "GRUB 2" and save your changes.
+
+9. Lastly, reboot the Linode.
+
+Once your server comes back online, you'll be running Ubuntu's default kernel. You can now follow Dokku's [normal installation instructions](/dokku/installation) and `bootstrap.sh` will take care of everything else.

docs/getting-started/install/vagrant.md

@@ -0,0 +1,40 @@
+# Install Dokku using Vagrant
+
+- Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
+- Download and install [Vagrant](http://www.vagrantup.com/downloads.html)
+- Clone Dokku
+
+    ```
+    git clone https://github.com/dokku/dokku.git
+    ```
+
+- Setup SSH hosts in your `/etc/hosts`
+
+    ```
+    10.0.0.2 dokku.me
+    ```
+
+- Create VM
+    ```
+    # Optional ENV arguments:
+    # - `BOX_NAME`
+    # - `BOX_URI`
+    # - `BOX_MEMORY`
+    # - `DOKKU_DOMAIN`
+    # - `DOKKU_IP`
+    # - `FORWARDED_PORT`.
+    cd path/to/dokku
+    vagrant up
+    ```
+- Setup SSH Config in `~/.ssh/config`. The port listed here is usually correct, though you may want to verify that it is the same as the one listed in the output of `vagrant ssh-config dokku`
+
+    ```
+    Host dokku.me
+        Port 22
+    ```
+
+- Copy your SSH key via `cat ~/.ssh/id_rsa.pub | pbcopy` and paste it into the dokku-installer at http://dokku.me . Change the `Hostname` field on the Dokku Setup screen to your domain and then check the box that says `Use virtualhost naming`. Then click *Finish Setup* to install your key. You'll be directed to application deployment instructions from here.
+
+You are now ready to deploy an app or install plugins.
+
+For a different, complete, example see https://github.com/RyanBalfanz/dokku-vagrant-example.

docs/getting-started/where-to-get-help.md

@@ -0,0 +1,22 @@
+# Where to Get Help
+
+If you’re stuck, there are a number of places you can get help:
+
+## The Official Dokku Website
+
+[http://dokku.viewdocs.io/dokku](/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 and Slack Channels
+
+- [irc.freenode.net/#dokku](https://webchat.freenode.net/?channels=dokku)
+- [Gliderlabs Slack](https://glider-slackin.herokuapp.com/)
+
+If you’re stumped, give us a holler in the Dokku IRC or Slack channels. 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.
+
+## Stack Overflow
+
+http://stackoverflow.com/
+
+Tag your questions with `dokku` to enable existing users of Stack Overflow to find your questions.

docs/home.html

@@ -0,0 +1,287 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+    <meta name="description" content="">
+    <meta name="author" content="">
+    <link href="https://fonts.googleapis.com/css?family=Montserrat:400,700" rel="stylesheet" type="text/css">
+    <title>Dokku - The smallest PaaS implementation you've ever seen</title>
+
+    <link rel="apple-touch-icon" sizes="57x57" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-57x57.png">
+    <link rel="apple-touch-icon" sizes="60x60" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-60x60.png">
+    <link rel="apple-touch-icon" sizes="72x72" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-72x72.png">
+    <link rel="apple-touch-icon" sizes="76x76" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-76x76.png">
+    <link rel="apple-touch-icon" sizes="114x114" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-114x114.png">
+    <link rel="apple-touch-icon" sizes="120x120" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-120x120.png">
+    <link rel="apple-touch-icon" sizes="144x144" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-144x144.png">
+    <link rel="apple-touch-icon" sizes="152x152" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-152x152.png">
+    <link rel="apple-touch-icon" sizes="180x180" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/apple-touch-icon-180x180.png">
+    <link rel="icon" type="image/png" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/android-chrome-192x192.png" sizes="192x192">
+    <link rel="icon" type="image/png" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/favicon-96x96.png" sizes="96x96">
+    <link rel="icon" type="image/png" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/favicon-16x16.png" sizes="16x16">
+    <link rel="manifest" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/manifest.json">
+    <link rel="shortcut icon" href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/favicon.ico">
+    <meta name="apple-mobile-web-app-title" content="Dokku">
+    <meta name="application-name" content="Dokku">
+    <meta name="msapplication-TileColor" content="#da532c">
+    <meta name="msapplication-TileImage" content="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/mstile-144x144.png">
+    <meta name="msapplication-config" content="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/favicons/browserconfig.xml">
+    <meta name="theme-color" content="#ffffff">
+
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.0.0-alpha.2/css/bootstrap.min.css" rel="stylesheet">
+    <link href="https://cdn.rawgit.com/dokku/dokku/v0.5.0/docs/assets/style.css" rel="stylesheet">
+    <!-- <link href="/dokku/docs/assets/style.css" rel="stylesheet"> -->
+    <style>
+    </style>
+  </head>
+  <body>
+    <div class="header">
+      <div class="container">
+        <div class="row">
+          <div>
+            <h1 class="heading navbar-brand">
+              <a href="http://dokku.viewdocs.io/dokku/">Dokku</a>
+            </h1>
+            <ul class="nav nav-pills pull-xs-right">
+              <li class="nav-item">
+                <a class="nav-link" href="https://github.com/dokku/dokku/">Code</a>
+              </li>
+              <li class="nav-item">
+                <a class="nav-link" href="/{{NAME}}/installation/">Docs</a>
+              </li>
+              <li class="nav-item">
+                <a class="nav-link" href="https://webchat.freenode.net/?channels=dokku">IRC</a>
+              </li>
+              <li class="nav-item">
+                <a class="nav-link" href="https://glider-slackin.herokuapp.com/">Slack</a>
+              </li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <div class="blurb">
+      <div class="container">
+        <div class="row">
+          <h2>The smallest PaaS implementation you've ever seen</h2>
+          <p>Docker powered mini-Heroku in around 200 lines of Bash</p>
+          <div class="blurb-buttons">
+            <a class="btn btn-lg btn-warning" href="/dokku/installation/">View Documentation</a>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <div class="container marketing">
+      <div class="quickstart-code">
+        <p class="title">Quick-start Instructions</p>
+        <div class="tabs">
+          <div data-tab="curl" class="tab tab-curl tab-active">curl | bash</div>
+          <div data-tab="apt" class="tab tab-apt">apt</div>
+          <div data-tab="arch" class="tab tab-arch">arch</div>
+        </div>
+        <div class="shell shell-curl shell-active">
+          <p class="line">
+            <span class="output">&nbsp;# only works on debian systems!</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">wget https://raw.githubusercontent.com/dokku/dokku/v0.5.0/bootstrap.sh</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">sudo DOKKU_TAG=v0.5.0 bash bootstrap.sh</span>
+          </p>
+          <p class="line">
+            <span class="output">&nbsp;# go to your server's IP and follow the web installer</span>
+          </p>
+        </div>
+
+        <div class="shell shell-apt">
+          <p class="line">
+            <span class="output">&nbsp;# install docker</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">wget -nv -O - https://get.docker.com/ | sh</span>
+          </p>
+          <p class="line">
+            <span class="output">&nbsp;# setup dokku apt repository</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">wget -nv -O - https://packagecloud.io/gpg.key | apt-key add -</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">export SOURCE="https://packagecloud.io/dokku/dokku/ubuntu/"</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">echo "deb $SOURCE trusty main" | tee /etc/apt/sources.list.d/dokku.list</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">apt-get update</span>
+          </p>
+          <p class="line">
+            <span class="output">&nbsp;# install dokku</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">apt-get install dokku</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">dokku plugin:install-dependencies --core <span class="output"># run with root!</span></span>
+          </p>
+          <p class="line">
+            <span class="output">&nbsp;# go to your server's IP and follow the web installer</span>
+          </p>
+        </div>
+
+        <div class="shell shell-arch">
+          <p class="line">
+            <span class="output">&nbsp;# install dokku via yaourt</span>
+          </p>
+          <p class="line">
+            <span class="path"></span>
+            <span class="prompt">$</span>
+            <span class="command">yaourt -S dokku</span>
+          </p>
+        </div>
+      </div>
+
+      <div class="alternate-instructions">
+        <p>Hate <code>curl | bash</code>? See our official <a href="https://github.com/Azure/azure-quickstart-templates/tree/master/dokku-vm" target="_blank">Azure</a>, <a href="https://www.digitalocean.com/features/one-click-apps/dokku/" target="_blank">DigitalOcean</a>, and <a href="/{{NAME}}~{{REF}}/getting-started/install/linode/" target="_blank">Linode</a> instructions.<p>
+        <p>Still no love? <a href="https://github.com/dokku/dokku/blob/master/CONTRIBUTING.md" target="_blank">Contributions welcome</a>!</a>
+      </div>
+
+      <!-- START THE FEATURETTES -->
+
+      <hr class="featurette-divider">
+
+      <div class="row featurette">
+        <div class="col-md-7">
+          <h2 class="featurette-heading">Own Your PaaS. <span class="text-muted">Infrastructure at a fraction of the cost.</span></h2>
+          <p class="lead">Powered by Docker, you can install Dokku on any hardware. Use it on inexpensive cloud providers. Use the extra cash to buy a pony or feed kittens. You'll save tens of dollars a year on your dog photo sharing website.</p>
+        </div>
+        <div class="col-md-5">
+          <img class="featurette-image img-responsive center-block" alt="Docker Logo" src="./assets/docker.png">
+        </div>
+      </div>
+
+      <hr class="featurette-divider">
+
+      <div class="row featurette">
+        <div class="col-md-7 col-md-push-5">
+          <h2 class="featurette-heading">Easy Git Deploys. <span class="text-muted">From your command-line to the cloud.</span></h2>
+          <p class="lead">Once it's set up on a host, you can push Heroku-compatible applications to it via Git. They'll build using Heroku buildpacks and then run in isolated containers. The end result is your own, single-host version of Heroku.</p>
+        </div>
+        <div class="col-md-5 col-md-pull-7">
+          <img class="featurette-image img-responsive center-block" alt="Git Logo" src="./assets/git.png">
+        </div>
+      </div>
+
+      <hr class="featurette-divider">
+
+      <div class="row featurette">
+        <div class="col-md-7">
+          <h2 class="featurette-heading">Extensible Platform. <span class="text-muted">Customize your PaaS.</span></h2>
+          <p class="lead">Write dokku plugins in any language. Share them online with others, and extend those already available. Dokku's simple core is easy to hack and add the features you need to get your job done.</p>
+        </div>
+        <div class="col-md-5">
+          <img class="featurette-image img-responsive center-block" alt="Extend Logo" src="./assets/extend.png">
+        </div>
+      </div>
+
+      <hr class="featurette-divider">
+    </div>
+
+    <!--
+    <div class="container-fluid slack-channel">
+      Have a question? Join us in our public slack channel!
+
+      <div class="inline-container">
+        <a class="button slack-button" href="https://glider-slackin.herokuapp.com/">
+          <img src="/assets/slack-logo.png" alt="Slack Logo">
+        </a>
+      </div>
+    </div>
+    -->
+
+    <div class="container">
+      <footer>
+        <p>&copy; 2013-2016 Dokku</p>
+      </footer>
+    </div>
+    <script>
+    document.addEventListener('DOMContentLoaded', function (e) {
+      var addClass = function (el, className) {
+        if (el.classList) {
+          el.classList.add(className);
+        } else {
+          el.className += ' ' + className;
+        }
+      },
+      addListener = function (elem, type, fn) {
+        if (elem.addEventListener) {
+          elem.addEventListener(type, fn, false);
+        } else if (elem.attachEvent) {
+          elem.attachEvent("on" + type, function() {
+            return fn.call(elem, window.event);
+          });
+        } else {
+          elem["on" + type] = fn;
+        }
+      },
+      hasClass = function(el, className) {
+        if (el.classList) {
+          return el.classList.contains(className);
+        } else {
+          return new RegExp('(^| )' + className + '( |$)', 'gi').test(el.className);
+        }
+      },
+      removeClass = function(el, className) {
+        if (el.classList) {
+          el.classList.remove(className);
+        } else {
+          el.className = el.className.replace(new RegExp('(^|\\b)' + className.split(' ').join('|') + '(\\b|$)', 'gi'), ' ');;
+        }
+      },
+      activateTab = function(tab) {
+        removeClass(document.querySelectorAll('.shell-active')[0], 'shell-active');
+        removeClass(document.querySelectorAll('.tab-active')[0], 'tab-active');
+        addClass(document.querySelectorAll('.shell-' + tab)[0], 'shell-active');
+        addClass(document.querySelectorAll('.tab-' + tab)[0], 'tab-active');
+        window.location.hash = '#install-' + tab;
+      };
+
+      var hash = window.location.hash.replace('#install-', '');
+      if (['curl', 'apt', 'arch'].indexOf(hash) !== -1) {
+        activateTab(hash);
+      }
+
+      Array.prototype.forEach.call(document.querySelectorAll('.tab'), function (el, i) {
+        addListener(el, 'click', function(e) {
+          activateTab(this.getAttribute('data-tab'));
+        });
+      });
+    });
+    </script>
+  </body>
+</html>

docs/index.md

@@ -1,26 +1,70 @@
-# Dokku Documentation
+<div class="blurb">
+  <div class="container">
+    <h2>The smallest PaaS implementation you've ever seen</h2>
+    <p>Docker powered mini-Heroku in around 200 lines of Bash</p>
+    <div class="blurb-buttons">
+      <a class="btn btn-lg btn-warning" href="/dokku/installation">View Documentation</a>
+    </div>
+  </div>
+</div>
 
-Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen.
+<div class="container marketing">
+  <div class="quickstart-code">
+    <p class="title">Quick-start Instructions</p>
+    <div class="shell">
+      <p class="line">
+        <span class="path">~</span>
+        <span class="prompt">$</span>
+        <span class="command">wget https://raw.githubusercontent.com/dokku/dokku/v0.5.0/bootstrap.sh</span>
+      </p>
+      <p class="line">
+        <span class="path">~</span>
+        <span class="prompt">$</span>
+        <span class="command">sudo DOKKU_TAG=v0.5.0 bash bootstrap.sh</span>
+      </p>
+      <p class="line">
+        <span class="output"># =&gt; Go to your server's IP and follow the web installer</span>
+      </p>
+    </div>
+  </div>
 
-## Table Of Contents
+  <hr class="featurette-divider">
 
-- [Installation](http://progrium.viewdocs.io/dokku/installation)
-- [Upgrading](http://progrium.viewdocs.io/dokku/upgrading)
-- [Troubleshooting](http://progrium.viewdocs.io/dokku/troubleshooting)
-- [Components](http://progrium.viewdocs.io/dokku/components)
-- [Application Deployment](http://progrium.viewdocs.io/dokku/application-deployment)
-- [Remote commands](http://progrium.viewdocs.io/dokku/remote-commands)
-- [Plugins](http://progrium.viewdocs.io/dokku/plugins)
-- [Configuration management](http://progrium.viewdocs.io/dokku/configuration-management)
-- [Nginx Configuration](http://progrium.viewdocs.io/dokku/nginx)
-- [DNS](http://progrium.viewdocs.io/dokku/dns)
+  <!-- START THE FEATURETTES -->
 
-## Things this project won't do
+  <div class="row featurette">
+    <div class="col-md-7">
+      <h2 class="featurette-heading">Own Your PaaS. <span class="text-muted">Infrastructure at a fraction of the cost.</span></h2>
+      <p class="lead">Powered by Docker, you can install Dokku on any hardware. Use it on inexpensive cloud providers. Use the extra cash to buy a pony or feed kittens. You'll save tens of dollars a year on your dog photo sharing website.</p>
+    </div>
+    <div class="col-md-5">
+      <img class="featurette-image img-responsive center-block" alt="Docker Logo" src="assets/docker.png">
+    </div>
+  </div>
 
- * **Multi-host.** Not a huge leap, but this isn't the project for it. Have a look at [Deis](http://deis.io/).
- * **Multitenancy.** It's ready for it, but again, have a look at [Deis](http://deis.io/).
- * **Client app.** Given the constraints, running commands remotely via SSH is fine.
+  <hr class="featurette-divider">
 
-## Sponsors
+  <div class="row featurette">
+    <div class="col-md-7 col-md-push-5">
+      <h2 class="featurette-heading">Easy Git Deploys. <span class="text-muted">From your command-line to the cloud.</span></h2>
+      <p class="lead">Once it's set up on a host, you can push Heroku-compatible applications to it via Git. They'll build using Heroku buildpacks and then run in isolated containers. The end result is your own, single-host version of Heroku.</p>
+    </div>
+    <div class="col-md-5 col-md-pull-7">
+      <img class="featurette-image img-responsive center-block" alt="Git Logo" src="assets/git.png">
+    </div>
+  </div>
 
-Though we love everybody doing open source, we especially love [Deis](http://deis.io/) for sponsoring Dokku.
+  <hr class="featurette-divider">
+
+  <div class="row featurette">
+    <div class="col-md-7">
+      <h2 class="featurette-heading">Extensible Platform. <span class="text-muted">Customize your PaaS.</span></h2>
+      <p class="lead">Write dokku plugins in any language. Share them online with others, and extend those already available. Dokku's simple core is easy to hack and add the features you need to get your job done.</p>
+    </div>
+    <div class="col-md-5">
+      <img class="featurette-image img-responsive center-block" alt="Extend Logo" src="assets/extend.png">
+    </div>
+  </div>
+
+  <hr class="featurette-divider">
+</div>

docs/installation.md

@@ -1,154 +1,49 @@
-# Installation
+# Getting Started with Dokku
 
-## Requirements
+## What is Dokku?
 
-- A fresh VM running Ubuntu `14.04 x64`
+Dokku is an extensible, open source Platform as a Service that runs on a single server of your choice.
 
-Ubuntu 14.04 x64 x64. Ideally have a domain ready to point to your host. It's designed for and is probably best to use a fresh VM. The bootstrapper will install everything it needs.
+To start using Dokku, you'll need a system that meets the following minimum requirements:
 
-## Installing the latest Stable version
+- A fresh installation of [Ubuntu 14.04 x64](http://www.ubuntu.com/download/) with the FQDN set <sup>[1]</sup>
+- At least `1GB` of system memory <sup>[2]</sup>
 
-To install the latest stable version of dokku, you can run the following bootstrapper command:
+You can *optionally* have a domain name pointed at the host's IP, though this is not necessary.
 
-```bash
-wget -qO- https://raw.github.com/progrium/dokku/v0.3.2/bootstrap.sh | sudo DOKKU_TAG=v0.3.2 bash
+Dokku is designed for usage on a fresh installation of Ubuntu, and should install all necessary dependencies if installing via the bootstrap method.
+
+### Installing the latest stable version
+
+To install the latest stable version of dokku, you can run the following shell commands:
+
+```shell
+# installs dokku via apt-get
+wget https://raw.githubusercontent.com/dokku/dokku/v0.5.0/bootstrap.sh
+sudo DOKKU_TAG=v0.5.0 bash bootstrap.sh
 ```
 
-## Configuring
+The installation process takes about 5-10 minutes, depending upon internet connection speed.
 
-Set up a domain and a wildcard domain pointing to that host. Make sure `/home/dokku/VHOST` is set to this domain. By default it's set to whatever hostname the host has. This file is only created if the hostname can be resolved by dig (`dig +short $(hostname -f)`). Otherwise you have to create the file manually and set it to your preferred domain. If this file still is not present when you push your app, dokku will publish the app with a port number (i.e. `http://example.com:49154` - note the missing subdomain).
+Once the installation is complete, you can open a browser to setup your SSH key and virtualhost settings. Open your browser of choice and navigate to the host's IP address - or the domain you assigned to that IP previously - and configure dokku via the web admin.
 
-You'll have to add a public key associated with a username by doing something like this from your local machine:
+Once you save your settings, the web admin will self-terminate and you should be able to run or deploy to the dokku installation.
 
-    $ cat ~/.ssh/id_rsa.pub | ssh progriumapp.com "sudo sshcommand acl-add dokku progrium"
+### Installing via other methods
 
-That's it!
+For various reasons, certain hosting providers may have other steps that should be preferred to the above. If hosted on any of the following popular hosts, please follow the linked to instructions:
 
-## Advanced installation
+- [Digital Ocean Installation Notes](/dokku/getting-started/install/digitalocean)
+- [Linode Installation Notes](/dokku/getting-started/install/linode/)
+- [Microsoft Azure Installation Notes](/dokku/getting-started/install/azure/)
 
-### Development via bash script
+As well, you may wish to customize your installation in some other fashion. or experiment with vagrant. The guides below should get you started:
 
-```bash
-wget -qO- https://raw.github.com/progrium/dokku/master/bootstrap.sh | sudo bash
-```
+- [Debian Package Installation Notes](/dokku/getting-started/install/debian)
+- [Vagrant Installation Notes](/dokku/getting-started/install/vagrant)
+- [Advanced Install Customization](/dokku/advanced-installation)
 
-This may take around 5 minutes. Certainly better than the several hours it takes to bootstrap Cloud Foundry.
+---
 
-You may also wish to take a look at the [advanced installation](http://progrium.viewdocs.io/dokku/advanced-installation) document for additional installation options.
-
-### Development From Source
-
-If you plan on developing dokku, the easiest way to install from your own repository is cloning
-the repository and calling the install script. Example:
-
-```bash
-git clone https://github.com/yourusername/dokku.git
-cd dokku
-sudo make install
-```
-
-The `Makefile` allows source URLs to be overridden to include customizations from your own
-repositories. The `DOCKER_URL`, `PLUGINHOOK_URL`, `SSHCOMMAND_URL` and `STACK_URL`
-environment variables may be set to override the defaults (see the `Makefile` for how these
-apply). Example:
-
-```bash
-sudo SSHCOMMAND_URL=https://raw.github.com/yourusername/sshcommand/master/sshcommand make install
-```
-
-### Bootstrap a server from your own repository
-
-The bootstrap script allows the dokku repository URL to be overridden to bootstrap a host from
-your own clone of dokku using the `DOKKU_REPO` environment variable. Example:
-
-```bash
-wget https://raw.github.com/progrium/dokku/master/bootstrap.sh
-chmod +x bootstrap.sh
-sudo DOKKU_REPO=https://github.com/yourusername/dokku.git ./bootstrap.sh
-```
-
-### Custom buildstep build
-
-Dokku ships with a pre-built version of the [buildstep](https://github.com/progrium/buildstep) component by
-default. If you want to build your own version you can specify that with an env
-variable.
-
-```bash
-git clone https://github.com/progrium/dokku.git
-cd dokku
-sudo BUILD_STACK=true make install
-```
-
-### Install Dokku using Vagrant
-
-- Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
-- Download and install [Vagrant](http://www.vagrantup.com/downloads.html)
-- Clone Dokku
-
-    ```
-    git clone https://github.com/progrium/dokku.git
-    ```
-
-- Setup SSH hosts in your `/etc/hosts`
-
-    ```
-    10.0.0.2 dokku.me
-    ```
-
-- Setup SSH Config in `~/.ssh/config`
-
-    ```
-    Host dokku.me
-        Port 2222
-    ```
-
-- Create VM
-    ```
-    # Optional ENV arguments:
-    # - `BOX_NAME`
-    # - `BOX_URI`
-    # - `BOX_MEMORY`
-    # - `DOKKU_DOMAIN`
-    # - `DOKKU_IP`.
-    vagrant up
-    ```
-
-- Copy your SSH key via `cat ~/.ssh/id_rsa.pub | pbcopy` and paste it into the dokku-installer at http://dokku.me . Change the `Hostname` field on the Dokku Setup screen to your domain and then check the box that says `Use virtualhost naming`. Then click *Finish Setup* to install your key. You'll be directed to application deployment instructions from here.
-
-You are now ready to deploy an app or install plugins.
-
-For a different, complete, example see https://github.com/RyanBalfanz/dokku-vagrant-example.
-
-### Installing on Linode
-
-#### Using StackScript
-
-Deploy using the following StackScript:
-* https://www.linode.com/stackscripts/view/8552
-
-#### Without StackScript
-
-* Build a Ubuntu 13.04 instance
-
-* Follow these instructions: https://www.linode.com/wiki/index.php/PV-GRUB#Ubuntu_12.04_Precise
-
-* If `apt-get update` no longer works:
-
-    * Verify if apt-get is trying to use ipv6 instead of ipv4 (e.g. you read something like "[Connecting to us.archive.ubuntu.com (2001:67c:1562::14)]" and apt-get would not proceed). In that case, follow these instructions: http://unix.stackexchange.com/questions/9940/convince-apt-get-not-to-use-ipv6-method (append "precedence ::ffff:0:0/96  100" to /etc/gai.conf)
-
-    * OR: change `/etc/apt/sources.list` to one mentioned in http://mirrors.ubuntu.com/mirrors.txt
-
-* Run the following commands:
-
-    ```bash
-    apt-get update
-
-    apt-get install lxc wget bsdtar linux-image-extra-$(uname -r)
-
-    modprobe aufs
-    ```
-* After this, you can install dokku the default way:
-
-    ```bash
-    wget -qO- https://raw.github.com/progrium/dokku/master/bootstrap.sh | sudo bash
-    ```
+- <sup>[1]: To check whether your system has an fqdn set, run `sudo hostname -f`</sup>
+- <sup>[2]: If your system has less than 1GB of memory, you can use [this workaround](/dokku/advanced-installation/#vms-with-less-than-1gb-of-memory).</sup>

docs/nginx.md

@@ -1,57 +1,88 @@
-# Nginx
+# Nginx Configuration
 
-Dokku uses nginx as it's server for routing requests to specific applications.
-
-## TLS/SPDY support
-
-Dokku provides easy TLS/SPDY support out of the box. This can be done app-by-app or for all subdomains at once. Note that whenever TLS support is enabled SPDY is also enabled.
-
-### Per App
-
-To enable TLS connection to to one of your applications, copy or symlink the `.crt`/`.pem` and `.key` files into the application's `/home/dokku/:app/tls` folder (create this folder if it doesn't exist) as `server.crt` and `server.key` respectively.
-
-Redeployment of the application will be needed to apply TLS configuration. Once it is redeployed, the application will be accessible by `https://` (redirection from `http://` is applied as well).
-
-### All Subdomains
-
-To enable TLS connections for all your applications at once you will need a wildcard TLS certificate.
-
-To enable TLS across all apps, copy or symlink the `.crt`/`.pem` and `.key` files into the  `/home/dokku/tls` folder (create this folder if it doesn't exist) as `server.crt` and `server.key` respectively. Then, enable the certificates by editing `/etc/nginx/conf.d/dokku.conf` and uncommenting these two lines (remove the #):
+Dokku uses nginx as its server for routing requests to specific applications. By default, access and error logs are written for each app to `/var/log/nginx/${APP}-access.log` and `/var/log/nginx/${APP}-error.log` respectively
 
 ```
-ssl_certificate /home/dokku/tls/server.crt;
-ssl_certificate_key /home/dokku/tls/server.key;
+nginx:access-logs <app> [-t]                                                                 Show the nginx access logs for an application (-t follows)
+nginx:build-config <app>                                                                     (Re)builds nginx config for given app
+nginx:error-logs <app> [-t]                                                                  Show the nginx error logs for an application (-t follows)
 ```
 
-The nginx configuration will need to be reloaded in order for the updated TLS configuration to be applied. This can be done either via the init system or by re-deploying the application. Once TLS is enabled, the application will be accessible by `https://` (redirection from `http://` is applied as well).
+## Customizing the nginx configuration
 
-**Note**: TLS will not be enabled unless the application's VHOST matches the certificate's name. (i.e. if you have a cert for *.example.com TLS won't be enabled for something.example.org or example.net)
+> New as of 0.5.0
 
-### HSTS Header
+Dokku uses a templating library by the name of [sigil](https://github.com/gliderlabs/sigil) to generate nginx configuration for each app. If you'd like to provide a custom template for your application, there are a couple options:
 
-The [HSTS header](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) is an HTTP header that can inform browsers that all requests to a given site should be made via HTTPS. dokku does not, by default, enable this header. It is thus left up to you, the user, to enable it for your site.
+- Copy the following example template to a file named `nginx.conf.sigil` and either:
+  - check it into the root of your app repo
+  - `ADD` it to your dockerfile `WORKDIR`
 
-Beware that if you enable the header and a subsequent deploy of your application results in an HTTP deploy (for whatever reason), the way the header works means that a browser will not attempt to request the HTTP version of your site if the HTTPS version fails.
+### Example Custom Template
+```
+server {
+  listen      [::]:{{ .NGINX_PORT }};
+  listen      {{ .NGINX_PORT }};
+  server_name {{ .NOSSL_SERVER_NAME }};
+  access_log  /var/log/nginx/{{ .APP }}-access.log;
+  error_log   /var/log/nginx/{{ .APP }}-error.log;
 
-### Importing ssl certificates
+  # set a custom header for requests
+  add_header X-Served-By www-ec2-01;
 
-You can import ssl certificates via tarball using the following command:
+  location    / {
+    proxy_pass  http://{{ .APP }};
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+    proxy_set_header Host $http_host;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_set_header X-Forwarded-For $remote_addr;
+    proxy_set_header X-Forwarded-Port $server_port;
+    proxy_set_header X-Request-Start $msec;
+  }
+  include {{ .DOKKU_ROOT }}/{{ .APP }}/nginx.conf.d/*.conf;
 
-``` bash
-dokku nginx:import-ssl myapp < archive-of-certs.tar
+  upstream {{ .APP }} {
+  {{ range .DOKKU_APP_LISTENERS | split " " }}
+    server {{ . }};
+  {{ end }}
+  }
+}
 ```
 
-This archive should is expanded via `tar xvf`. It should contain `server.crt` and `server.key`.
+The above is a sample http configuration that adds an `X-Served-By` header to requests.
 
-## Disabling VHOSTS
-
-If desired, it is possible to disable vhosts by setting the `NO_VHOST` environment variable:
-
-```bash
-dokku config:set myapp NO_VHOST=1
+### Available template variables
+```
+{{ .APP }}                          Application name
+{{ .APP_SSL_PATH }}                 Path to SSL certificate and key
+{{ .DOKKU_ROOT }}                   Global dokku root directory (ex: app dir would be `{{ .DOKKU_ROOT }}/{{ .APP }}`)
+{{ .DOKKU_APP_LISTENERS }}          List of IP:PORT pairs of app containers
+{{ .NGINX_PORT }}                   Non-SSL nginx listener port (same as `DOKKU_NGINX_PORT` config var)
+{{ .NGINX_SSL_PORT }}               SSL nginx listener port (same as `DOKKU_NGINX_SSL_PORT` config var)
+{{ .NOSSL_SERVER_NAME }}            List of non-SSL VHOSTS
+{{ .RAW_TCP_PORTS }}                List of exposed tcp ports as defined by Dockerfile `EXPOSE` directive (**Dockerfile apps only**)
+{{ .SSL_INUSE }}                    Boolean set when an app is SSL-enabled
+{{ .SSL_SERVER_NAME }}              List of SSL VHOSTS
 ```
 
-On subsequent deploys, the nginx virtualhost will be discarded. This is useful when deploying internal-facing services that should not be publicly routeable.
+### Customizing via configuration files included by the default templates
+
+The default nginx.conf template will include everything from your apps `nginx.conf.d/` subdirectory in the main `server {}` block (see above):
+
+```
+include {{ .DOKKU_ROOT }}/{{ .APP }}/nginx.conf.d/*.conf;
+```
+
+That means you can put additional configuration in separate files, for example to limit the uploaded body size to 50 megabytes, do
+
+```shell
+mkdir /home/dokku/myapp/nginx.conf.d/
+echo 'client_max_body_size 50M;' > /home/dokku/myapp/nginx.conf.d/upload.conf
+chown dokku:dokku /home/dokku/myapp/nginx.conf.d/upload.conf
+service nginx reload
+```
 
 ## Customizing hostnames
 
@@ -61,11 +92,13 @@ Applications typically have the following structure for their hostname:
 scheme://subdomain.domain.tld
 ```
 
-The `subdomain` is inferred from the pushed application name, while the `domain` is set during initial configuration in the `$DOKKU_ROOT/VHOST` file.
+The `subdomain` is inferred from the pushed application name, while the `domain.tld` is set during initial configuration and stored in the `$DOKKU_ROOT/VHOST` file. It can then be modified with `dokku domains:set-global`. This value is used as a default TLD for all applications on a host.
 
-You can optionally override this in a plugin by implementing the `nginx-hostname` pluginhook. For example, you can reverse the subdomain with the following sample `nginx-hostname` pluginhook:
+If a FQDN such as `other.tld` is used as the application name, the default `$DOKKU_ROOT/VHOST` will be ignored and the resulting vhost URL for that application will be `other.tld`. The exception to this rule being that if the FQDN has the same ending as the default vhost (such as `subdomain.domain.tld`), then the entire FQDN will be treated as a subdomain. The application will therefore be deployed at `subdomain.domain.tld.domain.tld`.
 
-```bash
+You can optionally override this in a plugin by implementing the `nginx-hostname` plugin trigger. For example, you can reverse the subdomain with the following sample `nginx-hostname` plugin trigger:
+
+```shell
 #!/usr/bin/env bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
@@ -76,3 +109,95 @@ echo "$NEW_SUBDOMAIN.$VHOST"
 ```
 
 If the `nginx-hostname` has no output, the normal hostname algorithm will be executed.
+
+You can also use the built-in `domains` plugin to handle:
+
+### Domains plugin
+
+> New as of 0.3.10
+
+```shell
+domains:add <app> DOMAIN                                                                     Add a domain to app
+domains [<app>]                                                                              List domains
+domains:clear <app>                                                                          Clear all domains for app
+domains:disable <app>                                                                        Disable VHOST support
+domains:enable <app>                                                                         Enable VHOST support
+domains:remove <app> DOMAIN                                                                  Remove a domain from app
+domains:set-global <domain>                                                                  Set global domain name
+```
+
+### Disabling VHOSTS
+
+If desired, it is possible to disable vhosts with the domains plugin.
+
+```shell
+dokku domains:disable myapp
+```
+
+On subsequent deploys, the nginx virtualhost will be discarded. This is useful when deploying internal-facing services that should not be publicly routeable. As of 0.4.0, nginx will still be configured to proxy your app on some random high port. This allows internal services to maintain the same port between deployments. You may change this port by setting `DOKKU_NGINX_PORT` and/or `DOKKU_NGINX_SSL_PORT` (for services configured to use SSL.)
+
+
+The domains plugin allows you to specify custom domains for applications. This plugin is aware of any ssl certificates that are imported via `certs:add`. Be aware that disabling domains (with `domains:disable`) will override any custom domains.
+
+```shell
+# where `myapp` is the name of your app
+
+# add a domain to an app
+dokku domains:add myapp example.com
+
+# list custom domains for app
+dokku domains myapp
+
+# clear all custom domains for app
+dokku domains:clear myapp
+
+# remove a custom domain from app
+dokku domains:remove myapp example.com
+```
+
+
+## Default site
+
+By default, dokku will route any received request with an unknown HOST header value to the lexicographically first site in the nginx config stack. If this is not the desired behavior, you may want to add the following configuration to the global nginx configuration. This will catch all unknown HOST header values and return a `410 Gone` response. You can replace the `return 410;` with `return 444;` which will cause nginx to not respond to requests that do not match known domains (connection refused).
+
+```
+server {
+  listen 80 default_server;
+  listen [::]:80 default_server;
+
+  server_name _;
+  return 410;
+  log_not_found off;
+}
+```
+
+You may also wish to use a separate vhost in your `/etc/nginx/sites-enabled` directory. To do so, create the vhost in that directory as `/etc/nginx/sites-enabled/00-default.conf`. You will also need to change two lines in the main `nginx.conf`:
+
+```
+# Swap both conf.d include line and the sites-enabled include line. From:
+include /etc/nginx/conf.d/*.conf;
+include /etc/nginx/sites-enabled/*;
+
+# to the following
+
+include /etc/nginx/sites-enabled/*;
+include /etc/nginx/conf.d/*.conf;
+```
+
+Alternatively, you may push an app to your dokku host with a name like "00-default". As long as it lists first in `ls /home/dokku/*/nginx.conf | head`, it will be used as the default nginx vhost.
+
+## Running behind a load balancer
+
+See the [load balancer documentation](/dokku/deployment/ssl-configuration/#running-behind-a-load-balancer).
+
+## HSTS Header
+
+See the [HSTS documentation](/dokku/deployment/ssl-configuration/#hsts-header).
+
+## SSL Configuration
+
+See the [ssl documentation](/dokku/deployment/ssl-configuration/).
+
+## Disabling Nginx
+
+See the [proxy documentation](/dokku/deployment/proxy/).

docs/plugins.md

@@ -1,79 +1,121 @@
 # Plugins
 
-Dokku itself is built out of plugins and uses [pluginhook](https://github.com/progrium/pluginhook) for its plugin system. In essence a plugin is a collection of scripts that will be run based on naming convention.
+Dokku itself is built out of plugins and uses [plugn](https://github.com/dokku/plugn) for its plugin system. In essence a plugin is a collection of scripts that will be run based on naming convention.
 
 Let's take a quick look at the current dokku nginx plugin that's shipped with dokku by default.
 
     nginx-vhosts/
+    ├── plugin.toml  # plugin metadata
     ├── commands     # contains additional commands
     ├── install      # runs on dokku installation
     └── post-deploy  # runs after an app is deployed
 
 ## Installing a plugin
 
-```bash
+```shell
+# This command requires `root` permissions as the `install` and `install-dependencies`
+# plugin triggers may utilize commands such as `apt-get`. For non-core plugins, please
+# inspect those plugins before running the following command as `root` user.
+sudo dokku plugin:install <git_url> [--committish tag/branch/commit|--name custom-plugin-name]
+
+# previous versions (0.3.x and below) of dokku require a manual process to install plugins
 cd /var/lib/dokku/plugins
 git clone <git url>
 dokku plugins-install
 ```
 
-> todo: add a command to dokku to install a plugin, given a git repository `dokku plugin:install <git url>`?
-
 ## Creating your own plugin
 
-If you create your own plugin:
+[See the full documentation](/dokku/development/plugin-creation).
 
-1. take a look at the plugins shipped with dokku and hack away!
-2. upload your plugin to github with a repository name in form of `dokku-<name>` (e.g. `dokku-mariadb`)
-3. edit this page and add a link to it below!
-4. subscribe to the [dokku development blog](http://progrium.com) to be notified about API changes and releases
+## Official Plugins (Beta)
+
+The following plugins are available and provided by dokku maintainers. Where noted, these plugins should be considered beta software and may not have been used as thoroughly as community plugins. Please file issues against their respective issue trackers.
+
+| Plugin                                                                                            | Author                | Compatibility         |
+| ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
+| [CouchDB (beta)](https://github.com/dokku/dokku-couchdb)                                          | [dokku][]             | 0.4.0+                |
+| [Elasticsearch (beta)](https://github.com/dokku/dokku-elasticsearch-plugin)                       | [dokku][]             | 0.4.0+                |
+| [MariaDB (beta)](https://github.com/dokku/dokku-mariadb-plugin)                                   | [dokku][]             | 0.4.0+                |
+| [Memcached (beta)](https://github.com/dokku/dokku-memcached-plugin)                               | [dokku][]             | 0.4.0+                |
+| [Mongo (beta)](https://github.com/dokku/dokku-mongo-plugin)                                       | [dokku][]             | 0.4.0+                |
+| [MySQL (beta)](https://github.com/dokku/dokku-mysql-plugin)                                       | [dokku][]             | 0.4.0+                |
+| [Nats (beta)](https://github.com/dokku/dokku-nats)                                                | [dokku][]             | 0.4.0+                |
+| [Postgres (beta)](https://github.com/dokku/dokku-postgres-plugin)                                 | [dokku][]             | 0.4.0+                |
+| [RabbitMQ (beta)](https://github.com/dokku/dokku-rabbitmq-plugin)                                 | [dokku][]             | 0.4.0+                |
+| [Redis (beta)](https://github.com/dokku/dokku-redis-plugin)                                       | [dokku][]             | 0.4.0+                |
+| [RethinkDB (beta)](https://github.com/dokku/dokku-rethinkdb-plugin)                               | [dokku][]             | 0.4.0+                |
+| [Copy Files to Image](https://github.com/dokku/dokku-copyfiles-to-image)                          | [dokku][]             | 0.4.0+                |
+| [HTTP Auth (beta)](https://github.com/dokku/dokku-http-auth)                                      | [dokku][]             | 0.4.0+                |
+| [Let's Encrypt (beta)](https://github.com/dokku/dokku-letsencrypt)                                | [dokku][]             | 0.4.0+                |
+| [Maintenance mode (beta)](https://github.com/dokku/dokku-maintenance)                             | [dokku][]             | 0.4.0+                |
+| [Redirect (beta)](https://github.com/dokku/dokku-redirect)                                        | [dokku][]             | 0.4.0+                |
 
 ## Community plugins
 
 Note: The following plugins have been supplied by our community and may not have been tested by dokku maintainers.
 
-[agco-adm]: https://github.com/agco-adm
+[256dpi]: https://github.com/256dpi
+[abossard]: https://github.com/dudagroup
 [ademuk]: https://github.com/ademuk
+[agco-adm]: https://github.com/agco-adm
+[alessio]: https://github.com/alessio
 [alex-sherwin]: https://github.com/alex-sherwin
 [alexanderbeletsky]: https://github.com/alexanderbeletsky
+[alexkruegger]: https://github.com/alexkruegger
 [Aomitayo]: https://github.com/Aomitayo
 [apmorton]: https://github.com/apmorton
+[Benjamin-Dobell]: https://github.com/Benjamin-Dobell
+[basgys]: https://github.com/basgys
 [blag]: https://github.com/blag
 [cameron-martin]: https://github.com/cameron-martin
 [cedricziel]: https://github.com/cedricziel
 [cef]: https://github.com/cef
+[cjblomqvist]: https://github.com/cjblomqvist
 [darkpixel]: https://github.com/darkpixel
+[dokku]: https://github.com/dokku
 [dyson]: https://github.com/dyson
 [F4-Group]: https://github.com/F4-Group
 [fermuch]: https://github.com/fermuch
 [fgrehm]: https://github.com/fgrehm
+[Flink]: https://github.com/Flink
 [gdi2290]: https://github.com/gdi2290
 [heichblatt]: https://github.com/heichblatt
 [hughfletcher]: https://github.com/hughfletcher
+[iamale]: https://github.com/iamale
+[ignlg]: https://github.com/ignlg
 [iskandar]: https://github.com/iskandar
+[jagandecapri]: https://github.com/jagandecapri
 [jeffutter]: https://github.com/jeffutter
-[jezdez]: https://github.com/jezdez
 [jlachowski]: https://github.com/jlachowski
-[krisrang]: https://github.com/krisrang
 [Kloadut]: https://github.com/Kloadut
+[krisrang]: https://github.com/krisrang
 [luxifer]: https://github.com/luxifer
-[mlebkowski]: https://github.com/mlebkowski
+[Maciej Łebkowski]: https://github.com/mlebkowski
 [matto1990]: https://github.com/matto1990
+[mbriskar]: https://github.com/mbriskar
 [michaelshobbs]: https://github.com/michaelshobbs
 [mikecsh]: https://github.com/mikecsh
 [mikexstudios]: https://github.com/mikexstudios
+[mixxorz]: https://github.com/mixxorz
+[mlebkowski]: https://github.com/mlebkowski
 [motin]: https://github.com/motin
 [musicglue]: https://github.com/musicglue
 [neam]: https://github.com/neam
+[nickstenning]: https://github.com/nickstenning
 [nornagon]: https://github.com/nornagon
 [ohardy]: https://github.com/ohardy
 [pauldub]: https://github.com/pauldub
 [pnegahdar]: https://github.com/pnegahdar
 [RaceHub]: https://github.com/racehub
+[ribot]: https://github.com/ribot
 [rlaneve]: https://github.com/rlaneve
 [robv]: https://github.com/robv
 [scottatron]: https://github.com/scottatron
 [sehrope]: https://github.com/sehrope
+[sekjun9878]: https://github.com/sekjun9878
+[sgulseth]: https://github.com/sgulseth
+[sseemayer]: https://github.com/sseemayer
 [statianzo]: https://github.com/statianzo
 [stuartpb]: https://github.com/stuartpb
 [thrashr888]: https://github.com/thrashr888
@@ -86,43 +128,34 @@ Note: The following plugins have been supplied by our community and may not have
 
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
-| [MariaDB](https://github.com/Kloadut/dokku-md-plugin)                                             | [Kloadut][]           | Compatible with 0.2.0 |
-| [MariaDB (single container)](https://github.com/ohardy/dokku-mariadb)                             | [ohardy][]            | Compatible with 0.2.0 |
-| [MySQL](https://github.com/hughfletcher/dokku-mysql-plugin)                                       | [hughfletcher][]      |                       |
-| [PostgreSQL](https://github.com/Kloadut/dokku-pg-plugin)                                          | [Kloadut][]           | Compatible with 0.2.0 |
-| [PostgreSQL](https://github.com/jezdez/dokku-postgres-plugin)                                     | [jezdez][]            | Compatible with 0.2.0 |
-| [PostgreSQL](https://github.com/jlachowski/dokku-pg-plugin)                                       | [jlachowski][]        | IP & PORT available directly in linked app container env variables (requires link plugin)|
-| [PostgreSQL (single container)](https://github.com/jeffutter/dokku-postgresql-plugin)             | [jeffutter][]         | This plugin creates a single postgresql container that all your apps can use. Thus only one instance of postgresql running (good for servers without a ton of memory). |
-| [PostgreSQL (single container)](https://github.com/ohardy/dokku-psql)                             | [ohardy][]            | Compatible with 0.2.0 |
-| [PostGIS](https://github.com/fermuch/dokku-pg-plugin)                                             | [fermuch][]           |                       |
+| [MariaDB](https://github.com/Kloadut/dokku-md-plugin)                                             | [Kloadut][]           | 0.3.x                  |
+| [MariaDB (single container)](https://github.com/ohardy/dokku-mariadb)                             | [ohardy][]            | 0.3.x                  |
+| [MariaDB (single container)](https://github.com/krisrang/dokku-mariadb)                           | [krisrang][]          | 0.3.26+                |
+| [PostgreSQL](https://github.com/jlachowski/dokku-pg-plugin)                                       | [jlachowski][]         | 0.3.x                  |
+| [PostgreSQL (single container)](https://github.com/ohardy/dokku-psql)                             | [ohardy][]            | 0.3.x                  |
+| [PostgreSQL (single container)](https://github.com/Flink/dokku-psql-single-container)             | [Flink][]             | 0.3.26+                |
 
 #### Caching
 
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
-| [Memcached](https://github.com/jezdez/dokku-memcached-plugin)                                     | [jezdez][]            | Compatible with 0.2.0 |
-| [Memcached](https://github.com/jlachowski/dokku-memcached-plugin)                                 | [jlachowski][]        | IP & PORT available directly in linked app container env variables (requires link plugin)|
-| [Redis](https://github.com/jezdez/dokku-redis-plugin)                                             | [jezdez][]            | Requires https://github.com/rlaneve/dokku-link; compatible with 0.2.0 |
-| [Redis](https://github.com/luxifer/dokku-redis-plugin)                                            | [luxifer][]           |                       |
-| [Redis (single container)](https://github.com/ohardy/dokku-redis)                                 | [ohardy][]            | Compatible with 0.2.0 |
+| [Redis](https://github.com/sekjun9878/dokku-redis-plugin)                                         | [sekjun9878][]         | 0.3.26+                |
+| [Redis (single container)](https://github.com/ohardy/dokku-redis)                                 | [ohardy][]            | 0.3.x                  |
 | [Varnish](https://github.com/Zenedith/dokku-varnish-plugin)                                       | [Zenedith][]          | Varnish cache between nginx and application with base configuration|
 
 #### Queuing
 
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
-| [RabbitMQ](https://github.com/jlachowski/dokku-rabbitmq-plugin)                                   | [jlachowski][]        | IP & PORT available directly in linked app container env variables (requires link plugin)|
-| [RabbitMQ (single container)](https://github.com/jlachowski/dokku-rabbitmq-single-plugin)         | [jlachowski][]        | IP & PORT available directly in linked app container env variables (requires link plugin)|
+| [RabbitMQ](https://github.com/jlachowski/dokku-rabbitmq-plugin)                                   | [jlachowski][]        | 0.3.x                 |
+| [RabbitMQ (single container)](https://github.com/jlachowski/dokku-rabbitmq-single-plugin)         | [jlachowski][]        | 0.3.x                 |
 
 #### Other
 
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
-| [CouchDB](https://github.com/racehub/dokku-couchdb-plugin)                                        | [RaceHub][]           | 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][]) |
-| [Neo4j](https://github.com/Aomitayo/dokku-neo4j-plugin)                                           | [Aomitayo][]          |                       |
+| [etcd](https://github.com/basgys/dokku-etcd)                                                      | [basgys][]            | 0.4.x                  |
+| [RethinkDB](https://github.com/stuartpb/dokku-rethinkdb-plugin)                                   | [stuartpb][]          | 0.3.x                  |
 
 [dccee02]: https://github.com/jeffutter/dokku-riakcs-plugin/commit/dccee02702e7001851917b7814e78a99148fb709
 
@@ -131,77 +164,122 @@ Note: The following plugins have been supplied by our community and may not have
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
 | [Circus](https://github.com/apmorton/dokku-circus)                                                | [apmorton][]          |                       |
-| [Shoreman ](https://github.com/statianzo/dokku-shoreman)                                          | [statianzo][]         | Compatible with 0.2.0 |
-| [Supervisord](https://github.com/statianzo/dokku-supervisord)                                     | [statianzo][]         | Compatible with 0.2.0 |
-| [Logging Supervisord](https://github.com/sehrope/dokku-logging-supervisord)                       | [sehrope][]           | Works with dokku @ [c77cbf1][] - no 0.2.0 compatibility |
 | [Forego](https://github.com/iskandar/dokku-forego)                                                | [iskandar][]          | Compatible with 0.2.x |
+| [Forego](https://github.com/Flink/dokku-forego)                                                   | [Flink][]             | 0.4.0+                |
+| [Logging Supervisord](https://github.com/sehrope/dokku-logging-supervisord)                       | [sehrope][]           | 0.4.0+                |
+| [Monit](https://github.com/cjblomqvist/dokku-monit)                                               | [cjblomqvist][]       | 0.3.x                 |
+| [Shoreman ](https://github.com/statianzo/dokku-shoreman)                                          | [statianzo][]         | 0.3.x                 |
+| [Supervisord](https://github.com/statianzo/dokku-supervisord)                                     | [statianzo][]         | 0.3.x                 |
 
-[c77cbf1]: https://github.com/progrium/dokku/commit/c77cbf1d3ae07f0eafb85082ed7edcae9e836147
-[28de3ec]: https://github.com/progrium/dokku/commit/28de3ecaa3231a223f83fd8d03f373308673bc40
+[c77cbf1]: https://github.com/dokku/dokku/commit/c77cbf1d3ae07f0eafb85082ed7edcae9e836147
+[28de3ec]: https://github.com/dokku/dokku/commit/28de3ecaa3231a223f83fd8d03f373308673bc40
 
 ### Dokku Features
 
 | 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][]        |                       |
+| [App name as env](https://github.com/cjblomqvist/dokku-app-name-env)                              | [cjblomqvist][]       | 0.3.x                 |
 | [Docker Direct](https://github.com/heichblatt/dokku-docker-direct)                                | [heichblatt][]        |                       |
-| [Docker Options](https://github.com/dyson/dokku-docker-options)                                   | [dyson][]             | dokku >= [c77cbf1][]  |
+| [Dokku Copy App Config Files](https://github.com/alexkruegger/dokku-app-configfiles)              | [alexkruegger][]      | Compatible with 0.3.17+ |
+| [Dokku Copy App Config Files](https://github.com/heichblatt/dokku-supply-config)                  | [heichblatt][]        |                       |
 | [Dokku Name](https://github.com/alex-sherwin/dokku-name)                                          | [alex-sherwin][]      | dokku >= [c77cbf1][]  |
-| [Dokku Registry](https://github.com/agco-adm/dokku-registry)                                      | [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][]  |
+| [Dokku Registry](https://github.com/agco-adm/dokku-registry)<sup>1</sup>                          | [agco-adm][]          | 0.4.0+                |
+| [git rev-parse HEAD in env](https://github.com/cjblomqvist/dokku-git-rev)                         | [cjblomqvist][]       | 0.4.0+                |
+| [Graduate (Environment Management)](https://github.com/glassechidna/dokku-graduate)               | [Benjamin-Dobell][]   | 0.3.14+               |
+| [Haproxy tcp load balancer](https://github.com/256dpi/dokku-haproxy)                              | [256dpi][]            | 0.4.0+                |
+| [HTTP Auth Secure Apps](https://github.com/matto1990/dokku-secure-apps)                           | [matto1990][]         | 0.4.0+                |
+| [Hostname](https://github.com/michaelshobbs/dokku-hostname)                                       | [michaelshobbs][]     | 0.4.0+                |
 | [Multi-Buildpack](https://github.com/pauldub/dokku-multi-buildpack)                               | [pauldub][]           |                       |
-| [Multiple Domains](https://github.com/wmluke/dokku-domains-plugin)<sup>4</sup>                    | [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)<sup>2</sup>            | [cedricziel][]        | 2014-01-17: compatible with upstream/master |
-| [SSH Hostkeys](https://github.com/cedricziel/dokku-hostkeys-plugin)<sup>3</sup>                   | [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     |
-| [user-env-compile](https://github.com/musicglue/dokku-user-env-compile)<sup>1</sup>               | [musicglue][]         | Compatible with dokku master branch |
-| [user-env-compile](https://github.com/motin/dokku-user-env-compile)<sup>1</sup>                   | [motin][]             | Compatible with 0.2.1 |
-| [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 |
+| [Nuke Containers](https://github.com/heichblatt/dokku-nuke)                                       | [heichblatt][]        |                       |
+| [Open App Ports](https://github.com/heichblatt/dokku-ports)                                       | [heichblatt][]        |                       |
+| [Pre-Deploy Tasks](https://github.com/michaelshobbs/dokku-app-predeploy-tasks)                    | [michaelshobbs][]     | 0.4.0+                |
+| [SSH Deployment Keys](https://github.com/cedricziel/dokku-deployment-keys)<sup>2</sup>            | [cedricziel][]        | 0.3.x                 |
+| [SSH Hostkeys](https://github.com/cedricziel/dokku-hostkeys-plugin)<sup>3</sup>                   | [cedricziel][]        | 0.3.x                 |
+| [Volume (persistent storage)](https://github.com/ohardy/dokku-volume)                             | [ohardy][]            | 0.3.x                 |
 
-[8fca220]: https://github.com/progrium/dokku/commit/8fca2204edb0017796d6915ca9157c05b1238e28
-[217d00a]: https://github.com/progrium/dokku/commit/217d00a1bc47a7e24d8847617bb08a1633025fc7
-[98332de]: https://github.com/dyson/dokku-persistent-storage/commit/98332de4b5b640610bee535f4d5260263074e18b
-[a043e98]: https://github.com/stuartpb/dokku-bind-port/commit/a043e9892f4815b6525c850131e09fd64db5c1fa
+[217d00a]: https://github.com/dokku/dokku/commit/217d00a1bc47a7e24d8847617bb08a1633025fc7
 
-<sup>1</sup> Similar to the heroku-labs feature (see https://devcenter.heroku.com/articles/labs-user-env-compile)
+<sup>1</sup> 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)
 
 <sup>2</sup> Adds the possibility to add SSH deployment keys to receive private hosted packages
 
 <sup>3</sup> Adds the ability to add custom hosts to the containers known_hosts file to be able to ssh them easily (useful with deployment keys)
 
-<sup>4</sup> Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration)
-
-<sup>5</sup> 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         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
-| [Node](https://github.com/pnegahdar/dokku-node)                                                   | [pnegahdar][]         |                       |
-| [Node](https://github.com/ademuk/dokku-nodejs)                                                    | [ademuk][]            |                       |
+| [Airbrake deploy](https://github.com/Flink/dokku-airbrake-deploy)                                 | [Flink][]             | 0.4.0+                |
+| [APT](https://github.com/F4-Group/dokku-apt)                                                      | [F4-Group][]          | 0.2.0+ (tag 0.2.0), 0.3.0+ (tag 0.3.0), 0.4.0+ |
 | [Chef cookbooks](https://github.com/fgrehm/chef-dokku)                                            | [fgrehm][]            |                       |
 | [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][]              |                       |
-| [Elasticsearch](https://github.com/jezdez/dokku-elasticsearch-plugin)                             | [jezdez][]            | Compatible with 0.2.0 |
-| [Elasticsearch](https://github.com/blag/dokku-elasticsearch-plugin)<sup>1</sup>                   | [blag][]              | Compatible with 0.2.0 |
+| [Bower/Gulp](https://github.com/jagandecapri/dokku-bower-gulp-build-plugin)                       | [jagandecapri][]      |                       |
+| [Builders: bower, compass, gulp, grunt](https://github.com/ignlg/dokku-builders-plugin)           | [ignlg][]             | 0.4.0+                |
+| [Docker auto persist volumes](https://github.com/Flink/dokku-docker-auto-volumes)                 | [Flink][]             | 0.4.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][]          |                       |
-| [User ACL](https://github.com/mlebkowski/dokku-acl)                                               | [Maciej Łebkowski][]  |                       |
-| [PrimeCache](https://github.com/darkpixel/dokku-prime-cache)                                      | [darkpixel][]         |                       |
+| [Graphite/statsd](https://github.com/jlachowski/dokku-graphite-plugin)                            | [jlachowski]          | <0.4.0                |
+| [Graphite/statsd](https://github.com/jlachowski/dokku-graphite-grafana)                           | [jlachowski]          | 0.4.0+, graphite & statsd plugin with grafana dashboard frontend  |
+| [Logspout](https://github.com/michaelshobbs/dokku-logspout)                                       | [michaelshobbs][]     | 0.3.26+               |
+| [Monorepo](https://github.com/iamale/dokku-monorepo)                                              | [iamale][]            | 0.4.0+               |
+| [Node](https://github.com/pnegahdar/dokku-node)                                                   | [pnegahdar][]         |                       |
+| [Node](https://github.com/ademuk/dokku-nodejs)                                                    | [ademuk][]            |                       |
+| [Reset mtime](https://github.com/mixxorz/dokku-docker-reset-mtime)                                | [mixxorz][]           | 0.3.15+, Dockerfile support |
+| [Slack Notifications](https://github.com/ribot/dokku-slack)                                       | [ribot][]             | 0.4.0+                |
+| [User ACL](https://github.com/mlebkowski/dokku-acl)                                               | [Maciej Łebkowski][]  | 0.4.0+                |
+| [Webhooks](https://github.com/nickstenning/dokku-webhooks)                                        | [nickstenning][]      |                       |
+| [Wkhtmltopdf](https://github.com/mbriskar/dokku-wkhtmltopdf)                                      | [mbriskar][]          |                       |
+| [Wordpress](https://github.com/dudagroup/dokku-wordpress-template)                                | [abossard][]          | Dokku dev, mariadb, volume, domains |
 
 <sup>1</sup> 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)          |
+| [Docker Options](https://github.com/dyson/dokku-docker-options)                                   | [dyson][]             | v0.3.17 (docker-options plugin) |
+| [Events Logger](https://github.com/alessio/dokku-events)                                          | [alessio][]           | v0.3.21 (events plugin)         |
+| [Host Port binding](https://github.com/stuartpb/dokku-bind-port)                                  | [stuartpb][]          | v0.3.17 (docker-options plugin) |
+| [List Containers](https://github.com/heichblatt/dokku-list)                                       | [heichblatt][]        | v0.3.14 (ps plugin              |
+| [Link Containers](https://github.com/rlaneve/dokku-link)                                          | [rlaneve][]           | v0.3.17 (docker-options plugin) |
+| [Multiple Domains](https://github.com/wmluke/dokku-domains-plugin)<sup>1</sup>                    | [wmluke][]            | v0.3.10 (domains plugin)        |
+| [Named-containers](https://github.com/Flink/dokku-named-containers)                               | [Flink][]             | v0.4.2 (named-containers plugin) |
+| [Nginx-Alt](https://github.com/mikexstudios/dokku-nginx-alt)                                      | [mikexstudios][]      | v0.3.10 (domains plugin)        |
+| [Persistent Storage](https://github.com/dyson/dokku-persistent-storage)                           | [dyson][]             | v0.3.17 (docker-options plugin) |
+| [PrimeCache](https://github.com/darkpixel/dokku-prime-cache)                                      | [darkpixel][]         | v0.3.0 (zero downtime deploys)  |
+| [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)<sup>2</sup>    | [cameron-martin][]    | v0.3.9 (build-env plugin)       |
+| [user-env-compile](https://github.com/musicglue/dokku-user-env-compile)<sup>2</sup>               | [musicglue][]         | v0.3.9 (build-env plugin)       |
+| [user-env-compile](https://github.com/motin/dokku-user-env-compile)<sup>2</sup>                   | [motin][]             | v0.3.9 (build-env plugin)       |
+| [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration)    | [motin][]             | v0.3.10 (domains plugin)        |
+
+<sup>1</sup> Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration)
+<sup>2</sup> Similar to the heroku-labs feature (see https://devcenter.heroku.com/articles/labs-user-env-compile)
+
+[a043e98]: https://github.com/stuartpb/dokku-bind-port/commit/a043e9892f4815b6525c850131e09fd64db5c1fa
+
+
+### Unmaintained Plugins
+
+The following plugins are no longer maintained by their developers.
+
+| Plugin                                                                                            | Author                | Compatibility         |
+| ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
+| [app-url](https://github.com/mikecsh/dokku-app-url)                                               | [mikecsh][]           | Works with 0.2.0      |
+| [CouchDB (multi containers)](https://github.com/Flink/dokku-couchdb-multi-containers)             | [Flink][]             | 0.4.0+                |
+| [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/blag/dokku-elasticsearch-plugin)<sup>1</sup>                   | [blag][]              | Compatible with 0.2.0 |
+| [Memcached](https://github.com/Flink/dokku-memcached-plugin)                                      | [Flink][]             | 0.4.0+                |
+| [MongoDB (single container)](https://github.com/jeffutter/dokku-mongodb-plugin)                   | [jeffutter][]         |                       |
+| [MySQL](https://github.com/hughfletcher/dokku-mysql-plugin)                                       | [hughfletcher][]      |                       |
+| [Neo4j](https://github.com/Aomitayo/dokku-neo4j-plugin)                                           | [Aomitayo][]          |                       |
+| [PostGIS](https://github.com/fermuch/dokku-pg-plugin)                                             | [fermuch][]           |                       |
+| [PostgreSQL (single container)](https://github.com/jeffutter/dokku-postgresql-plugin)             | [jeffutter][]         | This plugin creates a single postgresql container that all your apps can use. Thus only one instance of postgresql running (good for servers without a ton of memory). |
+| [RiakCS (single container)](https://github.com/jeffutter/dokku-riakcs-plugin)                     | [jeffutter][]         | Incompatible with 0.2.0 (checked at [dccee02][]) |
+| [Redis](https://github.com/luxifer/dokku-redis-plugin)                                            | [luxifer][]           |                       |

docs/process-management.md

@@ -0,0 +1,45 @@
+# Process/Container management
+
+> New as of 0.3.14
+
+Dokku supports rudimentary process (really container) management via the `ps` plugin.
+
+```
+ps <app>                                         List processes running in app container(s)
+ps:rebuildall                                    Rebuild all apps
+ps:rebuild <app>                                 Rebuild an app
+ps:restartall                                    Restart all deployed app containers
+ps:restart <app>                                 Restart app container(s)
+ps:scale <app> <proc>=<count> [<proc>=<count>]   Set how many processes of a given process to run
+ps:start <app>                                   Start app container(s)
+ps:stop <app>                                    Stop app container(s)
+```
+
+## Scaling
+
+Dokku allows you to run multiple process types at different container counts. For example, if you had an app that contained 1 web app listener and 1 background job processor, dokku can, spin up 1 container for each process type defined in the Procfile. *By default, dokku will only start a single web process (if defined.)* However, if you wanted, for example, 2 job processors running simultaneously, you can modify this behavior in one of the following ways.
+
+### DOKKU_SCALE file
+
+You can optionally create a `DOKKU_SCALE` file in the root of your repository. Dokku expects this file to contain one line for every process defined in your Procfile.
+
+Example:
+```
+web=1
+worker=2
+```
+
+### `ps:scale` command
+
+Dokku can also manage scaling itself via the `ps:scale` command. This command can be used to scale multiple process types at the same time.
+
+```
+dokku ps:scale app_name web=1 worker=2
+```
+
+*NOTE*: Dokku will always use the DOKKU_SCALE file that ships with the repo to override any local settings.
+
+
+## The web proctype
+
+Like Heroku, we handle the `web` proctype differently from others. The `web` proctype is the only proctype that will invoke custom checks as defined by a CHECKS file. It is also the only proctype that will be launched in a container that is either proxied via nginx or bound to an external port.

docs/proxy.md

@@ -0,0 +1,30 @@
+# Proxy plugin
+
+> New as of 0.5.0
+
+As of dokku 0.5.0, the proxy functionality has been decoupled from the nginx-vhosts plugin into the proxy plugin. In the future this will allow other proxy software (HAproxy for example) to be used instead of nginx.
+
+```
+proxy:disable <app>                                                                          Disable proxy for app
+proxy:enable <app>                                                                           Enable proxy for app
+proxy:set <app> <proxy_type>                                                                 NOT IMPLEMENTED YET!!
+```
+
+## Container network interface binding
+
+By default, the deployed docker container running your app's web process will bind to the internal docker network interface (i.e. `docker inspect --format '{{ .NetworkSettings.IPAddress }}' $CONTAINER_ID`). This behavior can be modified per app by disabling the proxy (i.e. `dokku proxy:disable <app>`). In this case, the container will bind to an external interface (i.e. 0.0.0.0) and your app container will be directly accessible by other hosts on your network.
+
+```shell
+# container bound to docker interface
+root@dokku:~/dokku# docker ps
+CONTAINER ID        IMAGE                      COMMAND                CREATED              STATUS              PORTS               NAMES
+1b88d8aec3d1        dokku/node-js-app:latest   "/bin/bash -c '/star   About a minute ago   Up About a minute                       node-js-app.web.1
+
+root@dokku:~/dokku# docker inspect --format '{{ .NetworkSettings.IPAddress }}' node-js-app.web.1
+172.17.0.6
+
+# container bound to all interfaces
+root@dokku:/home/dokku# docker ps
+CONTAINER ID        IMAGE                      COMMAND                CREATED              STATUS              PORTS                     NAMES
+d6499edb0edb        dokku/node-js-app:latest   "/bin/bash -c '/star   About a minute ago   Up About a minute   0.0.0.0:49153->5000/tcp   node-js-app.web.1
+```

docs/remote-commands.md

@@ -1,19 +1,28 @@
-# Remote commands
+# Remote Commands
 
-Dokku commands can be run over ssh. Anywhere you would run `dokku <command>`, just run `ssh -t dokku@progriumapp.com <command>`
+Dokku commands can be run over ssh. Anywhere you would run `dokku <command>`, just run `ssh -t dokku@dokku.me <command>`
 The `-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 progriumapp.com
+Host dokku.me
 RequestTTY yes
 ```
 
-## Run a command in the app environment
+## Behavioral modifiers
 
-It's possible to run commands in the environment of the deployed application:
+Dokku also supports certain command-line arguments that augment it's behavior. If using these over ssh, you must use the form `ssh -t dokku@dokku.me -- <command>`
+in order to avoid ssh interpretting dokku arguments for itself.
 
-```bash
-dokku run node-js-app ls -alh
-dokku run <app> <cmd>
+```shell
+--quiet                suppress output headers
+--trace                enable DOKKU_TRACE for current execution only
+--rm|--rm-container    remove docker container after successful dokku run <app> <command>
+--force                force flag. currently used in apps:destroy and other ":destroy" commands
 ```
+
+## Clients
+
+You may optionally use a client to connect to your dokku server. Most clients use the configured `git remote` to locate the dokku server, though some allow for overriding this via an environment variable or flag.
+
+Please refer to the [clients](/dokku/community/clients/) list for more details.