Release 0.24.4

# History

## 0.24.4

Install/update via the bootstrap script:

```shell
wget https://raw.githubusercontent.com/dokku/dokku/v0.24.4/bootstrap.sh
sudo DOKKU_TAG=v0.24.4 bash bootstrap.sh
```

### Bug Fixes

- #4526: @josegonzalez Do not cut off builder arguments that have a 'v-' substring
- #4523: @josegonzalez Ignore set pipefail errors when DOKKU_SHELL is set to sh
- #4516: @josegonzalez Properly handle letsencrypt certs in certs:report output
- #4510: @josegonzalez Reformat existing buildpacks files

### New Features

- #4525: @josegonzalez Update error for git:from- commands when the artifact is already synced
- #4524: @josegonzalez Allow skipping entrypoint detection if entrypoint is tini

### Documentation

- #4531: @elamje Update config command to config:show
- #4528: @grantjenks Fix typo in persistent storage docs
- #4530: @Tobbe deployment docs: fix letsencrypt plugin name
- #4517: @illgitthat Update README with correct link to docs
- #4513: @josegonzalez Add a note on ssl and letsencrypt usage to the setup docs
- #4511: @josegonzalez Document removal of nginx site-enabled files for first time installers
- #4506: @josegonzalez Add full example for custom nginx log format
- #4504: @josegonzalez Clarify permissions on persistent storage paths
- #4503: @josegonzalez Drop dead newsletter link

### Other

- #4540: @dependabot-preview[bot] chore(deps): bump github.com/golang/protobuf from 1.5.1 to 1.5.2 in /tests/apps/gogrpc
- #4535: @dependabot-preview[bot] chore(deps): bump gunicorn from 20.0.4 to 20.1.0 in /tests/apps/multi
- #4536: @dependabot-preview[bot] chore(deps): bump jetty-servlet from 11.0.1 to 11.0.2 in /tests/apps/java
- #4537: @dependabot-preview[bot] chore(deps): bump gunicorn from 20.0.4 to 20.1.0 in /tests/apps/python-flask
- #4527: @Cellane Remove all traces of dokku-update

.circleci/config.yml

@@ -0,0 +1,14 @@
+---
+version: 2.1
+
+jobs:
+  noop:
+    docker:
+      - image: cimg/base:2020.01
+    steps:
+      - run: echo "this is a noop"
+
+workflows:
+  noop:
+    jobs:
+      - noop

.codacy.yml

@@ -0,0 +1,6 @@
+---
+exclude_paths:
+  - vendor/**/*
+  - tests/**/*
+  - "**_test.go"
+  - contrib/*

.dockerignore

@@ -0,0 +1,14 @@
+*Dockerfile
+.dockerignore
+.git
+.vagrant
+contrib
+build
+docs
+tests
+!build/dokku.deb
+!tests/dhparam.pem
+!contrib/dokku-installer.py
+!contrib/bash-completion
+!contrib/docker
+vendor

.editorconfig

@@ -14,3 +14,8 @@ indent_size = 4
 insert_final_newline = true
 indent_style = tab
 indent_size = 4
+
+[*.go]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4

.github/commands/bump-azure

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+main() {
+  declare VERSION="$1" BOT_GITHUB_USERNAME="$2" BOT_GITHUB_API_TOKEN="$3"
+  local GH_VERSION=1.6.1
+  local DATE_UPDATED="$(date +"%Y-%m-%d")"
+  local GH_FOLDER="gh_${GH_VERSION}_linux_amd64"
+
+  echo "=====> Downloading gh"
+  wget -O gh.tar.gz "https://github.com/cli/cli/releases/download/v${GH_VERSION}/${GH_FOLDER}.tar.gz"
+  mkdir -p tmp
+  tar xzf gh.tar.gz -C tmp
+  if [[ ! -f tmp/$GH_FOLDER/bin/gh ]]; then
+    echo "Failed to extract gh"
+    return 1
+  fi
+
+  cd tmp
+
+  $GH_FOLDER/bin/gh auth login --with-token <<<"$BOT_GITHUB_API_TOKEN"
+
+  echo "=====> Cloning quickstart templates"
+  rm -rf azure-quickstart-templates >/dev/null
+  git clone https://github.com/Azure/azure-quickstart-templates.git azure-quickstart-templates
+
+  pushd azure-quickstart-templates >/dev/null
+
+  echo "=====> Updating values"
+  contents="$(jq '.githubUsername = "dokku"' dokku-vm/metadata.json)"
+  echo "${contents}" >dokku-vm/metadata.json
+  contents="$(jq --arg DATE_UPDATED "$DATE_UPDATED" '.dateUpdated = $DATE_UPDATED' dokku-vm/metadata.json)"
+  echo "${contents}" >dokku-vm/metadata.json
+
+  contents="$(jq --arg VERSION "$VERSION" '.parameters.dokkuVersion.defaultValue = $VERSION' dokku-vm/azuredeploy.json)"
+  echo "${contents}" >dokku-vm/azuredeploy.json
+
+  echo "=====> Updating remote repository"
+  git add dokku-vm
+  git checkout -b dokku-$VERSION
+  git commit -m "Update dokku-vm dokku version to $VERSION"
+  git remote set-url origin "https://$BOT_GITHUB_USERNAME:$BOT_GITHUB_API_TOKEN@github.com/dokku/azure-quickstart-templates.git"
+  git push -f origin dokku-$VERSION
+
+  echo "=====> Creating upstream pull request"
+  ../$GH_FOLDER/bin/gh pr create --head dokku:dokku-$VERSION --repo Azure/azure-quickstart-templates --title "Update dokku-vm dokku version to $VERSION" --body ''
+
+  popd &>/dev/null
+}
+
+main "$@"

.github/commands/ci-run

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+main() {
+  declare FILE_NAME="$1"
+
+  mkdir -p test-results/bats
+  pushd tests/unit >/dev/null
+  bats --report-formatter junit --output ../../test-results/bats "$FILE_NAME.bats"
+  popd &>/dev/null
+
+  ls -lah test-results/bats
+}
+
+main "$@"

.github/commands/ci-setup

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+echo "=====> set hostname"
+hostname
+internal_ip="$(ifconfig eth0 | grep 'inet addr:' | cut -d: -f2 | awk '{ print $1}')"
+sudo hostname "dokku.me"
+echo "dokku.me" | sudo tee /etc/hostname
+hostname
+sudo cat /etc/hostname
+
+echo "=====> resolve dokku.me"
+sudo apt -qq -y --no-install-recommends install net-tools
+# dokku.me now resolves to 10.0.0.2. add 10.0.0.2/24 to eth0
+ifconfig
+sudo ip addr add 10.0.0.2/24 broadcast 10.0.0.255 dev eth0
+
+echo "=====> install ci-dependencies"
+make ci-dependencies
+
+echo "=====> setup tests"
+./tests/ci/setup.sh
+
+echo "=====> dokku cleanup:skip"
+echo 'export DOKKU_SKIP_CLEANUP=true' | sudo tee /home/dokku/.dokkurc/dokku_skip_cleanup
+
+echo "=====> dokku report"
+dokku report

.github/commands/matrix

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+import json
+import os
+
+keys = ["index"]
+values = [[s.replace(".bats", "") for s in os.listdir("tests/unit/") if s.endswith(".bats")]]
+zi = zip(keys, values)
+data = json.dumps(dict(zi))
+print(data.replace(" ", ""))

.github/linters/.markdown-lint.yml

@@ -0,0 +1,10 @@
+---
+default: true
+
+# Line length
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013
+MD013: false
+
+# Inline HTML
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
+MD033: false

.github/linters/.yamllint.yml

@@ -0,0 +1,5 @@
+---
+extends: default
+
+rules:
+  line-length: disable

.github/workflows/ci.yml

@@ -0,0 +1,162 @@
+---
+name: CI
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-16.04
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    strategy:
+      fail-fast: true
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: build package
+        run: ./tests/ci/setup.sh build
+
+      - name: set matrix for build
+        id: set-matrix
+        run: |
+          json=$(python .github/commands/matrix)
+          echo $json
+          echo "::set-output name=matrix::$(echo "$json")"
+
+      - name: upload packages
+        uses: actions/upload-artifact@v2
+        with:
+          name: build
+          path: build
+
+  unit-tests:
+    name: unit.${{ matrix.index }}
+    needs: build
+    runs-on: ubuntu-16.04
+    strategy:
+      fail-fast: false
+      matrix: ${{fromJson(needs.build.outputs.matrix)}}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: download packages
+        uses: actions/download-artifact@v1
+        with:
+          name: build
+
+      - name: ci-setup
+        run: ./.github/commands/ci-setup
+
+      # - name: start ssh session
+      #   uses: luchihoratiu/debug-via-ssh@main
+      #   with:
+      #     NGROK_AUTH_TOKEN: ${{ secrets.NGROK_AUTH_TOKEN }}
+      #     SSH_PASS: ${{ secrets.SSH_PASS }}
+
+      - name: run ci
+        timeout-minutes: 30
+        run: sudo -E ./.github/commands/ci-run ${{ matrix.index }}
+        env:
+          SYNC_GITHUB_PASSWORD: ${{ secrets.SYNC_GITHUB_PASSWORD }}
+          SYNC_GITHUB_USERNAME: ${{ secrets.SYNC_GITHUB_USERNAME }}
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: test-results-${{ matrix.index }}
+          path: test-results
+
+  docker-deploy-tests:
+    name: docker
+    needs: build
+    runs-on: ubuntu-16.04
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: download packages
+        uses: actions/download-artifact@v1
+        with:
+          name: build
+
+      - name: ci-setup
+        run: ./.github/commands/ci-setup
+
+      - name: test docker deploys
+        shell: bash
+        timeout-minutes: 20
+        run: |
+          ./tests/ci/setup.sh docker
+          DOKKU_SSH_PORT=3022 sudo -E make -e test-ci-docker
+
+  go-tests:
+    name: go.${{ matrix.index }}
+    needs: build
+    runs-on: ubuntu-16.04
+    strategy:
+      fail-fast: false
+      matrix:
+        index: [0, 1, 2, 3]
+    env:
+      GITHUB_NODE_INDEX: ${{ matrix.index }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: download packages
+        uses: actions/download-artifact@v1
+        with:
+          name: build
+
+      - name: ci-setup
+        run: ./.github/commands/ci-setup
+
+      - name: run go tests
+        run: |
+          export CIRCLE_SHA1=$GITHUB_SHA
+          echo "CODACY_TOKEN=$CODACY_TOKEN"
+          if [ "$CODACY_TOKEN" != "" ]; then
+            echo "Detected value for CODACY_TOKEN"
+          fi
+          case $GITHUB_NODE_INDEX in
+            0) sudo -E make -e lint-ci go-tests ci-go-coverage ;;
+            1) sudo -E make -e deploy-test-checks-root deploy-test-config ;;
+            2) sudo -E make -e deploy-test-multi ;;
+            3) sudo -E make -e deploy-test-go-fail-predeploy deploy-test-go-fail-postdeploy ;;
+          esac
+      - uses: actions/upload-artifact@v2
+        with:
+          name: coverage.${{ matrix.index }}
+          path: test-results/coverage
+
+  publish-test-results:
+    name: publish-test-results
+    needs: unit-tests
+    runs-on: ubuntu-16.04
+    # the build-and-test job might be skipped, we don't need to run this job then
+    if: success() || failure()
+
+    steps:
+      - name: download test-results
+        uses: actions/download-artifact@v2
+        with:
+          path: test-results
+
+      - name: Publish Unit Test Results
+        uses: docker://ghcr.io/enricomi/publish-unit-test-result-action:v1.6
+        with:
+          check_name: Unit Test Results
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          files: test-results/**/*.xml
+          comment_on_pr: false

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+---
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+# ******** NOTE ********
+
+name: "CodeQL"
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: '18 22 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['go']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      # - run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/lint.yml

@@ -0,0 +1,74 @@
+---
+name: 'lint'
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  hadolint:
+    name: hadolint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+      - name: Run hadolint
+        uses: brpaz/hadolint-action@1623ba61710b974b55ba455930e6f2c8ef919778
+        # v1.3.1 => 1623ba61710b974b55ba455930e6f2c8ef919778
+
+  markdown-lint:
+    name: markdown-lint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+      - name: Run markdown-lint
+        uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb
+        # v1.5.0 => 04d43ee9191307b50935a753da3b775ab695eceb
+        with:
+          config: '.github/linters/.markdown-lint.yml'
+          args: './README.md'
+
+  shellcheck:
+    name: shellcheck
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+      - name: Run shellcheck
+        uses: ludeeus/action-shellcheck@d586102c117f97e63d7e3b56629d269efc9a7c60
+        # 1.0.0 => d586102c117f97e63d7e3b56629d269efc9a7c60
+        env:
+          # keep in sync with tests/shellcheck-exclude
+          SHELLCHECK_OPTS: -e SC1001 -e SC1003 -e SC1090 -e SC1091 -e SC1117 -e SC2029 -e SC2034 -e SC2046 -e SC2064 -e SC2068 -e SC2086 -e SC2119 -e SC2120 -e SC2128 -e SC2148 -e SC2153 -e SC2154 -e SC2155 -e SC2162 -e SC2174 -e SC2179 -e SC2191 -e SC2199 -e SC2207 -e SC2219 -e SC2220 -e SC2230 -e SC2231 -e SC2235
+
+  shfmt:
+    name: shfmt
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+      - name: Run shfmt
+        uses: luizm/action-sh-checker@442951059cb22d260c6e69309ae59cb7bb2334b8
+        # v0.1.12 => 442951059cb22d260c6e69309ae59cb7bb2334b8
+        env:
+          SHFMT_OPTS: -l -bn -ci -i 2 -d
+        with:
+          sh_checker_shellcheck_disable: true
+
+  yamllint:
+    name: yamllint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+      - name: Run yamllint
+        uses: ibiqlik/action-yamllint@b2aeacc1b7eeb8c23e84bba320d04fb5d6a323ee
+        # v3.0.0 => b2aeacc1b7eeb8c23e84bba320d04fb5d6a323ee
+        with:
+          config_file: '.github/linters/.yamllint.yml'

.github/workflows/release.yml

@@ -0,0 +1,87 @@
+---
+name: 'release'
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: 'Release type [build, betafish, patch, minor, major]'
+        required: true
+        default: 'build'
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-20.04
+    env:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: install package_cloud
+        run: gem install package_cloud
+
+      - name: configure git
+        run: |
+          git config --global user.name 'Dokku Bot'
+          git config --global user.email no-reply@dokku.com
+
+      - name: build package
+        run: contrib/release-dokku ${{ github.event.inputs.release_type }}
+
+      - name: output version
+        id: version
+        run: echo "::set-output name=version::$(cat build/next-version)"
+
+      - name: upload packages
+        uses: actions/upload-artifact@v2
+        with:
+          name: build
+          path: build
+
+  bump-azure:
+    name: bump-azure
+    runs-on: ubuntu-20.04
+    needs: release
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Bump Azure Template
+        env:
+          BOT_GITHUB_USERNAME: ${{ secrets.HOMEBREW_GITHUB_USERNAME }}
+          BOT_GITHUB_API_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }}
+        run: |
+          VERSION=${{ needs.release.outputs.version }}
+          git config --global user.name 'Dokku Bot'
+          git config --global user.email no-reply@dokku.com
+          .github/commands/bump-azure "${VERSION:1}" "$BOT_GITHUB_USERNAME" "$BOT_GITHUB_API_TOKEN"
+
+  bump-formula:
+    name: bump-formula
+    runs-on: macos-latest
+    needs: release
+    steps:
+      - name: Bump Homebrew Formula
+        env:
+          HOMEBREW_GITHUB_USERNAME: ${{ secrets.HOMEBREW_GITHUB_USERNAME }}
+          HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }}
+        run: |
+          git config --global user.name 'Dokku Bot'
+          git config --global user.email no-reply@dokku.com
+          brew tap dokku/repo "https://$HOMEBREW_GITHUB_USERNAME:$HOMEBREW_GITHUB_API_TOKEN@github.com/dokku/homebrew-repo.git"
+          brew bump-formula-pr -f --no-browse --no-audit --no-fork --url "https://github.com/dokku/dokku/archive/${{ needs.release.outputs.version }}.tar.gz" dokku/repo/dokku

.gitignore

@@ -1,7 +1,12 @@
 *.deb
+*.rpm
 .DS_Store
 .ruby-version
+.idea/
 .vagrant
+build/
 data/
+test-results/
 stack.tgz
 tmp
+coverage.out

.stickler.yml

@@ -0,0 +1,13 @@
+---
+linters:
+  shellcheck:
+    shell: bash
+    exclude: SC2034,SC1090,SC2191
+  golint:
+
+files:
+  ignore:
+    - 'debian/*'
+    - 'docs/*'
+    - 'tests/*'
+    - '*/vendor/*'

CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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

@@ -5,13 +5,13 @@ 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 [test cases](https://dokku.com/docs/development/testing/) 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/)
-* Come up with new ways to show off our [lovely logo](https://avatars1.githubusercontent.com/u/13455795)
+* Contribute to the [documentation](https://dokku.com/docs/)
+* Come up with new ways, non-commercial to show off our [lovely logo](https://avatars1.githubusercontent.com/u/13455795)
 * Blog about different ways you are using dokku
-* [Sponsor](https://opencollective.com/dokku#support) the Dokku project financially
+* Sponsor the Dokku project financially on [OpenCollective](https://opencollective.com/dokku#support) or [Patreon](https://www.patreon.com/dokku)
 
 There are a few guidelines that we need contributors to follow so that we have
 a chance of keeping on top of things.
@@ -25,7 +25,7 @@ a chance of keeping on top of things.
   * [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)
+  * [Running tests locally](#running-tests-locally)
 * [Additional Resources](#additional-resources)
 
 ## Reporting security issues
@@ -45,7 +45,7 @@ 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/),
+be found in pre-existing [plugins](https://dokku.com/docs/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.
@@ -55,22 +55,10 @@ 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)
+When reporting issues, please include all the information we ask for in our
+[issue template](https://github.com/dokku/dokku/blob/master/ISSUE_TEMPLATE.md).
+Not doing so will prolongue the support period, making it more difficult to support
+you.
 
 ## Contributing
 
@@ -126,7 +114,7 @@ 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
+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.
 
@@ -139,21 +127,10 @@ requests:
 - backwards incompatible change (minor)
 - major feature (minor)
 
-### Test cases and codesniffs
+### Running tests locally
 
-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.
+Please read the [testing docs](https://dokku.com/docs/development/testing/),
+which contains test setup information as well as tips for running tests.
 
 # Additional Resources
 

Dockerfile

@@ -0,0 +1,59 @@
+FROM phusion/baseimage:0.11
+
+CMD ["/sbin/my_init"]
+
+ARG DOKKU_TAG=0.17.7
+ARG DOKKU_GID=200
+ARG DOKKU_UID=200
+ARG DOKKU_HOSTNAME=dokku.invalid
+ARG DOKKU_SKIP_KEY_FILE=true
+ARG DOKKU_VHOST_ENABLE=false
+ARG DOKKU_WEB_CONFIG=false
+
+RUN addgroup --gid $DOKKU_GID dokku \
+      && adduser --uid $DOKKU_UID --gid $DOKKU_GID --disabled-password --gecos "" "dokku"
+
+COPY ./tests/dhparam.pem /tmp/dhparam.pem
+COPY ./build/dokku.deb /tmp/dokku.deb
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# hadolint ignore=DL3005,DL3008
+RUN echo "dokku dokku/hostname string $DOKKU_HOSTNAME" | debconf-set-selections \
+      && echo "dokku dokku/skip_key_file boolean $DOKKU_SKIP_KEY_FILE" | debconf-set-selections \
+      && echo "dokku dokku/vhost_enable boolean $DOKKU_VHOST_ENABLE" | debconf-set-selections \
+      && echo "dokku dokku/web_config boolean $DOKKU_WEB_CONFIG" | debconf-set-selections \
+      && curl -sSL https://packagecloud.io/dokku/dokku/gpgkey | apt-key add - \
+      && echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ bionic main" | tee /etc/apt/sources.list.d/dokku.list \
+      && mkdir -p /etc/nginx/ \
+      && cp /tmp/dhparam.pem /etc/nginx/dhparam.pem \
+      && apt-get update -qq \
+      && apt-get upgrade -qq -y \
+      && apt-get -qq -y --no-install-recommends --only-upgrade install openssl openssh-server \
+      && apt-get -qq -y --no-install-recommends install rsync /tmp/dokku.deb \
+      && apt-get purge -qq -y syslog-ng-core \
+      && apt-get autoremove -qq -y \
+      && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+WORKDIR /tmp
+
+COPY ./docker .
+
+RUN \
+    rsync -a /tmp/ / \
+      && rm -rf /tmp/* \
+      && rm /etc/runit/runsvdir/default/sshd/down \
+      && chown -R dokku:dokku /home/dokku/ \
+      && mkdir -p /skel/etc /skel/home /skel/var/lib/dokku /var/log/services \
+      && mv /etc/ssh /skel/etc/ssh \
+      && mv /home/dokku /skel/home/dokku \
+      && mv /var/lib/dokku/config /skel/var/lib/dokku/config \
+      && mv /var/lib/dokku/data /skel/var/lib/dokku/data \
+      && ln -sf /mnt/dokku/etc/ssh /etc/ssh \
+      && ln -sf /mnt/dokku/home/dokku /home/dokku \
+      && ln -sf /mnt/dokku/var/lib/dokku/config /var/lib/dokku/config \
+      && ln -sf /mnt/dokku/var/lib/dokku/data /var/lib/dokku/data \
+      && mv /etc/my_init.d/00_regen_ssh_host_keys.sh /etc/my_init.d/15_regen_ssh_host_keys \
+      && rm -f /etc/nginx/sites-enabled/default /usr/share/nginx/html/index.html /etc/my_init.d/10_syslog-ng.init \
+      && rm -f /usr/local/openresty/nginx/conf/sites-enabled/default /usr/share/openresty/html/index.html \
+      && sed -i '/imklog/d' /etc/rsyslog.conf \
+      && rm -f /var/log/btmp /var/log/wtmp /var/log/*log /var/log/apt/* /var/log/dokku/*.log /var/log/nginx/* /var/log/openresty/*

ISSUE_TEMPLATE.md

@@ -1,19 +1,42 @@
-Description of problem:
+> If you're using Dokku - especially for commercial purposes - consider donating to project development via [OpenCollective](https://opencollective.com/dokku) or [Patreon](https://www.patreon.com/dokku). Funds go to general development, support, and infrastructure costs.
+>
+> If you'd like to sponsor specific functionality, see the project's [Sponsoring](https://github.com/dokku/.github/blob/master/SPONSORING.md) document.
+>
+> If you need help figuring out how to use a specific buildpack, are seeing an issue in during the buildpack process, or are having issues using multiple buildpacks, please see our [slack channels or github discussion board](https://dokku.com/docs/getting-started/where-to-get-help/#monitored-locations). Issues pertaining to buildpacks may be closed and locked.
+>
+> If you need support for a version of Dokku that is more than a year old, your issue may be closed without an answer. Please upgrade to a recent version.
 
+## Description of problem
 
-Output of the following commands
+### How reproducible
 
-- `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):
+### Steps to Reproduce
+
+1.
+2.
+3.
+
+#### Actual Results
+
+#### Expected Results
+
+<-- Please replace APP_NAME with the name of your app -->
+
+## Environment Information
+
+### `dokku report APP_NAME` output
+
+> This is required! Issues missing this information may be closed.
+>
+> For problems affecting all applications, the report output for a broken application is useful for our debugging.
+> In these cases, you may run `dokku report` without any arguments to display the top-level reporting information.
+
+### How (deb/make/rpm) and where (AWS, VirtualBox, physical, etc.) was Dokku installed?:
+
+### Additional information
+
+- Container Inspect Output (if applicable) via `dokku ps:inspect APP_NAME`
+- The nginx configuration (if applicable) via `dokku nginx:show-config APP_NAME`
 - Link to the exact repository being deployed (if possible/applicable):
 - If a deploy is failing or behaving unexpectedly:
   - Application name
@@ -21,25 +44,5 @@ Output of the following commands
   - If using buildpacks, which custom buildpacks are in use
   - If using a `Dockerfile`, the contents of that file
   - 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:
+- 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 XXXXXX):

Makefile

@@ -1,13 +1,24 @@
-DOKKU_VERSION = master
+DOKKU_VERSION ?= master
 
-SSHCOMMAND_URL ?= https://raw.githubusercontent.com/dokku/sshcommand/v0.6.0/sshcommand
-PLUGN_URL ?= https://github.com/dokku/plugn/releases/download/v0.2.2/plugn_0.2.2_linux_x86_64.tgz
-SIGIL_URL ?= https://github.com/gliderlabs/sigil/releases/download/v0.4.0/sigil_0.4.0_Linux_x86_64.tgz
+DOCKER_IMAGE_LABELER_VERSION ?= 0.2.2
+HEROKUISH_VERSION ?= 0.5.25
+NETRC_VERSION ?= 0.3.0
+PLUGN_VERSION ?= 0.6.1
+PROCFILE_VERSION ?= 0.11.0
+SIGIL_VERSION ?= 0.6.0
+SSHCOMMAND_VERSION ?= 0.12.0
+DOCKER_IMAGE_LABELER_URL ?= https://github.com/dokku/docker-image-labeler/releases/download/v${DOCKER_IMAGE_LABELER_VERSION}/docker-image-labeler_${DOCKER_IMAGE_LABELER_VERSION}_linux_x86_64.tgz
+NETRC_URL ?= https://github.com/dokku/netrc/releases/download/v${NETRC_VERSION}/netrc_${NETRC_VERSION}_linux_x86_64.tgz
+PLUGN_URL ?= https://github.com/dokku/plugn/releases/download/v${PLUGN_VERSION}/plugn_${PLUGN_VERSION}_linux_x86_64.tgz
+PROCFILE_UTIL_URL ?= https://github.com/josegonzalez/go-procfile-util/releases/download/v${PROCFILE_VERSION}/procfile-util_${PROCFILE_VERSION}_linux_x86_64.tgz
+SIGIL_URL ?= https://github.com/gliderlabs/sigil/releases/download/v${SIGIL_VERSION}/sigil_${SIGIL_VERSION}_Linux_x86_64.tgz
+SSHCOMMAND_URL ?= https://github.com/dokku/sshcommand/releases/download/v${SSHCOMMAND_VERSION}/sshcommand_${SSHCOMMAND_VERSION}_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
+PLUGIN_MAKE_TARGET ?= build-in-docker
 
 # If the first argument is "vagrant-dokku"...
 ifeq (vagrant-dokku,$(firstword $(MAKECMDGOALS)))
@@ -23,10 +34,14 @@ 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 common.mk
+
+.PHONY: all apt-update install version copyfiles copyplugin man-db plugins dependencies docker-image-labeler netrc sshcommand procfile-util plugn docker aufs stack count dokku-installer vagrant-acl-add vagrant-dokku go-build
 
 include tests.mk
+include package.mk
 include deb.mk
+include rpm.mk
 include arch.mk
 
 all:
@@ -34,67 +49,113 @@ all:
 
 install: dependencies version copyfiles plugin-dependencies plugins
 
-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
 
+go-build:
+	basedir=$(PWD); \
+	for dir in plugins/*; do \
+		if [ -e $$dir/Makefile ]; then \
+			$(MAKE) -e -C $$dir $(PLUGIN_MAKE_TARGET) || exit $$? ;\
+		fi ;\
+	done
+
+
+go-build-plugin:
+ifndef PLUGIN_NAME
+	$(error PLUGIN_NAME not specified)
+endif
+	if [ -e plugins/$(PLUGIN_NAME)/Makefile ]; then \
+		$(MAKE) -e -C plugins/$(PLUGIN_NAME) $(PLUGIN_MAKE_TARGET) || exit $$? ;\
+	fi
+
+go-clean:
+	basedir=$(PWD); \
+	for dir in plugins/*; do \
+		if [ -e $$dir/Makefile ]; then \
+			$(MAKE) -e -C $$dir clean ;\
+		fi ;\
+	done
+
 copyfiles:
+	$(MAKE) go-build || exit 1
 	cp dokku /usr/local/bin/dokku
 	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 ${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
+	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do $(MAKE) copyplugin PLUGIN_NAME=$$plugin; done
+ifndef SKIP_GO_CLEAN
+	$(MAKE) go-clean
+endif
 	chown dokku:dokku -R ${PLUGINS_PATH} ${CORE_PLUGINS_PATH} || true
 	$(MAKE) addman
 
-addman: help2man
+copyplugin:
+ifndef PLUGIN_NAME
+	$(error PLUGIN_NAME not specified)
+endif
+	rm -Rf ${CORE_PLUGINS_PATH}/available/$(PLUGIN_NAME) && \
+		rm -Rf ${PLUGINS_PATH}/available/$(PLUGIN_NAME) && \
+		rm -rf ${CORE_PLUGINS_PATH}/$(PLUGIN_NAME) && \
+		rm -rf ${PLUGINS_PATH}/$(PLUGIN_NAME) && \
+		cp -R plugins/$(PLUGIN_NAME) ${CORE_PLUGINS_PATH}/available && \
+		rm -rf ${CORE_PLUGINS_PATH}/available/$(PLUGIN_NAME)/src && \
+		ln -s ${CORE_PLUGINS_PATH}/available/$(PLUGIN_NAME) ${PLUGINS_PATH}/available; \
+		find /var/lib/dokku/ -xtype l -delete;\
+		PLUGIN_PATH=${CORE_PLUGINS_PATH} plugn enable $(PLUGIN_NAME) ;\
+		PLUGIN_PATH=${PLUGINS_PATH} plugn enable $(PLUGIN_NAME)
+	chown dokku:dokku -R ${PLUGINS_PATH} ${CORE_PLUGINS_PATH} || true
+
+addman: help2man man-db
 	mkdir -p /usr/local/share/man/man1
 	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/VERSION  2> /dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ~dokku/VERSION
+	mkdir -p ${DOKKU_LIB_ROOT}
+ifeq ($(DOKKU_VERSION),master)
+	git describe --tags > ${DOKKU_LIB_ROOT}/VERSION  2>/dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ${DOKKU_LIB_ROOT}/VERSION
+else
+	echo $(DOKKU_VERSION) > ${DOKKU_LIB_ROOT}/STABLE_VERSION
+endif
 
-plugin-dependencies: plugn
+plugin-dependencies: plugn procfile-util
 	sudo -E dokku plugin:install-dependencies --core
 
-plugins: plugn docker
+plugins: plugn procfile-util docker
 	sudo -E dokku plugin:install --core
 
-dependencies: apt-update sshcommand plugn docker help2man man-db sigil
+dependencies: apt-update docker-image-labeler netrc sshcommand plugn procfile-util docker help2man man-db sigil dos2unix jq
 	$(MAKE) -e stack
 
 apt-update:
-	apt-get update
+	apt-get update -qq
+
+jq:
+	apt-get -qq -y --no-install-recommends install jq
+
+dos2unix:
+	apt-get -qq -y --no-install-recommends install dos2unix
 
 help2man:
-	apt-get install -qq -y help2man
+	apt-get -qq -y --no-install-recommends install help2man
 
 man-db:
-	apt-get install -qq -y man-db
+	apt-get -qq -y --no-install-recommends install man-db
 
-sshcommand:
-	wget -qO /usr/local/bin/sshcommand ${SSHCOMMAND_URL}
-	chmod +x /usr/local/bin/sshcommand
-	sshcommand create dokku /usr/local/bin/dokku
+docker-image-labeler:
+	wget -qO /tmp/docker-image-labeler_latest.tgz ${DOCKER_IMAGE_LABELER_URL}
+	tar xzf /tmp/docker-image-labeler_latest.tgz -C /usr/local/bin
+
+netrc:
+	wget -qO /tmp/netrc_latest.tgz ${NETRC_URL}
+	tar xzf /tmp/netrc_latest.tgz -C /usr/local/bin
+
+procfile-util:
+	wget -qO /tmp/procfile-util_latest.tgz ${PROCFILE_UTIL_URL}
+	tar xzf /tmp/procfile-util_latest.tgz -C /usr/local/bin
 
 plugn:
 	wget -qO /tmp/plugn_latest.tgz ${PLUGN_URL}
@@ -104,30 +165,30 @@ 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
+sshcommand:
+	wget -qO /tmp/sshcommand_latest.tgz ${SSHCOMMAND_URL}
+	tar xzf /tmp/sshcommand_latest.tgz -C /usr/local/bin
+	sshcommand create dokku /usr/local/bin/dokku
+
+docker:
+	apt-get -qq -y --no-install-recommends install curl
+	grep -i -E "^docker" /etc/group || groupadd docker
 	usermod -aG docker dokku
 ifndef CI
 	wget -nv -O - https://get.docker.com/ | sh
 ifdef DOCKER_VERSION
-	apt-get install -qq -y docker-engine=${DOCKER_VERSION} || (apt-cache madison docker-engine ; exit 1)
+	apt-get -qq -y --no-install-recommends install 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:
 ifeq ($(shell test -e /var/run/docker.sock && touch -c /var/run/docker.sock && echo $$?),0)
 ifdef BUILD_STACK
 	@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
-ifeq ($(shell echo ${PREBUILT_STACK_URL} | egrep -q 'http.*://|file://' && echo $$?),0)
+ifeq ($(shell echo ${PREBUILT_STACK_URL} | grep -q -E '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

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+**Note:** If this PR is just doc changes, please put [ci skip] in the body that way tests do not run.

README.md

@@ -1,43 +1,19 @@
-# 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)  [![Arch Package](https://img.shields.io/badge/package-arch-brightgreen.svg?style=flat-square "Arch Package")](https://aur.archlinux.org/packages/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/)
+# Dokku
+
+[![Build Status](https://github.com/dokku/dokku/workflows/CI/badge.svg)](https://github.com/dokku/dokku/actions?query=workflow%3ACI)
+[![Ubuntu Package](https://img.shields.io/badge/package-ubuntu-brightgreen.svg?style=flat-square "Ubuntu Package")](https://packagecloud.io/dokku/dokku)
+[![Arch Package](https://img.shields.io/badge/package-arch-brightgreen.svg?style=flat-square "Arch Package")](https://aur.archlinux.org/packages/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-site-blue.svg?style=flat-square "Site")](https://dokku.com/docs/getting-started/installation/)
 [![OpenCollective](https://opencollective.com/dokku/sponsors/badge.svg?style=flat-square)](#sponsors)
 [![OpenCollective](https://opencollective.com/dokku/backers/badge.svg?style=flat-square)](#backers)
-[![Gratipay](https://img.shields.io/gratipay/dokku.svg?style=flat-square)](https://gratipay.com/dokku/)
+[![Patreon](https://img.shields.io/badge/patreon-donate-green.svg?style=flat-square)](https://www.patreon.com/dokku/)
 
 Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen.
 
-## Requirements
-
-- A fresh VM running `Debian 8.2 x64`, `Ubuntu 14.04 x64`, or `Ubuntu 16.04 x64`
-
-## Installing
-
-To install the latest stable release, you can run the following commands as a user that has access to `sudo`:
-
-    wget https://raw.githubusercontent.com/dokku/dokku/v0.7.2/bootstrap.sh
-    sudo DOKKU_TAG=v0.7.2 bash bootstrap.sh
-
-### Upgrading
-
-[View the docs for upgrading](http://dokku.viewdocs.io/dokku/getting-started/upgrading/) from an older version of Dokku.
-
-## Documentation
-
-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/dokku/dokku/issues), check [Troubleshooting](http://dokku.viewdocs.io/dokku/getting-started/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/getting-started/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
 
-See our list of past sponsors in the [SPONSORS](https://github.com/dokku/dokku/blob/master/SPONSORS.md) file.
-
 Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/dokku#sponsor)]
 
 <a href="https://opencollective.com/dokku/sponsor/0/website" target="_blank"><img src="https://opencollective.com/dokku/sponsor/0/avatar.svg"></a>
@@ -71,7 +47,6 @@ Become a sponsor and get your logo on our README on Github with a link to your s
 <a href="https://opencollective.com/dokku/sponsor/28/website" target="_blank"><img src="https://opencollective.com/dokku/sponsor/28/avatar.svg"></a>
 <a href="https://opencollective.com/dokku/sponsor/29/website" target="_blank"><img src="https://opencollective.com/dokku/sponsor/29/avatar.svg"></a>
 
-
 ## Backers
 
 Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/dokku#backer)]
@@ -107,6 +82,49 @@ Support us with a monthly donation and help us continue our activities. [[Become
 <a href="https://opencollective.com/dokku/backer/28/website" target="_blank"><img src="https://opencollective.com/dokku/backer/28/avatar.svg"></a>
 <a href="https://opencollective.com/dokku/backer/29/website" target="_blank"><img src="https://opencollective.com/dokku/backer/29/avatar.svg"></a>
 
+## Requirements
+
+A fresh VM running any of the following operating systems:
+
+- Ubuntu 16.04/18.04/20.04 x64 - Any currently supported release
+- Debian 9+ x64
+- CentOS 7 x64 *(experimental)*
+- Arch Linux x64 *(experimental)*
+
+An SSH keypair that can be used for application deployment. If this exists before installation, it will be automatically imported into dokku.
+Otherwise, you will need to import the keypair manually after installation using `dokku ssh-keys:add`.
+
+## Installation
+
+To install the latest stable release, run the following commands as a user who has access to `sudo`:
+
+```shell
+wget https://raw.githubusercontent.com/dokku/dokku/v0.24.4/bootstrap.sh
+sudo DOKKU_TAG=v0.24.4 bash bootstrap.sh
+```
+
+You can then proceed to the ip address or domain name associated with your server to complete the web-based installation.
+
+If you wish for a more unattended installation method, see [these](https://dokku.com/docs/getting-started/install/debian/#unattended-installation) docs.
+
+### Upgrade
+
+[View the docs](https://dokku.com/docs/getting-started/upgrading/) for upgrading from an older version of Dokku.
+
+## Documentation
+
+Full documentation - including advanced installation docs - are available online at [https://dokku.com/docs/getting-started/installation/](https://dokku.com/docs/getting-started/installation/).
+
+## Support
+
+You can use [Github Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](https://dokku.com/docs/getting-started/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](https://dokku.com/docs/getting-started/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.
+
 ## License
 
 [MIT License](https://github.com/dokku/dokku/blob/master/LICENSE) © Jeff Lindsay

SPONSORS.md

@@ -1,5 +0,0 @@
-[Deis](http://deis.io)
-
-[DigitalOcean](https://www.digitalocean.com/)
-
-[Melvin Lammerts](http://dokku.net)

Vagrantfile

@@ -1,7 +1,7 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-14.04"
+BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-18.04"
 BOX_CPUS = ENV["BOX_CPUS"] || "1"
 BOX_MEMORY = ENV["BOX_MEMORY"] || "1024"
 DOKKU_DOMAIN = ENV["DOKKU_DOMAIN"] || "dokku.me"
@@ -31,6 +31,12 @@ Vagrant::configure("2") do |config|
 
   config.vm.provider :vmware_fusion do |v, override|
     v.vmx["memsize"] = BOX_MEMORY
+    v.ssh_info_public = true
+  end
+
+  config.vm.provider :vmware_desktop do |v, override|
+    v.vmx["memsize"] = BOX_MEMORY
+    v.ssh_info_public = true
   end
 
   config.vm.define "empty", autostart: false
@@ -45,9 +51,11 @@ Vagrant::configure("2") do |config|
     vm.vm.provider :virtualbox do |vb|
       vb.customize ["modifyvm", :id, "--natdnshostresolver1", "off"]
       vb.customize ["modifyvm", :id, "--natdnsproxy1", "off"]
+      # enable NAT adapter cable https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=838999
+      vb.customize ["modifyvm", :id, "--cableconnected1", "on"]
     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 => "export DEBIAN_FRONTEND=noninteractive && apt-get update -qq >/dev/null && apt-get -qq -y --no-install-recommends install git build-essential >/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
@@ -64,8 +72,9 @@ Vagrant::configure("2") do |config|
     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"
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update -qq >/dev/null && apt-get -qq -y --no-install-recommends install git dos2unix >/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 ./ && dos2unix bootstrap.sh && bash bootstrap.sh"
+    vm.vm.provision :shell, :inline => "cd /root/dokku && make dokku-installer"
   end
 
   config.vm.define "dokku-deb", autostart: false do |vm|
@@ -76,19 +85,30 @@ Vagrant::configure("2") do |config|
     vm.vm.provision :shell, :inline => "cd /root/dokku && make install-from-deb"
   end
 
+  config.vm.define "dokku-rpm", autostart: false do |vm|
+    vm.vm.box = "centos/7"
+    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 && bash bootstrap.sh"
+  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 => "export IS_RELEASE=true && cd /root/dokku && make deb-all"
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update -qq >/dev/null && apt-get -qq -y --no-install-recommends install git >/dev/null && cd /root/dokku && #{make_cmd}"
+    vm.vm.provision :shell, :inline => "export IS_RELEASE=true && cd /root/dokku && make deb-all rpm-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"
+    if Pathname.new("#{File.dirname(__FILE__)}/../dokku-arch").exist?
+      vm.vm.synced_folder "#{File.dirname(__FILE__)}/../dokku-arch", "/dokku-arch"
+    end
     vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
     vm.vm.hostname = "#{DOKKU_DOMAIN}"
     vm.vm.network :private_network, ip: DOKKU_IP

arch.mk

@@ -22,7 +22,11 @@ arch-setup:
 
 arch-dokku: arch-setup
 	echo "-> Update package sums, create metadata file and test the build of the package"
+ifeq ($(DOKKU_VERSION),master)
 	git describe --tags > /tmp/VERSION
+else
+	echo $(DOKKU_VERSION) > /tmp/VERSION
+endif
 	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,8 +1,9 @@
 #!/usr/bin/env bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
 # A script to bootstrap dokku.
-# It expects to be run on Ubuntu 14.04 via 'sudo'
+# It expects to be run on Ubuntu 16.04/18.04/20.04, or CentOS 7 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.
 
@@ -11,50 +12,88 @@ set -eo pipefail; [[ $TRACE ]] && set -x
 # That's good because it prevents our output overlapping with wget's.
 # It also means that we can't run a partially downloaded script.
 
+SUPPORTED_VERSIONS="Debian [9, 10], CentOS [7], Ubuntu [16.04, 18.04, 20.04]"
+
+log-fail() {
+  declare desc="log fail formatter"
+  echo "$@" 1>&2
+  exit 1
+}
+
 ensure-environment() {
   local FREE_MEMORY
-  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
+  if [[ -z "$DOKKU_TAG" ]]; then
+    echo "Preparing to install $DOKKU_REPO..."
+  else
+    echo "Preparing to install $DOKKU_TAG from $DOKKU_REPO..."
   fi
 
-  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
+  hostname -f >/dev/null 2>&1 || {
+    log-fail "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"
   }
 
   FREE_MEMORY=$(grep MemTotal /proc/meminfo | awk '{print $2}')
   if [[ "$FREE_MEMORY" -lt 1003600 ]]; then
     echo "For dokku to build containers, it is strongly suggested that you have 1024 megabytes or more of free memory"
-    echo "If necessary, please consult this document to setup swap: http://dokku.viewdocs.io/dokku/advanced-installation/#vms-with-less-than-1gb-of-memory"
+    echo "If necessary, please consult this document to setup swap: https://dokku.com/docs/getting-started/advanced-installation/#vms-with-less-than-1-gb-of-memory"
   fi
 }
 
 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
+
+  case "$DOKKU_DISTRO" in
+    debian)
+      if ! dpkg -l | grep -q software-properties-common; then
+        apt-get update -qq >/dev/null
+        apt-get -qq -y --no-install-recommends install software-properties-common
+      fi
+      ;;
+    ubuntu)
+      if ! dpkg -l | grep -q software-properties-common; then
+        apt-get update -qq >/dev/null
+        apt-get -qq -y --no-install-recommends install software-properties-common
+      fi
+
+      add-apt-repository universe >/dev/null
+      apt-get update -qq >/dev/null
+      ;;
+  esac
 }
 
 install-dokku() {
+  if ! command -v dokku &>/dev/null; then
+    echo "--> Note: Installing dokku for the first time will result in removal of"
+    echo "    files in the nginx 'sites-enabled' directory. Please manually"
+    echo "    restore any files that may be removed after the installation and"
+    echo "    web setup is complete."
+    echo ""
+    echo "    Installation will continue in 10 seconds."
+    sleep 10
+  fi
+
   if [[ -n $DOKKU_BRANCH ]]; then
     install-dokku-from-source "origin/$DOKKU_BRANCH"
   elif [[ -n $DOKKU_TAG ]]; then
-    local DOKKU_SEMVER="${DOKKU_TAG//v}"
+    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]}')
 
+    use_plugin=false
+    # 0.4.0 implemented a `plugin` plugin
+    if [[ "$major" -eq "0" ]] && [[ "$minor" -ge "4" ]] && [[ "$patch" -ge "0" ]]; then
+      use_plugin=true
+    elif [[ "$major" -ge "1" ]]; then
+      use_plugin=true
+    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
+    elif [[ "$use_plugin" == "true" ]]; then
       install-dokku-from-package "$DOKKU_SEMVER"
       echo "--> Running post-install dependency installation"
       sudo -E dokku plugin:install-dependencies --core
@@ -68,10 +107,14 @@ install-dokku() {
   fi
 }
 
-
 install-dokku-from-source() {
   local DOKKU_CHECKOUT="$1"
-  apt-get -qq -y install git make software-properties-common
+
+  if ! command -v apt-get &>/dev/null; then
+    log-fail "This installation script requires apt-get. For manual installation instructions, consult https://dokku.com/docs/getting-started/advanced-installation/"
+  fi
+
+  apt-get -qq -y --no-install-recommends install sudo git make software-properties-common
   cd /root
   if [[ ! -d /root/dokku ]]; then
     git clone "$DOKKU_REPO" /root/dokku
@@ -84,36 +127,88 @@ install-dokku-from-source() {
 }
 
 install-dokku-from-package() {
+  case "$DOKKU_DISTRO" in
+    debian | ubuntu)
+      install-dokku-from-deb-package "$@"
+      ;;
+    centos | rhel)
+      install-dokku-from-rpm-package "$@"
+      ;;
+    *)
+      log-fail "Unsupported Linux distribution. For manual installation instructions, consult https://dokku.com/docs/getting-started/advanced-installation/"
+      ;;
+  esac
+}
+
+in-array() {
+  declare desc="return true if value ($1) is in list (all other arguments)"
+
+  local e
+  for e in "${@:2}"; do
+    [[ "$e" == "$1" ]] && return 0
+  done
+  return 1
+}
+
+install-dokku-from-deb-package() {
   local DOKKU_CHECKOUT="$1"
   local NO_INSTALL_RECOMMENDS=${DOKKU_NO_INSTALL_RECOMMENDS:=""}
+  local OS_ID
+
+  if ! in-array "$DOKKU_DISTRO_VERSION" "16.04" "18.04" "20.04" "9" "10"; then
+    log-fail "Unsupported Linux distribution. Only the following versions are supported: $SUPPORTED_VERSIONS"
+  fi
 
   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
+  apt-get update -qq >/dev/null
+  apt-get -qq -y --no-install-recommends 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
+  if ! command -v docker &>/dev/null; then
+    echo "--> Installing docker"
+    if uname -r | grep -q linode; then
+      echo "--> NOTE: Using Linode? Docker may complain about missing AUFS support."
+      echo "    You can safely ignore this warning."
+      echo ""
+      echo "    Installation will continue in 10 seconds."
+      sleep 10
+    fi
+    export CHANNEL=stable
+    wget -nv -O - https://get.docker.com/ | sh
+  fi
+
+  OS_ID="$(lsb_release -cs 2>/dev/null || echo "bionic")"
+  if ! in-array "$DOKKU_DISTRO" "debian" "ubuntu"; then
+    DOKKU_DISTRO="ubuntu"
+    OS_ID="bionic"
+  fi
+
+  if [[ "$DOKKU_DISTRO" == "ubuntu" ]]; then
+    OS_IDS=("xenial" "bionic" "focal")
+    if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
+      OS_ID="bionic"
+    fi
+  elif [[ "$DOKKU_DISTRO" == "debian" ]]; then
+    OS_IDS=("stretch" "buster")
+    if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
+      OS_ID="buster"
+    fi
   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
+  wget -nv -O - https://packagecloud.io/dokku/dokku/gpgkey | apt-key add -
+  echo "deb https://packagecloud.io/dokku/dokku/$DOKKU_DISTRO/ $OS_ID 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 $DOKKU_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_VHOST_ENABLE ]] && echo "dokku dokku/vhost_enable boolean $DOKKU_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
+  [[ -n $DOKKU_KEY_FILE ]] && echo "dokku dokku/key_file string $DOKKU_KEY_FILE" | sudo debconf-set-selections
+  [[ -n $DOKKU_NGINX_ENABLE ]] && echo "dokku dokku/nginx_enable string $DOKKU_NGINX_ENABLE" | sudo debconf-set-selections
 
   if [[ -n $DOKKU_CHECKOUT ]]; then
     # shellcheck disable=SC2086
@@ -124,7 +219,42 @@ install-dokku-from-package() {
   fi
 }
 
+install-dokku-from-rpm-package() {
+  local DOKKU_CHECKOUT="$1"
+
+  if ! in-array "$DOKKU_DISTRO_VERSION" "7"; then
+    log-fail "Unsupported Linux distribution. Only the following versions are supported: $SUPPORTED_VERSIONS"
+  fi
+
+  echo "--> Installing docker"
+  curl -fsSL https://get.docker.com/ | sh
+
+  echo "--> Installing epel for nginx packages to be available"
+  yum install -y epel-release
+
+  echo "--> Installing herokuish and dokku"
+  curl -s https://packagecloud.io/install/repositories/dokku/dokku/script.rpm.sh | bash
+  if [[ -n $DOKKU_CHECKOUT ]]; then
+    yum -y install herokuish "dokku-$DOKKU_CHECKOUT"
+  else
+    yum -y install herokuish dokku
+  fi
+
+  echo "--> Enabling docker and nginx on system startup"
+  systemctl enable docker
+  systemctl enable nginx
+
+  echo "--> Starting nginx"
+  systemctl start nginx
+}
+
 main() {
+  export DOKKU_DISTRO DOKKU_DISTRO_VERSION
+  # shellcheck disable=SC1091
+  DOKKU_DISTRO=$(. /etc/os-release && echo "$ID")
+  # shellcheck disable=SC1091
+  DOKKU_DISTRO_VERSION=$(. /etc/os-release && echo "$VERSION_ID")
+
   export DEBIAN_FRONTEND=noninteractive
   export DOKKU_REPO=${DOKKU_REPO:-"https://github.com/dokku/dokku.git"}
 

circle.yml

@@ -1,20 +0,0 @@
-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
-    # dokku.me now resolves to 10.0.0.2. add 10.0.0.2/24 to eth0
-    - sudo ip a a 10.0.0.2/24 broadcast 10.0.0.255 dev eth0
-  post:
-    - sudo -E make -e lint
-test:
-  override:
-    - ./tests/ci/parallel_runner.sh testing: { parallel: true, timeout: 3600 }

common.mk

@@ -0,0 +1,46 @@
+GO_ARGS ?=
+GO_PLUGIN_MAKE_TARGET ?= build
+GO_REPO_ROOT := /go/src/github.com/dokku/dokku
+BUILD_IMAGE := golang:1.15.6
+GO_BUILD_CACHE ?= /tmp/dokku-go-build-cache
+GO_MOD_CACHE ?= /tmp/dokku-go-mod-mod
+
+.PHONY: build-in-docker build clean src-clean
+
+build: $(BUILD)
+
+build-in-docker: clean
+	mkdir -p /tmp/dokku-go-build-cache
+	docker run --rm \
+		-v $$PWD/../..:$(GO_REPO_ROOT) \
+		-v $(GO_BUILD_CACHE):/root/.cache \
+		-v $(GO_MOD_CACHE):/go/pkg/mod \
+		-e PLUGIN_NAME=$(PLUGIN_NAME) \
+		-e GO111MODULE=on \
+		-w $(GO_REPO_ROOT)/plugins/$(PLUGIN_NAME) \
+		$(BUILD_IMAGE) \
+		bash -c "GO_ARGS='$(GO_ARGS)' make -j4 $(GO_PLUGIN_MAKE_TARGET)" || exit $$?
+
+clean:
+	rm -rf $(BUILD)
+	find . -xtype l -delete
+
+commands: **/**/commands.go
+	go build -ldflags="-s -w" $(GO_ARGS) -o commands src/commands/commands.go
+
+subcommands:
+	go build -ldflags="-s -w" $(GO_ARGS) -o subcommands/subcommands src/subcommands/subcommands.go
+	$(MAKE) $(SUBCOMMANDS)
+
+subcommands/%:
+	ln -sf subcommands $@
+
+src-clean:
+	rm -rf .gitignore src vendor Makefile *.go glide.* go.sum go.mod
+
+triggers:
+	go build -ldflags="-s -w" $(GO_ARGS) -o triggers src/triggers/triggers.go
+	$(MAKE) $(TRIGGERS)
+
+triggers/%:
+	ln -sf triggers $(shell echo $@ | cut -d '/' -f2)

contrib/bash-completion

@@ -0,0 +1,31 @@
+# bash completion for dokku                                -*- shell-script -*-
+
+_dokku_complete_verify() {
+  declare desc="shows bash completion"
+  declare COMMAND="$1"
+  local COMMANDS=""
+
+  _dokku_complete_goals=$(cat "/var/cache/dokku-completion")
+
+  while read -r fn; do
+    if [[ -z "$COMMAND" ]] || [[ "$fn" == $COMMAND* ]]; then
+      COMMANDS="${COMMANDS};${fn}"
+    fi
+  done <<< "$_dokku_complete_goals"
+
+  echo "${COMMANDS#";"}"
+}
+
+_dokku() {
+  local cur prev
+  _get_comp_words_by_ref -n : cur
+
+  if [[ ! -f "/var/cache/dokku-completion" ]] || [[ ! -s "/var/cache/dokku-completion" ]]; then
+    dokku --quiet help --all | awk '/^    /{ print $1 }' | sort > "/var/cache/dokku-completion"
+  fi
+
+  opts=$(_dokku_complete_verify "${cur}")
+  COMPREPLY=($(IFS=";" compgen -W "$opts" -- "$cur"))
+  __ltrim_colon_completions "$cur"
+} &&
+complete -F _dokku dokku

contrib/build-base.Dockerfile

@@ -0,0 +1,6 @@
+FROM ubuntu:18.04
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq && apt-get -qq -y --no-install-recommends install gcc git build-essential wget ruby-dev ruby1.9.1 lintian rpm help2man man-db
+RUN command -v fpm >/dev/null || sudo gem install fpm --no-ri --no-rdoc

contrib/build-dokku.Dockerfile

@@ -0,0 +1,40 @@
+FROM dokku/build-base:0.0.1
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq && apt-get -qq -y --no-install-recommends install gcc git build-essential wget ruby-dev ruby1.9.1 lintian rpm help2man man-db
+RUN command -v fpm >/dev/null || sudo gem install fpm --no-ri --no-rdoc
+
+ARG GOLANG_VERSION
+
+RUN wget -qO /tmp/go${GOLANG_VERSION}.linux-amd64.tar.gz https://storage.googleapis.com/golang/go${GOLANG_VERSION}.linux-amd64.tar.gz \
+    && tar -C /usr/local -xzf /tmp/go${GOLANG_VERSION}.linux-amd64.tar.gz \
+    && cp /usr/local/go/bin/* /usr/local/bin
+
+ARG WORKDIR=/go/src/github.com/dokku/dokku
+
+WORKDIR ${WORKDIR}
+
+COPY Makefile ${WORKDIR}/
+COPY *.mk ${WORKDIR}/
+
+RUN make deb-setup rpm-setup sshcommand plugn
+
+COPY . ${WORKDIR}
+
+ARG PLUGIN_MAKE_TARGET
+ARG DOKKU_VERSION=master
+ARG DOKKU_GIT_REV
+ARG IS_RELEASE=false
+
+ENV GOPATH=/go
+
+RUN PLUGIN_MAKE_TARGET=${PLUGIN_MAKE_TARGET} \
+    DOKKU_VERSION=${DOKKU_VERSION} \
+    DOKKU_GIT_REV=${DOKKU_GIT_REV} \
+    IS_RELEASE=${IS_RELEASE} \
+    SKIP_GO_CLEAN=true \
+    make version copyfiles \
+    && make deb-dokku rpm-dokku
+
+RUN ls -lha /tmp/

contrib/copy-packages

@@ -0,0 +1,52 @@
+#!/usr/bin/env python2.7
+import os
+import requests
+import shutil
+import subprocess
+from requests.auth import HTTPBasicAuth
+
+PACKAGECLOUD_TOKEN = os.getenv('DOKKU_PACKAGECLOUD_TOKEN')
+
+
+def download_file(filename, url):
+    r = requests.get(url, stream=True)
+    with open(filename, 'wb') as f:
+        shutil.copyfileobj(r.raw, f)
+
+
+def upload_file(filename):
+    versions = [
+        "xenial"
+        "focal"
+    ]
+    cmd_template = "package_cloud push dokku/dokku/ubuntu/{0} {1}"
+    for version in versions:
+        cmd = cmd_template.format(version, filename)
+        subprocess.call(cmd, shell=True)
+
+
+def main():
+    auth = HTTPBasicAuth(PACKAGECLOUD_TOKEN, '')
+    base = requests.get('https://packagecloud.io/api/v1/repos/dokku/dokku/packages/deb/ubuntu/bionic.json',
+                        auth=auth)
+    data = base.json()
+    urls = []
+    for package in data:
+        urls.append(package['versions_url'])
+
+    download_urls = {}
+    for url in urls:
+        base = requests.get('https://packagecloud.io{0}'.format(url),
+                            auth=auth)
+        data = base.json()
+        for version in data:
+            download_urls['downloads/' + version['filename']] = version['download_url']
+
+    for filename, download_url in download_urls.items():
+        print("downloading {0}".format(filename))
+        download_file(filename, download_url)
+        upload_file(filename)
+
+
+if __name__ == "__main__":
+    main()

contrib/dokku-docker-bin.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x && DOKKU_DOCKER_ENV="--env DOKKU_TRACE=on"
+DOKKU_DOCKER_CONTAINER_NAME=${DOKKU_DOCKER_CONTAINER_NAME:=dokku}
+
+# TODO: handle cases where we need a tty
+# shellcheck disable=SC2086
+docker exec $DOKKU_DOCKER_ENV -i "$DOKKU_DOCKER_CONTAINER_NAME" dokku "$@"

contrib/dokku-installer.py

@@ -1,42 +1,91 @@
-#!/usr/bin/env python2.7
+#!/usr/bin/env python3
 
 import cgi
 import json
 import os
-import SimpleHTTPServer
-import SocketServer
+import re
+import shutil
+try:
+    import SimpleHTTPServer
+    import SocketServer
+except ImportError:
+    import http.server as SimpleHTTPServer
+    import socketserver as SocketServer
 import subprocess
 import sys
 import threading
 
-VERSION = 'v0.7.2'
+VERSION = 'v0.24.4'
+
+def bytes_to_string(b):
+    if type(b) == bytes:
+        encoding = sys.stdout.encoding
+        if encoding is None:
+            encoding = 'utf-8'
+        b = b.decode(encoding)
+    b = b.strip()
+    return b
+
+
+def string_to_bytes(s):
+    if type(s) == str:
+        encoding = sys.stdout.encoding
+        if encoding is None:
+            encoding = 'utf-8'
+        s = s.encode(encoding)
+    return s
+
 
 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 = ''
+    hostname = bytes_to_string(subprocess.check_output(command, shell=True))
 except subprocess.CalledProcessError:
     pass
 
-key_file = os.getenv('KEY_FILE', '/root/.ssh/authorized_keys')
+key_file = os.getenv('KEY_FILE', None)
+if os.path.isfile('/home/ec2-user/.ssh/authorized_keys'):
+    key_file = '/home/ec2-user/.ssh/authorized_keys'
+elif os.path.isfile('/home/ubuntu/.ssh/authorized_keys'):
+    key_file = '/home/ubuntu/.ssh/authorized_keys'
+else:
+    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")
+        admin_keys = bytes_to_string(subprocess.check_output(command, shell=True)).strip().split("\n")
     except subprocess.CalledProcessError:
         pass
 
+ufw_display = 'block'
+try:
+    command = "sudo ufw status"
+    ufw_output = bytes_to_string(subprocess.check_output(command, shell=True).strip())
+    if "inactive" in ufw_output:
+        ufw_display = 'none'
+except subprocess.CalledProcessError:
+    ufw_display = 'none'
+
+
+nginx_dir = '/etc/nginx'
+nginx_init = '/etc/init.d/nginx'
+try:
+    command = "test -x /usr/bin/openresty"
+    subprocess.check_output(command, shell=True)
+    nginx_dir = '/usr/local/openresty/nginx/conf'
+    nginx_init = '/etc/init.d/openresty'
+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')
+    nginx_conf_dir = os.getenv('NGINX_CONF_DIR', '{0}/conf.d'.format(nginx_dir))
 
     if os.path.exists(init_dir):
         with open('{0}/dokku-installer.conf'.format(init_dir), 'w') as f:
@@ -53,8 +102,8 @@ def check_boot():
             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:
+    if os.path.exists(nginx_conf_dir):
+        with open('{0}/dokku-installer.conf'.format(nginx_conf_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")
@@ -63,18 +112,27 @@ def check_boot():
             f.write("  }\n")
             f.write("}\n")
 
-    subprocess.call('rm -f /etc/nginx/sites-enabled/*', shell=True)
+    subprocess.call('rm -f {0}/sites-enabled/*'.format(nginx_dir), shell=True)
     sys.exit(0)
 
 
 class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
+    def write_content(self, content):
+        try:
+            self.wfile.write(content)
+        except TypeError:
+            self.wfile.write(string_to_bytes(content))
+
+
     def do_GET(self):
         content = PAGE.replace('{VERSION}', VERSION)
+        content = content.replace('{UFW_DISPLAY}', ufw_display)
         content = content.replace('{HOSTNAME}', hostname)
+        content = content.replace('{AUTHORIZED_KEYS_LOCATION}', key_file)
         content = content.replace('{ADMIN_KEYS}', "\n".join(admin_keys))
         self.send_response(200)
         self.end_headers()
-        self.wfile.write(content)
+        self.write_content(content)
 
     def do_POST(self):
         if self.path not in ['/setup', '/setup/']:
@@ -86,27 +144,54 @@ class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
                                       'REQUEST_METHOD': 'POST',
                                       'CONTENT_TYPE': self.headers['Content-Type']})
 
-        vhost_enable = 'false'
         dokku_root = os.getenv('DOKKU_ROOT', '/home/dokku')
+        dokku_user = os.getenv('DOKKU_SYSTEM_GROUP', 'dokku')
+        dokku_group = os.getenv('DOKKU_SYSTEM_USER', 'dokku')
+
+        vhost_enable = 'false'
+        vhost_filename = '{0}/VHOST'.format(dokku_root)
+
         if 'vhost' in params and params['vhost'].value == 'true':
             vhost_enable = 'true'
-            with open('{0}/VHOST'.format(dokku_root), 'w') as f:
-                f.write(params['hostname'].value)
+            with open(vhost_filename, 'w') as f:
+                f.write(params['hostname'].value.strip("/"))
+            shutil.chown(vhost_filename, dokku_user, dokku_group)
         else:
             try:
-                os.remove('{0}/VHOST'.format(dokku_root))
+                os.remove(vhost_filename)
             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"):
+        hostname_filename = '{0}/HOSTNAME'.format(dokku_root)
+
+        with open(hostname_filename, 'w') as f:
+            f.write(params['hostname'].value.strip("/"))
+
+        shutil.chown(hostname_filename, dokku_user, dokku_group)
+
+        for (index, key) in enumerate(params['keys'].value.splitlines(), 1):
+            user = 'admin'
+            if self.admin_user_exists() is not None:
+                user = 'web-admin'
+                if self.web_admin_user_exists() is not None:
+                    index = int(self.web_admin_user_exists()) + 1
+                elif self.web_admin_user_exists() is None:
+                    index = 1
+            elif self.admin_user_exists() is None:
+                pass
+            else:
+                index = int(self.admin_user_exists()) + 1
+            user = user + str(index)
+            command = ['sshcommand', 'acl-add', 'dokku', user]
             proc = subprocess.Popen(command, stdin=subprocess.PIPE)
-            proc.stdin.write(key)
+            try:
+                proc.stdin.write(key)
+            except TypeError:
+                proc.stdin.write(string_to_bytes(key))
             proc.stdin.close()
             proc.wait()
 
+        set_debconf_selection('boolean', 'nginx_enable', 'true')
         set_debconf_selection('boolean', 'skip_key_file', 'true')
         set_debconf_selection('boolean', 'vhost_enable', vhost_enable)
         set_debconf_selection('boolean', 'web_config', 'false')
@@ -115,9 +200,34 @@ class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
         if 'selfdestruct' in sys.argv:
             DeleteInstallerThread()
 
+        content = json.dumps({'status': 'ok'})
+
         self.send_response(200)
         self.end_headers()
-        self.wfile.write(json.dumps({'status': 'ok'}))
+        self.write_content(content)
+
+    def web_admin_user_exists(self):
+        return self.user_exists('web-admin(\d+)')
+
+    def admin_user_exists(self):
+        return self.user_exists('admin(\d+)')
+
+    def user_exists(self, name):
+        command = 'dokku ssh-keys:list'
+        pattern = re.compile(r'NAME="' + name + '"')
+        proc = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
+        max_num = 0
+        exists = False
+        for line in proc.stdout:
+            m = pattern.search(bytes_to_string(line))
+            if m:
+                # User of the form `user` or `user#` exists
+                exists = True
+                max_num = max(max_num, int(m.group(1)))
+        if exists:
+            return max_num
+        else:
+            return None
 
 
 def set_debconf_selection(debconf_type, key, value):
@@ -149,7 +259,7 @@ class DeleteInstallerThread(object):
         thread.start()
 
     def run(self):
-        command = "rm /etc/nginx/conf.d/dokku-installer.conf && /etc/init.d/nginx stop && /etc/init.d/nginx start"
+        command = "rm {0}/conf.d/dokku-installer.conf && {1} stop && {1} start".format(nginx_dir, nginx_init)
         try:
             subprocess.call(command, shell=True)
         except:
@@ -167,77 +277,157 @@ def main():
 
     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)
+    print("Listening on 0.0.0.0:{0}, CTRL+C to stop".format(port))
     httpd.serve_forever()
 
 
 PAGE = """
 <html>
 <head>
+  <meta charset="utf-8" />
   <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>
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
+  <style>
+    .bd-callout {
+      padding: 1.25rem;
+      margin-top: 1.25rem;
+      margin-bottom: 1.25rem;
+      border: 1px solid #eee;
+      border-left-width: .25rem;
+      border-radius: .25rem;
+    }
+    .bd-callout p:last-child {
+      margin-bottom: 0;
+    }
+    .bd-callout-info {
+      border-left-color: #5bc0de;
+    }
+    pre {
+      font-size: 80%;
+      margin-bottom: 0;
+    }
+    h1 small {
+      font-size: 50%;
+    }
+    h5 {
+      font-size: 1rem;
+    }
+    .container {
+      width: 640px;
+    }
+    .result {
+      padding-left: 20px;
+    }
+    input.form-control, textarea.form-control {
+      background-color: #fafbfc;
+      font-size: 14px;
+    }
+    input.form-control::placeholder, textarea.form-control::placeholder {
+      color:  #adb2b8
+    }
+  </style>
 </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 class="container">
+    <form id="form" role="form">
+      <h1 class="pt-3">Dokku Setup <small class="text-muted">{VERSION}</small></h1>
+      <div class="alert alert-warning small" role="alert">
+        <strong>Warning:</strong> The SSH key filled out here can grant root access to the server. Please complete the setup as soon as possible.
       </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 class="row">
+        <div class="col">
+          <h3>Admin Access</h3>
+          <div class="form-group">
+            <label for="key">Public SSH Keys</label><br />
+            <textarea class="form-control" name="keys" rows="5" id="key" placeholder="Begins with 'ssh-rsa', 'ssh-dss', 'ssh-ed25519', 'ecdsa-sha2-nistp256', 'ecdsa-sha2-nistp384', or 'ecdsa-sha2-nistp521'">{ADMIN_KEYS}</textarea>
+            <small class="form-text text-muted">Public keys allow users to ssh onto the server as the <code>dokku</code> user, as well as remotely execute Dokku commands. They are currently auto-populated from: <code>{AUTHORIZED_KEYS_LOCATION}</code>, and can be changed later via the  <a href="https://dokku.com/docs/deployment/user-management/" target="_blank"><code>dokku ssh-keys</code></a> plugin.</small>
+          </div>
+        </div>
       </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 class="row">
+        <div class="col">
+          <h3>Hostname Configuration</h3>
+          <div class="form-group">
+            <label for="hostname">Hostname</label>
+            <input class="form-control" type="text" id="hostname" name="hostname" value="{HOSTNAME}" placeholder="A hostname or ip address such as {HOSTNAME}" />
+            <small class="form-text text-muted">This will be used as the default host for all applications, and can be changed later via the <a href="https://dokku.com/docs/configuration/domains/" target="_blank"><code>dokku domains:set-global</code></a> command.</small>
+          </div>
+          <div class="form-check">
+            <input class="form-check-input" type="checkbox" id="vhost" name="vhost" value="true">
+            <label class="form-check-label" for="vhost">Use virtualhost naming for apps</label>
+            <small class="form-text text-muted">When enabled, Nginx will be run on port 80 and proxy requests to apps based on hostname.</small>
+            <small class="form-text text-muted">When disabled, a specific port will be setup for each application on first deploy, and requests to that port will be proxied to the relevant app.</small>
+          </div>
+          <div class="alert alert-warning small mt-3 d-{UFW_DISPLAY}" role="alert">
+            <strong>Warning:</strong> UFW is active. To allow traffic to specific ports, run <code>sudo ufw allow PORT</code> for the port in question.
+          </div>
+          <div class="bd-callout bd-callout-info">
+            <h5>What will app URLs look like?</h5>
+            <pre><code id="example">http://hostname:port</code></pre>
+          </div>
+        </div>
+      </div>
+      <button type="button" onclick="setup()" class="btn btn-primary">Finish Setup</button> <span class="result"></span>
+    </form>
   </div>
+
   <div id="error-output"></div>
   <script>
+    var $ = document.querySelector.bind(document)
+
     function setup() {
-      if ($.trim($("#key").val()) == "") {
+      if ($("#key").value.trim() == "") {
         alert("Your admin public key cannot be blank.")
         return
       }
-      if ($.trim($("#hostname").val()) == "") {
+      if ($("#hostname").value.trim() == "") {
         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/deployment/application-deployment/";
+      var data = new FormData($("#form"))
+
+      var inputs = [].slice.call(document.querySelectorAll("input, textarea, button"))
+      inputs.forEach(function (input) {
+        input.disabled = true
+      })
+
+      var result = $(".result")
+      fetch("/setup", {method: "POST", body: data})
+        .then(function(response) {
+            if (response.ok) {
+                return response.json()
+            } else {
+                throw new Error('Server returned error')
+            }
+        })
+        .then(function(response) {
+          result.classList.add("text-success");
+          result.textContent = "Success! Redirecting in 3 seconds. .."
+          setTimeout(function() {
+            window.location.href = "https://dokku.com/docs~{VERSION}/deployment/application-deployment/";
+          }, 3000);
+        })
+        .catch(function (error) {
+          result.classList.add("text-danger");
+          result.textContent = "Could not send the request"
         })
-        .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}$/)) {
+      if ($("#vhost").matches(":checked") && $("#hostname").value.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);
+        $("#vhost").checked = false;
       }
-      if ($("#vhost").is(':checked')) {
-        $("#example").html("http://&lt;app-name&gt;."+$("#hostname").val())
+      if ($("#vhost").matches(':checked')) {
+        $("#example").textContent = "http://<app-name>."+$("#hostname").value
       } else {
-        $("#example").html("http://"+$("#hostname").val()+":&lt;app-port&gt;")
+        $("#example").textContent = "http://"+$("#hostname").value+":<app-port>"
       }
     }
-    $("#vhost").change(update);
-    $("#hostname").change(update);
+    $("#vhost").addEventListener("change", update);
+    $("#hostname").addEventListener("input", update);
     update();
   </script>
 </body>

contrib/dokku_client.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+export DOKKU_PORT=${DOKKU_PORT:=22}
+export DOKKU_HOST=${DOKKU_HOST:=}
 
-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() {
+fn-random-number() {
   [[ -n "$1" ]] && RANGE="$1"
   if [[ -n "$RANGE" ]]; then
     number=$RANDOM
@@ -15,94 +15,149 @@ random_number() {
   echo $number
 }
 
-random_name() {
- NUM1=$(random_number ${#MOVES[@]})
- NUM2=$(random_number ${#MOVES[@]})
- NUM3=$(random_number ${#NAMES[@]})
+fn-random-name() {
+  local NUM1 NUM2 NUM3 UPPER_APPNAME lower_appname
+  local 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)
+  local 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)
 
- UPPER_APPNAME="${MOVES[${NUM1}]}-${MOVES[${NUM2}]}-${NAMES[${NUM3}]}"
+  NUM1=$(fn-random-number ${#MOVES[@]})
+  NUM2=$(fn-random-number ${#MOVES[@]})
+  NUM3=$(fn-random-number ${#NAMES[@]})
 
- [[ "$BASH_VERSION" =~ 4.* ]] && lower_appname=${UPPER_APPNAME,,}
- [[ -z "$lower_appname" ]] && lower_appname=$(echo "$UPPER_APPNAME" | tr '[:upper:]' '[:lower:]')
- echo "$lower_appname"
+  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>"
+fn-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
 }
 
-is_git_repo() {
-    git rev-parse &>/dev/null
+fn-is-git-repo() {
+  git rev-parse &>/dev/null
 }
 
-has_dokku_remote() {
-    git remote show | grep dokku
+fn-has-dokku-remote() {
+  git remote show | grep -E "^${DOKKU_GIT_REMOTE}\s"
 }
 
-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
+fn-dokku-host() {
+  declare DOKKU_GIT_REMOTE="$1" DOKKU_HOST="$2"
+
+  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_GIT_REMOTE}\s" | head -n 1 | cut -f1 -d' ' | cut -f2 -d '@' | cut -f1 -d':' 2>/dev/null || true)
+    fi
   fi
-fi
 
-export DOKKU_PORT=${DOKKU_PORT:=22}
+  if [[ -z "$DOKKU_HOST" ]]; then
+    fn-client-help-msg
+  fi
 
-if [[ ! -z $DOKKU_HOST ]]; then
-  _dokku() {
-    appname=""
-    if [[ -d .git ]] || git rev-parse --git-dir > /dev/null 2>&1; then
+  echo "$DOKKU_HOST"
+}
+
+main() {
+  declare CMD="$1" APP_ARG="$2"
+  local APP="" DOKKU_GIT_REMOTE="dokku" DOKKU_REMOTE_HOST=""
+  local cmd_set=false next_index=1 skip=false args=("$@")
+
+  for arg in "$@"; do
+    if [[ "$skip" == "true" ]]; then
+      next_index=$((next_index + 1))
+      skip=false
+      continue
+    fi
+    is_flag=false
+
+    [[ "$arg" =~ ^--.* ]] && is_flag=true
+
+    if [[ "$arg" == "--app" ]]; then
+      APP=${args[$next_index]}
+      skip=true
+      shift 2
+    elif [[ "$arg" == "--remote" ]]; then
+      DOKKU_GIT_REMOTE=${args[$next_index]}
+      skip=true
+      shift 2
+    elif [[ "$arg" =~ ^--.* ]]; then
+      [[ "$cmd_set" == "true" ]] && [[ "$is_flag" == "false" ]] && APP_ARG="$arg" && break
+      [[ "$arg" == "--trace" ]] && export DOKKU_TRACE=1 && set -x
+    else
+      if [[ "$cmd_set" == "true" ]] && [[ "$is_flag" == "false" ]]; then
+        APP_ARG="$arg"
+        break
+      else
+        CMD="$arg"
+        cmd_set=true
+      fi
+    fi
+    next_index=$((next_index + 1))
+  done
+
+  DOKKU_REMOTE_HOST="$(fn-dokku-host "$DOKKU_GIT_REMOTE" "$DOKKU_HOST")"
+
+  if [[ -z "$APP" ]]; then
+    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)
+      APP=$(git remote -v 2>/dev/null | grep -Ei "dokku@$DOKKU_REMOTE_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"
+      echo " !     This is not a git repository" 1>&2
     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
-        ;;
-    apps:destroy)
-      is_git_repo && has_dokku_remote && 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
+
+  case "$CMD" in
+    apps:create)
+      if [[ -z "$APP" ]] && [[ -z "$APP_ARG" ]]; then
+        APP=$(fn-random-name)
+        counter=0
+        while ssh -p "$DOKKU_PORT" "dokku@$DOKKU_REMOTE_HOST" apps 2>/dev/null | grep -q "$APP"; do
+          if [[ $counter -ge 100 ]]; then
+            echo " !     Could not reasonably generate a new app name. Try cleaning up some apps..." 1>&2
+            ssh -p "$DOKKU_PORT" "dokku@$DOKKU_REMOTE_HOST" apps
+            exit 1
+          else
+            APP=$(random_name)
+            counter=$((counter + 1))
+          fi
+        done
+      elif [[ -z "$APP" ]]; then
+        APP="$APP_ARG"
+      fi
+      if git remote add "$DOKKU_GIT_REMOTE" "dokku@$DOKKU_REMOTE_HOST:$APP"; then
+        echo "-----> Dokku remote added at ${DOKKU_REMOTE_HOST} called ${DOKKU_GIT_REMOTE}"
+        echo "-----> Application name is ${APP}"
+      else
+        echo " !     Dokku remote not added! Do you already have a dokku remote?" 1>&2
+        return
+      fi
+      ;;
+    apps:destroy)
+      fn-is-git-repo && fn-has-dokku-remote && git remote remove "$DOKKU_GIT_REMOTE"
+      ;;
+  esac
+
+  [[ " apps certs help ls nginx shell storage trace version " == *" $CMD "* ]] && unset APP
+  [[ " certs:chain domains:add-global domains:remove-global domains:set-global ps:restore " == *" $CMD "* ]] && unset APP
+  [[ "$CMD" =~ events*|plugin*|ssh-keys* ]] && unset APP
+  [[ -n "$APP_ARG" ]] && [[ "$APP_ARG" == "--global" ]] && unset APP
+  [[ -n "$@" ]] && [[ -n "$APP" ]] && app_arg="--app $APP"
+  # echo "ssh -o LogLevel=QUIET -p $DOKKU_PORT -t dokku@$DOKKU_REMOTE_HOST -- $app_arg $@"
+  # shellcheck disable=SC2068,SC2086
+  ssh -o LogLevel=QUIET -p $DOKKU_PORT -t dokku@$DOKKU_REMOTE_HOST -- $app_arg $@ || {
+    ssh_exit_code="$?"
+    echo " !     Failed to execute dokku command over ssh: exit code $?" 1>&2
+    echo " !     If there was no output from Dokku, ensure your configured SSH Key can connect to the remote server" 1>&2
+    return $ssh_exit_code
+  }
+}
+
+if [[ "$0" == "dokku" ]] || [[ "$0" == *dokku_client.sh ]] || [[ "$0" == $(which dokku) ]]; then
+  main "$@"
+  exit $?
 fi

contrib/packer.json

@@ -19,10 +19,10 @@
         "sleep 30",
 
         "echo '--> Updating apt repositories'",
-        "sudo apt-get update -qq > /dev/null",
+        "sudo apt-get update -qq >/dev/null",
 
         "echo '--> Installing make requirement'",
-        "sudo apt-get -qq -y install build-essential",
+        "sudo apt-get -qq -y --no-install-recommends install build-essential",
 
         "cd /tmp && make install-from-deb",
         "rm /root/.ssh/authorized_keys"

contrib/release-dokku

@@ -0,0 +1,409 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
+
+readonly ROOT_DIR="$(cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")" && pwd)"
+readonly TMP_WORK_DIR="$(mktemp -d "/tmp/dokku-release.XXXXXX")"
+readonly DOKKU_GIT_REV="$(git rev-parse HEAD)"
+
+trap 'rm -rf "$TMP_WORK_DIR" >/dev/null' RETURN INT TERM EXIT
+
+log-info() {
+  # shellcheck disable=SC2034
+  declare desc="Log info formatter"
+  echo "$*"
+}
+
+log-error() {
+  # shellcheck disable=SC2034
+  declare desc="Log error formatter"
+  echo "!   $*" 1>&2
+}
+
+log-fail() {
+  # shellcheck disable=SC2034
+  declare desc="Log fail formatter"
+  log-error "$*"
+  exit 1
+}
+
+fn-build-dokku() {
+  declare desc="Builds dokku packages within a docker container"
+  declare IS_RELEASE="$1" DOKKU_VERSION="$2"
+  local NAME GOLANG_VERSION
+
+  if [[ -z "$DOKKU_VERSION" ]]; then
+    log-error "Invalid deb file specified"
+    return 1
+  fi
+
+  NAME="dokku:build"
+  [[ "$IS_RELEASE" == "true" ]] && NAME="dokku:build-release"
+  [[ -n "$DOKKU_VERSION" ]] || DOKKU_VERSION="master"
+
+  pushd "$ROOT_DIR" >/dev/null
+  GOLANG_VERSION="$(grep BUILD_IMAGE common.mk | cut -d' ' -f3 | cut -d':' -f2)"
+  docker build \
+    --build-arg DOKKU_VERSION="$DOKKU_VERSION" \
+    --build-arg DOKKU_GIT_REV="$DOKKU_GIT_REV" \
+    --build-arg IS_RELEASE="$IS_RELEASE" \
+    --build-arg PLUGIN_MAKE_TARGET="build" \
+    --build-arg GOLANG_VERSION="$GOLANG_VERSION" \
+    -f "contrib/build-dokku.Dockerfile" \
+    -t "$NAME" .
+  return "$?"
+}
+
+fn-extract-package() {
+  declare desc="Extract packages from a docker container to the root directory"
+  declare IS_RELEASE="$1" PACKAGE_NAME="$2"
+  local NAME
+
+  if [[ -z "$PACKAGE_NAME" ]]; then
+    log-error "Invalid deb file specified"
+    return 1
+  fi
+
+  NAME="dokku:build"
+  [[ "$IS_RELEASE" == "true" ]] && NAME="dokku:build-release"
+
+  log-info "(extract-package) writing ${PACKAGE_NAME} to correct path"
+  docker run --rm --entrypoint cat "$NAME" "/tmp/${PACKAGE_NAME}" >"${ROOT_DIR}/build/${PACKAGE_NAME}"
+  return "$?"
+}
+
+fn-in-array() {
+  declare desc="return true if value ($1) is in list (all other arguments)"
+
+  local e
+  for e in "${@:2}"; do
+    [[ "$e" == "$1" ]] && return 0
+  done
+  return 1
+}
+
+fn-is-release() {
+  declare desc="Checks if a given run is a release run"
+  declare RELEASE="$1"
+  local IS_RELEASE=false
+  if [[ "$RELEASE" == "major" ]] || [[ "$RELEASE" == "minor" ]] || [[ "$RELEASE" == "patch" ]]; then
+    IS_RELEASE=true
+  fi
+
+  echo "$IS_RELEASE"
+}
+
+fn-version-current() {
+  declare desc="Retrieves the current version of dokku"
+  pushd "$ROOT_DIR" >/dev/null
+  grep Version debian/control | cut -d' ' -f2
+}
+
+fn-version-next() {
+  declare desc="Calculates the next version name of dokku"
+  declare CURRENT_VERSION="$1" RELEASE="$2"
+  local major minor patch short_object
+
+  major=$(echo "$CURRENT_VERSION" | awk '{split($0,a,"."); print a[1]}')
+  minor=$(echo "$CURRENT_VERSION" | awk '{split($0,a,"."); print a[2]}')
+  patch=$(echo "$CURRENT_VERSION" | awk '{split($0,a,"."); print a[3]}')
+
+  if [[ "$RELEASE" == "major" ]]; then
+    major=$((major + 1))
+    minor="0"
+    patch="0"
+  elif [[ "$RELEASE" == "minor" ]]; then
+    minor=$((minor + 1))
+    patch="0"
+  elif [[ "$RELEASE" == "patch" ]]; then
+    patch=$((patch + 1))
+  else
+    short_object=$(git log --oneline | tail -n 1 | cut -d' ' -f1)
+    echo "${CURRENT_VERSION}build+$(echo "$DOKKU_GIT_REV" | cut -c1-${#short_object})"
+    return 0
+  fi
+
+  echo "${major}.${minor}.${patch}"
+}
+
+fn-publish-package() {
+  declare desc="Publishes a package to packagecloud"
+  declare IS_RELEASE="$1" RELEASE_TYPE="$2" PACKAGE_NAME="$3"
+  local REPOSITORY=dokku/dokku-betafish DIST=ubuntu EXIT_CODE=0
+  local OS_ID ex
+
+  [[ "$IS_RELEASE" == "true" ]] && REPOSITORY=dokku/dokku
+  [[ "$RELEASE_TYPE" == "rpm" ]] && DIST=el/7
+
+  if [[ "$DIST" == "ubuntu" ]]; then
+    OS_IDS=("xenial" "bionic" "focal")
+    for OS_ID in "${OS_IDS[@]}"; do
+      log-info "(release-dokku) pushing ${RELEASE_TYPE} to packagecloud.com/${REPOSITORY}/${DIST}"
+      package_cloud push "${REPOSITORY}/${DIST}/${OS_ID}" "$PACKAGE_NAME"
+      ex="$?"
+      if [[ "$ex" -ne "0" ]]; then
+        EXIT_CODE="$ex"
+      fi
+    done
+
+    DIST=debian
+    OS_IDS=("stretch" "buster")
+    for OS_ID in "${OS_IDS[@]}"; do
+      log-info "(release-dokku) pushing ${RELEASE_TYPE} to packagecloud.com/${REPOSITORY}/${DIST}"
+      package_cloud push "${REPOSITORY}/${DIST}/${OS_ID}" "$PACKAGE_NAME"
+      ex="$?"
+      if [[ "$ex" -ne "0" ]]; then
+        EXIT_CODE="$ex"
+      fi
+    done
+  else
+    log-info "(release-dokku) pushing ${RELEASE_TYPE} to packagecloud.com/${REPOSITORY}/${DIST}"
+    package_cloud push "${REPOSITORY}/${DIST}" "$PACKAGE_NAME"
+    EXIT_CODE="$?"
+  fi
+  return "$EXIT_CODE"
+}
+
+fn-replace-version() {
+  declare desc="Replaces the version within a file"
+  local CURRENT_VERSION="$1"
+  local NEXT_VERSION="$2"
+  local FILENAME="$3"
+  sed -i.bak "s/${CURRENT_VERSION//./\.}/$NEXT_VERSION/g" "$FILENAME" && rm "$FILENAME.bak"
+  git add "$FILENAME"
+}
+
+fn-repo-merged-requests() {
+  declare desc="Retrieves all pull request ids since a given release of dokku"
+  declare TAG="$1"
+  git log "v${TAG}..HEAD" --oneline | grep "Merge pull request" | cut -d' ' -f 5 | cut -d '#' -f2
+}
+
+fn-repo-push-tags() {
+  declare desc="Pushes tags and the repository to github"
+  declare IS_RELEASE="$1"
+
+  if [[ "$IS_RELEASE" == "false" ]]; then
+    return
+  fi
+
+  pushd "$ROOT_DIR" >/dev/null
+  git push --tags origin master
+}
+
+fn-repo-update() {
+  declare desc="Updates files within the repository for a given release"
+  declare IS_RELEASE="$1" CURRENT_VERSION="$2" NEXT_VERSION="$3"
+
+  log-info "(release-dokku) Replacing ${CURRENT_VERSION} with ${NEXT_VERSION}"
+  for f in plugins/*/plugin.toml; do
+    fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" "$f"
+  done
+
+  if [[ "$IS_RELEASE" == "false" ]]; then
+    return
+  fi
+
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" contrib/dokku-installer.py
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" debian/control
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" Dockerfile
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/advanced-usage/plugin-management.md
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/assets/favicons/browserconfig.xml
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/assets/favicons/manifest.json
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/assets/style.css
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/development/release-process.md
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/getting-started/install/docker.md
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/getting-started/installation.md
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/home.html
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/template.html
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" README.md
+
+  if [[ "$RELEASE" == 'patch' ]]; then
+    fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" docs/assets/versions.json
+  else
+    versions=$(python -c 'import json,sys;d=json.load(sys.stdin);d["max-versions"].append("'"${NEXT_VERSION}"'"); print(json.dumps(d, indent=2, sort_keys=True))' <docs/assets/versions.json)
+    echo "$versions" >docs/assets/versions.json
+    git add docs/assets/versions.json
+  fi
+
+  if [[ "$IS_RELEASE" == "false" ]]; then
+    return
+  fi
+
+  log-info "(release-dokku) Adding HISTORY.md, committing and tagging"
+  fn-repo-update-history-and-commit "$CURRENT_VERSION" "$NEXT_VERSION"
+  git tag "v${NEXT_VERSION}"
+}
+
+fn-repo-update-history-and-commit() {
+  declare desc="Updates the history file and commits the changes"
+  declare CURRENT_VERSION="$1" NEXT_VERSION="$2"
+  local PULL_REQUEST_ID TITLE AUTHOR TYPE CHANGELOG_TEXT
+  local COMMIT_MESSAGE HISTORY HISTORY_CONTENTS HISTORY_DOCUMENTATION HISTORY_ENHANCEMENT HISTORY_BC_BREAK HISTORY_REFACTOR HISTORY_BUG HISTORY_OTHER HISTORY_TESTS ISSUE_FILE
+
+  pushd "$ROOT_DIR" >/dev/null
+
+  mkdir -p /tmp/github-data
+
+  for PULL_REQUEST_ID in $(fn-repo-merged-requests "$CURRENT_VERSION"); do
+    ISSUE_FILE="/tmp/github-data/${PULL_REQUEST_ID}.json"
+    if [[ ! -f "$ISSUE_FILE" ]]; then
+      curl -sS "https://api.github.com/repos/dokku/dokku/issues/${PULL_REQUEST_ID}" >"$ISSUE_FILE"
+    fi
+
+    TITLE="$(jq -r '.title' "$ISSUE_FILE")"
+    AUTHOR="$(jq -r '.user.login' "$ISSUE_FILE")"
+    TYPE="$(jq -r '.labels[] | select( .name | contains("type") ) | .name' "$ISSUE_FILE" | cut -d' ' -f2)"
+    CHANGELOG_TEXT="- #${PULL_REQUEST_ID}: @${AUTHOR} ${TITLE}"
+
+    if [[ "$TYPE" == "bc-break" ]]; then
+      HISTORY_BC_BREAK="${HISTORY_BC_BREAK}"$'\n'"$CHANGELOG_TEXT"
+    elif [[ "$TYPE" == "bug" ]]; then
+      HISTORY_BUG="${HISTORY_BUG}"$'\n'"$CHANGELOG_TEXT"
+    elif [[ "$TYPE" == "documentation" ]]; then
+      HISTORY_DOCUMENTATION="${HISTORY_DOCUMENTATION}"$'\n'"$CHANGELOG_TEXT"
+    elif [[ "$TYPE" == "enhancement" ]]; then
+      HISTORY_ENHANCEMENT="${HISTORY_ENHANCEMENT}"$'\n'"$CHANGELOG_TEXT"
+    elif [[ "$TYPE" == "refactor" ]]; then
+      HISTORY_REFACTOR="${HISTORY_REFACTOR}"$'\n'"$CHANGELOG_TEXT"
+    elif [[ "$TYPE" == "tests" ]]; then
+      HISTORY_TESTS="${HISTORY_TESTS}"$'\n'"$CHANGELOG_TEXT"
+    else
+      HISTORY_OTHER="${HISTORY_OTHER}"$'\n'"$CHANGELOG_TEXT"
+    fi
+  done
+
+  HISTORY="# History"
+  HISTORY="${HISTORY}"$'\n\n'"## ${NEXT_VERSION}"
+  HISTORY="${HISTORY}"$'\n\n'"Install/update via the bootstrap script:"
+  HISTORY="${HISTORY}"$'\n\n'"\`\`\`shell"
+  HISTORY="${HISTORY}"$'\n'"wget https://raw.githubusercontent.com/dokku/dokku/v${NEXT_VERSION}/bootstrap.sh"
+  HISTORY="${HISTORY}"$'\n'"sudo DOKKU_TAG=v${NEXT_VERSION} bash bootstrap.sh"
+  HISTORY="${HISTORY}"$'\n'"\`\`\`"
+
+  if [[ -f "docs/appendices/${NEXT_VERSION}-migration-guide.md" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"See the [${NEXT_VERSION} migration guide](/docs/appendices/${NEXT_VERSION}-migration-guide.md) for more information on migrating to ${NEXT_VERSION}."
+  fi
+
+  if [[ "$HISTORY_BC_BREAK" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### Backwards Compatibility Breaks"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_BC_BREAK"
+  fi
+
+  if [[ "$HISTORY_BUG" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### Bug Fixes"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_BUG"
+  fi
+
+  if [[ "$HISTORY_ENHANCEMENT" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### New Features"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_ENHANCEMENT"
+  fi
+
+  if [[ "$HISTORY_REFACTOR" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### Refactors"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_REFACTOR"
+  fi
+
+  if [[ "$HISTORY_DOCUMENTATION" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### Documentation"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_DOCUMENTATION"
+  fi
+
+  if [[ "$HISTORY_TESTS" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### Tests"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_TESTS"
+  fi
+
+  if [[ "$HISTORY_OTHER" ]]; then
+    HISTORY="${HISTORY}"$'\n\n'"### Other"
+    HISTORY="${HISTORY}"$'\n'"$HISTORY_OTHER"
+  fi
+
+  sed -i.bak '1d' HISTORY.md && rm HISTORY.md.bak
+  HISTORY_CONTENTS="$(cat HISTORY.md)"
+  echo -e "$HISTORY\n$HISTORY_CONTENTS" >HISTORY.md
+  git add HISTORY.md
+
+  COMMIT_MESSAGE="Release ${NEXT_VERSION}"$'\n\n'"${HISTORY}"
+  git commit -m "${COMMIT_MESSAGE}"
+}
+
+fn-require-bin() {
+  declare desc="Checks that a binary exists"
+  declare BINARY="$1"
+  if ! command -v "$BINARY" &>/dev/null; then
+    log-fail "Missing ${BINARY}, please install it"
+  fi
+}
+
+fn-build-docker-image() {
+  declare desc="Builds the dokku docker image and tags it with the given version"
+  declare VERSION="$1"
+  docker build -t "dokku/dokku:$VERSION" .
+}
+
+main() {
+  declare RELEASE="$1"
+  local CURRENT_VERSION NEXT_VERSION IS_RELEASE
+  local VALID_RELEASE_LEVELS=("major" "minor" "patch" "betafish" "build")
+
+  if [[ "$RELEASE" == '--trace' ]]; then
+    shift 1
+    RELEASE="$1"
+    TRACE=1 && set -x
+  fi
+
+  if [[ -z "$RELEASE" ]]; then
+    log-fail "Argument 1 must be one of [major, minor, patch, betafish, build], none given"
+  fi
+
+  if ! fn-in-array "$RELEASE" "${VALID_RELEASE_LEVELS[@]}"; then
+    log-fail "Argument 1 must be one of [major, minor, patch, betafish, build], '${RELEASE}' given"
+  fi
+
+  log-info "Creating $RELEASE release"
+
+  mkdir -p "build"
+  fn-require-bin "docker"
+  fn-require-bin "git"
+  if [[ "$RELEASE" != "build" ]]; then
+    fn-require-bin "package_cloud"
+    [[ -n "$PACKAGECLOUD_TOKEN" ]] || log-fail "Missing PACKAGECLOUD_TOKEN environment variable"
+  fi
+
+  CURRENT_VERSION="$(fn-version-current)"
+  NEXT_VERSION="$(fn-version-next "$CURRENT_VERSION" "$RELEASE")"
+  IS_RELEASE="$(fn-is-release "$RELEASE")"
+
+  echo "v${NEXT_VERSION}" >build/next-version
+
+  fn-repo-update "$IS_RELEASE" "$CURRENT_VERSION" "$NEXT_VERSION"
+  fn-build-dokku "$IS_RELEASE" "$NEXT_VERSION" || log-fail "Error building package"
+  fn-extract-package "$IS_RELEASE" "dokku_${NEXT_VERSION}_amd64.deb" || log-fail "Error extracting deb package"
+  fn-extract-package "$IS_RELEASE" "dokku-${NEXT_VERSION}-1.x86_64.rpm" || log-fail "Error extracting rpm package"
+  cp -f "build/dokku_${NEXT_VERSION}_amd64.deb" build/dokku.deb
+
+  if [[ "$RELEASE" != "build" ]]; then
+    fn-publish-package "$IS_RELEASE" "deb" "build/dokku_${NEXT_VERSION}_amd64.deb" || log-fail "Error publishing deb package"
+    fn-publish-package "$IS_RELEASE" "rpm" "build/dokku-${NEXT_VERSION}-1.x86_64.rpm" || log-fail "Error publishing rpm package"
+    fn-build-docker-image "$NEXT_VERSION" || log-fail "Error building docker image"
+
+    if [[ "$IS_RELEASE" == "true" ]]; then
+      docker tag "dokku/dokku:$NEXT_VERSION" "dokku/dokku:latest"
+      docker push "dokku/dokku:$NEXT_VERSION"
+      docker push "dokku/dokku:latest"
+    fi
+    fn-repo-push-tags "$IS_RELEASE"
+  fi
+
+  if [[ "$IS_RELEASE" != "true" ]]; then
+    git reset -q HEAD plugins/*/plugin.toml
+    git checkout -- plugins/*/plugin.toml
+  fi
+
+  echo "build/dokku_${NEXT_VERSION}_amd64.deb" >build/deb-filename
+  echo "build/dokku-${NEXT_VERSION}-1.x86_64.rpm" >build/rpm-filename
+}
+
+main "$@"

contrib/release-plugin

@@ -0,0 +1,175 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
+
+readonly TMP_WORK_DIR="$(mktemp -d "/tmp/dokku-plugin-release.XXXXXX")"
+
+trap 'rm -rf "$TMP_WORK_DIR" >/dev/null' RETURN INT TERM EXIT
+
+log-info() {
+  # shellcheck disable=SC2034
+  declare desc="Log info formatter"
+  echo "$*"
+}
+
+log-error() {
+  # shellcheck disable=SC2034
+  declare desc="Log error formatter"
+  echo "!   $*" 1>&2
+}
+
+log-fail() {
+  # shellcheck disable=SC2034
+  declare desc="Log fail formatter"
+  log-error "$*"
+  exit 1
+}
+
+fn-github-download-release() {
+  declare REPO_NAME="$1" VERSION="$2"
+
+  if [[ -n "$DOKKU_PLUGIN_GITHUB_ACCESS_TOKEN" ]]; then
+    curl -L "https://api.github.com/repos/${REPO_NAME}/tarball/${VERSION}?access_token=${DOKKU_PLUGIN_GITHUB_ACCESS_TOKEN}"
+  else
+    curl -L "https://api.github.com/repos/${REPO_NAME}/tarball/${VERSION}"
+  fi
+}
+
+fn-replace-version() {
+  declare desc="Replaces the version within a file"
+  local CURRENT_VERSION="$1"
+  local NEXT_VERSION="$2"
+  local FILENAME="$3"
+  sed -i.bak "s/${CURRENT_VERSION//./\.}/$NEXT_VERSION/g" "$FILENAME" && rm "$FILENAME.bak"
+  git add "$FILENAME"
+}
+
+fn-require-bin() {
+  declare desc="Checks that a binary exists"
+  declare BINARY="$1"
+  if ! command -v "$BINARY" &>/dev/null; then
+    log-fail "Missing ${BINARY}, please install it"
+  fi
+}
+
+main() {
+  local RELEASE="$1" AWS_RELEASE="$2"
+  local CURRENT_VERSION FILENAME NEXT_VERSION ORG_REPO_NAME REPO_NAME major minor patch
+
+  if [[ -z "$RELEASE" ]]; then
+    cat <<'EOF'
+requirements:
+
+- this is run in a plugin folder
+- a `plugin.toml` exists
+- the plugin is versioned via git
+
+usage:
+
+    # the following commands make these assumptions
+    # - the plugin's folder name is dokku-example, as is the remote repository
+    # - the current version is `0.0.1` in the `plugin.toml`
+
+    # create the alias
+    alias release-dokku-plugin="path/to/dokku/contrib/release-plugin"
+
+    # make a specific kind of release
+    release-dokku-plugin patch # creates a 0.0.2 release
+    release-dokku-plugin minor # creates a 0.1.0 release
+    release-dokku-plugin major # creates a 1.0.0 release
+
+    # release private plugins as tarballs to S3
+    # note that the plugin *must* exist on github for this to work
+    export DOKKU_PLUGIN_GITHUB_ACCESS_TOKEN="some-github-token"
+    export DOKKU_PLUGIN_S3_BUCKET="example"
+    export DOKKU_PLUGIN_S3_PATH="some/path"
+    # will upload the versioned tarball url to s3://example/some/path/dokku-plugin-name-0.0.1.tar.gz
+    release-dokku-plugin patch
+EOF
+    return
+  fi
+
+  fn-require-bin "git"
+
+  if [[ "$AWS_RELEASE" != "true" ]] && [[ "$AWS_RELEASE" != "false" ]]; then
+    local AWS_RELEASE=true
+  fi
+
+  if [[ "$AWS_RELEASE" == "true" ]] && [[ -z "$DOKKU_PLUGIN_GITHUB_ACCESS_TOKEN" ]]; then
+    log-info "You are running this without a DOKKU_PLUGIN_GITHUB_ACCESS_TOKEN environment variable."
+    log-info "Doing so disables uploading releases to S3, which may be necessary for installing private plugins."
+    while true; do
+      read -rp "Do you wish to continue? " yn
+      case $yn in
+        [Yy]*) break ;;
+        [Nn]*) exit ;;
+        *) echo "Please answer yes or no." ;;
+      esac
+    done
+  fi
+
+  if [[ "$AWS_RELEASE" == "true" ]]; then
+    fn-require-bin "aws"
+    fn-require-bin "curl"
+    if [[ -z "$DOKKU_PLUGIN_S3_BUCKET" ]]; then
+      log-fail "No DOKKU_PLUGIN_S3_BUCKET environment variable set"
+    fi
+    if [[ -z "$DOKKU_PLUGIN_S3_PATH" ]]; then
+      log-fail "No DOKKU_PLUGIN_S3_PATH environment variable set"
+    fi
+  fi
+
+  if [[ ! -f plugin.toml ]]; then
+    log-error "No plugin.toml found"
+    return 1
+  fi
+
+  if [[ ! -d .git ]]; then
+    log-error "No git repository found"
+    return 1
+  fi
+
+  CURRENT_VERSION=$(grep version plugin.toml | cut -d '"' -f2)
+  major=$(echo "$CURRENT_VERSION" | awk '{split($0,a,"."); print a[1]}')
+  minor=$(echo "$CURRENT_VERSION" | awk '{split($0,a,"."); print a[2]}')
+  patch=$(echo "$CURRENT_VERSION" | awk '{split($0,a,"."); print a[3]}')
+
+  if [[ "$RELEASE" == "major" ]]; then
+    major=$((major + 1))
+    minor="0"
+    patch="0"
+  elif [[ "$RELEASE" == "minor" ]]; then
+    minor=$((minor + 1))
+    patch="0"
+  elif [[ "$RELEASE" == "patch" ]]; then
+    patch=$((patch + 1))
+  else
+    log-error "Invalid release type specified"
+    return 1
+  fi
+  NEXT_VERSION="${major}.${minor}.${patch}"
+
+  fn-replace-version "$CURRENT_VERSION" "$NEXT_VERSION" plugin.toml
+  git add plugin.toml
+  git commit -m "Release ${NEXT_VERSION}"
+  git tag "${NEXT_VERSION}"
+  git push --tags origin master
+  git fetch
+
+  ORG_REPO_NAME="$(git remote -v | grep origin | HEAD -n1 | cut -d':' -f2 | cut -d'.' -f1)"
+  REPO_NAME="$(echo "$ORG_REPO_NAME" | cut -d'/' -f2)"
+  FILENAME="${REPO_NAME}-${NEXT_VERSION}.tar.gz"
+
+  if [[ "$AWS_RELEASE" == "true" ]]; then
+    DOKKU_PLUGIN_S3_BUCKET="${DOKKU_PLUGIN_S3_BUCKET%/}"
+    DOKKU_PLUGIN_S3_PATH="${DOKKU_PLUGIN_S3_PATH%/}"
+    if [[ "$DOKKU_PLUGIN_S3_PATH" != "/" ]]; then
+      DOKKU_PLUGIN_S3_PATH="${DOKKU_PLUGIN_S3_PATH}/"
+    fi
+
+    fn-github-download-release "$ORG_REPO_NAME" "$NEXT_VERSION" >"${TMP_WORK_DIR}/${FILENAME}"
+    aws s3 cp "${TMP_WORK_DIR}/${FILENAME}" "s3://${DOKKU_PLUGIN_S3_BUCKET}/${DOKKU_PLUGIN_S3_PATH}${FILENAME}" --acl public-read
+  fi
+}
+
+main "$@"

deb.mk

@@ -1,214 +1,53 @@
-HEROKUISH_DESCRIPTION = 'Herokuish uses Docker and Buildpacks to build applications like Heroku'
-HEROKUISH_REPO_NAME ?= gliderlabs/herokuish
-HEROKUISH_VERSION ?= 0.3.19
-HEROKUISH_ARCHITECTURE = amd64
-HEROKUISH_PACKAGE_NAME = herokuish_$(HEROKUISH_VERSION)_$(HEROKUISH_ARCHITECTURE).deb
+BUILD_DIRECTORY ?= /tmp
 
 DOKKU_DESCRIPTION = 'Docker powered PaaS that helps you build and manage the lifecycle of applications'
 DOKKU_REPO_NAME ?= dokku/dokku
 DOKKU_ARCHITECTURE = amd64
 
-define PLUGN_DESCRIPTION
-Hook system that lets users extend your application with plugins
-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 and has the proper language requirements installed
-endef
-PLUGN_REPO_NAME ?= dokku/plugn
-PLUGN_VERSION ?= 0.2.2
-PLUGN_ARCHITECTURE = amd64
-PLUGN_PACKAGE_NAME = plugn_$(PLUGN_VERSION)_$(PLUGN_ARCHITECTURE).deb
-PLUGN_URL = https://github.com/dokku/plugn/releases/download/v$(PLUGN_VERSION)/plugn_$(PLUGN_VERSION)_linux_x86_64.tgz
-
-define SSHCOMMAND_DESCRIPTION
-Turn SSH into a thin client specifically for your app
-Simplifies running a single command over SSH, and
-manages authorized keys (ACL) and users in order to do so.
-endef
-SSHCOMMAND_REPO_NAME ?= dokku/sshcommand
-SSHCOMMAND_VERSION ?= 0.6.0
-SSHCOMMAND_ARCHITECTURE = amd64
-SSHCOMMAND_PACKAGE_NAME = sshcommand_$(SSHCOMMAND_VERSION)_$(SSHCOMMAND_ARCHITECTURE).deb
-SSHCOMMAND_URL ?= https://raw.githubusercontent.com/dokku/sshcommand/v$(SSHCOMMAND_VERSION)/sshcommand
-
-define SIGIL_DESCRIPTION
-Standalone string interpolator and template processor
-Sigil is a command line tool for template processing
-and POSIX-compliant variable expansion. It was created
-for configuration templating, but can be used for any
-text processing.
-endef
-SIGIL_REPO_NAME ?= gliderlabs/sigil
-SIGIL_VERSION ?= 0.4.0
-SIGIL_ARCHITECTURE = amd64
-SIGIL_PACKAGE_NAME = gliderlabs_sigil_$(SIGIL_VERSION)_$(SIGIL_ARCHITECTURE).deb
-SIGIL_URL = https://github.com/gliderlabs/sigil/releases/download/v$(SIGIL_VERSION)/sigil_$(SIGIL_VERSION)_Linux_x86_64.tgz
-
 ifndef IS_RELEASE
 	IS_RELEASE = true
 endif
 
-export PLUGN_DESCRIPTION
-export SIGIL_DESCRIPTION
-export SSHCOMMAND_DESCRIPTION
 
-.PHONY: install-from-deb deb-all deb-herokuish deb-dokku deb-plugn deb-setup deb-sshcommand deb-sigil
+.PHONY: install-from-deb deb-all deb-dokku deb-setup
 
 install-from-deb:
 	@echo "--> Initial apt-get update"
-	sudo apt-get update -qq > /dev/null
-	sudo apt-get install -qq -y apt-transport-https
+	sudo apt-get update -qq >/dev/null
+	sudo apt-get -qq -y --no-install-recommends install 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
+	wget -nv -O - https://packagecloud.io/dokku/dokku/gpgkey | apt-key add -
+	@echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ $(shell lsb_release -cs 2>/dev/null || echo "bionic") 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 -qq -y --no-install-recommends install dokku
 
-deb-all: deb-setup deb-herokuish deb-dokku deb-plugn deb-sshcommand deb-sigil
-	mv /tmp/*.deb .
+deb-all: deb-setup deb-dokku
+	mv $(BUILD_DIRECTORY)/*.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 build-essential wget ruby-dev ruby1.9.1 lintian > /dev/null 2>&1
-	@command -v fpm > /dev/null || sudo gem install fpm --no-ri --no-rdoc
+	@sudo apt-get update -qq >/dev/null
+	@sudo DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true apt-get -qq -y --no-install-recommends install gcc git build-essential wget ruby-dev ruby1.9.1 lintian >/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:
-	rm -rf /tmp/tmp /tmp/build $(HEROKUISH_PACKAGE_NAME)
-	mkdir -p /tmp/tmp /tmp/build
+deb-dokku: /tmp/build-dokku/var/lib/dokku/GIT_REV
+	rm -f $(BUILD_DIRECTORY)/dokku_*_$(DOKKU_ARCHITECTURE).deb
 
-	@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" --branch "v$(HEROKUISH_VERSION)" /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:
-	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/bin
-	mkdir -p /tmp/build/usr/share/doc/dokku
-	mkdir -p /tmp/build/usr/share/dokku/contrib
-	mkdir -p /tmp/build/usr/share/lintian/overrides
-	mkdir -p /tmp/build/usr/share/man/man1
-	mkdir -p /tmp/build/var/lib/dokku/core-plugins/available
-
-	cp dokku /tmp/build/usr/bin
-	cp LICENSE /tmp/build/usr/share/doc/dokku/copyright
-	find . -name ".DS_Store" -depth -exec rm {} \;
-	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
+	cat /tmp/build-dokku/var/lib/dokku/VERSION | cut -d '-' -f 1 | cut -d 'v' -f 2 > /tmp/build-dokku/var/lib/dokku/STABLE_VERSION
 ifneq (,$(findstring false,$(IS_RELEASE)))
-	sed -i.bak -e "s/^/`date +%s`:/" /tmp/build/var/lib/dokku/STABLE_VERSION && rm /tmp/build/var/lib/dokku/STABLE_VERSION.bak
+	sed -i.bak -e "s/^/`date +%s`:/" /tmp/build-dokku/var/lib/dokku/STABLE_VERSION && rm /tmp/build-dokku/var/lib/dokku/STABLE_VERSION.bak
 endif
-	rm /tmp/build/DEBIAN/lintian-overrides
-	mv debian/lintian-overrides /tmp/build/usr/share/lintian/overrides/dokku
-	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 "/tmp/dokku_`cat /tmp/build/var/lib/dokku/STABLE_VERSION`_$(DOKKU_ARCHITECTURE).deb"
-	lintian "/tmp/dokku_`cat /tmp/build/var/lib/dokku/STABLE_VERSION`_$(DOKKU_ARCHITECTURE).deb"
 
-deb-plugn:
-	rm -rf /tmp/tmp /tmp/build $(PLUGN_PACKAGE_NAME)
-	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/bin
+	cp -r debian /tmp/build-dokku/DEBIAN
+	rm -f /tmp/build-dokku/DEBIAN/lintian-overrides
+	cp debian/lintian-overrides /tmp/build-dokku/usr/share/lintian/overrides/dokku
+	sed -i.bak "s/^Version: .*/Version: `cat /tmp/build-dokku/var/lib/dokku/STABLE_VERSION`/g" /tmp/build-dokku/DEBIAN/control && rm /tmp/build-dokku/DEBIAN/control.bak
+	dpkg-deb --build /tmp/build-dokku "$(BUILD_DIRECTORY)/dokku_`cat /tmp/build-dokku/var/lib/dokku/VERSION`_$(DOKKU_ARCHITECTURE).deb"
+	lintian "$(BUILD_DIRECTORY)/dokku_`cat /tmp/build-dokku/var/lib/dokku/VERSION`_$(DOKKU_ARCHITECTURE).deb"
 
-	@echo "-> Downloading package"
-	wget -q -O /tmp/tmp/plugn-$(PLUGN_VERSION).tgz $(PLUGN_URL)
-	cd /tmp/tmp/ && tar zxf /tmp/tmp/plugn-$(PLUGN_VERSION).tgz
-
-	@echo "-> Copying files into place"
-	cp /tmp/tmp/plugn /tmp/build/usr/bin/plugn && chmod +x /tmp/build/usr/bin/plugn
-
-	@echo "-> Creating $(PLUGN_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n plugn \
-			 --version $(PLUGN_VERSION) \
-			 --architecture $(PLUGN_ARCHITECTURE) \
-			 --package $(PLUGN_PACKAGE_NAME) \
-			 --url "https://github.com/$(PLUGN_REPO_NAME)" \
-			 --maintainer "Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>" \
-			 --category utils \
-			 --description "$$PLUGN_DESCRIPTION" \
-			 --license 'MIT License' \
-			 .
-	mv *.deb /tmp
-
-deb-sshcommand:
-	rm -rf /tmp/tmp /tmp/build $(SSHCOMMAND_PACKAGE_NAME)
-	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/local/bin
-
-	@echo "-> Downloading package"
-	wget -q -O /tmp/tmp/sshcommand-$(SSHCOMMAND_VERSION) $(SSHCOMMAND_URL)
-
-	@echo "-> Copying files into place"
-	mkdir -p "/tmp/build/usr/local/bin"
-	cp /tmp/tmp/sshcommand-$(SSHCOMMAND_VERSION) /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 \
-			 --version $(SSHCOMMAND_VERSION) \
-			 --architecture $(SSHCOMMAND_ARCHITECTURE) \
-			 --package $(SSHCOMMAND_PACKAGE_NAME) \
-			 --url "https://github.com/$(SSHCOMMAND_REPO_NAME)" \
-			 --maintainer "Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>" \
-			 --category admin \
-			 --description "$$SSHCOMMAND_DESCRIPTION" \
-			 --license 'MIT License' \
-			 .
-	mv *.deb /tmp
-
-deb-sigil:
-	rm -rf /tmp/tmp /tmp/build $(SIGIL_PACKAGE_NAME)
-	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/bin
-
-	@echo "-> Downloading package"
-	wget -q -O /tmp/tmp/sigil-$(SIGIL_VERSION).tgz $(SIGIL_URL)
-	cd /tmp/tmp/ && tar zxf /tmp/tmp/sigil-$(SIGIL_VERSION).tgz
-
-	@echo "-> Copying files into place"
-	cp /tmp/tmp/sigil /tmp/build/usr/bin/sigil && chmod +x /tmp/build/usr/bin/sigil
-
-	@echo "-> Creating $(SIGIL_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n gliderlabs-sigil \
-			 --version $(SIGIL_VERSION) \
-			 --architecture $(SIGIL_ARCHITECTURE) \
-			 --package $(SIGIL_PACKAGE_NAME) \
-			 --url "https://github.com/$(SIGIL_REPO_NAME)" \
-			 --maintainer "Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>" \
-			 --category utils \
-			 --description "$$SIGIL_DESCRIPTION" \
-			 --license 'MIT License' \
-			 .
-	mv *.deb /tmp

debian/config

@@ -1,5 +1,6 @@
 #!/bin/bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
 if [[ -e /usr/share/debconf/confmodule ]]; then
   # shellcheck disable=SC1091
@@ -14,9 +15,10 @@ db_go || true
 
 db_get "dokku/web_config"
 if [ $RET = "true" ]; then
-    exit 0
+  exit 0
 fi
 
+db_input "high" "dokku/nginx_enable" || true
 db_input "high" "dokku/hostname" || true
 db_input "high" "dokku/vhost_enable" || true
 if [ "$ACTION" != "reconfigure" ]; then

debian/control

@@ -1,11 +1,11 @@
 Package: dokku
-Version: 0.7.2
+Version: 0.24.4
 Section: web
 Priority: optional
 Architecture: amd64
-Depends: locales, git, make, curl, gcc, man-db, sshcommand, gliderlabs-sigil, docker-engine-cs (>= 1.9.1) | docker-engine (>= 1.9.1), software-properties-common, python-software-properties
-Recommends: herokuish
-Pre-Depends: nginx, dnsutils, cgroupfs-mount | cgroup-lite, plugn, sudo, python2.7, debconf
+Depends: locales, git, cpio, curl, man-db, netcat, sshcommand (>= 0.12.0), docker-engine-cs (>= 17.05.0) | docker-engine (>= 17.05.0) | docker-io (>= 17.05.0) | docker.io (>= 17.05.0) | docker-ce (>= 17.05.0) | docker-ee (>= 17.05.0) | moby-engine, docker-image-labeler (>= 0.2.2), net-tools, netrc, software-properties-common, procfile-util (>= 0.11.0), python-software-properties | python3-software-properties, rsyslog, dos2unix, jq, unzip
+Recommends: herokuish (>= 0.3.4), parallel, dokku-update, dokku-event-listener
+Pre-Depends: gliderlabs-sigil, nginx (>= 1.8.0) | openresty, dnsutils, cgroupfs-mount | cgroup-lite, plugn (>= 0.3.0), sudo, python3, debconf
 Maintainer: Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>
 Description: Docker-powered PaaS that helps build and manage the lifecycle of applications
  Dokku is an extensible, open source Platform as a Service

debian/lintian-overrides

@@ -1,3 +1,15 @@
-dokku: command-with-path-in-maintainer-script postinst:16 /usr/bin/sshcommand
-dokku: maintainer-script-calls-systemctl postinst:87
+dokku: command-with-path-in-maintainer-script postinst:22 /usr/bin/sshcommand
+dokku: maintainer-script-calls-systemctl postinst:98
 dokku: changelog-file-missing-in-native-package
+dokku: statically-linked-binary
+dokku: unstripped-binary-or-object
+
+# The Go compiler is currently unable to produce read-only relocations
+# (it produces static binaries).
+dokku: hardening-no-relro
+
+# Built golang binaries link to libc
+dokku: missing-dependency-on-libc
+
+# Temporary python dependency until #2247 is resolved
+dokku: python-script-but-no-python-dep usr/share/dokku/contrib/dokku-installer.py

debian/postinst

@@ -1,11 +1,17 @@
 #!/bin/bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
 if [[ -e /usr/share/debconf/confmodule ]]; then
   # shellcheck disable=SC1091
   . /usr/share/debconf/confmodule
 fi
 
+if [[ -r /etc/default/dokku ]]; then
+  # shellcheck disable=SC1091
+  source /etc/default/dokku
+fi
+
 readonly DOKKU_ROOT="${DOKKU_ROOT:-/home/dokku}"
 readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
 
@@ -20,103 +26,141 @@ call-sshcommand() {
   fi
 }
 
-case "$1" in
-  abort-upgrade|abort-remove|abort-deconfigure)
-    ;;
+setup-user() {
+  echo "Setting up dokku user"
+  call-sshcommand create dokku /usr/bin/dokku
+  grep -i -E "^docker" /etc/group || groupadd docker
+  usermod -aG docker dokku
+  mkdir -p "$DOKKU_ROOT/.ssh" "$DOKKU_ROOT/.dokkurc"
+  touch "$DOKKU_ROOT/.ssh/authorized_keys"
+  chown -R dokku:dokku "$DOKKU_ROOT/.ssh" "${DOKKU_ROOT}/.dokkurc"
+}
 
-  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!"
-    call-sshcommand create dokku /usr/bin/dokku
+setup-storage() {
+  echo "Setting up storage directories"
+  mkdir -p "${DOKKU_LIB_ROOT}/data" "${DOKKU_LIB_ROOT}/data/storage"
+  chown dokku:dokku "${DOKKU_LIB_ROOT}/data"
+}
 
-    egrep -i "^docker" /etc/group || groupadd docker
-    usermod -aG docker dokku
+setup-plugins() {
+  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 "Setting up storage directories"
-    mkdir -p ${DOKKU_LIB_ROOT}/data ${DOKKU_LIB_ROOT}/data/storage
-    chown dokku:dokku -R ${DOKKU_LIB_ROOT}/data
+  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 "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
+  db_get "dokku/nginx_enable"
+  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 [ "$plugin" = "nginx-vhosts" ] && [ "$RET" = "false" ]; then
+      echo "Skipping enable of nginx-vhosts plugin"
+      continue
+    elif [ ! -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
+  find -L "${DOKKU_LIB_ROOT}" -type l -delete
+  chown dokku:dokku -R "${DOKKU_LIB_ROOT}/plugins" "${DOKKU_LIB_ROOT}/core-plugins"
 
-    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 "Install all core plugins"
+  dokku plugin:install --core
+}
 
-    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
-    find -L ${DOKKU_LIB_ROOT} -type l -delete
-    chown dokku:dokku -R ${DOKKU_LIB_ROOT}/plugins ${DOKKU_LIB_ROOT}/core-plugins
+setup-sshcommand() {
+  echo "Ensure proper sshcommand path"
+  echo '/usr/bin/dokku' >"${DOKKU_ROOT}/.sshcommand"
+  if [[ -f .ssh/authorized_keys ]]; then
+    sed -i.bak 's#/usr/local/bin/dokku#/usr/bin/dokku#' "${DOKKU_ROOT}/.ssh/authorized_keys"
+    rm "${DOKKU_ROOT}/.ssh/authorized_keys"
+  fi
+}
 
-    echo "Ensure proper sshcommand path"
-    echo '/usr/bin/dokku' > "${DOKKU_ROOT}/.sshcommand"
-    if [[ -f .ssh/authorized_keys ]]; then
-      sed -i.bak 's#/usr/local/bin/dokku#/usr/bin/dokku#' "${DOKKU_ROOT}/.ssh/authorized_keys"
-      rm "${DOKKU_ROOT}/.ssh/authorized_keys"
+setup-dokku-installer() {
+  NGINX_ROOT="/etc/nginx"
+  [[ -x /usr/bin/openresty ]] && NGINX_ROOT="/usr/local/openresty/nginx/conf"
+
+  if command -v "python3" &>/dev/null; then
+    sed -i '1 s/^.*$/#!\/usr\/bin\/env python3/' /usr/share/dokku/contrib/dokku-installer.py
+  elif command -v "python2.7" &>/dev/null; then
+    sed -i '1 s/^.*$/#!\/usr\/bin\/env python2.7/' /usr/share/dokku/contrib/dokku-installer.py
+  fi
+
+  if [[ -f "$NGINX_ROOT/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
 
-    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
+    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
+dpkg-handling() {
+  db_get "dokku/web_config"
+  if [ "$RET" = "true" ]; then
+    db_stop
+    exit 0
+  fi
 
+  if [ -f "${DOKKU_ROOT}/VHOST" ]; then
+    echo "VHOST file detected, skipping modification"
+  else
     db_get "dokku/vhost_enable"
     if [ "$RET" = "true" ]; then
-        db_get "dokku/hostname"
-        echo "$RET" > "${DOKKU_ROOT}/VHOST"
-    else
-        rm -f "${DOKKU_ROOT}/VHOST"
+      db_get "dokku/hostname"
+      echo "Setting VHOST contents to $RET"
+      echo "$RET" >"${DOKKU_ROOT}/VHOST"
+    fi
+  fi
+
+  db_get "dokku/hostname"
+  echo "$RET" >"${DOKKU_ROOT}/HOSTNAME"
+
+  if [ -z "${DEBCONF_RECONFIGURE}" ]; then
+    db_get "dokku/key_file"
+    if [ -f "$RET" ]; then
+      call-sshcommand acl-add dokku default <"$RET" || true
+    fi
+  fi
+}
+
+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
+    if [[ -f /sbin/modprobe ]]; then
+      modprobe aufs || echo "WARNING: Restart server to finish installing dokku!"
     fi
 
-    db_get "dokku/hostname"
-    echo "$RET" > "${DOKKU_ROOT}/HOSTNAME"
-
-    if [ -z "${DEBCONF_RECONFIGURE}" ]; then
-      db_get "dokku/key_file"
-      if [ -f "$RET" ]; then
-        call-sshcommand acl-add dokku default < "$RET" || true
-      fi
-    fi
+    setup-user
+    setup-storage
+    setup-plugins
+    setup-sshcommand
+    setup-dokku-installer
+    dpkg-handling
     ;;
 
   *)

debian/postrm

@@ -1,5 +1,6 @@
 #!/bin/bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
 if [[ -e /usr/share/debconf/confmodule ]]; then
   # shellcheck disable=SC1091
@@ -11,20 +12,27 @@ readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
 readonly DOKKU_LOGS_DIR="${DOKKU_LOGS_DIR:="/var/log/dokku"}"
 
 main() {
-  if [[ -f /etc/systemd/system/dokku-installer.conf ]] || [[ -f /etc/init/dokku-installer.conf ]]; then
+  if [[ -f /etc/systemd/system/dokku-installer.service ]] || [[ -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-installer.service
   rm -f /etc/systemd/system/dokku-redeploy.service
   rm -f /etc/update-motd.d/99-dokku
 
-  (nginx -t && service nginx reload) || true
+  db_get "dokku/nginx_enable"
+  if [ "$RET" = "true" ]; then
+    (nginx -t && service nginx reload) || true
+  fi
 
   if [[ "$1" == "purge" ]]; then
-    rm -f ${DOKKU_ROOT}/.dokkurc ${DOKKU_ROOT}/dokkurc ${DOKKU_ROOT}/tls
+    rm -f /usr/local/openresty/nginx/conf/conf.d/dokku.conf
+    rm -f /usr/local/openresty/nginx/conf/conf.d/dokku-installer.conf
+    rm -f /etc/nginx/conf.d/dokku.conf
+    rm -f /etc/nginx/conf.d/dokku-installer.conf
+    rm -rf ${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

debian/preinst

@@ -1,54 +1,79 @@
 #!/bin/bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
 if [[ -e /usr/share/debconf/confmodule ]]; then
   # shellcheck disable=SC1091
   . /usr/share/debconf/confmodule
 fi
 
+setup_dokku_installer() {
+  NGINX_BASE_PATH="$1"
+  NGINX_INIT_NAME="$2"
+
+  NGINX_CONF="${NGINX_BASE_PATH}/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 $NGINX_BASE_PATH/sites-enabled/*
+  DOKKU_DISTRO="$(
+    . /etc/os-release >/dev/null 2>&1 || true
+    echo "$ID"
+  )"
+  case "$DOKKU_DISTRO" in
+    debian)
+      /usr/sbin/invoke-rc.d "$NGINX_INIT_NAME" reload || /usr/sbin/invoke-rc.d "$NGINX_INIT_NAME" start
+      ;;
+    ubuntu)
+      if [[ -x /usr/bin/sv ]]; then
+        /usr/bin/sv reload "$NGINX_INIT_NAME" || /usr/bin/sv start "$NGINX_INIT_NAME"
+      else
+        "/etc/init.d/$NGINX_INIT_NAME" reload || "/etc/init.d/$NGINX_INIT_NAME" start
+      fi
+      ;;
+  esac
+}
+
 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
+      if [[ -x /usr/bin/openresty ]]; then
+        setup_dokku_installer "/usr/local/openresty/nginx/conf" "openresty"
+      else
+        setup_dokku_installer "/etc/nginx" "nginx"
+      fi
     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
+        echo "Error: keyfile '$RET' not found." >&2
+        echo "       To deploy, you will need to generate a keypair and add with 'dokku ssh-keys:add'." >&2
+        db_reset "dokku/key_file"
       fi
     fi
     ;;
 
-  upgrade)
-    ;;
+  upgrade) ;;
 
-  abort-upgrade)
-    ;;
+  \
+    abort-upgrade) ;;
 
-  *)
+  \
+    *)
     echo "preinst called with unknown argument \`$1'" >&2
     exit 1
     ;;

debian/prerm

@@ -1,38 +1,39 @@
 #!/bin/bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+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
+    echo "Usage: $0 PID" >/dev/stderr
     exit 1
   fi
 
-  declare -i pid=$1;
-  ppid=0;
-  header_modifier="";
-  while : ; do
+  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;
+      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;
+      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
+  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
+    for app in $(DOKKU_QUIET_OUTPUT=1 dokku apps:list); do
       dokku --force apps:destroy $app
     done
 
@@ -40,7 +41,7 @@ main() {
     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;
+        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

debian/templates

@@ -22,3 +22,8 @@ Template: dokku/key_file
 Description: Keyfile for initial user:
 Type: string
 Default: /root/.ssh/id_rsa.pub
+
+Template: dokku/nginx_enable
+Description: Enable nginx-vhosts plugin?
+Type: boolean
+Default: true

docker/etc/cron.d/dokku-retire

@@ -0,0 +1,4 @@
+PATH=/usr/local/bin:/usr/bin:/bin
+SHELL=/bin/bash
+
+*/5 * * * * root /usr/bin/dokku ps:retire >> /var/log/dokku/retire.log 2>&1

docker/etc/logrotate.d/services

@@ -0,0 +1,9 @@
+/var/log/services/*[!0-9z] {
+  daily
+  missingok
+  rotate 7
+  compress
+  delaycompress
+  notifempty
+  copytruncate
+}

docker/etc/my_init.d/10_dokku_init

@@ -0,0 +1,73 @@
+#!/bin/bash
+set -eo pipefail
+
+log-info() {
+  declare desc="Log info formatter"
+  echo "    $*" 1>&2
+}
+
+log-fail() {
+  declare desc="Log fail formatter"
+  echo "!   $*" 1>&2
+  exit 1
+}
+
+main() {
+  local NGINX_ROOT
+
+  if [[ ! -d /mnt/dokku ]]; then
+    log-info "Creating missing /mnt/dokku"
+    mkdir -p /mnt/dokku
+  fi
+
+  directories=("/etc/ssh" "/home/dokku" "/var/lib/dokku/config" "/var/lib/dokku/data")
+  for dir in "${directories[@]}"; do
+    if [[ ! -e "$dir" ]]; then
+      log-info "Copying ${dir} skel into place"
+      mkdir -p "/mnt/dokku${dir}"
+      rsync -a "/skel${dir}/" "${dir}/" || log-fail "Unable to copy ${dir} skel into place"
+    fi
+
+    # chown mount directories to "dokku:dokku"
+    if [[ "$dir" != "/etc/ssh" ]]; then
+      find "$dir" -print0 | xargs -0 chown -h dokku:dokku
+    fi
+  done
+
+  if [[ -f /mnt/dokku/plugin-list ]]; then
+    while read line; do
+      dokku plugin:install "$(echo "$line" | awk '{print $2}')" "$(echo "$line" | cut -d':' -f1)"
+    done </mnt/dokku/plugin-list
+  fi
+
+  if [[ -n "$DOKKU_HOSTNAME" ]]; then
+    echo "dokku dokku/hostname string $DOKKU_HOSTNAME" | debconf-set-selections
+    echo "dokku dokku/vhost_enable boolean true" | debconf-set-selections
+    dokku --quiet domains:set-global "$DOKKU_HOSTNAME"
+  fi
+
+  if [[ -x /usr/local/bin/docker ]]; then
+    mkdir -p /home/dokku/.dokkurc
+    echo "export DOCKER_BIN=/usr/local/bin/docker" >"/home/dokku/.dokkurc/DOCKER_BIN"
+  fi
+
+  NGINX_ROOT="/etc/nginx"
+  if [[ -x /usr/bin/openresty ]]; then
+    NGINX_ROOT="/usr/local/openresty/nginx/conf"
+    rm -rf /etc/runit/runsvdir/default/nginx
+  else
+    rm -rf /etc/runit/runsvdir/default/openresty
+  fi
+
+  if [[ ! -f "/mnt/dokku${NGINX_ROOT}/dhparam.pem" ]]; then
+    mkdir -p "/mnt/dokku${NGINX_ROOT}"
+    openssl dhparam -out "/mnt/dokku${NGINX_ROOT}/dhparam.pem" 2048
+  fi
+
+  mkdir -p "${NGINX_ROOT}/conf.d"
+  cp -f "/mnt/dokku${NGINX_ROOT}/dhparam.pem" "${NGINX_ROOT}/dhparam.pem"
+  chown root:root "${NGINX_ROOT}/dhparam.pem"
+  chown root:root "${NGINX_ROOT}/conf.d"
+}
+
+main "$@"

docker/etc/runit/runsvdir/default/dokku-restore/finish

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+exec >>/var/log/services/dokku-restore
+exec 2>&1
+
+if [[ "$1" -ne 0 ]]; then
+  echo "Error restoring dokku apps! Retrying in 30 seconds..."
+  exec sleep 30
+  exit 0
+fi
+
+echo "Done restoring dokku apps."
+exec sleep infinity
+
+exit 0

docker/etc/runit/runsvdir/default/dokku-restore/run

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+exec >>/var/log/services/dokku-restore
+exec 2>&1
+
+echo "Running dokku-restore"
+cd /tmp || exit 1
+
+exec dokku ps:restore

docker/etc/runit/runsvdir/default/nginx/run

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+exec >>/var/log/services/nginx
+exec 2>&1
+
+echo "Running nginx"
+exec /usr/sbin/nginx -c /etc/nginx/nginx.conf -g "daemon off;"

docker/etc/runit/runsvdir/default/openresty/run

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+exec >>/var/log/services/openresty
+exec 2>&1
+
+echo "Running openresty"
+exec /usr/bin/openresty -c /usr/local/openresty/nginx/conf/nginx.conf -g "daemon off;"

docker/etc/runit/runsvdir/default/rsyslog/run

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+exec >>/var/log/services/rsyslog
+exec 2>&1
+
+echo "Running rsyslog"
+exec /usr/sbin/rsyslogd -n

docker/etc/sudoers.d/dokku-docker

@@ -0,0 +1 @@
+dokku    ALL=NOPASSWD:SETENV:/usr/bin/docker,/usr/bin/docker-image-labeler

docker/usr/local/bin/docker

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
+
+main() {
+  declare desc="re-runs docker commands as sudo"
+  local DOCKER_BIN=""
+  if [[ -x "/usr/bin/docker" ]]; then
+    DOCKER_BIN="/usr/bin/docker"
+  fi
+
+  if [[ -z "$DOCKER_BIN" ]]; then
+    echo "!   No docker binary found" 1>&2
+    exit 1
+  fi
+
+  sudo -E "$DOCKER_BIN" "$@"
+}
+
+main "$@"

docker/usr/local/bin/docker-image-labeler

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
+
+main() {
+  declare desc="re-runs docker-image-labeler commands as sudo"
+  local DOCKER_IMAGE_LABELER_BIN=""
+  if [[ -x "/usr/bin/docker-image-labeler" ]]; then
+    DOCKER_IMAGE_LABELER_BIN="/usr/bin/docker-image-labeler"
+  fi
+
+  if [[ -z "$DOCKER_IMAGE_LABELER_BIN" ]]; then
+    echo "!   No docker-image-labeler binary found" 1>&2
+    exit 1
+  fi
+
+  sudo -E "$DOCKER_IMAGE_LABELER_BIN" "$@"
+}
+
+main "$@"

docker/usr/local/openresty/nginx/conf/nginx.conf

@@ -0,0 +1,30 @@
+user www-data;
+worker_processes auto;
+pid /run/openresty.pid;
+include /usr/local/openresty/nginx/conf/modules-enabled/*.conf;
+
+events {
+  worker_connections 768;
+}
+
+http {
+  sendfile on;
+  tcp_nopush on;
+  tcp_nodelay on;
+  keepalive_timeout 65;
+  types_hash_max_size 2048;
+
+  include /usr/local/openresty/nginx/conf/mime.types;
+  default_type application/octet-stream;
+
+  ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+  ssl_prefer_server_ciphers on;
+
+  access_log /var/log/openresty/access.log;
+  error_log /var/log/openresty/error.log;
+
+  gzip on;
+
+  include /usr/local/openresty/nginx/conf/conf.d/*.conf;
+  include /usr/local/openresty/nginx/conf/sites-enabled/*;
+}

docs/advanced-usage/backup-recovery.md

@@ -2,7 +2,51 @@
 
 > The backup plugin was deprecated in 0.4.x, below are backup recommendations for 0.5.x and later.
 
-## Backup and Migration Tutorial
+The best plan for disaster recovery is to always keep multiple (remote) copies of your local repo, static assets and periodic database dumps. Backups should be regularly tested for data integrity and completeness.
+
+## TLDR
+
+> Warning: This method has many caveats. Please read this entire document before assuming these backups work as expected, and test your backups on a regular basis.
+
+### Creating a backup
+
+To create a backup, run the following command at a time when not executing any Dokku commands or app deployments:
+
+```shell
+export BACKUP_TIME=$(date +%Y-%m-%d-%H-%M)
+sudo mkdir -p /var/lib/dokku/services
+sudo chown dokku:dokku /var/lib/dokku/services
+mkdir -p /tmp/dokku-backups/
+sudo tar -czvf "/tmp/dokku-backups/${BACKUP_TIME}.tar.gz" /home/dokku /var/lib/dokku/config /var/lib/dokku/data /var/lib/dokku/services /var/lib/dokku/plugins
+```
+
+This will create a point-in-time backup of your entire Dokku installation in the `/tmp/dokku-backups` directory. This backup may be moved offsite to another location via rsync, sftp, or some other protocol.
+
+It is recommended that backups are regularly cleaned from the originating server and tested as necessary.
+
+### Restoring a backup
+
+To extract the backup onto another server, copy the backup to the server and extract it using the following command.
+
+```shell
+sudo tar -xzvf path/to/dokku/backup.tar.gz -C /
+```
+
+At this point, all datastores should be individually started and checked for data integrity. Once this is complete, individual applications can be rebuilt. Please consult the [process management documentation](/docs/processes/process-management.md#rebuilding-apps) for more information on how to rebuild applications.
+
+## Caveats
+
+### App config
+
+Application config is largely held in a small number of places:
+
+- `/var/lib/dokku/config`: Properties set and managed by plugins
+- `/var/lib/dokku/data`: Files generated or extracted by various plugins
+- `/home/dokku`: Certain parts of Dokku core store data in this location
+
+Compressing these directories when no Dokku commands are running is enough to ensure a complete backup of the system.
+
+### Code Repositories
 
 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.
 
@@ -11,7 +55,14 @@ git remote rm dokku
 git remote add dokku dokku@[dokku.me:dokku.me]
 git push dokku [master]
 ```
-## Databases
+
+### Docker Image and Tar-based Apps
+
+These applications may fail to rebuild via the normal `ps:rebuild` method. Redeploy these apps by running the original commands used to deploy them
+
+### Datastores
+
+> Please note that point-in-time backups of the `/var/lib/dokku/services` directory may contain partially written data due to how various datastores work. Consult the official datastore documentation for the best documentation surrounding proper backup and restore procedures.
 
 Some plugins, like the official [dokku-postgres](https://github.com/dokku/dokku-postgres) plugin, have built-in commands that allow non-volatile data be exported and imported.
 
@@ -22,16 +73,26 @@ dokku postgres:export [db_name] > [db_name].dump
 dokku postgres:import [db_name] < [db_name].dump
 ```
 
-## Volumes and Static Assets
+Additionally, data for official datastores is located in the `/var/lib/dokku/services` directory. If the directory is restored and the plugin is available, a `dokku $SERVICE:start` may be enough to restart the service with the underlying data, so long as the datastore version does not change and the underlying data is not corrupt. If this is the case, it may be necessary to re-import all the data onto a fresh version of the datastore service.
+
+### Plugins
+
+The plugin directory is contained at the `/var/lib/dokku/plugins` directory. Core plugins will automatically be included in new installs, but custom plugins may not. The aforementioned `tar` creation command will back all plugins up, and the `tar` extract command will restore the plugins.
+
+Note that restoring a plugin will not trigger any `install` or `dependencies` triggers. You will need to run these manually. See the [plugin management documentation](/docs/advanced-usage/plugin-management.md#installing-a-plugin) for more information on how to trigger these two hooks.
+
+
+### Volumes and Static Assets
 
 Dokku doesn't enforce a [300mb](https://devcenter.heroku.com/articles/slug-compiler#slug-size) 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.
 
-See the [persistent storage documentation](/dokku/advanced-usage/persistent-storage/) for more details.
+System administrators are highly encouraged to store persistent data in app-specific subdirectories of the path `/var/lib/dokku/data/storage`. This will help ensure restores of the aforementioned primary Dokku directories will restore service to all apps.
 
+See the [persistent storage documentation](/docs/advanced-usage/persistent-storage.md) for more information on how to attach persistent storage to your application.
 
-## Disaster Recovery
+## Recovering app code
 
-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).
+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).
 
 ```shell
 mkdir [app-name] ; cd !$

docs/advanced-usage/deployment-tasks.md

@@ -2,57 +2,91 @@
 
 > 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:
+Sometimes you need to run a command on deployment time, but before an app is completely deployed. Common use cases include:
 
 * Checking a database is initialized
 * Running database migrations
 * Any commands required to set up the server (e.g. something like a Django `collectstatic`)
 
-## `app.json` and `scripts.dokku`
+To support this, Dokku provides support for a special `release` command within your app's `Procfile`, as well as a special `scripts.dokku` key inside of your app's `app.json` file. Be aware that all commands are run within the context of the built docker image - no commands affect the host unless there are volume mounts attached to your app.
 
-Dokku accomplishes this by using an `app.json` file. The format in use is similar to format of 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`.
-For buildpack apps, simply place an `app.json` file in the root of your repository.
-For dockerfile apps, place `app.json` in the configured `WORKDIR` directory; otherwise Dokku defaults to the buildpack app behavior of looking in `/app`.
->NOTE: postdeploy changes are *NOT* committed to the app image.
+Each "phase" has different expectations and limitations:
 
-### Example app.json
+- `app.json`: `scripts.dokku.predeploy`
+    - When to use: This should be used if your app does not support arbitrary build commands and you need to make changes to the built image.
+    - Are changes committed to the image at this phase: Yes
+    - Example use-cases
+        - Bundling assets in a slightly different way
+        - Installing a custom package from source or copying a binary into place
+- `app.json`: `scripts.dokku.postdeploy`
+    - When to use: This should be used in conjunction with external systems to signal the completion of your deploy.
+    - Are changes committed to the image at this phase: No
+    - Example use-cases
+        - Notifying slack that your app is deployed
+        - Coordinating traffic routing with a central load balancer
+- `app.json`: `scripts.postdeploy`
+    - When to use: This should be used when you wish to run a command _once_, after the app is created and not on subsequent deploys to the app.
+    - Are changes committed to the image at this phase: No
+    - Example use-cases
+        - Setting up OAuth clients and DNS
+        - Loading seed/test data into the app’s test database
+- `Procfile`: `release`
+    - When to use: This should be used in conjunction with external systems to signal the completion of your app image build.
+    - Are changes committed to the image at this phase: No
+    - Example use-cases
+        - Sending CSS, JS, and other assets from your app’s slug to a CDN or S3 bucket
+        - Priming or invalidating cache stores
+        - Running database migrations
+
+Additionally, if using a Dockerfile with an `ENTRYPOINT`, the deployment task is passed to that entrypoint as is. The exceptions are if the entrypoint is one of the following:
+
+- `["/tini", "--"]`
+- `["/bin/tini", "--"]`
+- `["/usr/bin/tini", "--"]`
+- `["/usr/local/bin/tini", "--"]`
+
+Please keep the above in mind when utilizing deployment tasks.
+
+> To execute commands on the host during a release phase, see the [plugin creation documentation](/docs/development/plugin-creation.md) docs for more information on building your own custom plugin.
+
+## `app.json` deployment tasks
+
+Dokku provides limited support for the `app.json` manifest from Heroku (documentation available [here](https://devcenter.heroku.com/articles/app-json-schema)). The keys available for use with Deployment Tasks are:
+
+- `scripts.dokku.predeploy`: This is run _after_ an app's docker image is built, but _before_ any containers are scheduled. Changes made to your image are committed at this phase.
+- `scripts.dokku.postdeploy`: This is run _after_ an app's containers are scheduled. Changes made to your image are *not* committed at this phase.
+- `scripts.postdeploy`: This is run _after_ an app's containers are scheduled. Changes made to your image are *not* committed at this phase.
+
+For buildpack-based deployments, the location of the `app.json` file should be at the root of your repository. Dockerfile-based app deploys should have the `app.json` in the configured `WORKDIR` directory; otherwise Dokku defaults to the buildpack app behavior of looking in `/app`.
+
+> Warning: Any failed `app.json` deployment task will fail the deploy. In the case of either phase, a failure will not affect any running containers.
+
+The following is an example `app.json` file. Please note that only the `scripts.dokku.predeploy` and `scripts.dokku.postdeploy` tasks are supported by Dokku at this time. All other fields will be ignored and can be omitted.
 
 ```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=success"
-    }
-  },
-  "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"
-    }
-  ]
+    "postdeploy": "curl https://some.external.api.service.com/created?state=success"
+  }
 }
 ```
+
+## Procfile Release command
+
+> New as of 0.14.0
+
+The `Procfile` also supports a special `release` command which acts in a similar way to the [Heroku Release Phase](https://devcenter.heroku.com/articles/release-phase). This command is executed _after_ an app's docker image is built, but _before_ any containers are scheduled. This is also run _after_ any command executed by `scripts.dokku.predeploy`.
+
+To use the `release` command, simply add a `release` stanza to your Procfile.
+
+```Procfile
+release: curl https://some.external.api.service.com/deployment?state=built
+```
+
+Unlike the `scripts.dokku.predeploy` command, changes made during by the `release` command are *not* persisted to disk.
+
+> Warning: scaling the release command up will likely result in unspecified issues within your deployment, and is highly discouraged.

docs/advanced-usage/docker-options.md

@@ -5,15 +5,16 @@
 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:clear <app> [<phase(s)>...]    # Clear a docker options from application
 docker-options:remove <app> <phase(s)> OPTION # Remove Docker option from app for phase (comma-separated phase list)
+docker-options:report [<app>] [<flag>]        # Displays a docker options report for one or more apps
 ```
 
 > When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so:
 >
 > ```shell
-> dokku docker-options:add myapp deploy,run "-v /home/dokku/logs/myapp:/app/logs"
+> dokku docker-options:add node-js-app deploy,run "-v /var/log/node-js-app:/app/logs"
 > ```
 
 ## About Dokku phases
@@ -22,59 +23,103 @@ Dokku deploys your application in multiple "phases" and the `docker-options` plu
 
 - `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`
+- `run`: the container that executes any arbitrary command via `dokku run`
+
+Manipulation of docker options will not restart running containers. This enables multiple options to be set/unset before final application. As such, changing an app's docker options must be followed by a `dokku ps:rebuild` in order to take effect.
+
+More information on supported Docker options can be found here: https://docs.docker.com/engine/reference/commandline/run/.
 
 ## Examples
 
 ### Add Docker options
 
-Add some options for the deployed/running app and when executing [`dokku run`](/dokku/deployment/one-off-processes/):
+Add some options for the deployed/running app and when executing [`dokku run`](/docs/processes/one-off-tasks.md):
 
 ```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"
+dokku docker-options:add node-js-app deploy "-v /var/log/node-js-app:/app/logs"
+dokku docker-options:add node-js-app run "-v /var/log/node-js-app:/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"
+dokku docker-options:remove node-js-app run "-v /var/log/node-js-app:/app/logs"
 ```
 
-## Advanced usage
+### Clear all Docker options for an app
 
-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:
+Docker options can be removed for a specific app using the `docker-options:clear` command.
 
 ```shell
---link container_name:alias
--v /host/path:/container/path
--v /another/container/path
+dokku docker-options:clear node-js-app
 ```
 
-The above example will result in the following options being passed to Docker during `dokku run`:
+```
+-----> Clearing docker-options for node-js-app on all phases
+```
+
+One or more valid phases can also be specified. Phases are comma delimited, and specifying an invalid phase will result in an error.
 
 ```shell
---link container_name:alias -v /host/path:/container/path -v /another/container/path
+dokku docker-options:clear node-js-app run
 ```
 
-You may also include comments (lines beginning with a #) and blank lines in the DOCKER_OPTIONS file.
+```
+-----> Clearing docker-options for node-js-app on phase run
+```
 
-Move information on Docker options can be found here: http://docs.docker.io/en/latest/reference/run/ .
+```shell
+dokku docker-options:clear node-js-app build,run
+```
+
+```
+-----> Clearing docker-options for node-js-app on phase build
+-----> Clearing docker-options for node-js-app on phase run
+```
+
+### Displaying docker-options reports for an app
+
+> New as of 0.8.1
+
+You can get a report about the app's docker-options status using the `docker-options:report` command:
+
+```shell
+dokku docker-options:report
+```
+
+```
+=====> node-js-app docker options information
+       Docker options build:
+       Docker options deploy: -v /var/log/node-js-app:/app/logs
+       Docker options run:  -v /var/log/node-js-app:/app/logs
+=====> python-sample docker options information
+       Docker options build:
+       Docker options deploy:
+       Docker options run:
+=====> ruby-sample docker options information
+       Docker options build:
+       Docker options deploy:
+       Docker options run:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku docker-options:report node-js-app
+```
+
+```
+=====> node-js-app docker options information
+       Docker options build:
+       Docker options deploy: -v /var/log/node-js-app:/app/logs
+       Docker options run:  -v /var/log/node-js-app:/app/logs
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku docker-options:report node-js-app --docker-options-build
+```

docs/advanced-usage/event-logs.md

@@ -36,10 +36,8 @@ 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 )
@@ -56,29 +54,28 @@ 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-build
+docker-args-deploy
 docker-args-run
-pre-build-dockerfile
-post-release-buildpack
+git-post-pull
+git-pre-pull
+nginx-hostname
+nginx-pre-reload
+post-build-buildpack
 post-build-dockerfile
+post-delete
+post-deploy
+post-domains-update
+post-release-buildpack
+post-release-dockerfile
+pre-build-buildpack
+pre-build-dockerfile
+pre-delete
+pre-deploy
+pre-release-buildpack
 pre-release-dockerfile
+receive-app
 update
-```
+```

docs/advanced-usage/persistent-storage.md

@@ -8,41 +8,108 @@ The preferred method to mount external containers to a Dokku managed 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:report [<app>] [<flag>]                # Displays a checks report for one or more apps
 storage:unmount <app> <host-dir:container-dir> # Remove an existing bind mount
 ```
 
-## Ideology and Background
+> The storage plugin is compatible with storage mounts created with the docker-options. The storage plugin will only list mounts from the deploy/run phase.
 
-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.
+The storage plugin supports the following mount points:
+
+- explicit paths that exist on the host
+- docker volumes
 
 ## Usage
 
-This example demonstrates how to mount the recommended directory to `/storage` inside the container:
+This example demonstrates how to mount the recommended directory to `/storage` inside an application called `node-js-app`. For simplicity, the Dokku project recommends using the directory `/var/lib/dokku/data/storage` directory as the root host path for mounts. This directory is created on Dokku installation.
 
 ```shell
-dokku storage:mount app-name /var/lib/dokku/data/storage:/storage
+# we use a subdirectory inside of the host directory to scope it to just the app
+dokku storage:mount node-js-app /var/lib/dokku/data/storage/node-js-app:/storage
 ```
 
-Dokku will then mount the shared contents of `/var/lib/dokku/data/storage` to `/storage` inside the container.
+Dokku will then mount the shared contents of `/var/lib/dokku/data/storage/node-js-app` to `/storage` inside the container. Mounts are only available for containers crated via `run` and by the deploy process, and not during the build process. In addition, the host path is never auto-created by either Dokku or Docker, and should be an explicit path, not one relative to the current working directory.
 
-A more complete workflow may require making a custom directory for your application and mounting it within your `/app/storage` directory instead. The mount point is *not* relative to your application's working directory, and is instead relative to the root of the container.
+> If the `/storage` path within the container had pre-existing content, the container files will be overrwritten. This may be an issue for users that create assets at build time but then mount a directory at the same place during runtime. Files are not merged.
+
+Once you have mounted persistent storage, you will also need to restart the application. See the
+[process scaling documentation](/docs/processes/process-management.md) for more information.
 
 ```shell
-# creating storage for the app 'ruby-rails-sample'
-mkdir -p  /var/lib/dokku/data/storage/ruby-rails-sample
+dokku ps:restart app-name
+```
 
-# ensure the proper user has access to this directory
-chown -R dokku:dokku /var/lib/dokku/data/storage/ruby-rails-sample
+A more complete workflow may require making a custom directory for your application and mounting it within your `/app/storage` directory instead. The mount point is *not* relative to your application's working directory, and is instead relative to the root (`/`) of the container.
 
-# as of 0.7.x, you should chown using the `32767` user and group id
-chown -R 32767:32767 /var/lib/dokku/data/storage/ruby-rails-sample
+```shell
+# creating storage for the app 'node-js-app'
+mkdir -p  /var/lib/dokku/data/storage/node-js-app
+
+# set the directory ownership. Below is an example for herokuish
+# but see the `Directory Permissions` section for more details
+chown -R 32767:32767 /var/lib/dokku/data/storage/node-js-app
 
 # mount the directory into your container's /app/storage directory, relative to root
-dokku storage:mount app-name /var/lib/dokku/data/storage/app-name:/app/storage
+dokku storage:mount app-name /var/lib/dokku/data/storage/node-js-app:/app/storage
 ```
 
 You can mount one or more directories as desired by following the above pattern.
 
+### Directory Permissions
+
+The host directory should always be owned by the container user and group id. If this is not the case, files may not persist when written to mounted storage.
+
+- Buildpacks via Herokuish: Use `32767:32767` as the file permissions
+- For Cloud Native Buildpacks: This will depend on the builder in question, but can be retrieved via the `CNB_USER_ID` and `CNB_GROUP_ID` environment variables on the builder image. Common builders are as follows:
+  - heroku/buildpacks: `1000:1000`
+  - cloudfoundry/cnb: `2000:2000`
+  - packeto: `2000:2000`
+- Dockerfile and Docker Image: Use the user and group id which corresponds to the one running the process within the container.
+
+### Displaying storage reports for an app
+
+> New as of 0.8.1
+
+You can get a report about the app's storage status using the `storage:report` command:
+
+```shell
+dokku storage:report
+```
+
+```
+=====> node-js-app storage information
+       Storage build mounts:
+       Storage deploy mounts: -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+       Storage run mounts:  -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+=====> python-sample storage information
+       Storage build mounts:
+       Storage deploy mounts:
+       Storage run mounts:
+=====> ruby-sample storage information
+       Storage build mounts:
+       Storage deploy mounts:
+       Storage run mounts:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku storage:report node-js-app
+```
+
+```
+=====> node-js-app storage information
+       Storage build mounts:
+       Storage deploy mounts: -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+       Storage run mounts:  -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku storage:report node-js-app --storage-deploy-mounts
+```
+
 ## Use Cases
 
 ### Persistent storage
@@ -66,24 +133,19 @@ Your app may have services that are running in memory and need to be backed up l
 By default, Dokku will only bind storage mounts during the deploy and run phases. Under certain conditions, one might want to bind a storage mount during the build phase. This can be accomplished by using the `docker-options` plugin directly.
 
 ```shell
-dokku docker-options:add <app> build "-v /tmp/python-test:/opt/test"
+dokku docker-options:add node-js-app build "-v /tmp/python-test:/opt/test"
 ```
 
 You cannot use mounted volumes during the build phase of a Dockerfile deploy. This is because Docker does not support volumes when executing `docker build`.
 
 > Note: **This can cause data loss** if you bind a mount under `/app` in buildpack apps as herokuish will attempt to remove the original app path during the build phase.
 
-## Docker-Options Note
-
-The storage plugin is compatible with storage mounts created with the docker-options. The storage plugin will only list mounts from the deploy phase.
-
+## Application User and Persistent Storage file ownership (buildpack apps only)
 
 > New as of 0.7.1
 
-## Application User and Persistent Storage file ownership (buildpack apps only)
-
 By default, Dokku will execute your buildpack application processes as the `herokuishuser` user. You may override this by setting the `DOKKU_APP_USER` config variable.
 
 > NOTE: this user must exist in your herokuish image.
 
-Additionally, Dokku will ensure your storage mounts are owned by either `herokuishuser` or the overridden value you have set in `DOKKU_APP_USER`.
+Additionally, the default `docker-local` scheduler that comes with Dokku will ensure your storage mounts are owned by either `herokuishuser` or the overridden value you have set in `DOKKU_APP_USER`. See the [docker-local scheduler documentation](/docs/advanced-usage/schedulers/docker-local.md#disabling-chown-of-persistent-storage) docs for more information.

docs/advanced-usage/plugin-management.md

@@ -3,11 +3,13 @@
 > New as of 0.4.0
 
 ```
-plugin                                   # Print active plugins
 plugin:disable <name>                    # Disable an installed plugin (third-party only)
 plugin:enable <name>                     # Enable a previously disabled plugin
 plugin:install [--core|git-url [--committish tag|branch|commit|--name custom-plugin-name]]           # Optionally download git-url (with custom tag/committish) & run install trigger for active plugins (or only core ones)
+plugin:installed <name>                  # Checks if a plugin is installed
 plugin:install-dependencies [--core]     # Run install-dependencies trigger for active plugins (or only core ones)
+plugin:list                              # Print active plugins
+plugin:trigger <args...>.                # Trigger an arbitrary plugin hook
 plugin:uninstall <name>                  # Uninstall a plugin (third-party only)
 plugin:update [name [committish]]        # Optionally update named plugin from git (with custom tag/committish) & run update trigger for active plugins
 ```
@@ -23,42 +25,70 @@ dokku plugins-install
 
 ## Usage
 
-You can list all installed plugins using the `plugin` command:
+### Listing Plugins
+
+Installed plugins can be listed via the `plugin:list` command:
 
 ```shell
-dokku plugin
+dokku plugin:list
 ```
 
 ```
 plugn: dev
-  00_dokku-standard    0.7.2 enabled    dokku core standard plugin
-  20_events            0.7.2 enabled    dokku core events logging plugin
-  apps                 0.7.2 enabled    dokku core apps plugin
-  build-env            0.7.2 enabled    dokku core build-env plugin
-  certs                0.7.2 enabled    dokku core certificate management plugin
-  checks               0.7.2 enabled    dokku core checks plugin
-  common               0.7.2 enabled    dokku core common plugin
-  config               0.7.2 enabled    dokku core config plugin
-  docker-options       0.7.2 enabled    dokku core docker-options plugin
-  domains              0.7.2 enabled    dokku core domains plugin
-  enter                0.7.2 enabled    dokku core enter plugin
-  git                  0.7.2 enabled    dokku core git plugin
-  logs                 0.7.2 enabled    dokku core logs plugin
-  named-containers     0.7.2 enabled    dokku core named containers plugin
-  nginx-vhosts         0.7.2 enabled    dokku core nginx-vhosts plugin
-  plugin               0.7.2 enabled    dokku core plugin plugin
-  proxy                0.7.2 enabled    dokku core proxy plugin
-  ps                   0.7.2 enabled    dokku core ps plugin
-  repo                 0.7.2 enabled    dokku core repo plugin
-  shell                0.7.2 enabled    dokku core shell plugin
-  ssh-keys             0.7.2 enabled    dokku core ssh-keys plugin
-  storage              0.7.2 enabled    dokku core storage plugin
-  tags                 0.7.2 enabled    dokku core tags plugin
-  tar                  0.7.2 enabled    dokku core tar plugin
+  00_dokku-standard    0.24.4 enabled    dokku core standard plugin
+  20_events            0.24.4 enabled    dokku core events logging plugin
+  app-json             0.24.4 enabled    dokku core app-json plugin
+  apps                 0.24.4 enabled    dokku core apps plugin
+  build-env            0.24.4 enabled    dokku core build-env plugin
+  buildpacks           0.24.4 enabled    dokku core buildpacks plugin
+  certs                0.24.4 enabled    dokku core certificate management plugin
+  checks               0.24.4 enabled    dokku core checks plugin
+  common               0.24.4 enabled    dokku core common plugin
+  config               0.24.4 enabled    dokku core config plugin
+  docker-options       0.24.4 enabled    dokku core docker-options plugin
+  domains              0.24.4 enabled    dokku core domains plugin
+  enter                0.24.4 enabled    dokku core enter plugin
+  git                  0.24.4 enabled    dokku core git plugin
+  logs                 0.24.4 enabled    dokku core logs plugin
+  network              0.24.4 enabled    dokku core network plugin
+  nginx-vhosts         0.24.4 enabled    dokku core nginx-vhosts plugin
+  plugin               0.24.4 enabled    dokku core plugin plugin
+  proxy                0.24.4 enabled    dokku core proxy plugin
+  ps                   0.24.4 enabled    dokku core ps plugin
+  repo                 0.24.4 enabled    dokku core repo plugin
+  resource             0.24.4 enabled    dokku core resource plugin
+  scheduler-docker-local 0.24.4 enabled    dokku core scheduler-docker-local plugin
+  shell                0.24.4 enabled    dokku core shell plugin
+  ssh-keys             0.24.4 enabled    dokku core ssh-keys plugin
+  storage              0.24.4 enabled    dokku core storage plugin
+  tags                 0.24.4 enabled    dokku core tags plugin
+  tar                  0.24.4 enabled    dokku core tar plugin
+  trace                0.24.4 enabled    dokku core trace plugin
 ```
 
+> Warning: All plugin commands other than `plugin:list` and `plugin:help` require sudo access and must be run directly from the Dokku server.
+
+### Checking if a plugin is installed
+
+You can check if a plugin has been installed via the `plugin:installed` command:
+
+```shell
+dokku plugin:installed postgres
+```
+
+### Installing a plugin
+
 Installing a plugin is easy as well using the `plugin:install` command. This command will also trigger the `install` pluginhook on all existing plugins.
 
+The most common usage is to install a plugin from a url. This url may be any of the following:
+
+- `git`: For git+ssh based plugin repository clones.
+- `ssh`: For git+ssh based plugin repository clones.
+- `file`: For copying plugins from a path on disk.
+- `https`: For http based plugin repository clones.
+
+Additionally, any urls with the extensions `.tar.gz` or `.tgz` are treated as Gzipped Tarballs for installation purposes and will be downloaded and extracted into place.
+
 ```shell
 dokku plugin:install https://github.com/dokku/dokku-postgres.git
 ```
@@ -72,20 +102,70 @@ Receiving objects: 100% (646/646), 134.24 KiB | 0 bytes/s, done.
 Resolving deltas: 100% (406/406), done.
 Checking connectivity... done.
 -----> Plugin postgres enabled
------> Migrating zero downtime env variables to 0.5.x. The following variables have been deprecated
-=====> DOKKU_SKIP_ALL_CHECKS DOKKU_SKIP_DEFAULT_CHECKS
-=====> Please use dokku checks:[disable|enable] <app> to control zero downtime functionality
-=====> Migration complete
-=====>
------> Migrating zero downtime env variables to 0.6.x. The following variables will be migrated
-=====> DOKKU_CHECKS_ENABLED -> DOKKU_CHECKS_SKIPPED
-=====> Migration complete
-=====>
-Adding user dokku to group adm
-Starting nginx (via systemctl): nginx.service.
 ```
 
-You can also uninstall a third-party plugin using the `plugin:uninstall` command:
+For git-based plugin installation, a commit SHA-like object may be specified (tag/branch/commit sha) via the `--committish` argument and Dokku will attempt to install the specified commit object.
+
+```shell
+# where 2.0.0 is a potential git tag
+dokku plugin:install https://github.com/dokku/dokku-postgres.git --committish 2.0.0
+```
+
+Plugin names are interpolated based on the repository name minus the `dokku-` prefix. If the plugin being installed has a name other than what matches the repository name - or another name is desired - the `--name` flag can be used to override this interpolation.
+
+```shell
+dokku plugin:install https://github.com/dokku/smoke-test-plugin.git --name smoke-test-plugin
+```
+
+The `--core` flag may also be indicated as the sole argument, though it is only for installation of core plugins, and thus not useful for end-user installations.
+
+```shell
+dokku plugin:install --core
+```
+
+Finally, all flags may be omitted to trigger the `install` procedures for both core and third-party plugins:
+
+```shell
+dokku plugin:install
+```
+
+### Installing plugin dependencies
+
+In some cases, plugins will have system-level dependencies. These are not automatically installed via `plugin:install`, and must be separately via the `plugin:install-dependencies` command. This will run through all the `dependencies` trigger for all plugins.
+
+```shell
+dokku plugin:install-dependencies
+```
+
+This command may also target _just_ core plugins via the `--core` flag. This is usually only useful for source-based installs of Dokku.
+
+```shell
+dokku plugin:install-dependencies --core
+```
+
+### Updating a plugin
+
+An installed, third-party plugin can be updated can updated via the `plugin:update` command. This should be done after any upgrades of Dokku as there may be changes in the internal api that require an update of how the plugin interfaces with Dokku.
+
+Please note that this command is only valid for plugin installs that were backed by a git-repository.
+
+```shell
+dokku plugin:update postgres
+```
+
+```
+Plugin (postgres) updated
+```
+
+An optional commit SHA-like object may be specified.
+
+```shell
+dokku plugin:update postgres 2.0.0
+```
+
+### Uninstalling a plugin
+
+Third party plugins can be uninstalled using the `plugin:uninstall` command:
 
 ```shell
 dokku plugin:uninstall postgres
@@ -95,7 +175,9 @@ dokku plugin:uninstall postgres
 -----> Plugin postgres uninstalled
 ```
 
-Enabling or disabling a plugin can also be useful in cases where you are debugging whether a third-party plugin is causing issues in your Dokku installation:
+### Disabling a plugin
+
+Disabling a plugin can also be useful for debugging whether a third-party plugin is causing issues in a Dokku installation. Another common use case is for disabling core functionality for replacement with a third-party plugin.
 
 ```shell
 dokku plugin:disable postgres
@@ -105,6 +187,10 @@ dokku plugin:disable postgres
 -----> Plugin postgres disabled
 ```
 
+### Enabling a plugin
+
+Disabled plugins can be re-enabled via the `plugin:enable` command.
+
 ```shell
 dokku plugin:enable postgres
 ```
@@ -113,12 +199,10 @@ dokku plugin:enable postgres
 -----> Plugin postgres enabled
 ```
 
-Finally, you can update an installed third-party plugin. This should be done after any upgrades of Dokku as there may be changes in the internal api that require an update of how the plugin interfaces with Dokku.
+### Triggering a plugin trigger
+
+The `plugin:trigger` can be used to call any internal plugin trigger. This may have unintended consequences, and thus should only be called for development or debugging purposes.
 
 ```shell
-dokku plugin:update postgres
-```
-
-```
-Plugin (postgres) updated
+dokku plugin:trigger some-internal-trigger args-go-here
 ```

docs/advanced-usage/proxy-management.md

@@ -1,160 +0,0 @@
-# Proxy Management
-
-> New as of 0.5.0, Enhanced in 0.6.0
-
-```
-proxy <app>                              # Show proxy settings for app
-proxy:disable <app>                      # Disable proxy for app
-proxy:enable <app>                       # Enable proxy for app
-proxy:ports <app>                        # List proxy port mappings for app
-proxy:ports-add <app> <scheme>:<host-port>:<container-port> [<scheme>:<host-port>:<container-port>...]           # Set proxy port mappings for app
-proxy:ports-clear <app>                  # Clear all proxy port mappings for app
-proxy:ports-remove <app> <host-port> [<host-port>|<scheme>:<host-port>:<container-port>...]                      # Unset proxy port mappings for app
-proxy:set <app> <proxy-type>             # Set proxy type for app
-```
-
-In Dokku 0.5.0, port proxying was decoupled from the `nginx-vhosts` plugin into the proxy plugin. Dokku 0.6.0 introduced the ability to map host ports to specific container ports. In the future this will allow other proxy software - such as HAProxy or Caddy - to be used in place of nginx.
-
-## Container network interface binding
-
-> New as of 0.5.0
-
-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.
-
-> If a proxy is disabled, Dokku will bind your container's port to a random port on the host for every deploy, e.g. `0.0.0.0:32771->5000/tcp`.
-
-By way of example, in the default case, each container is bound to the docker interface:
-
-```shell
-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
-```
-
-As such, the container's IP address will be an internal IP, and thus it is only accessible on the host itself:
-
-```
-docker inspect --format '{{ .NetworkSettings.IPAddress }}' node-js-app.web.1
-```
-
-```
-172.17.0.6
-```
-
-However, you can disable the internal proxying via the `proxy:disable` command so that it will listen on the host's IP address:
-
-```shell
-dokku proxy:disable node-js-app
-
-# container bound to all interfaces
-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
-```
-
-## Proxy port mapping
-
-> New as of 0.6.0
-
-You can now configure `host -> container` port mappings with the `proxy:ports-*` commands. This mapping is currently supported by the built-in nginx-vhosts plugin.
-
-To inspect the port mapping for a given application, use the `proxy:ports` command:
-
-```shell
-dokku proxy:ports node-js-app
-```
-
-```
------> Port mappings for node-js-app
------> scheme             host port                 container port
-http                      80                        5000
-```
-
-The above application is listening on the host's port `80`, which we can test via curl:
-
-```shell
-curl http://node-js-app.dokku.me
-```
-
-```
-Hello World!
-```
-
-There are cases where we may wish for the service to be listening on more than one port, such as port 8080. Normally, this would not be possible:
-
-```shell
-curl http://node-js-app.dokku.me:8080
-```
-
-```
-curl: (7) Failed to connect to node-js-app.dokku.me port 8080: Connection refused
-```
-
-However, we can use the `proxy:ports-add` command to add a second external port mapping - `8080` - to our application's port `5000`.
-
-```shell
-dokku proxy:ports-add node-js-app http:8080:5000
-```
-
-```
------> Setting config vars
-       DOKKU_PROXY_PORT_MAP: http:80:5000 http:8080:5000
------> Configuring node-js-app.dokku.me...(using built-in template)
------> Creating http nginx.conf
------> Running nginx-pre-reload
-       Reloading nginx
-```
-
-We can now test that port 80 still responds properly:
-
-```shell
-curl http://node-js-app.dokku.me
-```
-
-```
-Hello World!
-```
-
-And our new listening port of `8080` also works:
-
-```shell
-curl http://node-js-app.dokku.me:8080
-```
-
-```
-Hello World!
-```
-
-You can also remove a port mapping that is no longer necessary:
-
-```shell
-dokku proxy:ports-remove node-js-app http:80:5000
-```
-
-By default, buildpack apps and dockerfile apps **without** explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on port `80` (and additionally a listener on 443 if ssl is enabled) that will proxy to the application container on port `5000`. Dockerfile apps **with** explicitly exposed ports will be configured with a listener on each exposed port and will proxy to that same port of the deployed application container.
-
-> Note: This default behavior **will not** be automatically changed on subsequent pushes and must be manipulated with the `proxy:ports-*` syntax detailed above.
-
-## Proxy Port Scheme
-
-The proxy port scheme is as follows:
-
-- `SCHEME:HOST_PORT:CONTAINER_PORT`
-
-The scheme metadata can be used by proxy implementations in order to properly handle proxying of requests. For example, the built-in `nginx-vhosts` proxy implementation supports both the `http` and `https` schemes.
-
-Developers of proxy implementations are encouraged to use whatever schemes make the most sense, and ignore configurations which they do not support. For instance, a `udp` proxy implementation can safely ignore `http` and `https` port mappings.
-
-To change the proxy implementation in use for an application, use the `proxy:set` command:
-
-```shell
-# no validation will be performed against
-# the specified proxy implementation
-dokku proxy:set node-js-app nginx
-```

docs/advanced-usage/repository-management.md

@@ -3,7 +3,7 @@
 > New as of 0.6.0
 
 ```
-repo:gc <app>                            # Runs 'git gc --agressive' against the application's repo
+repo:gc <app>                            # Runs 'git gc --aggressive' against the application's repo
 repo:purge-cache <app>                   # Deletes the contents of the build cache stored in the repository
 ```
 
@@ -13,7 +13,7 @@ The repository plugin is meant to allow users to perform management commands aga
 
 ### Git Garbage Collection
 
-This will run a git gc --agressive against the applications repo. This is performed on the Dokku host, and not within an application container.
+This will run a git gc --aggressive against the applications repo. This is performed on the Dokku host, and not within an application container.
 
 ```shell
 dokku repo:gc node-js-app

docs/advanced-usage/resource-management.md

@@ -0,0 +1,341 @@
+# Resource Management
+
+> New as of 0.15.0
+
+```
+resource:limit [--process-type <process-type>] [RESOURCE_OPTS...] <app>    # Limit resources for a given app/process-type combination
+resource:limit-clear [--process-type <process-type>] <app>                 # Limit resources for a given app/process-type combination
+resource:report [<app>] [<flag>]                                           # Displays a resource report for one or more apps
+resource:reserve [--process-type <process-type>] [RESOURCE_OPTS...] <app>  # Reserve resources for a given app/process-type combination
+resource:reserve-clear [--process-type <process-type>] <app>               # Reserve resources for a given app/process-type combination
+```
+
+The resource plugin is meant to allow users to limit or reserve resources for a given app/process-type combination.
+
+## Usage
+
+By default, Dokku allows unlimited resource access to apps deployed on a server. In some cases, it may be desirable to limit this on a per-app or per-process-type basis. The `resource` plugin allows management of both resource "limits" and resource "reservations", where each resource request type has specific meaning to the scheduler in use for a given app.
+
+> Warning: The meaning of a values and it's units are specific to the scheduler in use for a given app. If a value is incorrect for a scheduler, this may result in containers failing to start correctly. If a scheduler does not support a given resource type combination, it will be ignored. All resource commands require an app rebuild or deploy in order to take effect.
+
+Valid resource options include:
+
+- `--cpu`
+- `--memory`
+- `--memory-swap`
+- `--network`
+- `--network-ingress`
+- `--network-egress`
+- `--nvidia-gpu`
+
+See the [Supported Resource Management Properties](/docs/advanced-usage/schedulers/docker-local.md#supported-resource-management-properties) section of the docker local scheduler documentation for more information on how each resource limit maps to Docker.
+
+Resource limits and reservations are applied only during the `run` and `deploy` phases of an application, and will not impact the `build` phase of an application.
+
+### Resource Limits
+
+When specified and supported, a resource limit will ensure that your app does not go _over_ the specified value. If this occurs, the underlying scheduler may either cap resource utilization, or it may decide to terminate and reschedule your process.
+
+Resource limits may be set via the `resource:limit` command:
+
+```shell
+dokku resource:limit --memory 100 node-js-app
+```
+
+```
+=====> Setting resource limits for node-js-app
+       memory: 100
+```
+
+Multiple resources can be limited in a single call:
+
+```shell
+dokku resource:limit --cpu 100 --memory 100 node-js-app
+```
+
+```
+=====> Setting resource limits for node-js-app
+       cpu: 100
+       memory: 100
+```
+
+Resources can also be limited on a per-process type basis. If specified, this will override any generic limits set for the app.
+
+```shell
+dokku resource:limit --cpu 100 --memory 100 --process-type worker node-js-app
+```
+
+```
+=====> Setting resource limits for node-js-app (worker)
+       cpu: 100
+       memory: 100
+```
+
+A resource value can be individually cleared by setting the value to the special value `clear`.
+
+```shell
+dokku resource:limit --cpu clear node-js-app
+```
+
+```
+=====> Setting resource limits for node-js-app
+       cpu: cleared
+```
+
+#### Displaying Resource Limits
+
+Running the `resource:limit` command without any flags will display the currently configured default app limits.
+
+```shell
+dokku resource:limit node-js-app
+```
+
+```
+=====> resource limits node-js-app information [defaults]
+       cpu:
+       memory:
+       memory-swap: 100
+       network: 100
+       network-ingress:
+       network-egress:
+       nvidia-gpu:
+```
+
+This may also be combined with the `--process-type` flag to see app limits on a process-type level. Note that the displayed values are not merged with the defaults.
+
+
+```shell
+dokku resource:limit --process-type web node-js-app
+```
+
+```
+=====> resource limits node-js-app information (web)
+       cpu: 100
+       memory: 100
+       memory-swap:
+       network:
+       network-ingress:
+       network-egress:
+       nvidia-gpu:
+```
+
+#### Clearing Resource Limits
+
+In cases where the values are incorrect - or there is no desire to limit resources - resource limits may be cleared using the `resource:limit-clear` command.
+
+```shell
+dokku resource:limit-clear node-js-app
+```
+
+```
+-----> Clearing resource limit for node-js-app
+```
+
+Defaults can also be cleared by leaving the app unspecified.
+
+```shell
+dokku resource:limit-clear
+```
+
+```
+-----> Clearing default resource limits
+```
+
+### Resource Reservations
+
+When specified and supported, a resource reservation will ensure that your server has _at least_ the specified resources before placing a given app's process. If there a resource exhaustion, future rebuilds and deploys may fail.
+
+Resource reservations may be set via the `resource:reserve` command:
+
+```shell
+dokku resource:reserve --memory 100 node-js-app
+```
+
+```
+=====> Setting resource reservation for node-js-app
+       memory: 100
+```
+
+Multiple resources can be limited in a single call:
+
+```shell
+dokku resource:reserve --cpu 100 --memory 100 node-js-app
+```
+
+```
+=====> Setting resource reservation for node-js-app
+       cpu: 100
+       memory: 100
+```
+
+Resources can also be limited on a per-process type basis. If specified, this will override any generic limits set for the app.
+
+```shell
+dokku resource:reserve --cpu 100 --memory 100 --process-type worker node-js-app
+```
+
+```
+=====> Setting resource reservation for node-js-app (worker)
+       cpu: 100
+       memory: 100
+```
+
+A resource value can be individually cleared by setting the value to the special value `clear`.
+
+```shell
+dokku resource:reserve --cpu clear node-js-app
+```
+
+```
+=====> Setting resource reservation for node-js-app
+       cpu: cleared
+```
+
+#### Displaying Resource Reservations
+
+Running the `resource:reserve` command without any flags will display the currently configured default app reservations.
+
+```shell
+dokku resource:reserve node-js-app
+```
+
+```
+=====> resource reservation node-js-app information [defaults]
+       cpu: 100
+       memory: 100
+       memory-swap:
+       network:
+       network-ingress:
+       network-egress:
+       nvidia-gpu:
+```
+
+This may also be combined with the `--process-type` flag to see app reservations on a process-type level. Note that the displayed values are not merged with the defaults.
+
+```shell
+dokku resource:reserve --process-type web node-js-app
+```
+
+```
+=====> resource reservation node-js-app information (web)
+       cpu: 100
+       memory: 100
+       memory-swap:
+       network:
+       network-ingress:
+       network-egress:
+       nvidia-gpu:
+```
+
+#### Clearing Resource Reservations
+
+In cases where the values are incorrect - or there is no desire to reserve resources - resource reservations may be cleared using the `resource:reserve-clear` command.
+
+```shell
+dokku resource:reserve-clear node-js-app
+```
+
+```
+-----> Clearing resource reservation for node-js-app
+```
+
+Defaults can also be cleared by leaving the app unspecified.
+
+```shell
+dokku resource:reserve-clear
+```
+
+```
+-----> Clearing default resource reservation
+```
+
+### Displaying resource reports for an app
+
+You can get a report about the app's resource status using the `resource:report` command:
+
+```shell
+dokku resource:report
+```
+
+```
+=====> node-js-app resource information
+       web limit cpu:
+       web limit memory: 1024
+       web limit memory swap: 0
+       web limit network: 10
+       web limit network ingress:
+       web limit network egress:
+       web limit nvidia gpu:
+       web reservation cpu:
+       web reservation memory: 512
+       web reservation memory swap:
+       web reservation network: 8
+       web reservation network ingress:
+       web reservation network egress:
+       web reservation nvidia gpu:
+=====> python-sample resource information
+       web limit cpu:
+       web limit memory:
+       web limit memory swap:
+       web limit network:
+       web limit network ingress:
+       web limit network egress:
+       web limit nvidia gpu:
+       web reservation cpu:
+       web reservation memory:
+       web reservation memory swap:
+       web reservation network:
+       web reservation network ingress:
+       web reservation network egress:
+       web reservation nvidia gpu:
+=====> ruby-sample resource information
+       web limit cpu:
+       web limit memory:
+       web limit memory swap:
+       web limit network:
+       web limit network ingress:
+       web limit network egress:
+       web limit nvidia gpu:
+       web reservation cpu:
+       web reservation memory:
+       web reservation memory swap:
+       web reservation network:
+       web reservation network ingress:
+       web reservation network egress:
+       web reservation nvidia gpu:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku resource:report node-js-app
+```
+
+```
+=====> node-js-app resource information
+       web limit cpu:
+       web limit memory: 1024
+       web limit memory swap: 0
+       web limit network: 10
+       web limit network ingress:
+       web limit network egress:
+       web limit nvidia gpu:
+       web reservation cpu:
+       web reservation memory: 512
+       web reservation memory swap:
+       web reservation network: 8
+       web reservation network ingress:
+       web reservation network egress:
+       web reservation nvidia gpu:
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+# Note the periods in the flag name
+dokku resource:report node-js-app --resource-web.limit.memory
+```
+
+```
+1024
+```

docs/advanced-usage/schedulers/alternate-schedulers.md

@@ -0,0 +1,10 @@
+# Alternative Schedulers
+
+In addition to the built-in [docker-local scheduler](/docs/advanced-usage/schedulers/docker-local.md), Dokku also supports two scheduler plugins:
+
+- [Kubernetes](https://github.com/dokku/dokku-scheduler-kubernetes)
+- [Nomad](https://github.com/dokku/dokku-scheduler-nomad)
+
+These scheduler implementations may not be complete, though provide enough functionality for a user to get an app deployed via the underlying scheduler.
+
+For users that require additional functionality, please refer to the [Sponsoring Documentation](https://github.com/dokku/.github/blob/master/SPONSORING.md).

docs/advanced-usage/schedulers/docker-local.md

@@ -0,0 +1,83 @@
+# Docker Local Scheduler
+
+> Subcommands new as of 0.12.12
+
+```
+scheduler-docker-local:report [<app>] [<flag>]              # Displays a scheduler-docker-local report for one or more apps
+scheduler-docker-local:set <app> <key> (<value>)            # Set or clear a scheduler-docker-local property for an app
+```
+
+> New as of 0.12.0
+
+Dokku natively includes functionality to manage application lifecycles for a single server using the `scheduler-docker-local` plugin. It is the default scheduler, but as with all schedulers, it is set on a per-application basis. The scheduler can currently be overridden by running the following command:
+
+```shell
+dokku config:set node-js-app DOCKER_SCHEDULER=docker-local
+```
+
+As it is the default, unsetting the `DOCKER_SCHEDULER` config variable is also a valid way to reset the scheduler.
+
+```shell
+dokku config:unset node-js-app DOCKER_SCHEDULER
+```
+
+## Usage
+
+### Disabling chown of persistent storage
+
+The `scheduler-docker-local` plugin will ensure your storage mounts are owned by either `herokuishuser` or the overridden value you have set in `DOKKU_APP_USER`. You may disable this by running the following `scheduler-docker-local:set` command for your application:
+
+```shell
+dokku scheduler-docker-local:set node-js-app disable-chown true
+```
+
+Once set, you may re-enable it by setting a blank value for `disable-chown`:
+
+```shell
+dokku scheduler-docker-local:set node-js-app disable-chown
+```
+
+## Implemented Triggers
+
+This plugin implements various functionality through `plugn` triggers to integrate with Docker for running apps on a single server. The following functionality is supported by the `scheduler-docker-local` plugin.
+
+- `check-deploy`
+- `core-post-deploy`
+- `post-app-clone-setup`
+- `post-app-rename-setup`
+- `post-create`
+- `post-delete`
+- `pre-deploy`
+- `pre-restore`
+- `scheduler-app-status`
+- `scheduler-deploy`
+- `scheduler-docker-cleanup`
+- `scheduler-inspect`
+- `scheduler-is-deployed`
+- `scheduler-logs`
+- `scheduler-logs-failed`
+- `scheduler-retire`
+- `scheduler-run`
+- `scheduler-stop`
+- `scheduler-tags-create`
+- `scheduler-tags-destroy`
+
+## Supported Resource Management Properties
+
+The `docker-local` scheduler supports a minimal list of resource _limits_ and _reservations_. The following properties are supported:
+
+### Resource Limits
+
+- cpu: (docker option: `--cpus`), is specified in number of CPUs a process can access.
+  - See the ["CPU" section](https://docs.docker.com/config/containers/resource_constraints/#cpu) of the Docker Runtime Options documentation for more information.
+- memory: (docker option: `--memory`) should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes).
+  - See the ["Memory" section](https://docs.docker.com/config/containers/resource_constraints/#memory) of the Docker Runtime Options documentation for more information.
+- memory-swap: (docker option: `--memory-swap`) should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes)
+  - See the ["Memory" section](https://docs.docker.com/config/containers/resource_constraints/#memory) of the Docker Runtime Options documentation for more information.
+- nvidia-gpus: (docker option: `--gpus`), is specified in number of Nvidia GPUs a process can access.
+  - See the ["GPU" section](https://docs.docker.com/config/containers/resource_constraints/#gpu) of the Docker Runtime Options documentation for more information.
+
+### Resource Reservations
+
+- memory: (docker option: `--memory-reservation`) should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes)
+  - See the ["Memory" section](https://docs.docker.com/config/containers/resource_constraints/#memory) of the Docker Runtime Options documentation for more information.

docs/appendices/0.10.0-migration-guide.md

@@ -0,0 +1,13 @@
+# 0.10.0 Migration Guide
+
+## PCI Compliance
+
+By default, Dokku will ship a PCI Compliant nginx configuration. For developers whose users are on older browsers or mobile devices, you may need to ship a custom `nginx.conf.sigil` to enable ciphers for older browsers.
+
+See the [nginx customization](/docs/configuration/nginx/#customizing-the-nginx-configuration) docs for more details.
+
+## Nginx Error Pages
+
+We now ship with nicer error pages by default. You are free to customize your Dokku installation via a custom `nginx.conf.sigil` to change what error pages are displayed in different circumstances.
+
+See the [nginx customization](/docs/configuration/nginx/#customizing-the-nginx-configuration) docs for more details.

docs/appendices/0.20.0-migration-guide.md

@@ -0,0 +1,93 @@
+# 0.20.0 Migration Guide
+
+## Removals
+
+### Command removals
+
+The following commands were previously deprecated and were removed in this release.
+
+- `apps`: Use `apps:list` instead.
+- `certs`: Use `certs:report` instead.
+- `certs:info`: Use `certs:report` instead.
+- `checks`: Use `checks:report` instead.
+- `docker-options`: Use `docker-options:report` instead.
+- `domains`: Use `domains:report` instead.
+- `plugin`: Use `plugin:list` instead.
+- `proxy`: Use `proxy:report` instead.
+- `trace`: Use `trace:on` or `trace:off` instead.
+- `ps`: Use `enter` with a container ID instead to run `ps auxww` within a container.
+
+The refactor of the proxy plugin removes the following functions from being sourced in plugins:
+
+- `proxy#get_app_proxy_port_map()`
+- `proxy#list_app_proxy_ports()`
+- `proxy#filter_app_proxy_ports()`
+- `proxy#add_proxy_ports()`
+- `proxy#remove_proxy_ports()`
+- `proxy#set_proxy_ports()`
+
+The informal policy is to allow removal of functions within a `functions` file if they are not used in OSS plugins. Should you be affected by any such removals, please file an issue to expose the functionality via a plugin trigger.
+
+### Function renames
+
+- `tar#tar_in_cmd` was renamed to `tar#cmd-tar-in`. Users should avoid using `cmd-*` commands directly, and instead file an issue to have them exposed via a plugin trigger.
+- `tar#tar_from_cmd` was renamed to `tar#cmd-tar-from`. Users should avoid using `cmd-*` commands directly, and instead file an issue to have them exposed via a plugin trigger.
+
+### Remove support for Unsupported Operating Systems
+
+Dokku will no longer distribute packages for Ubuntu versions that have reached either End of Life or End of Standard Support (for LTS releases). This currently includes the following releases:
+
+- Ubuntu 14.04 (trusty)
+- Ubuntu 14.10 (utopic)
+- Ubuntu 15.04 (vivid)
+- Ubuntu 15.10 (wily)
+- Ubuntu 16.10 (yakkety)
+- Ubuntu 17.04 (zesty)
+- Ubuntu 17.10 (artful)
+
+Dokku will no longer distribute packages for Debian versions that are not `stable` or `oldstable`. This currently includes the following releases:
+
+- Debian 7 (wheezy)
+- Debian 8 (jessie)
+
+### App report flags
+
+The `--git-sha` flag was moved from the `apps:report` command to the `git:report` command.
+
+## App report output
+
+When an app is not deployed, the `apps:report` command no longer shows the message `not deployed`. Please use the `--deployed` flag on `ps:report` instead to see if the app has been deployed.
+
+## Changes
+
+### App report flags
+
+The following changes on the `apps:report` command were made in this release:
+
+- The `--deploy-source` flag was renamed to `--app-deploy-source`.
+- The `--locked` flag was renamed to `--app-locked`.
+
+### Network report flags
+
+The following changes on the `network:report` command were made in this release:
+
+- The `--network-listeners` flag was renamed to `--network-web-listeners`.
+
+### Plugin Triggers
+
+- The `network-get-port` trigger was incorrectly documented to have the `isHerokuishContainer` argument as the third argument. The code has been fixed to respect the documentation.
+- The `network-get-listeners` trigger now takes an additional `processType` argument. If not specified, it defaults to `web`. This default will be removed in an upcoming release.
+
+## Deprecations
+
+- `nginx:show-conf` has been deprecated in favor of `nginx:show-config`.
+- `proxy#is_app_proxy_enabled()` is deprecated in favor of `plugn trigger proxy-is-enabled`.
+- `proxy#get_app_proxy_type()` is deprecated in favor of `plugn trigger proxy-type`.
+- `apps#apps_create()` is deprecated in favor of `plugn trigger app-create`.
+- `apps#apps_destroy()` is deprecated in favor of `plugn trigger app-destroy`.
+- `apps#apps_exists()` is deprecated in favor of `plugn trigger app-exists`.
+- `apps#apps_maybe_create()` is deprecated in favor of `plugn trigger app-maybe-create`.
+- `plugin trigger network-get-listeners` usage without a second `processType` argument is deprecated.
+- `.NGINX_PORT` variable usage within `nginx.conf.sigil` templates is deprecated in favor of `.PROXY_PORT`.
+- `.NGINX_SSL_PORT` variable usage within `nginx.conf.sigil` templates is deprecated in favor of `.PROXY_SSL_PORT`.
+- `.DOKKU_APP_LISTENERS` variable usage within `nginx.conf.sigil` templates is deprecated in favor of `.DOKKU_APP_WEB_LISTENERS`.

docs/appendices/0.21.0-migration-guide.md

@@ -0,0 +1,18 @@
+# 0.21.0 Migration Guide
+
+## Changes
+
+The `tls` name is no longer a reserved app name, and can be used by applications. This was previously a reserved app name due to it's use as a place for global SSL certificate files; Dokku has not supported global SSL certificates for many releases, and thus there is no need to reserve the name.
+
+## Deprecations
+
+- `git#git_deploy_branch()` is deprecated in favor of `plugn trigger git-deploy-branch`.
+- The `config` command is deprecated in favor of `config:show`.
+  - Usage of this command in conjunction with either the `--export` or `--shell` flag is deprecated in favor of `config:export --format` with the correct format value (`exports` or `shell`, respectively).
+- The `nginx:build-config` command is deprecated in favor of `proxy:build-config`.
+
+## Removals
+
+The `apps:destroy` command no longer takes a second argument `force`. Instead, this can be passed as the `--force` flag, either globally or as a flag to the command itself.
+
+The `proxy:enable` and `proxy:disable` no longer restart apps when setting the `DOKKU_DISABLE_PROXY` environment variable. A future release will disable usage of `DOKKU_DISABLE_PROXY` altogether.

docs/appendices/0.22.0-migration-guide.md

@@ -0,0 +1,27 @@
+# 0.22.0 Migration Guide
+
+## Deprecations
+
+- Calling `logs:failed` without either a `<name>` or the `--all` flag is deprecated.
+
+## Changes
+
+- Underscores are no longer valid characters in app names. Please rename applications before upgrading.
+- Process type names specified in Procfile may no longer use characters not valid in DNS Label Names ([RFC 1123](https://tools.ietf.org/html/rfc1123)).
+- The minimum Docker version is now 17.05.0.
+- The `common.GetDeployingAppImageName()` function now returns an `error` as the second return argument instead of calling `common.LogFail()` internally.
+- Setting `DOKKU_DISABLE_ANSI_PREFIX_REMOVAL` is deprecated; Dokku 0.23.0 will avoid removing the `remote:` ansi prefix entirely. No warning will be added in this release.
+
+## Removals
+
+The `ps` command has had a few removals as a result of a rewrite to Golang:
+
+- The `ps:set-restart-policy` command has been removed in favor the `ps:set` command.
+- The `ps:restart-policy` command has been removed in favor of the `ps:report` command.
+- The `ps:rebuildall` command has been removed in favor of calling the `ps:rebuild` with the `--all` flag instead of an app name.
+- The `ps:restartall` command has been removed in favor of calling the `ps:restart` with the `--all` flag instead of an app name.
+- The `ps:stopall` command has been removed in favor of calling the `ps:stop` with the `--all` flag instead of an app name.
+- The `ps:startall` command has been removed in favor of calling the `ps:start` with the `--all` flag instead of an app name.
+- The `DOKKU_PROCFILE` file is no longer located in the git directory for a given app on the server. It's location is currently not exposed.
+- The `procfile-get-command` plugin trigger no longer takes a `procfile path` as the final argument.
+- All `ps` functions have been removed. Please us a trigger as appropriate or file a PR to have a new trigger/wrapper function added.

docs/appendices/0.23.0-migration-guide.md

@@ -0,0 +1,8 @@
+# 0.23.0 Migration Guide
+
+## Changes
+
+- The `plugin:list` command no longer outputs the version for the `plugn` binary.
+- Users building docker images that run Dokku will need to use a new sudoer wrapper for the `docker-image-labeler` binary to work correctly. A reference version has been placed in the `docker` skeleton directory. This should only impact platform developers, and users of our Docker image will already have the file available.
+- The `dokku` user's cron is now in use by Dokku itself. Customizations will be overwritten. Users are encouraged to use a cron entry in `/etc/cron.d/dokku` to avoid this issue.
+- As of 0.23.0, Dokku will now inject the `max-size` log driver option for applications. This is restricted to app-configured log driver values empty, `local` or `json-file` in 0.23.1 to increase setup compatibility. Users who configure alternative log drivers at the system level will need to either set the global `max-size` property to `unlimited` or switch to the built-in `vector` logging support.

docs/appendices/0.24.0-migration-guide.md

@@ -0,0 +1,12 @@
+# 0.24.0 Migration Guide
+
+## Changes
+
+- The commands `proxy:enable`, `proxy:disable` and `proxy:build-config` now support the `--all` flag in addition to general parallelism.
+- The `builder-cnb` plugin has been renamed `builder-pack`, and all related plugin triggers have had the suffix `-cnb` changed to `-pack`.
+
+## Deprecations
+
+- The 1.0.0 release of Dokku will no longer select buildpack builders over dockerfile builders if both builders match. Instead, Dokku will choose the first builder that responds to the `builder-detect` trigger. Users that wish to use a specific builder may set a builder using the `builder:set` command, which will force Dokku to use the specified builder regardless of what might be auto-detected.
+- The `tags` plugin is deprecated in favor of the [`git:from-image`](/docs/deployment/methods/git.md#initializing-an-app-repository-from-a-docker-image) command. It will be removed in the next minor release, and is considered unmaintained. Users are highly encouraged to switch their workflows to `git:from-image`.
+- The `tar` plugin is deprecated in favor of the [`git:from-archive`](/docs/deployment/methods/git.md#initializing-an-app-repository-from-an-archive-file) command. It will be removed in the next minor release, and is considered unmaintained. Users are highly encouraged to switch their workflows to `git:from-archive`.

docs/appendices/0.5.0-migration-guide.md

@@ -5,13 +5,13 @@
 - 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/configuration/nginx/#available-template-variables)
+  - A detailed list of template variables can be found [here](/docs/configuration/nginx.md#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/configuration/nginx/)
+  - Dokku no longer looks for this file in `/home/dokku/node-js-app` on the Dokku server
+  - Check out an example template [here](/docs/configuration/nginx.md)
 - Support for server-wide SSL certs have been dropped in favor of using the `certs` plugin
-  - `dokku certs:add myapp < certs.tar`
+  - `dokku certs:add node-js-app < 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`
@@ -20,6 +20,6 @@
 
 ## Dockerfile apps with exposed ports
 
-- Dockerfiles with `EXPOSE` clauses will get [all **tcp** ports proxied by default](/dokku/deployment/methods/dockerfiles/#exposed-ports)
+- Dockerfiles with `EXPOSE` clauses will get [all **tcp** ports proxied by default](/docs/deployment/builders/dockerfiles.md#exposed-ports)
   - Note that nginx will proxy the same port numbers to listen publicly
-  - UDP ports can be exposed by disabling the [nginx proxy](/dokku/advanced-usage/proxy-management/) with `dokku proxy:disable myapp`
+  - UDP ports can be exposed by disabling the [nginx proxy](/docs/networking/proxy-management.md) with `dokku proxy:disable node-js-app`

docs/appendices/0.6.0-migration-guide.md

@@ -7,16 +7,16 @@
     - `DOKKU_CHECKS_ENABLED` has been migrated to `DOKKU_CHECKS_SKIPPED`
     - `DOKKU_CHECKS_DISABLED` is now a thing
     - The values for the above can be a comma-separated list of process-types or the literal string `_all_`
-  - See the [updated `checks`](/dokku/deployment/zero-downtime-deploys/) docs for more info
+  - See the [updated `checks`](/docs/deployment/zero-downtime-deploys.md) docs for more info
 
 ## Proxy port mapping
 
 - You can now configure host -> container proxy port mappings
-  - The UI is handled by the [proxy](/dokku/advanced-usage/proxy-management/) interface plugin by setting the `DOKKU_PROXY_PORT_MAP` config variable in the format of `scheme:host-port:container-port`. The default `nginx-vhosts` proxy plugin supports both the `http` and `https` schemes.
+  - The UI is handled by the [proxy](/docs/networking/proxy-management.md) interface plugin by setting the `DOKKU_PROXY_PORT_MAP` config variable in the format of `scheme:host-port:container-port`. The default `nginx-vhosts` proxy plugin supports both the `http` and `https` schemes.
 - Default port mappings
   - buildpack apps will be set to `http:80:5000` and will also include `https:443:5000` if SSL is enabled.
   - dockerfile apps with explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on each exposed port that proxies to the same port of the deployed application container.
-    - You may override this behavior with the [`proxy:ports-*` commands](/dokku/advanced-usage/proxy-management/) or by directly setting `DOKKU_PROXY_PORT_MAP` with the `config:set` command
+    - You may override this behavior with the [`proxy:ports-*` commands](/docs/networking/proxy-management.md) or by directly setting `DOKKU_PROXY_PORT_MAP` with the `config:set` command
     - dockerfile apps without explicitly exposed ports will behave the same as a buildpack app
   - NOTE: These defaults **are not** automatically changed on subsequent pushes and must be manipulated with the aforementioned commands
 

docs/appendices/0.7.0-migration-guide.md

@@ -2,12 +2,12 @@
 
 ## Persistent Storage
 
-We should now properly handle file ownership for mounted directories. This was enhanced in 0.7.1. See the [persistent storage documentation](/dokku/advanced-usage/persistent-storage/) for more details.
+We should now properly handle file ownership for mounted directories. This was enhanced in 0.7.1. See the [persistent storage documentation](/docs/advanced-usage/persistent-storage.md) for more details.
 
 ## Restart Policies
 
-If you previously managed container restart policies via docker-options, these can now be managed natively via the built-in `ps` plugin. There is no migration necessary. See the [restart policy documentation](/dokku/deployment/process-management/#restart-policies) for more details.
+If you previously managed container restart policies via docker-options, these can now be managed natively via the built-in `ps` plugin. There is no migration necessary. See the [restart policy documentation](/docs/processes/process-management.md#restart-policies) for more details.
 
 ## SSH Keys
 
-Dokku now has an `ssh-keys` plugin that can be used to manage ssh keys for the `dokku` user on the host operating system. See the [user management documentation](/dokku/deployment/user-management/) for more details.
+Dokku now has an `ssh-keys` plugin that can be used to manage ssh keys for the `dokku` user on the host operating system. See the [user management documentation](/docs/deployment/user-management.md) for more details.

docs/appendices/0.8.0-migration-guide.md

@@ -0,0 +1,19 @@
+# 0.8.0 Migration Guide
+
+## Domain Management
+
+You can now set global and app domains via `domains:set` and `domains:set-global`. See the [domains documentation](/docs/configuration/domains/) for more details.
+
+## Plugin Uninstallation
+
+A new `uninstall` plugin trigger was introduced. This functionality may be in use for newer plugins, so be aware that older Dokku versions may require manual cleanup.
+
+See the [uninstall trigger documentation](/docs/development/plugin-triggers/#uninstall) for implementation instructions.
+
+## Deployment Tasks
+
+Should a pre or post deployment task fail, we now fail the entire deploy.
+
+## Nginx HTTP2 Support
+
+Due to bugs in Nginx, the minimum version for HTTP2 is now 1.11.5.

docs/appendices/0.9.0-migration-guide.md

@@ -0,0 +1,12 @@
+# 0.9.0 Migration Guide
+
+## Golang Migration
+
+There is an ongoing migration to rewrite Dokku in Golang. The reasons are beyond the scope of this document, but this may impact any patches you have for Dokku. As of 0.9.0, only the `repo` plugin is in Golang.
+
+The following shall remain true, regardless of the state of our rewrite:
+
+- You will be able to write custom plugins in any language.
+- You will be able to enable or disable core plugins.
+- `plugn` will continue to be used for executing plugin triggers.
+- We will provide bash wrappers that can be sourced to execute core functionality that is implemented in golang.

docs/assets/favicons/browserconfig.xml

@@ -2,10 +2,10 @@
 <browserconfig>
   <msapplication>
     <tile>
-      <square70x70logo src="https://cdn.rawgit.com/dokku/dokku/v0.7.2/docs/assets/favicons/mstile-70x70.png"/>
-      <square150x150logo src="https://cdn.rawgit.com/dokku/dokku/v0.7.2/docs/assets/favicons/mstile-150x150.png"/>
-      <square310x310logo src="https://cdn.rawgit.com/dokku/dokku/v0.7.2/docs/assets/favicons/mstile-310x310.png"/>
-      <wide310x150logo src="https://cdn.rawgit.com/dokku/dokku/v0.7.2/docs/assets/favicons/mstile-310x150.png"/>
+      <square70x70logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.24.4/docs/assets/favicons/mstile-70x70.png"/>
+      <square150x150logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.24.4/docs/assets/favicons/mstile-150x150.png"/>
+      <square310x310logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.24.4/docs/assets/favicons/mstile-310x310.png"/>
+      <wide310x150logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.24.4/docs/assets/favicons/mstile-310x150.png"/>
       <TileColor>#da532c</TileColor>
     </tile>
   </msapplication>

docs/assets/favicons/manifest.json

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

docs/assets/style.css

@@ -1,7 +1,10 @@
+:root {
+  color-scheme: light dark;
+}
 body {
-  font-family: 'Open Sans', sans-serif;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+  font-size: 62.5%;
   font-weight: 400;
-  font-size: 12px;
   padding-bottom: 40px;
   color: #5a5a5a;
   -webkit-font-smoothing: antialiased;
@@ -20,8 +23,8 @@ h1 {
 }
 .header .heading {
   color: #fff;
-  font-size: 23px;
-  margin: 0;
+  font-size: 2.4em;
+  margin: 7px 0 0 0;
   padding: 0 0 0 1em;
 }
 .header a {
@@ -35,28 +38,37 @@ h1 {
   background-size: contain;
   background-repeat: no-repeat;
 }
+.header .nav-item a {
+  font-size: 1.6em;
+}
 .header .navbar-brand a {
-  background-image: url(https://cdn.rawgit.com/dokku/dokku/v0.7.2/docs/assets/dokku.png);
+  background-image: url(https://cdn.jsdelivr.net/gh/dokku/dokku@v0.24.4/docs/assets/dokku.png);
   text-indent: 40px;
 }
 .blurb {
   color: #424242;
   background-color: #ededed;
-  background-image: url(https://cdn.rawgit.com/dokku/dokku/v0.7.2/docs/assets/gplaypattern.png);
+  background-image: url(https://cdn.jsdelivr.net/gh/dokku/dokku@v0.24.4/docs/assets/gplaypattern.png);
   padding: 45px 0;
   text-align: center;
 }
+.blurb h2 {
+  font-size: 3.5em;
+}
 .blurb p {
-  font-size: 17px;
+  font-size: 1.9em;
   font-weight: 300;
   margin: 18px 0;
   text-align: center;
 }
+.blurb .btn-lg {
+  font-size: 2.2em;
+}
 .quickstart-code {
   display: block;
   line-height: 1.3em;
   margin: 45px auto;
-  max-width: 750px;
+  max-width: 860px;
   padding: 0;
 }
 .quickstart-code .title {
@@ -66,8 +78,8 @@ h1 {
   box-shadow: 0 3px 0 rgba(0, 0, 0, 0.5);
   color: #444;
   display: block;
+  font-size: 1.6em;
   font-weight: 400;
-  font-size: 14px;
   margin: 0 20px;
   padding: 3px 0;
   text-align: center;
@@ -105,6 +117,7 @@ h1 {
   border-top: 1px solid #bcbcbc;
   box-shadow: 0 5px 30px rgba(0, 0, 0, 0.3);
   display: none;
+  font-size: 1.4em;
   font-family: Menlo, Consolas, "Courier New", Courier, "Liberation Mono", monospace;
   margin: 0 20px;
   padding: 20px;
@@ -138,9 +151,10 @@ h1 {
 }
 .alternate-instructions {
   display: block;
+  font-size: 1.6em;
   line-height: 1.3em;
   margin: 45px auto;
-  max-width: 750px;
+  max-width: 860px;
   padding: 0;
   text-align: center;
 }
@@ -166,12 +180,14 @@ h1 {
 .featurette img {
   width: 400px;
 }
-.slack-channel {
+.slack-channel,
+.sponsors {
   background-color: #EEF1F7;
-  font-size: 16px;
+  font-size: 1.6em;
   font-weight: 300;
   margin-bottom: 2.5em;
-  padding: 2.5em 0;
+  padding-top: 2.5em;
+  padding-bottom: 2.5em;
   text-align: center
 }
 .slack-channel .inline-container {
@@ -187,30 +203,38 @@ h1 {
 .slack-button img {
   height: 1em;
 }
-.team-members img {
-  -moz-box-shadow: 4px 4px 8px 0px rgba(0,0,0,0.75);
+.sponsors {
+  background-color: #272822;
+  color: #FCFCFC;
+}
+.sponsors a {
+  color: #f0ad4e;
+}
+.sponsors .backer img,
+.sponsors .sponsor img {
   -webkit-border-radius: 3px;
-  -webkit-box-shadow: 4px 4px 8px 0px rgba(0,0,0,0.75);
   border-radius: 3px;
-  border: 8px solid white;
-  box-shadow: 4px 4px 8px 0px rgba(0,0,0,0.75);
-  display: block;
-  height: 200px;
+  border: 8px solid gray;
   margin: 20px auto 20px auto;
+  max-width: 192px;
 }
-.team-members .fund-link {
+.sponsors .backer img {
+  -webkit-border-radius: 50%;
+  border-radius: 50%;
+  border: 0;
+}
+.sponsors img:hover {
+  -moz-box-shadow: 4px 4px 8px 0px rgba(0,0,0,0.75);
+  -webkit-box-shadow: 4px 4px 8px 0px rgba(0,0,0,0.75);
+  box-shadow: 0px 0px 32px 0px rgba(0,0,0,0.75);
+}
+.sponsors .fund-link {
   display: block;
-  font-size: 80%;
+  font-size: .8em;
 }
-.team-member {
-  min-height: 320px;
-}
-.team-member-image img:last-child { display: none }
-.team-member-image:hover img:first-child { display: none; }
-.team-member-image:hover img:last-child { display: inline-block; }
-
 .list-group-item {
   border: none;
+  font-size: 14px;
   font-weight: normal;
   padding: .2rem .5rem;
   color: #157577;
@@ -231,7 +255,7 @@ a.list-group-item {
   text-transform: uppercase;
 }
 .table-of-contents {
-  font-size: 0.8em;
+  font-size: 1.2em;
   padding: 1em;
   margin: 0 0 0.5em 0.5em;
 }
@@ -246,35 +270,35 @@ a.list-group-item {
   -webkit-font-smoothing: antialiased;
   box-sizing: border-box;
   color: rgb(71, 74, 84);
-  font-size: 14px;
+  font-size: 1.6em;
   font-weight: normal;
   height: 20px;
-  line-height: 20px;
+  line-height: 1.5;
   text-align: left;
 }
 .markdown-body h1 {
   border-bottom: 1px solid #dfdfdf;
   color: #444;
-  font-size: 24px;
+  font-size: 1.6em;
   padding-bottom: 1em;
   margin-top: 0;
   text-rendering: optimizelegibility;
 }
 .markdown-body h2 {
-  font-size: 17px;
+  font-size: 1.3em;
   font-weight: 700;
   color: #555;
   margin-top: 2em;
   text-transform: uppercase;
 }
 .markdown-body h3 {
-  font-size: 15px;
+  font-size: 1.2em;
   font-weight: 700;
   color: #555;
   margin: 1em 0;
 }
 .markdown-body h4 {
-  font-size: 14px;
+  font-size: 1.1em;
   font-weight: 700;
   color: #555;
   margin: 1em 0;
@@ -296,7 +320,7 @@ a.list-group-item {
   right: 0;
   width: auto;
   height: auto;
-  font-size: 0.9em;
+  font-size: 1em;
   border-radius: 0 0 0 5px;
   padding: 0 0.5em;
   text-shadow: none;
@@ -320,7 +344,6 @@ code {
   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;
@@ -368,6 +391,11 @@ blockquote {
   border-left: 4px solid #ef5b58;
   background-color: #f9ad76;
 }
+.warning {
+  border-left: 4px solid #cd2512;
+  background-color: #d1675f;
+  color: white;
+}
 .fa:before {
   -webkit-font-smoothing: antialiased
 }
@@ -416,10 +444,9 @@ blockquote {
   font-weight: 700;
   text-transform: uppercase;
   margin: 0;
-  font-size: 14px;
+  font-size: 1.3em;
 }
 .git-improve {
-  font-size: 20px;
   vertical-align: -2px;
   padding-left: 8px;
 }
@@ -434,7 +461,6 @@ blockquote {
 .icon-improve {
   color: #bdbdb5;
   padding: 2px 9px 0 10px;
-  font-size: 14px;
 }
 a .fa {
   display: inline-block;
@@ -585,7 +611,7 @@ ul.fas li .fa-large:before, ul.fas li .fa-large:before {
   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;
+  font-size: 1.6em;
   text-align: center;
   background-color: #ffe761;
 }
@@ -602,18 +628,20 @@ ul.fas li .fa-large:before, ul.fas li .fa-large:before {
     height: auto
   }
 }
+
+.button.slack-button > img {
+    width: inherit;
+}
+
 @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;
+    font-size: 5em;
   }
 }
 @media (min-width: 992px) {
@@ -629,3 +657,75 @@ ul.fas li .fa-large:before, ul.fas li .fa-large:before {
     width: 200px;
   }
 }
+@media (prefers-color-scheme: dark) {
+    body {
+        background-color: rgb(13, 17, 23);
+    }
+    .header {
+        background-color: #0b1f4c;
+    }
+    .blurb {
+        filter: invert(1);
+    }
+    .slack-channel {
+        background-color: #110e09;
+    }
+
+    code {
+        background-color: rgb(22, 27, 34);
+        color: #bbb;
+    }
+    pre {
+        background-color: rgb(22, 27, 34);
+        color: #bbb;
+        border: 1px solid #555;
+        box-shadow: 0 0 0 3px #111;
+    }
+    .highlight-show-language-label {
+      filter: invert(1);
+    }
+    .list-group-item {
+        background-color: rgb(13, 17, 23);
+    }
+    blockquote {
+        background-color: rgba(0, 82, 204, 0.18);
+        border-left: 4px solid rgba(108, 169, 255, 0.3);;
+        color: rgb(108, 169, 255);
+    }
+    blockquote.warning {
+        border-left: 4px solid rgba(239, 136, 84, 0.3);
+        background-color: rgba(235, 100, 32, 0.18);
+        color: rgb(239, 136, 84);
+    }
+    blockquote.new-as-of {
+        border-left: 4px solid rgba(11, 216, 73, 0.3);
+        background-color: rgba(9, 171, 60, 0.18);
+        color: rgb(11, 216, 73);
+    }
+    .dev-warning, .outdated-warning {
+        background-color: #4e440d;
+        color: #fff;
+    }
+    .table-striped tbody tr:nth-of-type(odd) {
+      background-color: #080808
+    }
+    .table-hover tbody tr:hover {
+      background-color: #3b3b3b;
+      color: #bbb;
+    }
+    .table td, .table th {
+      border-top: 1px solid #131110;
+    }
+    .table thead th {
+      border-bottom: 2px solid #131110;
+    }
+    .markdown-body {
+      color: rgb(184, 181, 171);
+    }
+    .markdown-body h1 {
+      color: #bbb;
+    }
+    .markdown-body h2, .markdown-body h3, .markdown-body h4 {
+      color: #aaa;
+    }
+}

docs/assets/versions.json

@@ -1 +1,26 @@
-{ "max-versions": [ "0.3.26", "0.4.14", "0.5.8", "0.6.5", "0.7.2" ] }
+{
+  "max-versions": [
+    "0.3.26",
+    "0.4.14",
+    "0.5.8",
+    "0.6.5",
+    "0.7.2",
+    "0.8.2",
+    "0.9.4",
+    "0.10.5",
+    "0.11.6",
+    "0.12.13",
+    "0.13.4",
+    "0.14.6",
+    "0.15.5",
+    "0.16.4",
+    "0.17.9",
+    "0.18.5",
+    "0.19.13",
+    "0.20.4",
+    "0.21.4",
+    "0.22.9",
+    "0.23.9",
+    "0.24.4"
+  ]
+}

docs/community/clients.md

@@ -2,42 +2,11 @@
 
 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.
+The easiest way to interact with Dokku remotely is by using the official client. Documented below are the various clients that you may wish to use.
 
-## (bash, zsh, etc.) `dokku_client.sh`
+## Official Client
 
-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`.
+See the [remote commands documentation](/docs/deployment/remote-commands.md) for more information on how to install and use the official client.
 
 ## (nodejs) dokku-toolbelt
 
@@ -51,7 +20,7 @@ See [documentation here](https://www.npmjs.com/package/dokku-toolbelt) for more
 
 ## (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):
+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

docs/community/plugins.md

@@ -12,39 +12,40 @@ Let's take a quick look at the current Dokku nginx plugin that's shipped with Do
 
 ## Installing a plugin
 
-[See the plugin management documentation](/dokku/advanced-usage/plugin-management/).
+[See the plugin management documentation](/docs/advanced-usage/plugin-management.md).
 
 ## Creating your own plugin
 
-[See the full documentation](/dokku/development/plugin-creation/).
+[See the full documentation](/docs/development/plugin-creation.md).
 
-## Official Plugins (Beta)
+## Official Plugins
 
-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.
+The following plugins are available and provided by Dokku maintainers.  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+                |
-| [Grafana/Graphite/Statsd (beta)](https://github.com/dokku/dokku-graphite-grafana)                 | [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+                |
+| [CouchDB](https://github.com/dokku/dokku-couchdb)                                                 | [dokku][]             | 0.4.0+                |
+| [Elasticsearch](https://github.com/dokku/dokku-elasticsearch-plugin)                              | [dokku][]             | 0.4.0+                |
+| [Grafana/Graphite/Statsd](https://github.com/dokku/dokku-graphite-grafana)                        | [dokku][]             | 0.4.0+                |
+| [MariaDB](https://github.com/dokku/dokku-mariadb-plugin)                                          | [dokku][]             | 0.4.0+                |
+| [Memcached](https://github.com/dokku/dokku-memcached-plugin)                                      | [dokku][]             | 0.4.0+                |
+| [Mongo](https://github.com/dokku/dokku-mongo-plugin)                                              | [dokku][]             | 0.4.0+                |
+| [MySQL](https://github.com/dokku/dokku-mysql-plugin)                                              | [dokku][]             | 0.4.0+                |
+| [Nats](https://github.com/dokku/dokku-nats)                                                       | [dokku][]             | 0.4.0+                |
+| [Postgres](https://github.com/dokku/dokku-postgres-plugin)                                        | [dokku][]             | 0.4.0+                |
+| [RabbitMQ](https://github.com/dokku/dokku-rabbitmq-plugin)                                        | [dokku][]             | 0.4.0+                |
+| [Redis](https://github.com/dokku/dokku-redis-plugin)                                              | [dokku][]             | 0.4.0+                |
+| [RethinkDB](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+                |
+| [HTTP Auth](https://github.com/dokku/dokku-http-auth)                                             | [dokku][]             | 0.4.0+                |
+| [Let's Encrypt](https://github.com/dokku/dokku-letsencrypt)                                       | [dokku][]             | 0.4.0+                |
+| [Maintenance mode](https://github.com/dokku/dokku-maintenance)                                    | [dokku][]             | 0.4.0+                |
+| [Redirect](https://github.com/dokku/dokku-redirect)                                               | [dokku][]             | 0.4.0+                |
+| [Registry](https://github.com/dokku/dokku-registry)                                               | [dokku][]             | 0.12.0+
 
 ## Community plugins
 
-Note: The following plugins have been supplied by our community and may not have been tested by Dokku maintainers.
+> Warning: The following plugins have been supplied by our community and may not have been tested by Dokku maintainers.
 
 [256dpi]: https://github.com/256dpi
 [abossard]: https://github.com/dudagroup
@@ -57,10 +58,13 @@ Note: The following plugins have been supplied by our community and may not have
 [Aluxian]: https://github.com/Aluxian
 [Aomitayo]: https://github.com/Aomitayo
 [apmorton]: https://github.com/apmorton
+[artofrawr]: https://github.com/artofrawr
+[badsyntax]: https://github.com/badsyntax
 [basgys]: https://github.com/basgys
 [Benjamin-Dobell]: https://github.com/Benjamin-Dobell
 [blag]: https://github.com/blag
 [cameron-martin]: https://github.com/cameron-martin
+[candlewaster]: https://notabug.org/candlewaster
 [cedricziel]: https://github.com/cedricziel
 [cef]: https://github.com/cef
 [cjblomqvist]: https://github.com/cjblomqvist
@@ -68,11 +72,12 @@ Note: The following plugins have been supplied by our community and may not have
 [cu12]: https://github.com/cu12
 [darkpixel]: https://github.com/darkpixel
 [dokku]: https://github.com/dokku
+[dokku-community]: https://github.com/dokku-community
 [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
+[fomojola]: https://github.com/fomojola
 [gdi2290]: https://github.com/gdi2290
 [hughfletcher]: https://github.com/hughfletcher
 [iamale]: https://github.com/iamale
@@ -87,15 +92,19 @@ Note: The following plugins have been supplied by our community and may not have
 [Kloadut]: https://github.com/Kloadut
 [krisrang]: https://github.com/krisrang
 [luxifer]: https://github.com/luxifer
+[m0rth1um]: https://github.com/m0rth1um
 [Maciej Łebkowski]: https://github.com/mlebkowski
 [matto1990]: https://github.com/matto1990
+[mbreit]: https://github.com/mbreit
 [mbriskar]: https://github.com/mbriskar
 [michaelshobbs]: https://github.com/michaelshobbs
 [mikecsh]: https://github.com/mikecsh
 [mikexstudios]: https://github.com/mikexstudios
+[mimischi]: https://github.com/mimischi
 [mixxorz]: https://github.com/mixxorz
 [mlebkowski]: https://github.com/mlebkowski
 [motin]: https://github.com/motin
+[mrname]: https://github.com/mrname
 [musicglue]: https://github.com/musicglue
 [neam]: https://github.com/neam
 [nickcharlton]: https://github.com/nickcharlton
@@ -118,6 +127,11 @@ Note: The following plugins have been supplied by our community and may not have
 [thrashr888]: https://github.com/thrashr888
 [wmluke]: https://github.com/wmluke
 [Zenedith]: https://github.com/Zenedith
+[fteychene]: https://github.com/fteychene
+[sarendsen]: https://github.com/sarendsen
+[baikunz]: https://github.com/baikunz
+[lazyatom]: https://github.com/lazyatom
+[ollej]: https://github.com/ollej
 
 ### Datastores
 
@@ -147,6 +161,7 @@ Note: The following plugins have been supplied by our community and may not have
 | [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                 |
 | [ElasticMQ (SQS compatible)](https://github.com/cu12/dokku-elasticmq)                             | [cu12][]              | 0.5.0+                |
+| [VerneMQ (MQTT Broker)](https://github.com/SpinifexGroup/dokku-vernemq)                           | [mrname][]            | 0.4.0+                |
 
 #### Other
 
@@ -156,12 +171,13 @@ Note: The following plugins have been supplied by our community and may not have
 | [FakeSNS](https://github.com/cu12/dokku-fake_sns)                                                 | [cu12][]              | 0.5.0+                |
 | [InfluxDB](https://github.com/basgys/dokku-influxdb)                                              | [basgys][]            | 0.4.x                 |
 | [RethinkDB](https://github.com/stuartpb/dokku-rethinkdb-plugin)                                   | [stuartpb][]          | 0.3.x                 |
+| [Headless Chrome](https://github.com/lazyatom/dokku-chrome)                                       | [lazyatom][]          | 0.8.1+                |
 
 [dccee02]: https://github.com/jeffutter/dokku-riakcs-plugin/commit/dccee02702e7001851917b7814e78a99148fb709
 [c77cbf1]: https://github.com/dokku/dokku/commit/c77cbf1d3ae07f0eafb85082ed7edcae9e836147
 [28de3ec]: https://github.com/dokku/dokku/commit/28de3ecaa3231a223f83fd8d03f373308673bc40
 
-### Dokku Features
+### Plugins Implementing New Dokku Functionality
 
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
@@ -169,36 +185,43 @@ Note: The following plugins have been supplied by our community and may not have
 | [Docker Direct](https://github.com/josegonzalez/dokku-docker-direct)                              | [josegonzalez][]      | 0.4.0+                |
 | [Dokku Clone](https://github.com/crisward/dokku-clone)                                            | [crisward][]          | 0.4.0+                |
 | [Dokku Copy App Config Files](https://github.com/josegonzalez/dokku-supply-config)                | [josegonzalez][]      | 0.4.0+                |
-| [Dokku Registry](https://github.com/agco-adm/dokku-registry)<sup>1</sup>                          | [agco-adm][]          | 0.4.0+                |
-| [Dokku Require](https://github.com/crisward/dokku-require)<sup>2</sup>                            | [crisward][]          | 0.4.0+                |
-| [git rev-parse HEAD in env](https://github.com/cjblomqvist/dokku-git-rev)                         | [cjblomqvist][]       | 0.4.0+                |
+| [Dockerfile custom path](https://github.com/mimischi/dokku-dockerfile)                            | [mimischi][]          | 0.8.0+                               |
+| [Dokku Require](https://github.com/crisward/dokku-require)<sup>1</sup>                            | [crisward][]          | 0.4.0+                |
 | [Global Certificates](https://github.com/josegonzalez/dokku-global-cert)                          | [josegonzalez][]      | 0.5.0+                |
 | [Graduate (Environment Management)](https://github.com/glassechidna/dokku-graduate)               | [Benjamin-Dobell][]   | 0.4.0+                |
 | [Haproxy tcp load balancer](https://github.com/256dpi/dokku-haproxy)                              | [256dpi][]            | 0.4.0+                |
 | [Hostname](https://github.com/michaelshobbs/dokku-hostname)                                       | [michaelshobbs][]     | 0.4.0+                |
 | [HTTP Auth Secure Apps](https://github.com/matto1990/dokku-secure-apps)                           | [matto1990][]         | 0.4.0+                |
+| [Monit (Health Checks)](https://github.com/mbreit/dokku-monit)                                    | [mbreit][]            | 0.8.0+                |
 | [Nuke Containers](https://github.com/josegonzalez/dokku-nuke)                                     | [josegonzalez][]      | 0.4.0+                |
 | [Open App Ports](https://github.com/josegonzalez/dokku-ports)                                     | [josegonzalez][]      | 0.3.x                 |
 | [Proctype Filter](https://github.com/michaelshobbs/dokku-proctype-filter)                         | [michaelshobbs][]     | 0.4.0+                |
-| [SSH Deployment Keys](https://github.com/cedricziel/dokku-deployment-keys)<sup>3</sup>            | [cedricziel][]        | 0.4.0+                |
-| [SSH Hostkeys](https://github.com/cedricziel/dokku-hostkeys-plugin)<sup>4</sup>                   | [cedricziel][]        | 0.3.x                 |
+| [robots.txt](https://notabug.org/candlewaster/dokku-robots.txt)                                   | [candlewaster][]      | 0.4.x                 |
+| [SSH Deployment Keys](https://github.com/cedricziel/dokku-deployment-keys)<sup>2</sup>            | [cedricziel][]        | 0.4.0+                |
+| [SSH Hostkeys](https://github.com/cedricziel/dokku-hostkeys-plugin)<sup>3</sup>                   | [cedricziel][]        | 0.3.x                 |
+| [Application build hook](https://github.com/fteychene/dokku-build-hook)                           | [fteychene][]         | 0.4.0+                 |
+| [Post Deploy Script](https://github.com/baikunz/dokku-post-deploy-script)                         | [baikunz][]           | 0.4.0+                 |
+| [Auto Sync](https://github.com/IdeaSynthesis/dokku-autosync)<sup>4</sup>                          | [fomojola][]          | 0.8.1+                |
+| [Deploy Webhook](https://github.com/IdeaSynthesis/dokku-deploy-webhook)<sup>5</sup>               | [fomojola][]          | 0.8.1+                |
 
 [217d00a]: https://github.com/dokku/dokku/commit/217d00a1bc47a7e24d8847617bb08a1633025fc7
 
-<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>1</sup> Extends app.json support to include creating volumes and creating / linking databases on push
 
-<sup>2</sup> Extends app.json support to include creating volumes and creating / linking databases on push
+<sup>2</sup> Adds the possibility to add SSH deployment keys to receive private hosted packages
 
-<sup>3</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> 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> Adds the ability to sync an application repo with a remote Github repo (useful for automated rebuilds without needing a git push from an external system
+
+<sup>5</sup> Adds the ability to invoke a post-deploy webhook with the IP, port and app name, all with a single config:set).
 
 ### Other Plugins
 
 | Plugin                                                                                            | Author                | Compatibility         |
 | ------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
 | [Airbrake deploy](https://github.com/Flink/dokku-airbrake-deploy)                                 | [Flink][]             | 0.4.0+                |
-| [APT](https://github.com/F4-Group/dokku-apt)                                                      | [F4-Group][]          | 0.4.0+                |
+| [APT](https://github.com/dokku-community/dokku-apt)                                               | [dokku-community][]   | 0.18.x+               |
 | [Bower install](https://github.com/alexanderbeletsky/dokku-bower-install)                         | [alexanderbeletsky][] | 0.3.x                 |
 | [Bower/Grunt](https://github.com/thrashr888/dokku-bower-grunt-build-plugin)                       | [thrashr888][]        | 0.3.x                 |
 | [Bower/Gulp](https://github.com/gdi2290/dokku-bower-gulp-build-plugin)                            | [gdi2290][]           | 0.3.x                 |
@@ -207,19 +230,28 @@ Note: The following plugins have been supplied by our community and may not have
 | [Chef cookbook](https://github.com/nickcharlton/dokku-cookbook)                                   | [nickcharlton][]      |                       |
 | [Docker auto persist volumes](https://github.com/Flink/dokku-docker-auto-volumes)                 | [Flink][]             | 0.4.0+                |
 | [Hostname](https://github.com/michaelshobbs/dokku-hostname)                                       | [michaelshobbs][]     | 0.4.0+                |
+| [Limit (Resource management)](https://github.com/sarendsen/dokku-limit)                           | [sarendsen][]         | 0.9.0+                |
 | [Logspout](https://github.com/michaelshobbs/dokku-logspout)                                       | [michaelshobbs][]     | 0.4.0+                |
+| [Syslog](https://github.com/michaelshobbs/dokku-syslog)                                           | [michaelshobbs][]     | 0.10.4+               |
 | [Long Timeout](https://github.com/investtools/dokku-long-timeout-plugin)                          | [investtools][]       | 0.4.0+                |
 | [Monit](https://github.com/cjblomqvist/dokku-monit)                                               | [cjblomqvist][]       | 0.3.x                 |
 | [Monorepo](https://github.com/iamale/dokku-monorepo)                                              | [iamale][]            | 0.4.0+                |
+| [Multi Dockerfile](https://github.com/artofrawr/dokku-multi-dockerfile)                           | [artofrawr][]         | 0.4.0+                |
 | [Node](https://github.com/ademuk/dokku-nodejs)                                                    | [ademuk][]            | 0.3.x                 |
 | [Node](https://github.com/pnegahdar/dokku-node)                                                   | [pnegahdar][]         | 0.3.x                 |
 | [Rollbar](https://github.com/iloveitaly/dokku-rollbar)                                            | [iloveitaly][]        | 0.5.0+                |
 | [Slack Notifications](https://github.com/ribot/dokku-slack)                                       | [ribot][]             | 0.4.0+                |
+| [Telegram Notifications](https://github.com/m0rth1um/dokku-telegram)                              | [m0rth1um][]          | 0.4.0+                |
 | [Tor](https://github.com/michaelshobbs/dokku-tor)                                                 | [michaelshobbs][]     | 0.4.0+                |
-| [User ACL](https://github.com/mlebkowski/dokku-acl)                                               | [Maciej Łebkowski][]  | 0.4.0+                |
+| [User ACL](https://github.com/dokku-community/dokku-acl)                                          | [Maciej Łebkowski][]  | 0.4.0+                |
 | [Webhooks](https://github.com/nickstenning/dokku-webhooks)                                        | [nickstenning][]      | 0.3.x                 |
 | [Wkhtmltopdf](https://github.com/mbriskar/dokku-wkhtmltopdf)                                      | [mbriskar][]          | 0.4.0+                |
-| [Wordpress Setup](https://github.com/dudagroup/dokku-wordpress-template)                          | [abossard][]          |                       |
+| [Dokku Wordpress](https://github.com/dokku-community/dokku-wordpress)                             | [dokku-community][]      | 0.4.0+                |
+| [Access](https://github.com/mainto/dokku-access)                                                  | [mainto](https://github.com/mainto)            | 0.4.0+                |
+| [Dokku Nginx Trust Proxy](https://github.com/kingsquare/dokku-nginx-vhost-trustproxy)             | [kingsquare](https://github.com/kingsquare)  | 0.4.0+ |
+| [Fonts](https://github.com/ollej/dokku-fonts)             | [ollej]  | 0.19.11+ |
+| [Discourse](https://github.com/badsyntax/dokku-discourse)                                         | [badsyntax][]         | 0.21.4+               |
+
 
 ### Deprecated Plugins
 
@@ -233,6 +265,7 @@ The following plugins have been removed as their functionality is now in Dokku C
 | [Docker Options](https://github.com/dyson/dokku-docker-options)                                   | [dyson][]             | v0.3.17 (docker-options plugin)           |
 | [Dokku Name](https://github.com/alex-sherwin/dokku-name)                                          | [alex-sherwin][]      | v0.4.2 (named containers plugin)          |
 | [Events Logger](https://github.com/alessio/dokku-events)                                          | [alessio][]           | v0.3.21 (events plugin)                   |
+| [git rev-parse HEAD in env](https://github.com/dokku-community/dokku-git-rev)                     | [cjblomqvist][]       | v0.12.0 (enhanced core git plugin)        |
 | [Host Port binding](https://github.com/stuartpb/dokku-bind-port)                                  | [stuartpb][]          | v0.3.17 (docker-options plugin)           |
 | [Link Containers](https://github.com/rlaneve/dokku-link)                                          | [rlaneve][]           | v0.3.17 (docker-options plugin)           |
 | [List Containers](https://github.com/josegonzalez/dokku-list)                                     | [josegonzalez][]      | v0.3.14 (ps plugin)                       |
@@ -274,6 +307,7 @@ The following plugins are no longer maintained by their developers.
 | [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 |
 | [Dokku Copy App Config Files](https://github.com/alexkruegger/dokku-app-configfiles)              | [alexkruegger][]      | Compatible with 0.3.17+ |
+| [Dokku Registry](https://github.com/agco-adm/dokku-registry)                                      | [agco-adm][]          | 0.4.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 |
 | [Graphite/statsd](https://github.com/jlachowski/dokku-graphite-plugin)                            | [jlachowski][]        | < 0.4.0               |

docs/community/tutorials/run-on-external-volume.md

@@ -0,0 +1,78 @@
+# Run Dokku on External Volume
+
+In order to leverage cloud-provider facilities like _attachable volumes_, (_a.k.a. block storage_)
+the following is an easy tutorial to achieve Dokku runs on them.
+
+> Warning: If the block storage is not available and attached on boot it is possible that containers will not correctly start. Please keep this in mind when considering moving Dokku and/or Docker to network attached storage.
+
+## Tutorial
+
+The following is intended to be executed on the dokku host machine as `root`.
+Say, _for instance_, that our volume is mapped into the systems as `/dev/vdb1`.
+
+Stop docker daemon
+
+```shell
+systemctl stop docker
+```
+
+Prepare the filesystem:
+
+```shell
+mkfs -t ext4 /dev/vdb1
+mkdir /mnt/volume
+mount /dev/vdb1 /mnt/volume
+```
+
+Move the old data directories:
+
+```shell
+mv /home/dokku /home/dokku.OLD
+mv /var/lib/docker /var/lib/docker.OLD
+mv /var/lib/dokku /var/lib/dokku.OLD
+```
+
+Move the data on the volume
+
+```shell
+mkdir /mnt/volume/home/
+mkdir -p /mnt/volume/var/lib/
+mv /home/dokku.OLD /mnt/volume/home/dokku
+mv /var/lib/dokku.OLD /mnt/volume/var/lib/dokku
+mv /var/lib/docker.OLD /mnt/volume/var/lib/docker
+```
+
+Prepare the mountpoints
+
+```shell
+mkdir /home/dokku
+mkdir /var/lib/dokku
+mkdir /var/lib/docker
+chown dokku:dokku /home/dokku   # respect the original ownership
+chmod 711 /var/lib/docker       # respect the original permissions
+```
+
+Mount bind
+
+```shell
+mount -o bind /mnt/volume/home/dokku /home/dokku
+mount -o bind /mnt/volume/var/lib/dokku /var/lib/dokku
+mount -o bind /mnt/volume/var/lib/docker /var/lib/docker
+```
+
+Start docker daemon
+
+```shell
+systemctl start docker
+```
+
+At this point all should be working fine, please check it out.
+
+Then, let the changes be reboot-persistent
+
+```shell
+echo '/dev/vdb1 /mnt/volume ext4 defaults 0 2' | sudo tee -a /etc/fstab
+echo '/mnt/volume/home/dokku /home/dokku none defaults,bind 0 0' | sudo tee -a /etc/fstab
+echo '/mnt/volume/var/lib/dokku /var/lib/dokku none defaults,bind 0 0' | sudo tee -a /etc/fstab
+echo '/mnt/volume/var/lib/docker /var/lib/docker none defaults,bind 0 0' | sudo tee -a /etc/fstab
+```

docs/configuration/domains.md

@@ -5,15 +5,18 @@
 ```
 domains:add <app> <domain> [<domain> ...]      # Add domains to app
 domains:add-global <domain> [<domain> ...]     # Add global domain names
-domains [<app>]                                # List domains
 domains:clear <app>                            # Clear all domains for app
+domains:clear-global                           # Clear global domain names
 domains:disable <app>                          # Disable VHOST support
 domains:enable <app>                           # Enable VHOST support
 domains:remove <app> <domain> [<domain> ...]   # Remove domains from app
 domains:remove-global <domain> [<domain> ...]  # Remove global domain names
+domains:report [<app>|--global] [<flag>]       # Displays a domains report for one or more apps
+domains:set <app> <domain> [<domain> ...]      # Set domains for app
+domains:set-global <domain> [<domain> ...]     # Set global domain names
 ```
 
-> Adding a domain before deploying an application will result in port mappings being set. This may cause issues for applications that use non-standard ports, as those will not be automatically detected. Please refer to the [proxy documentation](/dokku/advanced-usage/proxy-management/) for information as to how to reconfigure the mappings.
+> Adding a domain before deploying an application will result in port mappings being set. This may cause issues for applications that use non-standard ports, as those will not be automatically detected. Please refer to the [proxy documentation](/docs/networking/proxy-management.md) for information as to how to reconfigure the mappings.
 
 ## Customizing hostnames
 
@@ -23,79 +26,93 @@ 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.tld` is set during initial configuration and stored in the `$DOKKU_ROOT/VHOST` file. It can then be modified with `dokku domains:add-global` and `dokku domains:remove-global`. This value is used as a default TLD for all applications on a host.
+The `subdomain` is inferred from the pushed application name, while the `domain.tld` is set during initial dokku configuration. It can then be modified with `dokku domains:add-global` and `dokku domains:remove-global`. This value is used as a default TLD for all applications on a host.
 
-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`.
+If an FQDN such as `dokku.org` is used as the application name, the global virtualhost will be ignored and the resulting vhost URL for that application will be `dokku.org`.
 
-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:
+You can optionally override this in a plugin by implementing the `nginx-hostname` plugin trigger. If the `nginx-hostname` plugin has no output, the normal hostname algorithm will be executed. See the [plugin trigger documentation](/docs/development/plugin-triggers.md#nginx-hostname) for more information.
 
-```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"
-```
-
-If the `nginx-hostname` has no output, the normal hostname algorithm will be executed.
 
 ## Disabling VHOSTS
 
 If desired, it is possible to disable vhosts with the domains plugin.
 
 ```shell
-dokku domains:disable myapp
+dokku domains:disable node-js-app
 ```
 
-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.)
+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_PROXY_PORT` and/or `DOKKU_PROXY_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
+# where `node-js-app` is the name of your app
 
 # add a domain to an app
-dokku domains:add myapp example.com
+dokku domains:add node-js-app dokku.me
 
 # list custom domains for app
-dokku domains myapp
+dokku domains:report node-js-app
 
 # clear all custom domains for app
-dokku domains:clear myapp
+dokku domains:clear node-js-app
 
 # remove a custom domain from app
-dokku domains:remove myapp example.com
+dokku domains:remove node-js-app dokku.me
+
+# set all custom domains for app
+dokku domains:set node-js-app dokku.me dokku.org
+```
+
+## Displaying domains reports for an app
+
+> New as of 0.8.1
+
+You can get a report about the app's domains status using the `domains:report` command:
+
+```shell
+dokku domains:report
+```
+
+```
+=====> node-js-app domains information
+       Domains app enabled: true
+       Domains app vhosts:  node-js-app.dokku.org
+       Domains global enabled: true
+       Domains global vhosts: dokku.org
+=====> python-app domains information
+       Domains app enabled: true
+       Domains app vhosts:  python-app.dokku.org
+       Domains global enabled: true
+       Domains global vhosts: dokku.org
+=====> ruby-app domains information
+       Domains app enabled: true
+       Domains app vhosts:  ruby-app.dokku.org
+       Domains global enabled: true
+       Domains global vhosts: dokku.org
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku domains:report node-js-app
+```
+
+```
+=====> node-js-app domains information
+       Domains app enabled: true
+       Domains app vhosts:  node-js-app.dokku.org
+       Domains global enabled: true
+       Domains global vhosts: dokku.org
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku domains:report node-js-app --domains-app-enabled
 ```
 
 ## 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).
-
-```nginx
-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`:
-
-```nginx
-# 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.
+This is specific to your proxy plugin of choice. See the [nginx documentation](/docs/configuration/nginx.md#default-site) for more information on how to configure this for the default nginx proxy implementation.

docs/configuration/environment-variables.md

@@ -5,13 +5,18 @@ Typically an application will require some configuration to run properly. Dokku
 The `config` plugin provides the following commands to manage your variables:
 
 ```
-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
+config:show (<app>|--global)                                                          Pretty-print an app or global environment
+config:bundle (<app>|--global) [--merged]                                             Bundle environment into tarfile
+config:clear (<app>|--global)                                                         Clears environment variables
+config:export (<app>|--global) [--envfile]                                            Export a global or app environment
+config:get (<app>|--global) KEY                                                       Display a global or app-specific config value
+config:keys (<app>|--global) [--merged]                                               Show keys set in environment
+config:set [--encoded] [--no-restart] (<app>|--global) KEY1=VALUE1 [KEY2=VALUE2 ...]  Set one or more config vars
+config:unset [--no-restart] (<app>|--global) KEY1 [KEY2 ...]                          Unset one or more config vars
 ```
+> 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).
 
-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).
+Environment variables are available both at run time and during the application build/compilation step for buildpack-based deploys.
 
 For buildpack deploys, Dokku will create a  `/app/.env` file that can be used for legacy buildpacks. Note that this is *not* updated when `config:set` or `config:unset` is called, and is only written during a `deploy` or `ps:rebuild`. Developers are encouraged to instead read from the application environment directly, as the proper values will be available then.
 
@@ -23,10 +28,15 @@ You can set multiple environment variables at once:
 dokku config:set node-js-app ENV=prod COMPILE_ASSETS=1
 ```
 
-When setting variables with whitespaces, you need to escape them:
+> Note: Whitespace and special characters get tricky. If you are using dokku locally you don't need to do any special escaping. If you are using dokku over ssh you will need to backslash-escape spaces:
+```shell
+dokku config:set node-js-app KEY="VAL\ WITH\ SPACES"
+```
+
+Dokku can also read base64 encoded values. That's the easiest way to set a value with newlines or spaces. To set a value with newlines you need to base64 encode it first and pass the `--encoded` flag:
 
 ```shell
-dokku config:set node-js-app KEY=\"VAL\ WITH\ SPACES\"
+dokku config:set --encoded node-js-app KEY="$(base64 ~/.ssh/id_rsa)"
 ```
 
 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:
@@ -35,25 +45,84 @@ When setting or unsetting environment variables, you may wish to avoid an applic
 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:
+If you wish to have the variables output in an `eval`-compatible form, you can use the `config:export` command
 
 ```shell
-dokku config node-js-app --export
+dokku config:export node-js-app
 # 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)
+eval $(dokku config:export node-js-app)
 ```
 
-You can also output the variables in a single-line for usage in command-line utilities with the `--shell` flag:
+You can control the format of the exported variables with the `--format` flag. 
+`--format=shell` will output the variables in a single-line for usage in command-line utilities:
 
 ```shell
-dokku config node-js-app --shell
+dokku config:export --format shell node-js-app
 
 # outputs variables in the form:
 #
 #   ENV='prod' COMPILE_ASSETS='1'
 ```
+
+## Special Config Variables
+
+The following config variables have special meanings and can be set in a variety of ways. Unless specified via global app config, the values may not be passed into applications. Usage of these values within applications should be considered unsafe, as they are an internal configuration values that may be moved to the internal properties system in the future.
+
+> Warning: This list is not exhaustive, and may vary from version to version.
+
+| Name                           | Default                         | How to modify                                                                                                                                    | Description                                                                                                |
+| ------------------------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
+| `DOKKU_ROOT`                   | `~dokku`                        | `/etc/environment`                                                                                                                               | The root directory where dokku will store application repositories, as well as certain configuration files. |
+| `DOKKU_IMAGE`                  | `gliderlabs/herokuish`          | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The default image to use when building herokuish containers. Deprecated in favor of using `buildpacks:set-property` |
+| `DOKKU_LIB_ROOT`               | `/var/lib/dokku`                | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The directory where plugins, certain data, and general configuration is stored. |
+| `PLUGIN_PATH`                  | `$DOKKU_LIB_ROOT/plugins"`      | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The top-level directory where plugins are stored. |
+| `PLUGIN_AVAILABLE_PATH`        | `$PLUGIN_PATH/available"`       | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The directory that holds all available plugins, including core. |
+| `PLUGIN_ENABLED_PATH`          | `$PLUGIN_PATH/enabled"`         | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The directory that holds all enabled plugins, including core. |
+| `PLUGIN_CORE_PATH`             | `$DOKKU_LIB_ROOT/core-plugins"` | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The directory that stores all core plugins. |
+| `PLUGIN_CORE_AVAILABLE_PATH`   | `$PLUGIN_CORE_PATH/available"`  | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The directory that stores all available core plugins. |
+| `PLUGIN_CORE_ENABLED_PATH`     | `$PLUGIN_CORE_PATH/enabled"`    | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | The directory that stores all enabled core plugins. |
+| `DOKKU_LOGS_DIR`               | `/var/log/dokku`                | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | Where dokku logs should be written to. |
+| `DOKKU_LOGS_HOST_DIR`          | `$DOKKU_LOGS_DIR`               | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | A path on the host that will be mounted into the vector logging container. |
+| `DOKKU_EVENTS_LOGFILE`         | `$DOKKU_LOGS_DIR/events.log`    | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | Where the events log file is written to. |
+| `DOKKU_APP_NAME`               | none                            | `--app APP` flag                                                                                                                                 | Name of application to work on. Respected by core plugins. |
+| `DOKKU_APPS_FORCE_DELETE`      | none                            | `--force` flag                                                                                                                                   | Whether to force delete an application. Also used by other plugins for destructive actions. |
+| `DOKKU_CHECKS_URL`             | `https://dokku.com/docs/deployment/zero-downtime-deploys/` | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                        | Url displayed during deployment when no CHECKS file exists. |
+| `DOKKU_DETACH_CONTAINER`       | none                            | `--detach` flag                                                                                                                                  | Whether to detach a container started via `dokku run`. |
+| `DOKKU_QUIET_OUTPUT`           | none                            | `--quiet` flag                                                                                                                                   | Silences certain header output for `dokku` commands. |
+| `DOKKU_RM_CONTAINER`           | none                            | `dokku config:set` <br /> `--rm-container` flag <br /> `--rm` flag                                                                               | Whether to keep `dokku run` containers around or not. |
+| `DOKKU_TRACE`                  | none                            | `dokku trace:on`   <br /> `dokku trace:off` <br /> `--trace` flag                                                                              | Turn on very verbose debugging. |
+| `DOKKU_APP_PROXY_TYPE`         | `nginx`                         | `dokku proxy:set`                                                                                                                                | |
+| `DOKKU_APP_RESTORE`            | `1`                             | `dokku config:set` <br /> `dokku ps:stop`                                                                                                        | |
+| `DOKKU_APP_SHELL`              | `/bin/bash`                     | `dokku config:set`                                                                                                                               | Allows users to change the default shell used by Dokku for `dokku enter` and execution of deployment tasks. |
+| `DOKKU_APP_TYPE`               | `herokuish`                     |  Auto-detected by using buildpacks or dockerfile                                                                                                 | |
+| `DOKKU_CHECKS_DISABLED`        | none                            | `dokku checks:disable`                                                                                                                           | |
+| `DOKKU_CHECKS_ENABLED`         | none                            | `dokku checks:enable`                                                                                                                            | |
+| `DOKKU_CHECKS_SKIPPED`         | none                            | `dokku checks:skip`                                                                                                                              | |
+| `DOKKU_CHECKS_WAIT`            | `5`                             | `dokku config:set`                                                                                                                               | Wait this many seconds for the container to start before running checks.
+| `DOKKU_CHECKS_TIMEOUT`         | `30`                            | `dokku config:set`                                                                                                                               | Wait this many seconds for each response before marking it as a failure.
+| `DOKKU_CHECKS_ATTEMPTS`        | `5`                             | `dokku config:set`                                                                                                                               | Number of retries for to run for a specific check before marking it as a failure
+| `DOKKU_DEFAULT_CHECKS_WAIT`    | `10`                            | `dokku config:set`                                                                                                                               | If no user-defined checks are specified - or if the process being checked is not a `web` process - this is the period of time Dokku will wait before checking that a container is still running. |
+| `DOKKU_DISABLE_PROXY`          | none                            | `dokku proxy:disable` <br /> `dokku proxy:enable`                                                                                                | Disables the proxy in front of your application, resulting in publicly routing the docker container. |
+| `DOKKU_DISABLE_ANSI_PREFIX_REMOVAL` | none                       | `dokku config:set` <br /> `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                 | Disables removal of the ANSI prefix during deploys. Can be used in cases where the client deployer does not understand ansi escape  codes. |
+| `DOKKU_DISABLE_APP_AUTOCREATION` | none                            | `dokku config:set`                                                                                                                               | Disables automatic creation of a non-existent app on deploy. |
+| `DOKKU_DOCKER_STOP_TIMEOUT`    | `10`                            | `dokku config:set`                                                                                                                               | Configurable grace period given to the `docker stop` command. If a container has not stopped by this time, a `kill -9` signal or equivalent is sent in order to force-terminate the container. Both the `ps:stop` and `apps:destroy` commands _also_ respect this value. If not specified, the docker defaults for the [docker stop command](https://docs.docker.com/engine/reference/commandline/stop/) will be used.|
+| `DOKKU_DOCKERFILE_CACHE_BUILD` | none                            | `dokku config:set`                                                                                                                               | |
+| `DOKKU_DOCKERFILE_PORTS`       | dockerfile ports                | `dokku config:set`                                                                                                                               | |
+| `DOKKU_DOCKERFILE_START_CMD`   | none                            | `dokku config:set`                                                                                                                               | |
+| `DOKKU_PARALLEL_ARGUMENTS`.    | none                            | `dokku config:set`                                                                                                                               | Allows passing custom arguments to parallel for `ps:*all` commands |
+| `DOKKU_PROXY_PORT`             | automatically assigned          | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` <br /> `dokku config:set`                                                 | |
+| `DOKKU_PROXY_SSL_PORT`         | automatically assigned          | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` <br /> `dokku config:set`                                                 | |
+| `DOKKU_PROXY_PORT_MAP`         | automatically assigned          | `dokku proxy:ports-add` <br /> `dokku proxy:ports-remove`, `dokku proxy:ports-clear`                                                             | |
+| `DOKKU_SKIP_ALL_CHECKS`        | none                            | `dokku config:set`                                                                                                                               | |
+| `DOKKU_SKIP_CLEANUP`           |                                 | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | When a deploy is triggered, if this is set to a non-empty value, then old docker containers and images will not be removed. |
+| `DOKKU_SKIP_DEFAULT_CHECKS`    |                                 | `dokku config:set`                                                                                                                               | |
+| `DOKKU_SKIP_DEPLOY`            |                                 | `dokku config:set`                                                                                                                               | |
+| `DOKKU_START_CMD`              | none                            | `dokku config:set`                                                                                                                               | Command to run instead of `/start $PROC_TYPE` |
+| `DOKKU_SYSTEM_GROUP`           | `dokku`                         | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | System group to chown files as. |
+| `DOKKU_SYSTEM_USER`            | `dokku`                         | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*`                                                                           | System user to chown files as. |
+| `DOKKU_WAIT_TO_RETIRE`         | `60`                            | `dokku config:set`                                                                                                                               | After a successful deploy, the grace period given to old containers before they are stopped/terminated. This is useful for ensuring completion of long-running http connections. |

docs/configuration/nginx.md

@@ -4,75 +4,282 @@ Dokku uses nginx as its server for routing requests to specific applications. By
 
 ```
 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)
+nginx:report [<app>] [<flag>]            # Displays a nginx report for one or more apps
+nginx:set <app> <property> (<value>)     # Set or clear an nginx property for an app
+nginx:show-config <app>                  # Display app nginx config
+nginx:validate-config [<app>] [--clean]  # Validates and optionally cleans up invalid nginx configurations
 ```
 
-## Customizing the nginx configuration
+## Usage
+
+### Request Proxying
+
+By default, the `web` process is the only process proxied by the nginx proxy implementation. Proxying to other process types may be handled by a custom `nginx.conf.sigil` file, as generally described [below](/docs/configuration/nginx.md#customizing-the-nginx-configuration)
+
+Nginx will proxy the requests in a [round-robin balancing fashion](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) to the different deployed (scaled) containers running the `web` proctype. This way, the host's resources can be fully leveraged for single-threaded applications (e.g. `dokku ps:scale node-js-app web=4` on a 4-core machine)
+
+### Binding to specific addresses
+
+> New as of 0.19.2
+
+By default, nginx will listen to all interfaces (`[::]` for IPv6, `0.0.0.0` for IPv4) when proxying requests to applications. This may be changed using the `bind-address-ipv4` and `bind-address-ipv6` properties. This is useful in cases where the proxying should be internal to a network or if there are multiple network interfaces that should respond with different content.
+
+```shell
+dokku nginx:set node-js-app bind-address-ipv4 127.0.0.1
+dokku nginx:set node-js-app bind-address-ipv6 ::1
+```
+
+This may be reverted by setting an empty bind address.
+
+```shell
+dokku nginx:set node-js-app bind-address-ipv4
+dokku nginx:set node-js-app bind-address-ipv6
+```
+
+> Warning: Validation is not performed on either value.
+
+Users with apps that contain a custom `nginx.conf.sigil` file will need to modify the files to respect the new `NGINX_BIND_ADDRESS_IPV4` and `NGINX_BIND_ADDRESS_IPV6` variables.
+
+### HSTS Header
+
+> New as of 0.20.0
+
+If SSL certificates are present, HSTS will be automatically enabled. It can be toggled via `nginx:set`:
+
+```shell
+dokku nginx:set node-js-app hsts true
+dokku nginx:set node-js-app hsts false
+```
+
+The following options are also available via the `nginx:set` command:
+
+- `hsts` (type: boolean, default: `true`): Enables or disables HSTS for your application.
+- `hsts-include-subdomains` (type: boolean, default: `true`): Tells the browser that the HSTS policy also applies to all subdomains of the current domain.
+- `hsts-max-age` (type: integer, default: `15724800`): Time in seconds to cache HSTS configuration.
+- `hsts-preload` (type: boolean, default: `false`): Tells most major web browsers to include the domain in their HSTS preload lists.
+
+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 until the max-age is reached.
+
+#### Globally disabling the HSTS Header
+
+HSTS Header can be disabled for all apps by setting the `hsts` property to false after passing the `--global` flag to `nginx:set`. Changing this value globally or on a per-app basis will require rebuilding the nginx config via the `proxy:build-config` command.
+
+```shell
+dokku nginx:set --global hsts false
+```
+
+Once the HSTS setting is disabled globally, it can be re-enabled on a per-app basis by setting the `hsts` property as normal.
+
+```shell
+dokku nginx:set node-js-app hsts true
+```
+
+### Checking access logs
+
+You may check nginx access logs via the `nginx:access-logs` command. This assumes that app access logs are being stored in `/var/log/nginx/$APP-access.log`, as is the default in the generated `nginx.conf`.
+
+```shell
+dokku nginx:access-logs node-js-app
+```
+
+You may also follow the logs by specifying the `-t` flag.
+
+```shell
+dokku nginx:access-logs node-js-app -t
+```
+
+### Checking error logs
+
+You may check nginx error logs via the `nginx:error-logs` command. This assumes that app error logs are being stored in `/var/log/nginx/$APP-error.log`, as is the default in the generated `nginx.conf`.
+
+```shell
+dokku nginx:error-logs node-js-app
+```
+
+You may also follow the logs by specifying the `-t` flag.
+
+```shell
+dokku nginx:error-logs node-js-app -t
+```
+
+### Changing log path
+
+> New as of 0.20.1
+
+The path to where log files are stored can be changed by calling the `nginx:set` command with the following options:
+
+- `access-log-path` (type: string, default: `${NGINX_LOG_ROOT}/${APP}-access.log`): Log path for nginx access logs
+- `error-log-path` (type: string, default: `${NGINX_LOG_ROOT}/${APP}-error.log`): Log path for nginx error logs
+
+The defaults should not be changed without verifying that the paths will be writeable by nginx. However, this setting is useful for enabling or disabling logging by setting the values to `off`.
+
+```shell
+dokku nginx:set node-js-app access-log-path off
+dokku nginx:set node-js-app error-log-path off
+```
+
+The default value may be set by passing an empty value for the option:
+
+```shell
+dokku nginx:set node-js-app access-log-path
+dokku nginx:set node-js-app error-log-path
+```
+
+In all cases, the nginx config must be regenerated after setting the above values.
+
+### Changing log format
+
+> New as of 0.22.0
+
+The format of the access log can be changed by calling the `nginx:set` command as follows:
+
+```shell
+dokku nginx:set node-js-app access-log-format custom-format
+```
+
+Prior to changing the log-format, log formats should be specified at a file such as `/etc/nginx/conf.d/00-log-formats.conf`. This will ensure they are available within your app's nginx context. For instance, the following may be added to the above file. It only needs to be specified once to be used for all apps.
+
+```nginx
+# /etc/nginx/conf.d/00-log-formats.conf
+# escape=json was added in nginx 1.11.8
+log_format json_combined escape=json
+  '{'
+    '"time_local":"$time_local",'
+    '"remote_addr":"$remote_addr",'
+    '"remote_user":"$remote_user",'
+    '"request":"$request",'
+    '"status": "$status",'
+    '"body_bytes_sent":"$body_bytes_sent",'
+    '"request_time":"$request_time",'
+    '"http_referrer":"$http_referer",'
+    '"http_user_agent":"$http_user_agent"'
+  '}';
+```
+
+Next, the format should be set for the given app.
+
+```shell
+dokku nginx:set node-js-app access-log-format json_combined
+```
+
+Finally, a proxy rebuild will change the format as desired.
+
+```shell
+dokku proxy:build-config node-js-app
+```
+
+### Specifying a read timeout
+
+> New as of 0.21.0
+
+When proxying requests to your applications, it may be useful to specify a proxy read timeout. This can be done via the `nginx:set` command as follows:
+
+```shell
+dokku nginx:set node-js-app proxy-read-timeout 120s
+```
+
+The default value is `60s`, and all numeric values _must_ have a trailing time value specified (`s` for seconds, `m` for minutes).
+
+The default value may be set by passing an empty value for the option:
+
+```shell
+dokku nginx:set node-js-app proxy-read-timeout
+```
+
+In all cases, the nginx config must be regenerated after setting the above value.
+
+### Specifying a custom client_max_body_size
+
+> New as of 0.23.0
+
+Users can override the default `client_max_body_size` value - which limits file uploads - via `nginx:set`. Changing this value will only apply to every `server` stanza of the default `nginx.conf.sigil`; users of custom `nginx.conf.sigil` files must update their templates to support the new value.
+
+```shell
+dokku nginx:set node-js-app client-max-body-size 50m
+```
+
+The default value is empty string, which will result in nginx falling back to any configured, higher-level defaults (or `1m` if unconfigued; all numerical values _must_ have a size unit specified (`k` for kilobytes, `m` for megabytes).
+
+The default value may be set by passing an empty value for the option:
+
+```shell
+dokku nginx:set node-js-app client-max-body-size
+```
+
+In all cases, the nginx config must be regenerated after setting the above value.
+
+Changing this value when using the PHP buildpack (or any other buildpack that uses an intermediary server) will require changing the value in the server config shipped with that buildpack. Consult your buildpack documentation for further details.
+
+### Showing the nginx config
+
+For debugging purposes, it may be useful to show the nginx config. This can be achieved via the `nginx:show-config` command.
+
+```shell
+dokku nginx:show-config node-js-app
+```
+
+### Validating nginx configs
+
+It may be desired to validate an nginx config outside of the deployment process. To do so, run the `nginx:validate-config` command. With no arguments, this will validate all app nginx configs, one at a time. A minimal wrapper nginx config is generated for each app's nginx config, upon which `nginx -t` will be run.
+
+```shell
+dokku nginx:validate-config
+```
+
+As app nginx configs are actually executed within a shared context, it is possible for an individual config to be invalid when being validated standalone but _also_ be valid within the global server context. As such, the exit code for the `nginx:validate-config` command is the exit code of `nginx -t` against the server's real nginx config.
+
+The `nginx:validate-config` command also takes an optional `--clean` flag. If specified, invalid nginx configs will be removed.
+
+> Warning: Invalid app nginx config's will be removed _even if_ the config is valid in the global server context.
+
+```shell
+dokku nginx:validate-config --clean
+```
+
+The `--clean` flag may also be specified for a given app:
+
+```shell
+dokku nginx:validate-config node-js-app --clean
+```
+
+### Customizing the nginx configuration
 
 > New as of 0.5.0
 
 Dokku uses a templating library by the name of [sigil](https://github.com/gliderlabs/sigil) to generate nginx configuration for each app. You may also provide a custom template for your application as follows:
 
 - Copy the following example template to a file named `nginx.conf.sigil` and either:
-  - check it into the root of your app repo for buildpack applications
-  - `ADD` it to your dockerfile `WORKDIR`
-  - if your dockerfile has no `WORKDIR`, `ADD` it to the `/app` folder
+  - If using a buildpack application, you __must__ check it into the root of your app repo.
+  - If using a dockerfile or docker image for deploys, either:
+    - If `WORKDIR` is specified, add the file to the `WORKDIR` specified in the last Dockerfile stage  (example: `WORKDIR /app` and `ADD nginx.conf.sigil /app`).
+    - If no `WORKDIR` is specified, add the file to the root (`/`) of the docker image (example: `ADD nginx.conf.sigil /`).
 
 > When using a custom `nginx.conf.sigil` file, depending upon your application configuration, you *may* be exposing the file externally. As this file is extracted before the container is run, you can, safely delete it in a custom `entrypoint.sh` configured in a Dockerfile `ENTRYPOINT`.
 
-### Example Custom Template
+> The default template is available [here](https://github.com/dokku/dokku/blob/master/plugins/nginx-vhosts/templates/nginx.conf.sigil), and can be used as a guide for your own, custom `nginx.conf.sigil` file. Please refer to the appropriate template file version for your Dokku version.
 
-Use case: add an `X-Served-By` header to requests
+While enabled by default, using a custom nginx config can be disabled via `nginx:set`. This may be useful in cases where you do not want to allow users to override any higher-level customization of app nginx config.
 
-```go
-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;
+```shell
+# enable fetching custom config (default)
+dokku nginx:set node-js-app disable-custom-config false
 
-  # set a custom header for requests
-  add_header X-Served-By www-ec2-01;
-
-  gzip on;
-  gzip_min_length  1100;
-  gzip_buffers  4 32k;
-  gzip_types    text/css text/javascript text/xml text/plain text/x-component application/javascript application/x-javascript application/json application/xml  application/rss+xml font/truetype application/x-font-ttf font/opentype application/vnd.ms-fontobject image/svg+xml;
-  gzip_vary on;
-  gzip_comp_level  6;
-
-  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;
-}
-
-upstream {{ .APP }} {
-{{ range .DOKKU_APP_LISTENERS | split " " }}
-  server {{ . }};
-{{ end }}
-}
+# disable fetching custom config
+dokku nginx:set node-js-app disable-custom-config true
 ```
 
-### Available template variables
+Unsetting this value is the same as enabling custom nginx config usage.
+
+
+#### 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)
+{{ .PROXY_PORT }}                   Non-SSL nginx listener port (same as `DOKKU_PROXY_PORT` config var)
+{{ .PROXY_SSL_PORT }}               SSL nginx listener port (same as `DOKKU_PROXY_SSL_PORT` config var)
 {{ .NOSSL_SERVER_NAME }}            List of non-SSL VHOSTS
 {{ .PROXY_PORT_MAP }}               List of port mappings (same as `DOKKU_PROXY_PORT_MAP` config var)
 {{ .PROXY_UPSTREAM_PORTS }}         List of configured upstream ports (derived from `DOKKU_PROXY_PORT_MAP` config var)
@@ -81,157 +288,127 @@ upstream {{ .APP }} {
 {{ .SSL_SERVER_NAME }}              List of SSL VHOSTS
 ```
 
+Finally, each process type has it's network listeners - a list of IP:PORT pairs for the respective app containers - exposed via an `.DOKKU_APP_${PROCESS_TYPE}_LISTENERS` variable - the `PROCESS_TYPE` will be upper-cased with hyphens transformed into underscores. Users can use the new variables to expose non-web processes via the nginx proxy.
+
 > Note: Application config variables are available for use in custom templates. To do so, use the form of `{{ var "FOO" }}` to access a variable named `FOO`.
 
-
-### Example HTTP to HTTPS Custom Template
-Use case: a simple dockerfile app that includes `EXPOSE 80`
-
-```go
-server {
-  listen      [::]:80;
-  listen      80;
-  server_name {{ .NOSSL_SERVER_NAME }};
-
-  access_log  /var/log/nginx/{{ .APP }}-access.log;
-  error_log   /var/log/nginx/{{ .APP }}-error.log;
-
-  return 301 https://$host:443$request_uri;
-}
-server {
-  listen      [::]:443 ssl spdy;
-  listen      443 ssl spdy;
-  {{ if .SSL_SERVER_NAME }}server_name {{ .SSL_SERVER_NAME }}; {{ end }}
-
-  access_log  /var/log/nginx/{{ .APP }}-access.log;
-  error_log   /var/log/nginx/{{ .APP }}-error.log;
-
-  ssl_certificate     {{ .APP_SSL_PATH }}/server.crt;
-  ssl_certificate_key {{ .APP_SSL_PATH }}/server.key;
-
-  keepalive_timeout   70;
-  add_header          Alternate-Protocol  443:npn-spdy/2;
-  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;
-}
-
-upstream {{ .APP }} {
-{{ range .DOKKU_APP_LISTENERS | split " " }}
-  server {{ . }};
-{{ end }}
-}
-```
-
-### Example using new proxy port mapping
-
-```go
-{{ range $port_map := .PROXY_PORT_MAP | split " " }}
-{{ $port_map_list := $port_map | split ":" }}
-{{ $scheme := index $port_map_list 0 }}
-{{ $listen_port := index $port_map_list 1 }}
-{{ $upstream_port := index $port_map_list 2 }}
-
-server {
-  listen      [::]:{{ $listen_port }};
-  listen      {{ $listen_port }};
-  server_name {{ $.NOSSL_SERVER_NAME }};
-  access_log  /var/log/nginx/{{ $.APP }}-access.log;
-  error_log   /var/log/nginx/{{ $.APP }}-error.log;
-
-  location    / {
-
-    gzip on;
-    gzip_min_length  1100;
-    gzip_buffers  4 32k;
-    gzip_types    text/css text/javascript text/xml text/plain text/x-component application/javascript application/x-javascript application/json application/xml  application/rss+xml font/truetype application/x-font-ttf font/opentype application/vnd.ms-fontobject image/svg+xml;
-    gzip_vary on;
-    gzip_comp_level  6;
-
-    proxy_pass  http://{{ $.APP }}-{{ $upstream_port }};
-    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;
-}
-
-{{ range $upstream_port := $.PROXY_UPSTREAM_PORTS | split " " }}
-upstream {{ $.APP }}-{{ $upstream_port }} {
-{{ range $listeners := $.DOKKU_APP_LISTENERS | split " " }}
-{{ $listener_list := $listeners | split ":" }}
-{{ $listener_ip := index $listener_list 0 }}
-{{ $listener_port := index $listener_list 1 }}
-  server {{ $listener_ip }}:{{ $upstream_port }};{{ end }}
-}
-{{ end }}
-```
-
-### Customizing via configuration files included by the default templates
+#### 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):
 
-```go
+```
 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
+That means you can put additional configuration in separate files. To increase the client request header timeout, the following can be performed:
 
 ```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
+mkdir /home/dokku/node-js-app/nginx.conf.d/
+echo 'client_header_timeout 50s;' > /home/dokku/node-js-app/nginx.conf.d/timeout.conf
+chown dokku:dokku /home/dokku/node-js-app/nginx.conf.d/upload.conf
 service nginx reload
 ```
 
-The example above uses additional configuration files directly on the Dokku host. Unlike the `nginx.conf.sigil` file, these additional files will not be copied over from your application repo, and thus need to be placed in the `/home/dokku/myapp/nginx.conf.d/` directory manually.
+The example above uses additional configuration files directly on the Dokku host. Unlike the `nginx.conf.sigil` file, these additional files will not be copied over from your application repo, and thus need to be placed in the `/home/dokku/node-js-app/nginx.conf.d/` directory manually.
 
-## Domains plugin
+For PHP Buildpack users, you will also need to provide a `Procfile` and an accompanying `nginx.conf` file to customize the nginx config *within* the container. The following are example contents for your `Procfile`
 
-See the [domain configuration documentation](/dokku/configuration/domains/).
+    web: vendor/bin/heroku-php-nginx -C nginx.conf -i php.ini php/
 
-## Customizing hostnames
+Your `nginx.conf` file - not to be confused with Dokku's `nginx.conf.sigil` - would also need to be configured as shown in this example:
 
-See the [customizing hostnames documentation](/dokku/configuration/domains/#customizing-hostnames).
+    client_header_timeout 50s;
+    location / {
+        index index.php;
+        try_files $uri $uri/ /index.php$is_args$args;
+    }
 
-## Disabling VHOSTS
+Please adjust the `Procfile` and `nginx.conf` file as appropriate.
 
-See the [disabling vhosts documentation](/dokku/configuration/domains/#disabling-vhosts).
+### Custom Error Pages
 
-## Default site
+By default, Dokku provides custom error pages for the following three categories of errors:
 
-See the [default site documentation](/dokku/configuration/domains/#default-site).
+- 4xx: For all non-404 errors with a 4xx response code.
+- 404: For "404 Not Found" errors.
+- 5xx: For all 5xx error responses
 
-## Running behind a load balancer
+These are provided as an alternative to the generic Nginx error page, are shared for _all_ applications, and their contents are located on disk at `/var/lib/dokku/data/nginx-vhosts/dokku-errors`. To customize them for a specific app, create a custom `nginx.conf.sigil` as described above and change the paths to point elsewhere.
 
-See the [load balancer documentation](/dokku/configuration/ssl/#running-behind-a-load-balancer).
+### Default site
 
-## HSTS Header
+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.
 
-See the [HSTS documentation](/dokku/configuration/ssl/#hsts-header).
+Create the file at `/etc/nginx/conf.d/00-default-vhost.conf`:
 
-## SSL Configuration
+```nginx
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server;
 
-See the [ssl documentation](/dokku/configuration/ssl/).
+    server_name _;
+    access_log off;
+    return 410;
+}
 
-## Disabling Nginx
+# To handle HTTPS requests, you can uncomment the following section.
+#
+# Please note that in order to let this work as expected, you need a valid
+# SSL certificate for any domains being served. Browsers will show SSL
+# errors in all other cases.
+#
+# Note that the key and certificate files in the below example need to
+# be copied into /etc/nginx/ssl/ folder.
+#
+# server {
+#     listen 443 ssl;
+#     listen [::]:443 ssl;
+#     server_name _;
+#     ssl_certificate /etc/nginx/ssl/cert.crt;
+#     ssl_certificate_key /etc/nginx/ssl/cert.key;
+#     access_log off;
+#     return 410;
+# }
+```
 
-See the [proxy documentation](/dokku/advanced-usage/proxy-management/).
+Make sure to reload nginx after creating this file by running `service nginx reload`.
 
-## Managing Proxy Port mappings
+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).
 
-See the [proxy documentation](/dokku/advanced-usage/proxy-management/#proxy-port-mapping).
+The configuration file must be loaded before `/etc/nginx/conf.d/dokku.conf`, so it can not be arranged as a vhost in `/etc/nginx/sites-enabled` that is only processed afterwards.
+
+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.
+
+## Other
+
+### Domains plugin
+
+See the [domain configuration documentation](/docs/configuration/domains.md) for more information on how to configure domains for your app.
+
+### Customizing hostnames
+
+See the [customizing hostnames documentation](/docs/configuration/domains.md#customizing-hostnames) for more information on how to configure domains for your app.
+
+### Disabling VHOSTS
+
+See the [disabling vhosts documentation](/docs/configuration/domains.md#disabling-vhosts) for more information on how to disable domain usage for your app.
+
+### Running behind a load balancer
+
+See the [load balancer documentation](/docs/configuration/ssl.md#running-behind-a-load-balancer) for more information on how to configure your nginx config for running behind a network load balancer.
+
+### SSL Configuration
+
+See the [ssl documentation](/docs/configuration/ssl.md) for more information on how to configure SSL certificates for your application.
+
+### Disabling Nginx
+
+See the [proxy documentation](/docs/networking/proxy-management.md) for more information on how to disable nginx as the proxy implementation for your app.
+
+### Managing Proxy Port mappings
+
+See the [proxy documentation](/docs/networking/proxy-management.md#proxy-port-mapping) for more information on how to manage ports proxied for your app.
+
+### Regenerating nginx config
+
+See the [proxy documentation](/docs/networking/proxy-management.md#regenerating-proxy-config) for more information on how to rebuild the nginx proxy configuration for your app.

docs/configuration/ssl.md

@@ -7,8 +7,9 @@ Dokku supports SSL/TLS certificate inspection and CSR/Self-signed certificate ge
 ```
 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:report [<app>] [<flag>]            # Displays an ssl report for one or more apps
+certs:show <app> <crt|key>               # Show the server.crt or server.key on stdout
 certs:update <app> CRT KEY               # Update an SSL Endpoint on an app. Can also import from a tarball on stdin
 ```
 
@@ -17,7 +18,7 @@ certs:update <app> CRT KEY               # Update an SSL Endpoint on an app. Can
 dokku nginx:import-ssl <app> < certs.tar
 ```
 
-> Adding an ssl certificate before deploying an application will result in port mappings being updated. This may cause issues for applications that use non-standard ports, as those may not be automatically detected. Please refer to the [proxy documentation](/dokku/advanced-usage/proxy-management/) for information as to how to reconfigure the mappings.
+> Adding an ssl certificate before deploying an application will result in port mappings being updated. This may cause issues for applications that use non-standard ports, as those may not be automatically detected. Please refer to the [proxy documentation](/docs/networking/proxy-management.md) for information as to how to reconfigure the mappings.
 
 ## Per-application certificate management
 
@@ -29,8 +30,7 @@ The `certs:add` command can be used to push a `tar` containing a certificate `.c
 
 ```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
+dokku certs:add node-js-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`.
@@ -41,9 +41,9 @@ cat yourdomain_com.crt yourdomain_com.ca-bundle > server.crt
 
 #### SSL and Multiple Domains
 
-When an SSL certificate is associated to an application, the certificate will be associated with *all* domains currently associated with said application. Your certificate _should_ be associated with all of those domains, otherwise accessing the application will result in SSL errors. If you wish to remove one of the domains from the application, refer to the [domain configuration documentation](/dokku/configuration/domains/).
+When an SSL certificate is associated to an application, the certificate will be associated with *all* domains currently associated with said application. Your certificate _should_ be associated with all of those domains, otherwise accessing the application will result in SSL errors. If you wish to remove one of the domains from the application, refer to the [domain configuration documentation](/docs/configuration/domains.md).
 
-Note that with the default nginx template, requests will be redirected to the `https` version of the domain. If this is not the desired state of request resolution, you may customize the nginx template in use. For more details, see the [nginx documentation](/dokku/configuration/nginx/).
+Note that with the default nginx template, requests will be redirected to the `https` version of the domain. If this is not the desired state of request resolution, you may customize the nginx template in use. For more details, see the [nginx documentation](/docs/configuration/nginx.md).
 
 ### Certificate generation
 
@@ -51,82 +51,118 @@ Note that with the default nginx template, requests will be redirected to the `h
 
 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.
-
-```shell
-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.
-```
+If you decide to obtain a CA signed certificate, you can import that certificate using the aforementioned `dokku certs:add` command.
 
 ### 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.
 
+### Showing the certificate
+
+The `certs:show` command can be used to show your configured certs for an app. The show command can be used for example to export Let's Encrypt certificates
+after they've been generated. You can export it as follows:
+
+```shell
+dokku certs:show node-js-app crt > server.crt
+dokku certs:show node-js-app key > server.key
+```
+
+### Displaying certificate reports for an app
+
+> New as of 0.8.1
+
+You can get a report about the apps ssl status using the `certs:report` command:
+
+```shell
+dokku certs:report
+```
+
+```
+=====> node-js-app
+       Ssl dir:             /home/dokku/node-js-app/tls
+       Ssl enabled:         true
+       Ssl hostnames:       *.node-js-app.org node-js-app.org
+       Ssl expires at:      Oct  5 23:59:59 2019 GMT
+       Ssl issuer:          C=GB, ST=Greater Manchester, L=Salford, O=COMODO CA Limited, CN=COMODO RSA Domain Validation Secure Server CA
+       Ssl starts at:       Oct  5 00:00:00 2016 GMT
+       Ssl subject:         OU=Domain Control Validated; OU=PositiveSSL Wildcard; CN=*.node-js-app.org
+       Ssl verified:        self signed.
+=====> python-app
+       Ssl dir:             /home/dokku/python-app/tls
+       Ssl enabled:         false
+       Ssl hostnames:
+       Ssl expires at:
+       Ssl issuer:
+       Ssl starts at:
+       Ssl subject:
+       Ssl verified:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku certs:report node-js-app
+```
+
+```
+=====> node-js-app ssl information
+       Ssl dir:             /home/dokku/node-js-app/tls
+       Ssl enabled:         true
+       Ssl hostnames:       *.dokku.org dokku.org
+       Ssl expires at:      Oct  5 23:59:59 2019 GMT
+       Ssl issuer:          C=GB, ST=Greater Manchester, L=Salford, O=COMODO CA Limited, CN=COMODO RSA Domain Validation Secure Server CA
+       Ssl starts at:       Oct  5 00:00:00 2016 GMT
+       Ssl subject:         OU=Domain Control Validated; OU=PositiveSSL Wildcard; CN=*.dokku.org
+       Ssl verified:        self signed.
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku certs:report node-js-app --ssl-enabled
+```
 
 ## 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.
+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 enables this header by default for HTTPS requests.
 
-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.
+See the [NGINX HSTS documentation](/docs/configuration/nginx.md#hsts-header) for more information on how the HSTS configuration can be managed for your application.
+
+## HTTP/2 support
+
+Certain versions of nginx have bugs that prevent [HTTP/2](https://nginx.org/en/docs/http/ngx_http_v2_module.html) from properly responding to all clients, thus causing applications to be unavailable. For HTTP/2 to be enabled in your applications' nginx configs, you need to have installed nginx 1.11.5 or higher. See [issue 2435](https://github.com/dokku/dokku/issues/2435) for more details.
 
 ## 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.
+Your application has access to the HTTP headers `X-Forwarded-Proto`, `X-Forwarded-Port` and `X-Forwarded-For`. 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/configuration/nginx/#customizing-the-nginx-configuration)
+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 via `nginx:set`:
 
-```go
-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;
-
-  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 }}
-}
+```shell
+dokku nginx:set node-js-app x-forwarded-for-value "\$http_x_forwarded_for"
+dokku nginx:set node-js-app x-forwarded-port-value "\$http_x_forwarded_port"
+dokku nginx:set node-js-app x-forwarded-proto-value "\$http_x_forwarded_proto"
 ```
 
 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.
+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.
+The `x-forwarded-ssl` property may also be set for application frameworks that require this value. Note that this is a non-standard version of setting `x-forwarded-proto` to `https`, and should only be done as a last resort.
+
+```shell
+# force-setting value to `on`
+dokku nginx:set node-js-app x-forwarded-ssl on
+
+# force-setting value to `off`
+dokku nginx:set node-js-app x-forwarded-ssl on
+
+# removing the value from nginx.conf (default)
+dokku nginx:set node-js-app x-forwarded-ssl
+```
 
 ### SSL Port Exposure
 
-When your app is served from port `80` then the `/home/dokku/APP/nginx.conf` file will automatically be updated to instruct nginx to respond to ssl on port 443 as a new cert is added.  If your app uses a non-standard port (perhaps you have a dockerfile deploy exposing port `99999`) you may need to manually expose an ssl port via `dokku proxy:ports-add <APP> https:443:99999`.  
+When your app is served from port `80` then the `/home/dokku/APP/nginx.conf` file will automatically be updated to instruct nginx to respond to ssl on port 443 as a new cert is added.  If your app uses a non-standard port (perhaps you have a dockerfile deploy exposing port `99999`) you may need to manually expose an ssl port via `dokku proxy:ports-add <APP> https:443:99999`.

docs/deployment/application-deployment.md

@@ -1,61 +1,78 @@
 # Deploying to Dokku
 
+> Note: This walkthrough uses the hostname `dokku.me` in commands. When deploying to your own server, you should substitute the domain `dokku.me` for the domain name or IP address associated with your server. Users of the Vagrant VM included with Dokku can use `dokku.me` which points to the IP of the VM.
+
 ## Deploy tutorial
 
-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.
+Once you have configured Dokku with at least one user, you can deploy applications using `git push`. To quickly see Dokku deployment in action, try using [the Heroku Ruby on Rails "Getting Started" app](https://github.com/heroku/ruby-getting-started).
 
 ```shell
 # from your local machine
-git clone git@github.com:heroku/ruby-rails-sample.git
+# SSH access to github must be enabled on this host
+git clone https://github.com/heroku/ruby-getting-started
 ```
 
 ### Create the app
 
-Create the application on the Dokku host. You will need to ssh onto the host to run this command.
+SSH into the Dokku host and create the application as follows:
 
 ```shell
-# on your Dokku host
-dokku apps:create ruby-rails-sample
+# on the Dokku host
+dokku apps:create ruby-getting-started
 ```
 
 ### 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/community/plugins/#official-plugins-beta) for common datastores. Our sample app requires a PostgreSQL service:
+Dokku by default **does not** provide datastores (e.g. MySQL, PostgreSQL) on a newly created app. You can add datastore support by installing plugins, and the Dokku project [provides official plugins](/docs/community/plugins.md#official-plugins-beta) for common datastores.
+
+The Getting Started app requires a PostgreSQL service, so install the plugin and create the related service as follows:
 
 ```shell
-# on your Dokku host
+# on the 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
+# create a postgres service with the name railsdatabase
+dokku postgres:create railsdatabase
 ```
 
-> Each services may take a few moments to create.
+Each service 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.
+Once the services have been created, you then set the `DATABASE_URL` environment variable by linking the service, as follows:
 
 ```shell
-# on your Dokku host
+# on the Dokku host
 # each official datastore offers a `link` method to link a service to any application
-dokku postgres:link rails-database ruby-rails-sample
+dokku postgres:link railsdatabase ruby-getting-started
 ```
 
-> You can link a single service to multiple applications or use one service per application.
+Dokku supports linking a single service to multiple applications as well as linking only 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.
+> Warning: Your app should respect the `PORT` environment variable, otherwise it may not respond to web requests. You can find more information in the [port management documentation](/docs/networking/port-management.md).**
+
+Now you can deploy the `ruby-getting-started` 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
+# the remote username *must* be dokku or pushes will fail
+cd ruby-getting-started
+git remote add dokku dokku@dokku.me:ruby-getting-started
+git push dokku main:master
 ```
 
+> Note: Some tools may not support the short-upstream syntax referenced above, and you may need to prefix
+> the upstream with the scheme `ssh://` like so: `ssh://dokku@dokku.me:ruby-getting-started`
+> Please see the [Git](https://git-scm.com/docs/git-clone#_git_urls_a_id_urls_a) documentation for more details.
+
+> Note: Your private key should be registered with `ssh-agent` in your local development environment. If you get a `permission denied` error when pushing, you can register your private key as follows: `ssh-add -k ~/<your private key>`.
+
+After running `git push dokku main:master`, you should have output similar to this in your terminal:
+
 ```
 Counting objects: 231, done.
 Delta compression using up to 8 threads.
@@ -63,7 +80,7 @@ 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...
+-----> Building ruby-getting-started from herokuish...
 -----> Adding BUILD_ENV to build environment...
 -----> Ruby app detected
 -----> Compiling Ruby/Rails
@@ -78,61 +95,106 @@ Total 231 (delta 93), reused 147 (delta 53)
 ...
 
 =====> Application deployed:
-       http://ruby-rails-sample.dokku.me
+       http://ruby-getting-started.dokku.me
 ```
 
-When the deploy finishes, the application's URL will be shown as seen above.
+Once the deploy is complete, the application's web URL will be generated as above.
 
-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/).
+Dokku supports deploying applications in a few ways:
 
+- [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) via [Herokuish](https://github.com/gliderlabs/herokuish#buildpacks): See the [herokuish buildpacks documentation](/docs/deployment/builders/herokuish-buildpacks.md) to learn about the different ways to specify a buildpack.
+  - This is the default method used by Dokku.
+- [Dockerfile](https://docs.docker.com/reference/builder/): See the [dockerfile documentation](/docs/deployment/builders/dockerfiles.md) to learn about the different ways to configure Dockerfile-based deploys.
+- [Docker Image](https://docs.docker.com/get-started/overview/#docker-objects): See the [docker image documentation](/docs/deployment/methods/images.md) to learn about how to deploy a Docker Image.
 
-### Deploying non-master branch
+### Setting up SSL
 
-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```
+> While SSL certificates can be imported, automated SSL via Letsencrypt requires that all domains on an app correctly point at your server's public ip address. Please keep this in mind when using Letsencrypt.
 
-You can also support pushing multiple branches using the [receive-branch](/dokku/development/plugin-triggers/#receive-branch) plugin trigger in a custom plugin.
+For many users, responding to requests via `https` will be desirable. Dokku has a complete [ssl plugin](/docs/configuration/ssl.md) built in that can be used to import SSL certificates (below is a short example, please refer to the [ssl documentation](/docs/configuration/ssl.md) for more information):
+
+```shell
+dokku certs:add ruby-getting-started server.crt server.key
+```
+
+As an alternative, the Dokku project offers an optional letsencrypt plugin that can be used to automate SSL certificate retrieval and renewal.
+
+```shell
+# on the Dokku host
+# install the letsencrypt plugin
+# plugin installation requires root, hence the user change
+sudo dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git
+
+# configure the plugin
+dokku config:set --global DOKKU_LETSENCRYPT_EMAIL=your-email@your.domain.com
+
+# set a custom domain that you own for your application
+dokku domains:set ruby-getting-started ruby-getting-started.your.domain.com
+
+# enable letsencrypt
+dokku letsencrypt:enable ruby-getting-started
+
+# enable auto-renewal
+dokku letsencrypt:cron-job --add
+```
 
 ### 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
+# on the Dokku host
+dokku config:set ruby-getting-started DOKKU_SKIP_DEPLOY=true
 ```
 
-### Deploying with private git submodules
+### Redeploying or restarting
 
-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.
+If you need to redeploy or restart your app: 
 
 ```shell
-# on your Dokku host
+# on the Dokku host
+dokku ps:rebuild ruby-getting-started
+```
+
+See the [process scaling documentation](/docs/processes/process-management.md) for more information on how to manage your app processes.
+
+### 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, as the `dokku` user. This means that in order to deploy private Git submodules, you need to put your deploy key in `/home/dokku/.ssh/` and potentially add `github.com` (or your VCS host key) into `/home/dokku/.ssh/known_hosts`. You can use the following test to confirm your setup is correct:
+
+```shell
+# on the 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.
+> Warning: 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:
+If you do not enter a fully qualified domain name when pushing your app, Dokku deploys the app to `<remotename>.yourdomain.tld` as follows:
 
 ```shell
-git remote add dokku dokku@dokku.me:ruby-rails-sample
-git push dokku master
+# from your local machine
+# the remote username *must* be dokku or pushes will fail
+# the below example assumes your app server domain or IP is dokku.me. Push in the form of: dokku@{serveripordomain}:{dokkuappname} 
+git remote add dokku dokku@dokku.me:ruby-getting-started
+git push dokku main:master
 ```
 
 ```
 remote: -----> Application deployed:
-remote:        http://ruby-rails-sample.dokku.me
+remote:        http://ruby-getting-started.dokku.me
 ```
 
-You can also specify fully qualified names, say `app.dokku.me`, as
+You can also specify the fully qualified name as follows:
 
 ```shell
+# from your local machine
+# the remote username *must* be dokku or pushes will fail
 git remote add dokku dokku@dokku.me:app.dokku.me
-git push dokku master
+git push dokku main:master
 ```
 
 ```
@@ -140,11 +202,13 @@ remote: -----> Application deployed:
 remote:        http://app.dokku.me
 ```
 
-This is in particular useful, then you want to deploy to root domain, as
+This is useful when you want to deploy to the root domain:
 
 ```shell
+# from your local machine
+# the remote username *must* be dokku or pushes will fail
 git remote add dokku dokku@dokku.me:dokku.me
-git push dokku master
+git push dokku main:master
 ```
 
     ... deployment ...
@@ -152,40 +216,44 @@ git push dokku master
     remote: -----> Application deployed:
     remote:        http://dokku.me
 
-## Dokku/Docker Container Management Compatibility
+## Dokku/Docker container management compatibility
 
-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.
+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.
 
-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.
+Prior to every deployment, Dokku will execute a cleanup function. As of 0.5.x, the cleanup removes all containers with the `dokku` label where the status is either `dead` or `exited` (previous versions would remove _all_ `dead` or `exited` containers). The cleanup function also removes all images with `dangling` status.
 
 ## Adding deploy users
 
-See the [user management documentation](/dokku/deployment/user-management).
+See the [user management documentation](/docs/deployment/user-management.md) for more information on how to manage users with access to your Dokku server.
 
 ## Default vhost
 
-See the [nginx documentation](/dokku/configuration/nginx/#default-site).
+See the [domains documentation](/docs/configuration/domains.md#default-site) for more information on how to manage the default site.
+
+## Deploying non-master branch
+
+See the [Git documentation](/docs/deployment/methods/git.md#changing-the-deploy-branch) for more information on deploying a non-master branch to your application.
 
 ## Dockerfile deployment
 
-See the [dockerfile documentation](/dokku/deployment/methods/dockerfiles/).
-
-## Specifying a custom buildpack
-
-See the [buildpack documentation](/dokku/deployment/methods/buildpacks/).
+See the [Dockerfile documentation](/docs/deployment/builders/dockerfiles.md) for information Dokku's Dockerfile support.
 
 ## Image tagging
 
-See the [image tagging documentation](/dokku/deployment/methods/images/).
+See the [image tagging documentation](/docs/deployment/methods/images.md) for more information on how Docker images can be tagged and deployed for a given application.
+
+## Specifying a custom buildpack
+
+See the [herokuish buildpack documentation](/docs/deployment/builders/herokuish-buildpacks.md) for more information on how to specify a set of custom buildpacks for your application.
 
 ## Removing a deployed app
 
-See the [application management documentation](/dokku/deployment/application-management/#removing-a-deployed-app).
+See the [application management documentation](/docs/deployment/application-management.md#removing-a-deployed-app) for more information on how to remove an application from your Dokku server.
 
-### Renaming a deployed app
+## Renaming a deployed app
 
-See the [application management documentation](/dokku/deployment/application-management/#renaming-a-deployed-app).
+See the [application management documentation](/docs/deployment/application-management.md#renaming-a-deployed-app) for more information on how an application can be renamed and the impact of doing so upon the application and associated resources.
 
 ## Zero downtime deploy
 
-See the [zero-downtime deploy documentation](/dokku/deployment/zero-downtime-deploys/).
+See the [zero-downtime deploy documentation](/docs/deployment/zero-downtime-deploys.md) for more information on how Dokku enables zero-downtime deploys.

docs/deployment/application-management.md

@@ -3,20 +3,28 @@
 > New as of 0.3.1
 
 ```
-apps                                           # List your apps
+apps:clone <old-app> <new-app>                 # Clones an app
 apps:create <app>                              # Create a new app
 apps:destroy <app>                             # Permanently destroy an app
+apps:exists <app>                              # Checks if an app exists
+apps:list                                      # List your apps
+apps:lock <app>                                # Locks an app for deployment
+apps:locked <app>                              # Checks if an app is locked for deployment
 apps:rename <old-app> <new-app>                # Rename an app
+apps:report [<app>] [<flag>]                   # Display report about an app
+apps:unlock <app>                              # Unlocks an app for deployment
 ```
 
 ## Usage
 
-### Listing Applications
+### Listing applications
 
-You can easily list all available applications using the `apps` command:
+> New as of 0.8.1. Use the `apps` command for older versions.
+
+You can easily list all available applications using the `apps:list` command:
 
 ```shell
-dokku apps
+dokku apps:list
 ```
 
 ```
@@ -25,10 +33,10 @@ node-js-app
 python-app
 ```
 
-Note that you can easily hide extra output from Dokku commands by using the `--quiet` flag, which makes it easier to parse on the command-line.
+Note that you can easily hide extra output from Dokku commands by using the `--quiet` flag, which makes it easier to parse on the command line.
 
 ```shell
-dokku --quiet apps
+dokku --quiet apps:list
 ```
 
 ```
@@ -36,6 +44,20 @@ node-js-app
 python-app
 ```
 
+### Checking if an application exists
+
+For CI/CD pipelines, it may be useful to see if an application exists before creating a "review" application for a specific branch. You can do so via the `apps:exists` command:
+
+```shell
+dokku apps:exists  node-js-app
+```
+
+```
+App does not exist
+```
+
+The `apps:exists` command will return non-zero if the application does not exist, and zero if it does.
+
 ### Manually creating an application
 
 A common pattern for deploying applications to Dokku is to configure an application before deploying it. You can do so via the `apps:create` command:
@@ -50,9 +72,9 @@ Creating node-js-app... done
 
 Once created, you can configure the application as normal, and deploy the application whenever ready. This is useful for cases where you may wish to do any of the following kinds of tasks:
 
-- configure domain names and ssl certificates
-- create and link datastores
-- set environment variables
+- Configure domain names and SSL certificates.
+- Create and link datastores.
+- Set environment variables.
 
 ### Removing a deployed app
 
@@ -81,6 +103,15 @@ dokku --force apps:destroy node-js-app
 Destroying node-js-app (including all add-ons)
 ```
 
+The `--force` flag can also be specified on the command vs globally:
+
+```shell
+dokku apps:destroy --force node-js-app
+```
+
+```
+Destroying node-js-app (including all add-ons)
+```
 
 Destroying an application 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).
 
@@ -112,3 +143,136 @@ Renaming node-js-app to io-js-app... done
 ```
 
 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.
+
+By default, Dokku will deploy the renamed app, though you can skip the deploy by using the `--skip-deploy` flag:
+
+```shell
+dokku apps:rename --skip-deploy node-js-app io-js-app
+```
+
+### Cloning an existing app
+
+> New as of 0.11.5
+
+You can clone an existing app using the `apps:clone` command.  Note that the application *must* have been deployed at least once, or cloning will not complete successfully:
+
+```shell
+dokku apps:clone node-js-app io-js-app
+```
+
+```
+Cloning node-js-app to io-js-app... done
+```
+
+This will copy all of your app's contents into a new app directory with the name of your choice and then rebuild the new version of the app and deploy it with the following caveats:
+
+- All of your environment variables, including database urls, will be preserved.
+- Custom domains are not applied to the new app.
+- SSL certificates will not be copied to the new app.
+- Port mappings with the scheme `https` and host-port `443` will be skipped.
+
+> Warning: If you have exposed specific ports via `docker-options` plugin, or performed anything that cannot be done against multiple applications, `apps:clone` may result in errors.
+
+By default, Dokku will deploy this new app, though you can skip the deploy by using the `--skip-deploy` flag:
+
+```shell
+dokku apps:clone --skip-deploy node-js-app io-js-app
+```
+
+Finally, if the application already exists, you may wish to ignore errors resulting from attempting to clone over it. To do so, you can use the `--ignore-existing` flag. A warning will be emitted, but the command will return `0`.
+
+```shell
+dokku apps:clone --ignore-existing node-js-app io-js-app
+```
+
+### Locking app deploys
+
+> New as of 0.11.6
+
+If you wish to disable deploying for a period of time, this can be done via deploy locks. Normally, deploy locks exist only for the duration of a deploy so as to avoid deploys from colliding, but a deploy lock can be created by running the `apps:lock` command.
+
+
+```shell
+dokku apps:lock node-js-app
+```
+
+```
+-----> Deploy lock created
+```
+
+### Unlocking app deploys
+
+> New as of 0.11.6
+
+In some cases, it may be necessary to remove an existing deploy lock. This can be performed via the `apps:unlock` command.
+
+> Warning: Removing the deploy lock *will not* stop in progress deploys. At this time, in progress deploys will need to be manually terminated by someone with server access.
+
+```shell
+dokku apps:unlock node-js-app
+```
+
+```
+ !     A deploy may be in progress.
+ !     Removing the app lock will not stop in progress deploys.
+-----> Deploy lock removed.
+```
+
+### Checking lock status
+
+> New as of 0.13.0
+
+In some cases, you may wish to inspect the state of an app lock. To do so, you can issue an `apps:lock` command. This will exit non-zero if there is no app lock in place.
+
+
+```shell
+dokku apps:locked node-js-app
+```
+
+```
+Deploy lock does not exist
+```
+
+### Displaying reports for an app
+
+> New as of 0.8.1
+
+You can get a report about the deployed apps using the `apps:report` command:
+
+```shell
+dokku apps:report
+```
+
+```
+=====> node-js-app app information
+       App dir:             /home/dokku/node-js-app
+       App deploy source:   git
+       App locked:          false
+=====> python-sample app information
+       App dir:             /home/dokku/python-sample
+       App deploy source:
+       App locked:          false
+=====> ruby-sample app information
+       App dir:             /home/dokku/ruby-sample
+       App deploy source:   git
+       App locked:          false
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku apps:report node-js-app
+```
+
+```
+=====> node-js-app app information
+       App dir:             /home/dokku/node-js-app
+       App deploy source:   git
+       App locked:          false
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku apps:report node-js-app --app-dir
+```

docs/deployment/builders/builder-management.md

@@ -0,0 +1,108 @@
+# Builder Management
+
+> New as of 0.24.0
+
+```
+builder:report [<app>] [<flag>]   # Displays a builder report for one or more apps
+builder:set <app> <key> (<value>) # Set or clear a builder property for an app
+```
+
+Builders are a way of customizing how an app is built from a source, allowing users flexibility in how artifacts are created for later scheduling.
+
+## Usage
+
+### Builder selection
+
+Dokku supports the following built-in builders:
+
+- `builder-dockerfile`: Builds apps using a `Dockerfile` via `docker build`. See the [dockerfile builder documentation](/docs/deployment/builders/dockerfiles.md) for more information on how this builder functions.
+- `builder-herokuish`: Builds apps with Heroku's v2a Buildpack specification via `gliderlabs/herokuish`. See the [herokuish builder documentation](/docs/deployment/builders/herokuish-buildpacks.md) for more information on how this builder functions.
+- `builder-pack`: Builds apps with Cloud Native Buildpacks via the `pack-cli`  tool. See the [cloud native buildpacks builder documentation](/docs/deployment/builders/cloud-native-buildpacks.md) for more information on how this builder functions.
+
+Builders run a detection script against a source code repository, and the first detected builder will be used to build the app artifact. The exception to this is when a `Dockerfile` is detected and the app is also able to use either `herokuish` or `pack-cli` for building, in which case one of the latter will be chosen.
+
+### Overriding the auto-selected builder
+
+If desired, the builder can be specified via the `builder:set` command by speifying a value for `selected`. The selected builder will always be used.
+
+```shell
+dokku builder:set node-js-app selected dockerfile
+```
+
+The default value may be set by passing an empty value for the option:
+
+```shell
+dokku builder:set node-js-app selected
+```
+
+The `selected` property can also be set globally. The global default is an empty string, and auto-detection will be performed when no value is set per-app or globally.
+
+```shell
+dokku builder:set --global selected herokuish
+```
+
+The default value may be set by passing an empty value for the option.
+
+```shell
+dokku builder:set --global selected
+```
+
+### Displaying builder reports for an app
+
+You can get a report about the app's builder status using the `builder:report` command:
+
+```shell
+dokku builder:report
+```
+
+```
+=====> node-js-app builder information
+       Builder computed selected: herokuish
+       Builder global selected: herokuish
+       Builder selected: herokuish
+=====> python-sample builder information
+       Builder computed selected: dockerfile
+       Builder global selected: herokuish
+       Builder selected: dockerfile
+=====> ruby-sample builder information
+       Builder computed selected: herokuish
+       Builder global selected: herokuish
+       Builder selected:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku builder:report node-js-app
+```
+
+```
+=====> node-js-app builder information
+       Builder selected: herokuish
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku builder:report node-js-app --builder-selected
+```
+
+### Custom builders
+
+To create a custom builder, the following triggers must be implemented:
+
+- `builder-build`:
+  - arguments: `BUILDER_TYPE` `APP` `SOURCECODE_WORK_DIR`
+  - description: Creates a docker image named with the output of `common#get_app_image_name $APP`.
+- `builder-detect`:
+  - arguments: `APP` `SOURCECODE_WORK_DIR`
+  - description: Outputs the name of the builder (without the `builder-` prefix) to use to build the app.
+- `builder-release`:
+  - arguments: `BUILDER_TYPE` `APP` `IMAGE_AG`
+  - description: A post-build, pre-release trigger that can be used to post-process the image. Usually simply tags and labels the image appropriately.
+
+Custom plugins names _must_ have the prefix `builder-` or builder overriding via `builder:set` may not function as expected.
+
+Builders can use any tools available on the system to build the docker image, and may even be used to schedule building off-server. The only current requirement is that the image must exist on the server at the end of the `builder-build` command, though this requirement may be relaxed in a future release.
+
+For a simple example of how to implement this trigger, see `builder-pack`, which utilizes a cli tool - `pack-cli` - to generate an OCI image that is compatible with Docker and can be scheduled by the official scheduling plugins.

docs/deployment/builders/cloud-native-buildpacks.md

@@ -0,0 +1,80 @@
+# Cloud Native Buildpacks (Experimental)
+
+> New as of 0.22.0
+
+```
+buildpacks:set-property [--global|<app>] <key> <value>  # Set or clear a buildpacks property for an app
+```
+
+Cloud Native Buildpacks are an evolution over the Buildpacks technology provided by the Herokuish builder. See the [herokuish buildpacks documentation](/docs/deployment/builders/herokuish-buildpacks.md) for more information on how to clear buildpack build cache for an application.
+
+> Warning: This functionality uses the `pack` cli from the [Cloud Native Buildpacks](https://buildpacks.io) project to build apps. As the integration is experimental in Dokku, it is likely to change over time.
+
+## Usage
+
+### Detection
+
+This builder will be auto-detected in either the following cases:
+
+- The `DOKKU_CNB_EXPERIMENTAL` app environment variable is set to `1`.
+  ```shell
+  dokku config:set --no-restart node-js-app DOKKU_CNB_EXPERIMENTAL=1
+  ```
+- A `.project.toml` file exists in the root of the app repository.
+  - This file is consumed by `pack-cli` and used to describe how the app is built.
+
+The builder can also be specified via the `builder:set` command:
+
+```shell
+dokku builder:set node-js-app selected pack
+```
+
+> Dokku will only select the `dockerfile` builder if both the `herokuish` and `pack` builders are not detected and a Dockerfile exists. See the [dockerfile builder documentation](/docs/deployment/builders/dockerfiles.md) for more information on how that builder functions.
+
+### Requirements
+
+The `pack` cli tool is not included by default with Dokku or as a dependency. It must also be installed as shown on [this page](https://buildpacks.io/docs/tools/pack/).
+
+Builds will proceed with the `pack` cli for the app from then on.
+
+### Caveats
+
+As this functionality is highly experimental, there are a number of caveats. Please note that not all issuesare listed below.
+
+- Specifying specific buildpacks is not currently possible.
+  - A future release will add support for specifying buildpacks via the `buildpacks` plugin.
+- There is currently no way to specify extra arguments for `pack` cli invocations.
+  - A future release will add support for injecting extra arguments during the build process.
+- The default process type is `web`.
+- Build cache is stored in Docker volumes instead of on disk. As such, `repo:purge-cache` currently has no effect.
+  - A future version will add integration with the `repo` plugin.
+- `pack` is not currently included with Dokku, nor is it added as a package dependency.
+  - A future version will include it as a package dependency.
+
+### Customizing the Buildpack stack builder
+
+> New as of 0.23.0
+
+The default stack builder in use by CNB buildpacks in Dokku is based on `heroku/buildpacks`. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:set-property` command.
+
+```shell
+dokku buildpacks:set-property node-js-app stack paketobuildpacks/build:base-cnb
+```
+
+The specified stack builder can also be unset by omitting the name of the stack builder when calling `buildpacks:set-property`.
+
+```shell
+dokku buildpacks:set-property node-js-app stack
+```
+
+A change in the stack builder value will execute the `post-stack-set` trigger.
+
+Finally, stack builders can be set or unset globally as a fallback. This will take precedence over a globally set `DOKKU_CNB_STACK` environment variable (`heroku/buildpacks` by default).
+
+```shell
+# set globally
+dokku buildpacks:set-property --global stack paketobuildpacks/build:base-cnb
+
+# unset globally
+dokku buildpacks:set-property --global stack
+```