Release 0.23.2

# History

## 0.23.2

Install/update via the bootstrap script:

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

### Bug Fixes

- #4388: @josegonzalez Do not inject max-size option when not using local or json-file log-drivers
- #4386: @josegonzalez Update to docker-image-labeler that handles in-use images

### New Features

- #4387: @josegonzalez Only warn if the vector container is stopped when fetching logs
- #4372: @josegonzalez Add ability to clear an individual resource
- #4384: @josegonzalez Add support for injected cron entries from external plugins

### Refactors

- #4373: @josegonzalez Do not attempt to extract Procfile in ps:scale

### Documentation

- #4377: @josegonzalez Add note about the dokku user cron being overwritten by Dokku

### Other

- #3757: @pickettd Add provision line to Windows Vagrant box for dokku-installer

.circleci/config.yml

@@ -1,34 +1,13 @@
-version: 2
+version: 2.1
+
 jobs:
-  build:
-    machine: true
-    parallelism: 4
+  noop:
+    docker:
+      - image: cimg/base:2020.01
     steps:
-      - checkout
-      - run: |
-          make ci-dependencies
-      - run: |
-          ./tests/ci/setup.sh
-      - run: |
-          echo 'export DOKKU_SKIP_CLEANUP=true' | sudo tee /home/dokku/.dokkurc/dokku_skip_cleanup
-      - run: |
-          # 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
-      - run: |
-          case $CIRCLE_NODE_INDEX in
-            0) sudo -E make -e lint 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
-      - run:
-          shell: /bin/bash
-          command: sudo -E make -e test-ci
-          no_output_timeout: 60m
-      - store_artifacts:
-          path: ./coverage.out
-      - store_artifacts:
-          path: ./test-results
-          destination: test-results
-      - store_test_results:
-          path: test-results
+      - run: echo "this is a noop"
+
+workflows:
+  noop:
+    jobs:
+      - noop

.dockerignore

@@ -6,6 +6,8 @@ contrib
 build
 docs
 tests
+!build/dokku.deb
+!tests/dhparam.pem
 !contrib/dokku-installer.py
 !contrib/dokku-update
 !contrib/bash-completion

.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/workflows/bump-formula.yml

@@ -0,0 +1,23 @@
+name: bump-formula
+on:
+  push:
+   tags:
+     - '*'
+jobs:
+  bump-formula:
+    runs-on: macos-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+    - name: Get version
+      id: get_version
+      run: echo ::set-output name=version::${GITHUB_REF/refs\/tags\//}
+    - name: Bump Brew
+      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/${{ steps.get_version.outputs.version }}.tar.gz" dokku/repo/dokku

.github/workflows/ci.yml

@@ -0,0 +1,157 @@
+name: CI
+
+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 }}
+
+    - 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,68 @@
+# 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"
+
+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

.stickler.yml

@@ -1,3 +1,4 @@
+---
 linters:
   shellcheck:
     shell: bash
@@ -5,6 +6,8 @@ linters:
   golint:
 
 files:
-    ignore:
-      - './debian/*'
-      - '*/vendor/*'
+  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,11 +5,11 @@ 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](http://dokku.viewdocs.io/dokku/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)
+* 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 the Dokku project financially on [OpenCollective](https://opencollective.com/dokku#support) or [Patreon](https://www.patreon.com/dokku)
 
@@ -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
@@ -127,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](http://dokku.viewdocs.io/dokku/development/testing/),
+which contains test setup information as well as tips for running tests.
 
 # Additional Resources
 

Dockerfile

@@ -0,0 +1,56 @@
+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
+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,6 +1,10 @@
 > 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 need help figuring out how to use a specific buildpack, or are having issues using multiple buildpacks, please see our [irc or slack channels](http://dokku.viewdocs.io/dokku/getting-started/where-to-get-help/#the-irc-and-slack-channels). Issues pertaining to buildpacks may be closed and locked.
+> 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](http://dokku.viewdocs.io/dokku/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
 
@@ -16,6 +20,8 @@
 
 #### Expected Results
 
+<-- Please replace APP_NAME with the name of your app -->
+
 ## Environment Information
 
 ### `dokku report APP_NAME` output
@@ -23,16 +29,14 @@
 > 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.
-> You may also run `dokku report` without any arguments to display the top-level reporting information.
+> 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):
-  - 0.13.0+: `dokku inspect APP_NAME`
-  - <0.13.0: `docker inspect CONTAINER_ID`: WARNING, `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):
+- 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
@@ -40,5 +44,5 @@
   - 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):
+- 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,11 +1,16 @@
 DOKKU_VERSION ?= master
 
-PROCFILE_VERSION ?= 0.6.0
-PLUGN_VERSION ?= 0.3.2
-SSHCOMMAND_URL ?= https://raw.githubusercontent.com/dokku/sshcommand/v0.7.0/sshcommand
-PROCFILE_UTIL_URL ?= https://github.com/josegonzalez/go-procfile-util/releases/download/v${PROCFILE_VERSION}/procfile-util_${PROCFILE_VERSION}_linux_x86_64.tgz
+DOCKER_IMAGE_LABELER_VERSION ?= 0.2.2
+HEROKUISH_VERSION ?= 0.5.19
+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
 PLUGN_URL ?= https://github.com/dokku/plugn/releases/download/v${PLUGN_VERSION}/plugn_${PLUGN_VERSION}_linux_x86_64.tgz
-SIGIL_URL ?= https://github.com/gliderlabs/sigil/releases/download/v0.4.0/sigil_0.4.0_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
@@ -29,7 +34,7 @@ endif
 
 include common.mk
 
-.PHONY: all apt-update install version copyfiles copyplugin man-db plugins dependencies sshcommand procfile-util plugn docker aufs stack count dokku-installer vagrant-acl-add vagrant-dokku go-build
+.PHONY: all apt-update install version copyfiles copyplugin man-db plugins dependencies docker-image-labeler sshcommand procfile-util plugn docker aufs stack count dokku-installer vagrant-acl-add vagrant-dokku go-build
 
 include tests.mk
 include package.mk
@@ -107,10 +112,11 @@ addman: help2man man-db
 	mandb
 
 version:
+	mkdir -p ${DOKKU_LIB_ROOT}
 ifeq ($(DOKKU_VERSION),master)
-	git describe --tags > ~dokku/VERSION  2>/dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ~dokku/VERSION
+	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/VERSION
+	echo $(DOKKU_VERSION) > ${DOKKU_LIB_ROOT}/STABLE_VERSION
 endif
 
 plugin-dependencies: plugn procfile-util
@@ -119,21 +125,31 @@ plugin-dependencies: plugn procfile-util
 plugins: plugn procfile-util docker
 	sudo -E dokku plugin:install --core
 
-dependencies: apt-update sshcommand plugn procfile-util docker help2man man-db sigil
+dependencies: apt-update docker-image-labeler sshcommand plugn procfile-util docker help2man man-db sigil dos2unix jq
 	$(MAKE) -e stack
 
 apt-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
+
+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
 
 sshcommand:
-	wget -qO /usr/local/bin/sshcommand ${SSHCOMMAND_URL}
-	chmod +x /usr/local/bin/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
 
 procfile-util:
@@ -149,13 +165,13 @@ sigil:
 	tar xzf /tmp/sigil_latest.tgz -C /usr/local/bin
 
 docker:
-	apt-get install -qq -y curl
-	egrep -i "^docker" /etc/group || groupadd 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
@@ -166,7 +182,7 @@ 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

README.md

@@ -1,5 +1,5 @@
 # Dokku
-[![Build Status](https://img.shields.io/circleci/project/github/dokku/dokku.svg?style=flat-square "Build Status")](https://circleci.com/gh/dokku/dokku/tree/master)
+[![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)
@@ -13,8 +13,6 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen.
 
 ## 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>
@@ -88,18 +86,21 @@ Support us with a monthly donation and help us continue our activities. [[Become
 
 A fresh VM running any of the following operating systems:
 
-- Ubuntu x64 - Any currently supported release
-- Debian 8.2+ x64
+- 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.16.3/bootstrap.sh
-sudo DOKKU_TAG=v0.16.3 bash bootstrap.sh
+wget https://raw.githubusercontent.com/dokku/dokku/v0.23.2/bootstrap.sh
+sudo DOKKU_TAG=v0.23.2 bash bootstrap.sh
 ```
 
 You can then proceed to the ip address or domain name associated with your server to complete the web-based installation.

Vagrantfile

@@ -31,10 +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
@@ -53,7 +55,7 @@ Vagrant::configure("2") do |config|
       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
@@ -70,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 dos2unix >/dev/null"
+    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|
@@ -96,14 +99,16 @@ 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 && 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 >/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

bootstrap.sh

@@ -3,7 +3,7 @@ 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.
 
@@ -12,19 +12,30 @@ set -eo pipefail
 # 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 [[ -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
+    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: http://dokku.viewdocs.io/dokku/getting-started/advanced-installation/#vms-with-less-than-1-gb-of-memory"
   fi
 }
 
@@ -35,13 +46,13 @@ install-requirements() {
     debian)
       if ! dpkg -l | grep -q software-properties-common; then
         apt-get update -qq >/dev/null
-        apt-get -qq -y install software-properties-common
+        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 install software-properties-common
+        apt-get -qq -y --no-install-recommends install software-properties-common
       fi
 
       add-apt-repository universe >/dev/null
@@ -90,11 +101,10 @@ install-dokku-from-source() {
   local DOKKU_CHECKOUT="$1"
 
   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
+    log-fail "This installation script requires apt-get. For manual installation instructions, consult http://dokku.viewdocs.io/dokku/advanced-installation/"
   fi
 
-  apt-get -qq -y install git make software-properties-common
+  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
@@ -115,8 +125,7 @@ install-dokku-from-package() {
       install-dokku-from-rpm-package "$@"
       ;;
     *)
-      echo "Unsupported Linux distribution. For manual installation instructions, consult http://dokku.viewdocs.io/dokku/advanced-installation/"
-      exit 1
+      log-fail "Unsupported Linux distribution. For manual installation instructions, consult http://dokku.viewdocs.io/dokku/advanced-installation/"
       ;;
   esac
 }
@@ -136,13 +145,17 @@ install-dokku-from-deb-package() {
   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 -qq -y --no-install-recommends install apt-transport-https
 
   if ! command -v docker &>/dev/null; then
     echo "--> Installing docker"
@@ -156,26 +169,21 @@ install-dokku-from-deb-package() {
     wget -nv -O - https://get.docker.com/ | sh
   fi
 
-  if [[ "$DOKKU_DISTRO_VERSION" == "14.04" ]]; then
-    echo "--> Adding nginx PPA"
-    add-apt-repository -y ppa:nginx/stable
-  fi
-
-  OS_ID="$(lsb_release -cs 2>/dev/null || echo "trusty")"
+  OS_ID="$(lsb_release -cs 2>/dev/null || echo "bionic")"
   if ! in-array "$DOKKU_DISTRO" "debian" "ubuntu"; then
     DOKKU_DISTRO="ubuntu"
-    OS_ID="trusty"
+    OS_ID="bionic"
   fi
 
   if [[ "$DOKKU_DISTRO" == "ubuntu" ]]; then
-    OS_IDS=("trusty" "utopic" "vivid" "wily" "xenial" "yakkety" "zesty" "artful" "bionic")
+    OS_IDS=("xenial" "bionic" "focal")
     if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
-      OS_ID="trusty"
+      OS_ID="bionic"
     fi
   elif [[ "$DOKKU_DISTRO" == "debian" ]]; then
-    OS_IDS=("wheezy" "jessie" "stretch" "buster")
+    OS_IDS=("stretch" "buster")
     if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
-      OS_ID="stretch"
+      OS_ID="buster"
     fi
   fi
 
@@ -203,9 +211,8 @@ install-dokku-from-deb-package() {
 install-dokku-from-rpm-package() {
   local DOKKU_CHECKOUT="$1"
 
-  if [[ "$DOKKU_DISTRO_VERSION" != "7" ]]; then
-    echo "Only CentOS version 7 is supported."
-    exit 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"

common.mk

@@ -1,4 +1,46 @@
+GO_ARGS ?=
+GO_PLUGIN_MAKE_TARGET ?= build
 GO_REPO_ROOT := /go/src/github.com/dokku/dokku
-BUILD_IMAGE := golang:1.12
+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

@@ -1,4 +1,4 @@
-# bash completion for dd                                   -*- shell-script -*-
+# bash completion for dokku                                -*- shell-script -*-
 
 _dokku_complete_verify() {
   declare desc="shows bash completion"

contrib/build-base.Dockerfile

@@ -1,6 +1,6 @@
-FROM ubuntu:14.04
+FROM ubuntu:18.04
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update && apt-get -y install gcc git build-essential wget ruby-dev ruby1.9.1 lintian rpm help2man man-db
+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-update.Dockerfile

@@ -2,7 +2,7 @@ FROM dokku/build-base:0.0.1
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update && apt-get -y install gcc git build-essential wget ruby-dev ruby1.9.1 lintian rpm help2man man-db
+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 WORKDIR=/go/src/github.com/dokku/dokku

contrib/build-dokku.Dockerfile

@@ -2,7 +2,7 @@ FROM dokku/build-base:0.0.1
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update && apt-get -y install gcc git build-essential wget ruby-dev ruby1.9.1 lintian rpm help2man man-db
+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
@@ -35,8 +35,7 @@ RUN PLUGIN_MAKE_TARGET=${PLUGIN_MAKE_TARGET} \
     IS_RELEASE=${IS_RELEASE} \
     SKIP_GO_CLEAN=true \
     make version copyfiles \
-    && rm -rf plugins/common/*.go  plugins/common/glide*  plugins/common/vendor/ \
-    && make deb-dokku deb-sshcommand deb-sigil \
-            rpm-dokku rpm-sshcommand rpm-sigil
+    && make deb-dokku deb-sigil \
+            rpm-dokku rpm-sigil
 
 RUN ls -lha /tmp/

contrib/build-herokuish.Dockerfile

@@ -1,16 +0,0 @@
-FROM dokku/build-base:0.0.1
-
-ENV DEBIAN_FRONTEND=noninteractive
-
-RUN apt-get update && apt-get -y 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 WORKDIR=/go/src/github.com/dokku/dokku
-
-WORKDIR ${WORKDIR}
-
-COPY . ${WORKDIR}
-
-RUN make deb-herokuish rpm-herokuish
-
-RUN ls -lha /tmp/

contrib/copy-packages

@@ -16,7 +16,8 @@ def download_file(filename, url):
 
 def upload_file(filename):
     versions = [
-        "bionic",
+        "xenial"
+        "focal"
     ]
     cmd_template = "package_cloud push dokku/dokku/ubuntu/{0} {1}"
     for version in versions:
@@ -26,7 +27,7 @@ def upload_file(filename):
 
 def main():
     auth = HTTPBasicAuth(PACKAGECLOUD_TOKEN, '')
-    base = requests.get('https://packagecloud.io/api/v1/repos/dokku/dokku/packages/deb/ubuntu/trusty.json',
+    base = requests.get('https://packagecloud.io/api/v1/repos/dokku/dokku/packages/deb/ubuntu/bionic.json',
                         auth=auth)
     data = base.json()
     urls = []
@@ -42,7 +43,7 @@ def main():
             download_urls['downloads/' + version['filename']] = version['download_url']
 
     for filename, download_url in download_urls.items():
-        print "downloading", filename
+        print("downloading {0}".format(filename))
         download_file(filename, download_url)
         upload_file(filename)
 

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,23 +1,45 @@
-#!/usr/bin/env python2.7
+#!/usr/bin/env python3
 
 import cgi
 import json
 import os
 import re
-import SimpleHTTPServer
-import SocketServer
+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.16.3'
+VERSION = 'v0.23.2'
+
+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
 
@@ -33,26 +55,37 @@ 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 = subprocess.check_output(command, shell=True).strip()
+    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:
@@ -69,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")
@@ -79,11 +112,18 @@ 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)
@@ -92,7 +132,7 @@ class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
         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/']:
@@ -104,19 +144,30 @@ 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)
+
+        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'
@@ -133,7 +184,10 @@ class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
             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()
 
@@ -146,9 +200,11 @@ 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+)')
@@ -163,11 +219,11 @@ class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
         max_num = 0
         exists = False
         for line in proc.stdout:
-            m = pattern.search(line)
+            m = pattern.search(bytes_to_string(line))
             if m:
                 # User of the form `user` or `user#` exists
                 exists = True
-                max_num = max(max_num, m.group(1))
+                max_num = max(max_num, int(m.group(1)))
         if exists:
             return max_num
         else:
@@ -203,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:
@@ -221,7 +277,7 @@ 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()
 
 

contrib/dokku-update

@@ -77,11 +77,11 @@ main() {
   dokku-log-info "Running system updates"
   case "$DOKKU_DISTRO" in
     arch)
-      yaourt -Syyua
+      yay -Syyua
       ;;
     debian | ubuntu)
       apt-get update -qq >/dev/null
-      apt-get -qq -y --force-yes dist-upgrade
+      apt-get -qq -y dist-upgrade
       ;;
     centos | opensuse | rhel)
       dokku-log-warn "Updating this operating system is not supported"
@@ -101,7 +101,7 @@ main() {
 
   # rebuild all applications
   dokku-log-info "Rebuilding all applications"
-  dokku ps:rebuildall
+  dokku ps:rebuild --all
 
   dokku-log-info "Waiting for old containers to stop"
   sleep 120

contrib/dokku_client.sh

@@ -32,8 +32,8 @@ fn-random-name() {
 }
 
 fn-client-help-msg() {
-  echo "==> Configure the DOKKU_HOST environment variable or run $0 from a repository with a git remote named dokku" 1>&2
-  echo "--> i.e. git remote add dokku dokku@<dokku-host>:<app-name>" 1>&2
+  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
 }
 
@@ -72,6 +72,9 @@ main() {
       skip=false
       continue
     fi
+    is_flag=false
+
+    [[ "$arg" =~ ^--.* ]] && is_flag=true
 
     if [[ "$arg" == "--app" ]]; then
       APP=${args[$next_index]}
@@ -82,10 +85,10 @@ main() {
       skip=true
       shift 2
     elif [[ "$arg" =~ ^--.* ]]; then
-      [[ "$cmd_set" == "true" ]] && APP_ARG="$arg" && break
+      [[ "$cmd_set" == "true" ]] && [[ "$is_flag" == "false" ]] && APP_ARG="$arg" && break
       [[ "$arg" == "--trace" ]] && export DOKKU_TRACE=1 && set -x
     else
-      if [[ "$cmd_set" == "true" ]]; then
+      if [[ "$cmd_set" == "true" ]] && [[ "$is_flag" == "false" ]]; then
         APP_ARG="$arg"
         break
       else
@@ -104,18 +107,18 @@ main() {
       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
   fi
 
   case "$CMD" in
     apps:create)
-      if [[ -z "$APP_ARG" ]]; then
+      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 "Error: could not reasonably generate a new app name. try cleaning up some apps..."
+            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
@@ -123,14 +126,14 @@ main() {
             counter=$((counter + 1))
           fi
         done
-      else
+      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?"
+        echo " !     Dokku remote not added! Do you already have a dokku remote?" 1>&2
         return
       fi
       ;;
@@ -140,13 +143,18 @@ main() {
   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:rebuildall ps:restartall ps:restore ps:startall ps:stopall " == *" $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 -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

contrib/packer.json

@@ -22,7 +22,7 @@
         "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

@@ -3,7 +3,7 @@ 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.XXXX")"
+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
@@ -136,7 +136,7 @@ fn-publish-package() {
   [[ "$RELEASE_TYPE" == "rpm" ]] && DIST=el/7
 
   if [[ "$DIST" == "ubuntu" ]]; then
-    OS_IDS=("trusty" "utopic" "vivid" "wily" "xenial" "yakkety" "zesty" "artful" "bionic")
+    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"
@@ -147,7 +147,7 @@ fn-publish-package() {
     done
 
     DIST=debian
-    OS_IDS=("wheezy" "jessie" "stretch" "buster")
+    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"
@@ -206,13 +206,15 @@ fn-repo-update() {
 
   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/home.html
+  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
 
@@ -237,7 +239,7 @@ 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_BUG HISTORY_OTHER HISTORY_TESTS ISSUE_FILE
+  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
 
@@ -254,12 +256,16 @@ fn-repo-update-history-and-commit() {
     TYPE="$(jq -r '.labels[] | select( .name | contains("type") ) | .name' "$ISSUE_FILE" | cut -d' ' -f2)"
     CHANGELOG_TEXT="- #${PULL_REQUEST_ID}: @${AUTHOR} ${TITLE}"
 
-    if [[ "$TYPE" == "bug" ]]; then
+    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" ]] || [[ "$TYPE" == "refactor" ]]; then
+    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
@@ -275,6 +281,15 @@ fn-repo-update-history-and-commit() {
   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"
@@ -285,6 +300,11 @@ fn-repo-update-history-and-commit() {
     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"
@@ -317,6 +337,12 @@ fn-require-bin() {
   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
@@ -354,10 +380,18 @@ main() {
   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
 

contrib/release-dokku-update

@@ -3,7 +3,7 @@ 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.XXXX")"
+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
@@ -61,7 +61,7 @@ fn-publish-package() {
   [[ "$RELEASE_TYPE" == "rpm" ]] && DIST=el/7
 
   if [[ "$DIST" == "ubuntu" ]]; then
-    OS_IDS=("trusty" "utopic" "vivid" "wily" "xenial" "yakkety" "zesty" "artful" "bionic")
+    OS_IDS=("xenial" "bionic" "focal")
     for OS_ID in "${OS_IDS[@]}"; do
       log-info "(release-dokku-update) pushing ${RELEASE_TYPE} to packagecloud.com/${REPOSITORY}/${DIST}"
       package_cloud push "${REPOSITORY}/${DIST}/${OS_ID}" "$PACKAGE_NAME"
@@ -72,7 +72,7 @@ fn-publish-package() {
     done
 
     DIST=debian
-    OS_IDS=("wheezy" "jessie" "stretch" "buster")
+    OS_IDS=("stretch" "buster")
     for OS_ID in "${OS_IDS[@]}"; do
       log-info "(release-dokku-update) pushing ${RELEASE_TYPE} to packagecloud.com/${REPOSITORY}/${DIST}"
       package_cloud push "${REPOSITORY}/${DIST}/${OS_ID}" "$PACKAGE_NAME"

contrib/release-herokuish

@@ -1,160 +0,0 @@
-#!/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.XXXX")"
-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"
-
-  pushd "$ROOT_DIR" >/dev/null
-  docker build \
-    -f "contrib/build-herokuish.Dockerfile" \
-    -t herokuish:build .
-  return "$?"
-}
-
-fn-extract-package() {
-  declare desc="Extract packages from a docker container to the root directory"
-  declare PACKAGE_NAME="$1"
-
-  if [[ -z "$PACKAGE_NAME" ]]; then
-    log-error "Invalid deb file specified"
-    return 1
-  fi
-
-  log-info "(extract-package) writing ${PACKAGE_NAME} to correct path"
-  docker run --rm --entrypoint cat herokuish:build "/tmp/${PACKAGE_NAME}" >"${ROOT_DIR}/build/${PACKAGE_NAME}"
-  return "$?"
-}
-
-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
-  local OS_ID ex EXIT_CODE=0
-
-  [[ "$IS_RELEASE" == "true" ]] && REPOSITORY=dokku/dokku
-  [[ "$RELEASE_TYPE" == "rpm" ]] && DIST=el/7
-
-  if [[ "$DIST" == "ubuntu" ]]; then
-    OS_IDS=("trusty" "utopic" "vivid" "wily" "xenial" "yakkety" "zesty" "artful" "bionic")
-    for OS_ID in "${OS_IDS[@]}"; do
-      log-info "(release-herokuish) 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=("wheezy" "jessie" "stretch" "buster")
-    for OS_ID in "${OS_IDS[@]}"; do
-      log-info "(release-herokuish) 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-herokuish) pushing ${RELEASE_TYPE} to packagecloud.com/${REPOSITORY}/${DIST}"
-    package_cloud push "${REPOSITORY}/${DIST}" "$PACKAGE_NAME"
-    EXIT_CODE="$?"
-  fi
-  return "$EXIT_CODE"
-}
-
-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-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() {
-  declare RELEASE="$1"
-  local NEXT_VERSION
-  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
-
-  mkdir -p "build"
-  fn-require-bin "docker"
-  if [[ "$RELEASE" != "build" ]]; then
-    fn-require-bin "package_cloud"
-    [[ -n "$PACKAGECLOUD_TOKEN" ]] || log-fail "Missing PACKAGECLOUD_TOKEN environment variable"
-  fi
-
-  NEXT_VERSION="$(grep HEROKUISH_VERSION deb.mk | head -n1 | cut -d'=' -f2 | xargs)"
-  IS_RELEASE="$(fn-is-release "$RELEASE")"
-
-  fn-build-dokku || log-fail "Error building package"
-  fn-extract-package "herokuish_${NEXT_VERSION}_amd64.deb" || log-fail "Error extracting deb package"
-  fn-extract-package "herokuish-${NEXT_VERSION}-1.x86_64.rpm" || log-fail "Error extracting rpm package"
-
-  if [[ "$RELEASE" != "build" ]]; then
-    fn-publish-package "$IS_RELEASE" "deb" "build/herokuish_${NEXT_VERSION}_amd64.deb" || log-fail "Error publishing deb package"
-    fn-publish-package "$IS_RELEASE" "rpm" "build/herokuish-${NEXT_VERSION}-1.x86_64.rpm" || log-fail "Error publishing rpm package"
-  fi
-}
-
-main "$@"

contrib/release-plugin

@@ -2,7 +2,7 @@
 set -eo pipefail
 [[ $TRACE ]] && set -x
 
-readonly TMP_WORK_DIR="$(mktemp -d "/tmp/dokku-plugin-release.XXXX")"
+readonly TMP_WORK_DIR="$(mktemp -d "/tmp/dokku-plugin-release.XXXXXX")"
 
 trap 'rm -rf "$TMP_WORK_DIR" >/dev/null' RETURN INT TERM EXIT
 
@@ -95,7 +95,7 @@ EOF
     local AWS_RELEASE=true
   fi
 
-  if [[ "$CI" != "true" ]] && [[ -z "$DOKKU_PLUGIN_GITHUB_ACCESS_TOKEN" ]]; then
+  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

deb.mk

@@ -1,32 +1,15 @@
 BUILD_DIRECTORY ?= /tmp
 
-HEROKUISH_DESCRIPTION = 'Herokuish uses Docker and Buildpacks to build applications like Heroku'
-HEROKUISH_REPO_NAME ?= gliderlabs/herokuish
-HEROKUISH_VERSION ?= 0.5.0
-HEROKUISH_ARCHITECTURE = amd64
-HEROKUISH_PACKAGE_NAME = herokuish_$(HEROKUISH_VERSION)_$(HEROKUISH_ARCHITECTURE).deb
-
 DOKKU_DESCRIPTION = 'Docker powered PaaS that helps you build and manage the lifecycle of applications'
 DOKKU_REPO_NAME ?= dokku/dokku
 DOKKU_ARCHITECTURE = amd64
 
 DOKKU_UPDATE_DESCRIPTION = 'Binary that handles updating Dokku and related systems'
 DOKKU_UPDATE_REPO_NAME ?= dokku/dokku
-DOKKU_UPDATE_VERSION ?= 0.1.0
+DOKKU_UPDATE_VERSION ?= 0.2.0
 DOKKU_UPDATE_ARCHITECTURE = amd64
 DOKKU_UPDATE_PACKAGE_NAME = dokku-update_$(DOKKU_UPDATE_VERSION)_$(DOKKU_UPDATE_ARCHITECTURE).deb
 
-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.7.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
@@ -45,61 +28,34 @@ ifndef IS_RELEASE
 endif
 
 export SIGIL_DESCRIPTION
-export SSHCOMMAND_DESCRIPTION
 
-.PHONY: install-from-deb deb-all deb-herokuish deb-dokku deb-dokku-update deb-setup deb-sshcommand deb-sigil
+.PHONY: install-from-deb deb-all deb-dokku deb-dokku-update deb-setup deb-sigil
 
 install-from-deb:
 	@echo "--> Initial apt-get update"
 	sudo apt-get update -qq >/dev/null
-	sudo apt-get install -qq -y apt-transport-https
+	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/dokku/dokku/gpgkey | apt-key add -
-	@echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ $(shell lsb_release -cs 2>/dev/null || echo "trusty") main" | sudo tee /etc/apt/sources.list.d/dokku.list
+	@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 install -yy dokku
+	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-sshcommand deb-sigil deb-dokku-update
+deb-all: deb-setup deb-dokku deb-sigil deb-dokku-update
 	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
+	@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
-
-	@echo "-> Creating deb files"
-	@echo "#!/usr/bin/env bash" >> /tmp/tmp/post-install
-	@echo "sleep 5" >> /tmp/tmp/post-install
-	@echo "echo 'Importing herokuish into docker (around 5 minutes)'" >> /tmp/tmp/post-install
-	@echo 'if [[ -n $${http_proxy+x} ]]; then echo "See the docker pull docs for proxy configuration"; fi' >> /tmp/tmp/post-install
-	@echo 'if [[ -n $${https_proxy+x} ]]; then echo "See the docker pull docs for proxy configuration"; fi' >> /tmp/tmp/post-install
-	@echo 'if [[ -n $${BUILDARGS+x} ]]; then echo "See the docker pull docs for proxy configuration"; fi' >> /tmp/tmp/post-install
-	@echo "sudo docker pull gliderlabs/herokuish:v${HEROKUISH_VERSION} && sudo docker tag gliderlabs/herokuish:v${HEROKUISH_VERSION} gliderlabs/herokuish:latest" >> /tmp/tmp/post-install
-
-	@echo "-> Creating $(HEROKUISH_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n herokuish \
-		--version $(HEROKUISH_VERSION) \
-		--architecture $(HEROKUISH_ARCHITECTURE) \
-		--package $(BUILD_DIRECTORY)/$(HEROKUISH_PACKAGE_NAME) \
-		--deb-pre-depends 'docker-engine-cs (>= 1.9.1) | docker-engine (>= 1.9.1) | docker-ce | docker-ee' \
-		--deb-pre-depends sudo \
-		--after-install /tmp/tmp/post-install \
-		--url "https://github.com/$(HEROKUISH_REPO_NAME)" \
-		--description $(HEROKUISH_DESCRIPTION) \
-		--license 'MIT License' \
-		.
-
 deb-dokku: /tmp/build-dokku/var/lib/dokku/GIT_REV
 	rm -f $(BUILD_DIRECTORY)/dokku_*_$(DOKKU_ARCHITECTURE).deb
 
@@ -129,30 +85,6 @@ deb-dokku-update:
 			 contrib/dokku-update=/usr/local/bin/dokku-update \
 			 contrib/dokku-update-version=/var/lib/dokku-update/VERSION
 
-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 $(BUILD_DIRECTORY)/$(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' \
-			 .
-
 deb-sigil:
 	rm -rf /tmp/tmp /tmp/build $(SIGIL_PACKAGE_NAME)
 	mkdir -p /tmp/tmp /tmp/build /tmp/build/usr/bin

debian/control

@@ -1,11 +1,11 @@
 Package: dokku
-Version: 0.16.3
+Version: 0.23.2
 Section: web
 Priority: optional
 Architecture: amd64
-Depends: locales, git, make, curl, gcc, man-db, netcat, sshcommand (>= 0.6.0), gliderlabs-sigil, docker-engine-cs (>= 1.7.1) | docker-engine (>= 1.7.1) | docker-io (>= 1.7.1)  | docker.io (>= 1.7.1) | docker-ce | docker-ee, net-tools, software-properties-common, procfile-util, python-software-properties | python3-software-properties, rsyslog
-Recommends: herokuish (>= 0.3.4), parallel, dokku-update
-Pre-Depends: nginx (>= 1.8.0) | openresty, dnsutils, cgroupfs-mount | cgroup-lite, plugn (>= 0.3.0), 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, software-properties-common, procfile-util (>= 0.11.0), python-software-properties | python3-software-properties, rsyslog, dos2unix, jq
+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,5 +1,5 @@
-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
@@ -10,3 +10,6 @@ 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

@@ -26,6 +26,124 @@ call-sshcommand() {
   fi
 }
 
+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"
+}
+
+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"
+}
+
+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 "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
+
+  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 "Install all core plugins"
+  dokku plugin:install --core
+}
+
+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
+}
+
+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
+
+    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
+}
+
+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 "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) ;;
 
@@ -33,103 +151,16 @@ case "$1" in
     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
-
-    egrep -i "^docker" /etc/group || groupadd docker
-    usermod -aG docker dokku
-
-    echo "Setting up storage directories"
-    mkdir -p ${DOKKU_LIB_ROOT}/data ${DOKKU_LIB_ROOT}/data/storage
-    chown dokku:dokku ${DOKKU_LIB_ROOT}/data ${DOKKU_LIB_ROOT}/data/storage
-
-    echo "Setting up plugin directories"
-    # should be replaced by `plugn init`
-    mkdir -p ${DOKKU_LIB_ROOT}/core-plugins/available ${DOKKU_LIB_ROOT}/plugins/available
-    mkdir -p ${DOKKU_LIB_ROOT}/core-plugins/enabled ${DOKKU_LIB_ROOT}/plugins/enabled
-    touch ${DOKKU_LIB_ROOT}/core-plugins/config.toml ${DOKKU_LIB_ROOT}/plugins/config.toml
-
-    echo "Migrating old plugins"
-    find ${DOKKU_LIB_ROOT}/plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read -r plugin; do
-      if [ "$plugin" = "available" ] || [ "$plugin" = "enabled" ]; then
-        continue
-      elif [ -f ${DOKKU_LIB_ROOT}/plugins/$plugin/.core ]; then
-        rm -rf ${DOKKU_LIB_ROOT}/plugins/$plugin
-      elif [ ! -d ${DOKKU_LIB_ROOT}/plugins/available/$plugin ]; then
-        mv ${DOKKU_LIB_ROOT}/plugins/$plugin ${DOKKU_LIB_ROOT}/plugins/available
-      fi
-    done
-
-    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 "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"
+    if [[ -f /sbin/modprobe ]]; then
+      modprobe aufs || echo "WARNING: Restart server to finish installing dokku!"
     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
-    fi
-
-    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 "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
+    setup-user
+    setup-storage
+    setup-plugins
+    setup-sshcommand
+    setup-dokku-installer
+    dpkg-handling
     ;;
 
   *)

debian/postrm

@@ -28,9 +28,11 @@ main() {
   fi
 
   if [[ "$1" == "purge" ]]; then
+    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 -f ${DOKKU_ROOT}/.dokkurc ${DOKKU_ROOT}/dokkurc ${DOKKU_ROOT}/tls
+    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

@@ -7,51 +7,62 @@ if [[ -e /usr/share/debconf/confmodule ]]; then
   . /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/*
-      DOKKU_DISTRO="$(
-        . /etc/os-release >/dev/null 2>&1 || true
-        echo "$ID"
-      )"
-      case "$DOKKU_DISTRO" in
-        debian)
-          NGINX_INIT="/usr/sbin/invoke-rc.d"
-          "$NGINX_INIT" nginx reload || "$NGINX_INIT" nginx start
-          ;;
-        ubuntu)
-          NGINX_INIT="/etc/init.d/nginx"
-          "$NGINX_INIT" reload || "$NGINX_INIT" start
-          ;;
-      esac
-      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."
+        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"
-        exit 1
       fi
     fi
     ;;

debian/prerm

@@ -33,7 +33,7 @@ main() {
     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
 

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/deployment/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](/docs/advanced-usage/persistent-storage.md) 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,7 +2,7 @@
 
 > 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
@@ -32,9 +32,11 @@ Each "phase" has different expectations and limitations:
         - 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.
+
 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) docs for more information on building your own custom plugin.
+> 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
 

docs/advanced-usage/docker-options.md

@@ -6,6 +6,7 @@ Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during D
 
 ```
 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
 ```
@@ -24,6 +25,10 @@ Dokku deploys your application in multiple "phases" and the `docker-options` plu
 - `deploy`: the container that executes your running/deployed application
 - `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
@@ -44,6 +49,37 @@ dokku docker-options:add node-js-app run "-v /var/log/node-js-app:/app/logs"
 dokku docker-options:remove node-js-app run "-v /var/log/node-js-app:/app/logs"
 ```
 
+### Clear all Docker options for an app
+
+Docker options can be removed for a specific app using the `docker-options:clear` command.
+
+```shell
+dokku docker-options:clear node-js-app
+```
+
+```
+-----> 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
+dokku docker-options:clear node-js-app run
+```
+
+```
+-----> Clearing docker-options for node-js-app on phase 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
@@ -87,25 +123,3 @@ You can pass flags which will output only the value of the specific information
 ```shell
 dokku docker-options:report node-js-app --docker-options-build
 ```
-
-## Advanced usage
-
-In your applications folder `/home/dokku/app_name` create a file called `DOCKER_OPTIONS_RUN` (or `DOCKER_OPTIONS_BUILD` or `DOCKER_OPTIONS_DEPLOY`).
-
-Inside this file list one Docker option per line. For example:
-
-```shell
---link container_name:alias
--v /host/path:/container/path
--v /another/container/path
-```
-
-The above example will result in the following options being passed to Docker during `dokku run`:
-
-```shell
---link container_name:alias -v /host/path:/container/path -v /another/container/path
-```
-
-You may also include comments (lines beginning with a #) and blank lines in the DOCKER_OPTIONS file.
-
-More information on Docker options can be found here: https://docs.docker.com/engine/reference/commandline/run/.

docs/advanced-usage/persistent-storage.md

@@ -37,7 +37,7 @@ This example demonstrates how to mount the recommended directory to `/storage` i
 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.
 
 Once you have mounted persistent storage, you will also need to restart the application. See the
 [process scaling documentation](/docs/deployment/process-management.md) for more information.
@@ -147,4 +147,4 @@ By default, Dokku will execute your buildpack application processes as the `hero
 
 > NOTE: this user must exist in your herokuish image.
 
-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 [scheduler-docker-local documentation](/docs/advanced-usage/schedulers/docker-local.md#disabling-chown-of-persistent-storage) docs for more information.
+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

@@ -6,8 +6,10 @@
 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,43 +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.16.3 enabled    dokku core standard plugin
-  20_events            0.16.3 enabled    dokku core events logging plugin
-  apps                 0.16.3 enabled    dokku core apps plugin
-  build-env            0.16.3 enabled    dokku core build-env plugin
-  certs                0.16.3 enabled    dokku core certificate management plugin
-  checks               0.16.3 enabled    dokku core checks plugin
-  common               0.16.3 enabled    dokku core common plugin
-  config               0.16.3 enabled    dokku core config plugin
-  docker-options       0.16.3 enabled    dokku core docker-options plugin
-  domains              0.16.3 enabled    dokku core domains plugin
-  enter                0.16.3 enabled    dokku core enter plugin
-  git                  0.16.3 enabled    dokku core git plugin
-  logs                 0.16.3 enabled    dokku core logs plugin
-  named-containers     0.16.3 enabled    dokku core named containers plugin
-  network              0.16.3 enabled    dokku core network plugin
-  nginx-vhosts         0.16.3 enabled    dokku core nginx-vhosts plugin
-  plugin               0.16.3 enabled    dokku core plugin plugin
-  proxy                0.16.3 enabled    dokku core proxy plugin
-  ps                   0.16.3 enabled    dokku core ps plugin
-  repo                 0.16.3 enabled    dokku core repo plugin
-  shell                0.16.3 enabled    dokku core shell plugin
-  ssh-keys             0.16.3 enabled    dokku core ssh-keys plugin
-  storage              0.16.3 enabled    dokku core storage plugin
-  tags                 0.16.3 enabled    dokku core tags plugin
-  tar                  0.16.3 enabled    dokku core tar plugin
+  00_dokku-standard    0.23.2 enabled    dokku core standard plugin
+  20_events            0.23.2 enabled    dokku core events logging plugin
+  app-json             0.23.2 enabled    dokku core app-json plugin
+  apps                 0.23.2 enabled    dokku core apps plugin
+  build-env            0.23.2 enabled    dokku core build-env plugin
+  buildpacks           0.23.2 enabled    dokku core buildpacks plugin
+  certs                0.23.2 enabled    dokku core certificate management plugin
+  checks               0.23.2 enabled    dokku core checks plugin
+  common               0.23.2 enabled    dokku core common plugin
+  config               0.23.2 enabled    dokku core config plugin
+  docker-options       0.23.2 enabled    dokku core docker-options plugin
+  domains              0.23.2 enabled    dokku core domains plugin
+  enter                0.23.2 enabled    dokku core enter plugin
+  git                  0.23.2 enabled    dokku core git plugin
+  logs                 0.23.2 enabled    dokku core logs plugin
+  network              0.23.2 enabled    dokku core network plugin
+  nginx-vhosts         0.23.2 enabled    dokku core nginx-vhosts plugin
+  plugin               0.23.2 enabled    dokku core plugin plugin
+  proxy                0.23.2 enabled    dokku core proxy plugin
+  ps                   0.23.2 enabled    dokku core ps plugin
+  repo                 0.23.2 enabled    dokku core repo plugin
+  resource             0.23.2 enabled    dokku core resource plugin
+  scheduler-docker-local 0.23.2 enabled    dokku core scheduler-docker-local plugin
+  shell                0.23.2 enabled    dokku core shell plugin
+  ssh-keys             0.23.2 enabled    dokku core ssh-keys plugin
+  storage              0.23.2 enabled    dokku core storage plugin
+  tags                 0.23.2 enabled    dokku core tags plugin
+  tar                  0.23.2 enabled    dokku core tar plugin
+  trace                0.23.2 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
 ```
@@ -75,7 +104,68 @@ Checking connectivity... done.
 -----> Plugin postgres enabled
 ```
 
-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
@@ -85,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
@@ -95,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
 ```
@@ -103,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/resource-management.md

@@ -16,7 +16,7 @@ The resource plugin is meant to allow users to limit or reserve resources for a
 
 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.
 
-> The meaning of a values and it's units are specific to the scheduler in use for a given app. 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.
+> 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:
 
@@ -26,6 +26,9 @@ Valid resource options include:
 - `--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.
 
@@ -68,77 +71,52 @@ dokku resource:limit --cpu 100 --memory 100 --process-type worker node-js-app
        memory: 100
 ```
 
-#### Displaying Resource Limits
-
-Running the `resource:limits` command without any flags will display the currently configured app reservation.
+A resource value can be individually cleared by setting the value to the special value `clear`.
 
 ```shell
-dokku resource:limits node-js-app
-=====> resource limits node-js-app information
+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:
-```
-
-#### Global Resource Limits
-
-By default, Dokku does not limit any resources, though these can be specified at the server level via the `--global` flag on the `resource:limit` command.
-
-```shell
-dokku resource:limit --global --memory 200
-```
-
-```
-=====> Setting default resource limits
-       memory: 200
-```
-
-This may also be combined with the `--process-type` flag to set global limits on a process-type level:
-
-```shell
-dokku resource:limit --global --memory 150 --process-type web node-js-app
-```
-
-```
-=====> Setting default resource limits (web)
-       memory: 150
-```
-
-#### Displaying Global Resource Limits
-
-Running the `resource:limit` command with only the `--global` flag will display the currently configured default limits.
-
-```shell
-dokku resource:limit --global
-```
-
-```
-=====> resource limits default information
-       cpu:
-       memory: 200
-       memory-swap:
-       network:
-       network-ingress:
-       network-egress:
-```
-
-This may also be combined with the `--process-type` flag to see global limits on a process-type level:
-
-```shell
-dokku resource:limit --global --process-type web
-```
-
-```
-=====> resource limits default information (web)
-       cpu:
-       memory-swap:
-       memory: 150
-       network-egress:
-       network-ingress:
-       network:
+       nvidia-gpu:
 ```
 
 #### Clearing Resource Limits
@@ -202,77 +180,51 @@ dokku resource:reserve --cpu 100 --memory 100 --process-type worker node-js-app
        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 app reservation.
+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
+```
+
+```
+=====> resource reservation node-js-app information [defaults]
        cpu: 100
        memory: 100
        memory-swap:
        network:
        network-ingress:
        network-egress:
+       nvidia-gpu:
 ```
 
-#### Global Resource Reservations
-
-By default, Dokku does not reserve any resources, though these can be specified at the server level via the `--global` flag on the `resource:reserve` command.
+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 --global --memory 200
+dokku resource:reserve --process-type web node-js-app
 ```
 
 ```
-=====> Setting default resource reservation
-       memory: 200
-```
-
-This may also be combined with the `--process-type` flag to set global reservations on a process-type level:
-
-```shell
-dokku resource:reserve --global --memory 150 --process-type web node-js-app
-```
-
-```
-=====> Setting default resource reservation (web)
-       memory: 150
-```
-
-#### Displaying Global Resource Reservations
-
-Running the `resource:reserve` command with only the `--global` flag will display the currently configured default reservation.
-
-```shell
-dokku resource:reserve --global
-```
-
-```
-=====> resource reservation default information
-       cpu:
-       memory: 200
+=====> resource reservation node-js-app information (web)
+       cpu: 100
+       memory: 100
        memory-swap:
        network:
        network-ingress:
        network-egress:
-```
-
-This may also be combined with the `--process-type` flag to see global reservations on a process-type level:
-
-```shell
-dokku resource:reserve --global --process-type web
-```
-
-```
-=====> resource reservation default information (web)
-       cpu:
-       memory-swap:
-       memory: 150
-       network-egress:
-       network-ingress:
-       network:
+       nvidia-gpu:
 ```
 
 #### Clearing Resource Reservations
@@ -313,12 +265,14 @@ dokku resource:report
        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:
@@ -326,12 +280,14 @@ dokku resource:report
        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:
@@ -339,12 +295,14 @@ dokku resource:report
        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.
@@ -361,12 +319,14 @@ dokku resource:report node-js-app
        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:

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

@@ -44,15 +44,18 @@ This plugin implements various functionality through `plugn` triggers to integra
 - `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-logs-failed`
+- `scheduler-is-deployed`
 - `scheduler-logs`
+- `scheduler-logs-failed`
 - `scheduler-retire`
 - `scheduler-run`
 - `scheduler-stop`
@@ -65,10 +68,16 @@ The `docker-local` scheduler supports a minimal list of resource _limits_ and _r
 
 ### Resource Limits
 
-- cpu: (docker option: `--cpus`), and is specified in number of CPUs a process can access.
-- memory: (docker option: `--memory`) and should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes)
-- memory-swap: (docker option: `--memory-swap`) and should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes)
+- 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`) and should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes)
+- 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.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/assets/favicons/browserconfig.xml

@@ -2,10 +2,10 @@
 <browserconfig>
   <msapplication>
     <tile>
-      <square70x70logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.16.3/docs/assets/favicons/mstile-70x70.png"/>
-      <square150x150logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.16.3/docs/assets/favicons/mstile-150x150.png"/>
-      <square310x310logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.16.3/docs/assets/favicons/mstile-310x310.png"/>
-      <wide310x150logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.16.3/docs/assets/favicons/mstile-310x150.png"/>
+      <square70x70logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.23.2/docs/assets/favicons/mstile-70x70.png"/>
+      <square150x150logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.23.2/docs/assets/favicons/mstile-150x150.png"/>
+      <square310x310logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.23.2/docs/assets/favicons/mstile-310x310.png"/>
+      <wide310x150logo src="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.23.2/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.16.3\/docs\/assets\/favicons\/android-chrome-36x36.png",
+            "src": "https:\/\/cdn.jsdelivr.net\/dokku\/dokku@v0.23.2\/docs\/assets\/favicons\/android-chrome-36x36.png",
             "sizes": "36x36",
             "type": "image\/png",
             "density": "0.75"
         },
         {
-            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.16.3\/docs\/assets\/favicons\/android-chrome-48x48.png",
+            "src": "https:\/\/cdn.jsdelivr.net\/dokku\/dokku@v0.23.2\/docs\/assets\/favicons\/android-chrome-48x48.png",
             "sizes": "48x48",
             "type": "image\/png",
             "density": "1.0"
         },
         {
-            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.16.3\/docs\/assets\/favicons\/android-chrome-72x72.png",
+            "src": "https:\/\/cdn.jsdelivr.net\/dokku\/dokku@v0.23.2\/docs\/assets\/favicons\/android-chrome-72x72.png",
             "sizes": "72x72",
             "type": "image\/png",
             "density": "1.5"
         },
         {
-            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.16.3\/docs\/assets\/favicons\/android-chrome-96x96.png",
+            "src": "https:\/\/cdn.jsdelivr.net\/dokku\/dokku@v0.23.2\/docs\/assets\/favicons\/android-chrome-96x96.png",
             "sizes": "96x96",
             "type": "image\/png",
             "density": "2.0"
         },
         {
-            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.16.3\/docs\/assets\/favicons\/android-chrome-144x144.png",
+            "src": "https:\/\/cdn.jsdelivr.net\/dokku\/dokku@v0.23.2\/docs\/assets\/favicons\/android-chrome-144x144.png",
             "sizes": "144x144",
             "type": "image\/png",
             "density": "3.0"
         },
         {
-            "src": "https:\/\/cdn.rawgit.com\/progrium\/dokku\/v0.16.3\/docs\/assets\/favicons\/android-chrome-192x192.png",
+            "src": "https:\/\/cdn.jsdelivr.net\/dokku\/dokku@v0.23.2\/docs\/assets\/favicons\/android-chrome-192x192.png",
             "sizes": "192x192",
             "type": "image\/png",
             "density": "4.0"

docs/assets/style.css

@@ -39,13 +39,13 @@ h1 {
   font-size: 1.6em;
 }
 .header .navbar-brand a {
-  background-image: url(https://cdn.jsdelivr.net/gh/dokku/dokku@v0.16.3/docs/assets/dokku.png);
+  background-image: url(https://cdn.jsdelivr.net/gh/dokku/dokku@v0.23.2/docs/assets/dokku.png);
   text-indent: 40px;
 }
 .blurb {
   color: #424242;
   background-color: #ededed;
-  background-image: url(https://cdn.jsdelivr.net/gh/dokku/dokku@v0.16.3/docs/assets/gplaypattern.png);
+  background-image: url(https://cdn.jsdelivr.net/gh/dokku/dokku@v0.23.2/docs/assets/gplaypattern.png);
   padding: 45px 0;
   text-align: center;
 }

docs/assets/versions.json

@@ -13,6 +13,13 @@
     "0.13.4",
     "0.14.6",
     "0.15.5",
-    "0.16.3"
+    "0.16.4",
+    "0.17.9",
+    "0.18.5",
+    "0.19.13",
+    "0.20.4",
+    "0.21.4",
+    "0.22.9",
+    "0.23.2"
   ]
 }

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

@@ -18,29 +18,30 @@ Let's take a quick look at the current Dokku nginx plugin that's shipped with Do
 
 [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
 
@@ -58,6 +59,7 @@ The following plugins are available and provided by Dokku maintainers. Where not
 [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
@@ -72,10 +74,10 @@ The following plugins are available and provided by Dokku maintainers. Where not
 [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
@@ -129,6 +131,7 @@ The following plugins are available and provided by Dokku maintainers. Where not
 [sarendsen]: https://github.com/sarendsen
 [baikunz]: https://github.com/baikunz
 [lazyatom]: https://github.com/lazyatom
+[ollej]: https://github.com/ollej
 
 ### Datastores
 
@@ -182,9 +185,8 @@ The following plugins are available and provided by Dokku maintainers. Where not
 | [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+                |
-| [Dockerfile custom path](https://github.com/mimischi/dokku-dockerfile)                            | [mimischi][]          | 0.8.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+                |
+| [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+                |
@@ -195,27 +197,31 @@ The following plugins are available and provided by Dokku maintainers. Where not
 | [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+                |
 | [robots.txt](https://notabug.org/candlewaster/dokku-robots.txt)                                   | [candlewaster][]      | 0.4.x                 |
-| [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                 |
+| [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                 |
@@ -242,6 +248,10 @@ The following plugins are available and provided by Dokku maintainers. Where not
 | [Wkhtmltopdf](https://github.com/mbriskar/dokku-wkhtmltopdf)                                      | [mbriskar][]          | 0.4.0+                |
 | [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
 
@@ -297,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/deploying-with-gitlab-ci.md

@@ -1,108 +0,0 @@
-# Deploying with Gitlab CI
-
-Gitlab-CI can be used to automatically deploy a Dokku application using the [ilyasemenov/gitlab-ci-git-push image](https://github.com/IlyaSemenov/gitlab-ci-git-push) docker image.
-
-## Prerequisites
-
-Make sure you have a Gitlab account and a Dokku project hosted on Gitlab. This method works whether if you are using buildpacks or Dockerfile.
-
-Make sure you have set up an app on the remote machine following [these instructions](http://dokku.viewdocs.io/dokku/deployment/application-deployment/) and can successfully deploy to it from the local machine.
-
-## Deploy automatically to production
-
-### Add a secret variable
-
-Browse to the repository in question and visit the following path: `the Gitlab project > Settings > CI/CD.`
-
-Click on `Secret variables > Expand` and fill in the blanks.
-
-- Key: `SSH_PRIVATE_KEY`
-- Value: paste in an SSH private key registered in Dokku:
-
-    -----BEGIN RSA PRIVATE KEY-----
-    ...
-    -----END RSA PRIVATE KEY-----
-
-- Environment scope: `production` (This make sure that `SSH_PRIVATE_KEY` is not available on merge requests or tests)
-- Protected: Do not check this checkbox unless you know what you are doing
-
-### Add CI script
-
-Create a file named `.gitlab-ci.yml` at the root directory of the repository with the following contents:
-
-```yaml
-stages:
-  - deploy
-
-variables:
-  APP_NAME: node-js-app
-
-deploy:
-  image: ilyasemenov/gitlab-ci-git-push
-  stage: deploy
-  environment:
-    name: production
-    url: https://$APP_NAME.dokku.me/
-  only:
-    - master
-  script:
-    - git-push ssh://dokku@dokku.me:22/$APP_NAME
-```
-
-You will need to modify the `APP_NAME` variable to the correct value for your application name.
-
-Running `git push origin master` will now trigger a gitlab-ci pipeline that will automatically deploy your application to your Dokku server. Go to your project on Gitlab and visit "Project > Pipelines" to see the deployment log.
-
-
-## Review Applications
-
-One useful feature of gitlab is to be able to create review applications for non-production branches. This allows teams to review changes _before_ they are pushed to production. First, recreate the `SSH_PRIVATE_KEY` secret - do not delete the existing secret - but scoped to the `review/*` environment. This will allow non-production gitlab environments access to the secret.
-
-Next, we'll need to create the `review_app` gitlab job in our `.gitlab-ci.yaml`.
-
-```yaml
-review_app:
-  image: ilyasemenov/gitlab-ci-git-push
-  stage: deploy
-  environment:
-    name: review/$CI_COMMIT_REF_NAME
-    url: https://$CI_ENVIRONMENT_SLUG.dokku.me/
-    on_stop: stop_review_app
-  only:
-    - branches
-  except:
-    - master
-  script:
-    - mkdir -p ~/.ssh && echo "$SSH_PRIVATE_KEY" | tr -d '\r' > ~/.ssh/id_rsa && chmod 600 ~/.ssh/id_rsa
-    - ssh-keyscan -H 22 "dokku.me" >> ~/.ssh/known_hosts
-    - ssh -t dokku@dokku.me -- apps:clone --ignore-existing --skip-deploy "$APP_NAME" "$CI_ENVIRONMENT_SLUG"
-    - git-push ssh://dokku@dokku.me:22/$CI_ENVIRONMENT_SLUG
-```
-
-The first two lines ensure that Gitlab can talk to the Dokku server. Next, we take advantage of the `apps:clone` command, and clone the existing application and all of it's configuration to a new location. If the new application already exists, the third line of the `script` step will be ignored. We also ignore the first deploy script to speed up the cloning process. Finally, the fourth line of the `script` step will deploy the code as normal.
-
-The above only runs for non-master branches, and will _also_ trigger an `on_stop` job called `stop_review_app`. When the branch is deleted or the code is merged, the `stop_review_app` job will be triggered.
-
-```yaml
-stop_review_app:
-  image: ilyasemenov/gitlab-ci-git-push
-  stage: deploy
-  variables:
-    GIT_STRATEGY: none
-  environment:
-    name: review/$CI_COMMIT_REF_NAME
-    action: stop
-  when: manual
-  script:
-    - mkdir -p ~/.ssh && echo "$SSH_PRIVATE_KEY" | tr -d '\r' > ~/.ssh/id_rsa && chmod 600 ~/.ssh/id_rsa
-    - ssh-keyscan -H 22 "dokku.me" >> ~/.ssh/known_hosts
-    - ssh -t dokku@dokku.me -- --force apps:destroy "$CI_ENVIRONMENT_SLUG"
-```
-
-The `stop_review_app` step will delete the temporary application, cleaning up now unused server resources.
-
-Going further, the following modifications can be done:
-
-- Notify via chat whenever a review application is created/destroyed.
-- Push to a separate, staging server as opposed to a production server.
-- Clone a "staging" application so that review applications do not affect production datasets.

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

@@ -36,7 +36,7 @@ Move the data on the volume
 
 ```shell
 mkdir /mnt/volume/home/
-mkdir /mnt/volume/var/lib/
+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

docs/configuration/domains.md

@@ -28,21 +28,10 @@ scheme://subdomain.domain.tld
 
 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 global virtualhost 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` plugin has no output, the normal hostname algorithm will be executed.
 
 ## Disabling VHOSTS
 
@@ -64,7 +53,7 @@ The domains plugin allows you to specify custom domains for applications. This p
 dokku domains:add node-js-app dokku.me
 
 # list custom domains for app
-dokku domains node-js-app
+dokku domains:report node-js-app
 
 # clear all custom domains for app
 dokku domains:clear node-js-app
@@ -89,17 +78,17 @@ dokku domains:report
 ```
 =====> node-js-app domains information
        Domains app enabled: true
-       Domains app vhosts:  node-js-sample.dokku.org
+       Domains app vhosts:  node-js-app.dokku.org
        Domains global enabled: true
        Domains global vhosts: dokku.org
-=====> python-sample domains information
+=====> python-app domains information
        Domains app enabled: true
-       Domains app vhosts:  python-sample.dokku.org
+       Domains app vhosts:  python-app.dokku.org
        Domains global enabled: true
        Domains global vhosts: dokku.org
-=====> ruby-sample domains information
+=====> ruby-app domains information
        Domains app enabled: true
-       Domains app vhosts:  ruby-sample.dokku.org
+       Domains app vhosts:  ruby-app.dokku.org
        Domains global enabled: true
        Domains global vhosts: dokku.org
 ```
@@ -126,41 +115,4 @@ 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.
-
-Create the file at `/etc/nginx/conf.d/00-default-vhost.conf`:
-
-```nginx
-server {
-    listen 80 default_server;
-    server_name _;
-    access_log off;
-    return 410;
-}
-
-# 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;
-#     server_name _;
-#     ssl_certificate /etc/nginx/ssl/cert.crt;
-#     ssl_certificate_key /etc/nginx/ssl/cert.key;
-#     access_log off;
-#     return 410;
-# }
-```
-
-Make sure to reload nginx after creating this file by running `service nginx reload`.
-
-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).
-
-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.
+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

@@ -6,12 +6,13 @@ The `config` plugin provides the following commands to manage your variables:
 
 ```
 config (<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
-config:export (<app>|--global) [--envfile]                                            Export a global or app environment
-config:keys (<app>|--global) [--merged]                                               Show keys set in environment
-config:bundle (<app>|--global) [--merged]                                             Bundle environment into tarfile
 ```
 > 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).
 
@@ -70,14 +71,14 @@ dokku config:export --format shell node-js-app
 
 ## Special Config Variables
 
-The following list config variables have special meaning and can be set in a variety of ways.
+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. |
+| `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. |
@@ -86,13 +87,15 @@ The following list config variables have special meaning and can be set in a var
 | `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`             | `http://dokku.viewdocs.io/dokku/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 false` <br /> `--trace` flag                                                                              | Turn on very verbose debugging. |
+| `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. |
@@ -108,18 +111,18 @@ The following list config variables have special meaning and can be set in a var
 | `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_CMD`         | dockerfile cmd                  | `dokku config:set`                                                                                                                               | |
 | `DOKKU_DOCKERFILE_CACHE_BUILD` | none                            | `dokku config:set`                                                                                                                               | |
-| `DOKKU_DOCKERFILE_ENTRYPOINT`  | dockerfile entrypoint           | `dokku config:set`                                                                                                                               | |
 | `DOKKU_DOCKERFILE_PORTS`       | dockerfile ports                | `dokku config:set`                                                                                                                               | |
 | `DOKKU_DOCKERFILE_START_CMD`   | none                            | `dokku config:set`                                                                                                                               | |
-| `DOKKU_PROXY_PORT`             | automatically assigned          | `dokku config:set`                                                                                                                               | |
-| `DOKKU_PROXY_SSL_PORT`         | automatically assigned          | `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,12 +4,78 @@ 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:validate [<app>] [--clean]         # Validates and optionally cleans up invalid nginx configurations
+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
 ```
 
-## Checking access logs
+## 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 `nginx: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`.
 
@@ -23,9 +89,9 @@ You may also follow the logs by specifying the `-t` flag.
 dokku nginx:access-logs node-js-app -t
 ```
 
-## Checking error logs
+### Checking error logs
 
-You may check nginx error logs via the `nginx:access-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`.
+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
@@ -37,39 +103,116 @@ You may also follow the logs by specifying the `-t` flag.
 dokku nginx:error-logs node-js-app -t
 ```
 
-## Regenerating nginx config
+### Changing log path
 
-In certain cases, your app nginx configs may drift from the correct config for your app. You may regenerate the config at any point via the `nginx:build-config` command. This may fail if there are no current web listeners for your app.
+> 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:build-config node-js-app
+dokku nginx:set node-js-app access-log-path off
+dokku nginx:set node-js-app error-log-path off
 ```
 
-## Validating nginx configs
-
-It may be desired to validate an nginx config outside of the deployment process. To do so, run the `nginx:validate` 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.
+The default value may be set by passing an empty value for the option:
 
 ```shell
-dokku nginx:validate
+dokku nginx:set node-js-app access-log-path
+dokku nginx:set node-js-app error-log-path
 ```
 
-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` command is the exit code of `nginx -t` against the server's real nginx config.
+In all cases, the nginx config must be regenerated after setting the above values.
 
-The `nginx:validate` command also takes an optional `--clean` flag. If specified, invalid nginx configs will be removed.
+### 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
+```
+
+### 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 --clean
+dokku nginx:validate-config --clean
 ```
 
 The `--clean` flag may also be specified for a given app:
 
 ```shell
-dokku nginx:validate node-js-app --clean
+dokku nginx:validate-config node-js-app --clean
 ```
 
-## Customizing the nginx configuration
+### Customizing the nginx configuration
 
 > New as of 0.5.0
 
@@ -77,20 +220,33 @@ Dokku uses a templating library by the name of [sigil](https://github.com/glider
 
 - Copy the following example template to a file named `nginx.conf.sigil` and either:
   - If using a buildpack application, you __must__ check it into the root of your app repo.
-  - `ADD` it to your dockerfile `WORKDIR`
-  - if your dockerfile has no `WORKDIR`, `ADD` it to the `/app` folder
+  - 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`.
 
 > 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.
 
-### Available template variables
+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.
+
+```shell
+# enable fetching custom config (default)
+dokku nginx:set node-js-app disable-custom-config false
+
+# disable fetching custom config
+dokku nginx:set node-js-app disable-custom-config true
+```
+
+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
 {{ .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
@@ -101,9 +257,11 @@ Dokku uses a templating library by the name of [sigil](https://github.com/glider
 {{ .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`.
 
-### 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):
 
@@ -111,11 +269,11 @@ The default nginx.conf template will include everything from your apps `nginx.co
 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/node-js-app/nginx.conf.d/
-echo 'client_max_body_size 50m;' > /home/dokku/node-js-app/nginx.conf.d/upload.conf
+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
 ```
@@ -125,10 +283,10 @@ The example above uses additional configuration files directly on the Dokku host
 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`
 
     web: vendor/bin/heroku-php-nginx -C nginx.conf -i php.ini php/
-    
+
 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:
 
-    client_max_body_size 50m;
+    client_header_timeout 50s;
     location / {
         index index.php;
         try_files $uri $uri/ /index.php$is_args$args;
@@ -136,7 +294,7 @@ Your `nginx.conf` file - not to be confused with Dokku's `nginx.conf.sigil` - wo
 
 Please adjust the `Procfile` and `nginx.conf` file as appropriate.
 
-## Custom Error Pages
+### Custom Error Pages
 
 By default, Dokku provides custom error pages for the following three categories of errors:
 
@@ -146,38 +304,80 @@ By default, Dokku provides custom error pages for the following three categories
 
 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.
 
-## Domains plugin
+### Default site
 
-See the [domain configuration documentation](/docs/configuration/domains.md).
+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.
 
-## Customizing hostnames
+Create the file at `/etc/nginx/conf.d/00-default-vhost.conf`:
 
-See the [customizing hostnames documentation](/docs/configuration/domains.md#customizing-hostnames).
+```nginx
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server;
 
-## Disabling VHOSTS
+    server_name _;
+    access_log off;
+    return 410;
+}
 
-See the [disabling vhosts documentation](/docs/configuration/domains.md#disabling-vhosts).
+# 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;
+# }
+```
 
-## Default site
+Make sure to reload nginx after creating this file by running `service nginx reload`.
 
-See the [default site documentation](/docs/configuration/domains.md#default-site).
+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).
 
-## Running behind a load balancer
+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.
 
-See the [load balancer documentation](/docs/configuration/ssl.md#running-behind-a-load-balancer).
+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.
 
-## HSTS Header
+## Other
 
-See the [HSTS documentation](/docs/configuration/ssl.md#hsts-header).
+### Domains plugin
 
-## SSL Configuration
+See the [domain configuration documentation](/docs/configuration/domains.md) for more information on how to configure domains for your app.
 
-See the [ssl documentation](/docs/configuration/ssl.md).
+### Customizing hostnames
 
-## Disabling Nginx
+See the [customizing hostnames documentation](/docs/configuration/domains.md#customizing-hostnames) for more information on how to configure domains for your app.
 
-See the [proxy documentation](/docs/advanced-usage/proxy-management.md).
+### Disabling VHOSTS
 
-## Managing Proxy Port mappings
+See the [disabling vhosts documentation](/docs/configuration/domains.md#disabling-vhosts) for more information on how to disable domain usage for your app.
 
-See the [proxy documentation](/docs/advanced-usage/proxy-management.md#proxy-port-mapping).
+### 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/advanced-usage/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/advanced-usage/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/advanced-usage/proxy-management.md#regenerating-proxy-config) for more information on how to rebuild the nginx proxy configuration for your app.

docs/configuration/ssl.md

@@ -9,6 +9,7 @@ certs:add <app> CRT KEY                  # Add an ssl endpoint to an app. Can al
 certs:generate <app> DOMAIN              # Generate a key and certificate signing request (and self-signed certificate)
 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
 ```
 
@@ -56,6 +57,16 @@ If you decide to obtain a CA signed certificate, you can import that certificate
 
 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
@@ -67,17 +78,17 @@ dokku certs:report
 ```
 
 ```
-=====> node-js-sample
-       Ssl dir:             /home/dokku/node-js-sample/tls
+=====> node-js-app
+       Ssl dir:             /home/dokku/node-js-app/tls
        Ssl enabled:         true
-       Ssl hostnames:       *.node-js-sample.org node-js-sample.org
+       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-sample.org
+       Ssl subject:         OU=Domain Control Validated; OU=PositiveSSL Wildcard; CN=*.node-js-app.org
        Ssl verified:        self signed.
-=====> python-sample
-       Ssl dir:             /home/dokku/python-sample/tls
+=====> python-app
+       Ssl dir:             /home/dokku/python-app/tls
        Ssl enabled:         false
        Ssl hostnames:
        Ssl expires at:
@@ -90,12 +101,12 @@ dokku certs:report
 You can run the command for a specific app also.
 
 ```shell
-dokku certs:report node-js-sample
+dokku certs:report node-js-app
 ```
 
 ```
-=====> node-js-sample ssl information
-       Ssl dir:             /home/dokku/node-js-sample/tls
+=====> 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
@@ -108,14 +119,14 @@ dokku certs:report node-js-sample
 You can pass flags which will output only the value of the specific information you want. For example:
 
 ```shell
-dokku certs:report node-js-sample --ssl-enabled
+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
 
@@ -125,44 +136,19 @@ Certain versions of nginx have bugs that prevent [HTTP/2](https://nginx.org/en/d
 
 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](/docs/configuration/nginx.md#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      [::]:{{ .PROXY_PORT }};
-  listen      {{ .PROXY_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.
-
-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.
+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.
 
 ### SSL Port Exposure
 

docs/deployment/application-deployment.md

@@ -1,6 +1,6 @@
 # Deploying to Dokku
 
-> Note: This walkthrough uses the hostname `dokku.me` in commands. When deploying to your own server, you should set the `DOKKU_DOMAIN` value in the `Vagrantfile` before you initialize the Vagrant VM.
+> 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
 
@@ -9,7 +9,7 @@ Once you have configured Dokku with at least one user, you can deploy applicatio
 ```shell
 # from your local machine
 # SSH access to github must be enabled on this host
-git clone git@github.com:heroku/ruby-getting-started.git
+git clone https://github.com/heroku/ruby-getting-started
 ```
 
 ### Create the app
@@ -62,7 +62,7 @@ Now you can deploy the `ruby-getting-started` app to your Dokku server. All you
 # 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 master
+git push dokku main:master
 ```
 
 > Note: Some tools may not support the short-upstream syntax referenced above, and you may need to prefix
@@ -71,7 +71,7 @@ git push dokku master
 
 > 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 master`, you should have output similar to this in your terminal:
+After running `git push dokku main:master`, you should have output similar to this in your terminal:
 
 ```
 Counting objects: 231, done.
@@ -100,8 +100,12 @@ Total 231 (delta 93), reused 147 (delta 53)
 
 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), as well as by 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/methods/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/methods/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.
 
 ### Skipping deployment
 
@@ -121,7 +125,7 @@ If you need to redeploy or restart your app:
 dokku ps:rebuild ruby-getting-started
 ```
 
-See the [process scaling documentation](/docs/deployment/process-management.md) for more information.
+See the [process scaling documentation](/docs/deployment/process-management.md) for more information on how to manage your app processes.
 
 ### Deploying with private Git submodules
 
@@ -143,8 +147,9 @@ If you do not enter a fully qualified domain name when pushing your app, Dokku d
 ```shell
 # 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 master
+git push dokku main:master
 ```
 
 ```
@@ -158,7 +163,7 @@ You can also specify the fully qualified name as follows:
 # 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
 ```
 
 ```
@@ -172,7 +177,7 @@ This is useful when you want to deploy to the root domain:
 # 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 ...
@@ -188,36 +193,36 @@ Prior to every deployment, Dokku will execute a cleanup function. As of 0.5.x, t
 
 ## Adding deploy users
 
-See the [user management documentation](/docs/deployment/user-management.md).
+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](/docs/configuration/nginx.md#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).
+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](/docs/deployment/methods/dockerfiles.md).
+See the [Dockerfile documentation](/docs/deployment/methods/dockerfiles.md) for information Dokku's Dockerfile support.
 
 ## Image tagging
 
-See the [image tagging documentation](/docs/deployment/methods/images.md).
+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 [buildpack documentation](/docs/deployment/methods/buildpacks.md).
+See the [herokuish buildpack documentation](/docs/deployment/methods/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](/docs/deployment/application-management.md#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
 
-See the [application management documentation](/docs/deployment/application-management.md#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](/docs/deployment/zero-downtime-deploys.md).
+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

@@ -103,6 +103,16 @@ 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).
 
 ### Renaming a deployed app
@@ -134,6 +144,12 @@ 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
@@ -157,7 +173,7 @@ This will copy all of your app's contents into a new app directory with the name
 
 > 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 application, though you can skip the deploy by using the `--skip-deploy` flag:
+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
@@ -228,18 +244,18 @@ dokku apps:report
 ```
 
 ```
-=====> node-js-app
+=====> node-js-app app information
        App dir:             /home/dokku/node-js-app
-       Git sha:             dbddc3f
-       Deploy source:       git
-       Locked:              false
-=====> python-sample
-not deployed
-=====> ruby-sample
+       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
-       Git sha:             a2d477c
-       Deploy source:       git
-       Locked:              false
+       App deploy source:   git
+       App locked:          false
 ```
 
 You can run the command for a specific app also.
@@ -249,15 +265,14 @@ dokku apps:report node-js-app
 ```
 
 ```
-=====> node-js-app
+=====> node-js-app app information
        App dir:             /home/dokku/node-js-app
-       Git sha:             dbddc3f
-       Deploy source:       git
-       Locked:              false
+       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 --git-sha
+dokku apps:report node-js-app --app-dir
 ```

docs/deployment/continuous-integration/generic.md

@@ -0,0 +1,25 @@
+# Generic CI/CD Integration
+
+In cases where there is no direct or documented integration available, the Dokku project provides an [Official Docker Image](https://github.com/dokku/ci-docker-image) for use in Continuous Integration/Continuous Deployment (CI/CD) systems.
+
+Assuming a Docker image can be run as a CI task with environment variables injected, the following CI systems will have their variables automatically detected:
+
+- [circleci](https://circleci.com/)
+- [cloudbees](https://www.cloudbees.com/)
+- [drone](https://www.drone.io/)
+- [github actions](https://github.com/features/actions)
+- [gitlab-ci](https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/)
+- [semaphoreci](https://semaphoreci.com/)
+- [travisci](https://travis-ci.com/)
+
+## Simple Usage
+
+The simplest usage of the image is as follows.
+
+```shell
+# where the `.env` file contains `GIT_REMOTE_URL` and `SSH_PRIVATE_KEY`
+
+docker run --rm -v="$PWD:/app" --env-file=.env dokku/ci-docker-image dokku-deploy
+```
+
+For more configuration examples and further documentation, see the [ci-docker-image](https://github.com/dokku/ci-docker-image) readme.

docs/deployment/continuous-integration/github-actions.md

@@ -0,0 +1,31 @@
+# Github Actions
+
+The Dokku project has an official Githb Action available on the [Github Marketplace](https://github.com/marketplace/actions/dokku). The simplest usage example is as follows:
+
+```yaml
+---
+name: 'deploy'
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cloning repo
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Push to dokku
+        uses: dokku/github-action@v1
+        with:
+          git_remote_url: 'ssh://dokku@dokku.me:22/appname'
+          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+```
+
+
+For further usage documentation and other advanced examples, see the entry on the [Github Marketplace](https://github.com/marketplace/actions/dokku).

docs/deployment/continuous-integration/gitlab-ci.md

@@ -0,0 +1,25 @@
+# Gitlab CI
+
+Gitlab-CI can be used to automatically deploy a Dokku application via the official the [dokku/ci-docker-image](https://github.com/dokku/ci-docker-image). The simplest example is as follows:
+
+```
+---
+image: dokku/ci-docker-image
+
+stages:
+  - deploy
+
+variables:
+  GIT_DEPTH: 0
+
+deploy:
+  stage: deploy
+  only:
+    - master
+  variables:
+    GIT_REMOTE_URL: ssh://dokku@dokku.me:22/appname
+  script: dokku-deploy
+  after_script: dokku-unlock
+```
+
+For further usage documentation and other advanced examples, see Dokku's [gitlab-ci](https://github.com/dokku/gitlab-ci) repository.

docs/deployment/logs.md

@@ -2,7 +2,12 @@
 
 ```
 logs <app> [-h] [-t] [-n num] [-q] [-p process]  # Display recent log output
-logs:failed [<app>]                              # Shows the last failed deploy logs
+logs:failed [--all|<app>]                        # Shows the last failed deploy logs
+logs:report [<app>] [<flag>]                     # Displays a logs report for one or more apps
+logs:set [--global|<app>] <key> <value>          # Set or clear a logs property for an app
+logs:vector-logs [--num num] [--tail]            # Display vector log output
+logs:vector-start                                # Start the vector logging container
+logs:vector-stop                                 # Stop the vector logging container
 ```
 
 ## Usage
@@ -36,18 +41,137 @@ will show logs continually from the web process.
 
 ### Failed deploy logs
 
-> Warning: The default `docker-local` scheduler will "store" these until the next deploy or until the old containers are garbage collected - whichever runs first. If you require the logs beyond this point in time, please ship the logs to a centralized log server.
+> Warning: The default [docker-local scheduler](/docs/advanced-usage/schedulers/docker-local.md) will "store" these until the next deploy or until the old containers are garbage collected - whichever runs first. If you require the logs beyond this point in time, please ship the logs to a centralized log server.
 
 In some cases, it may be useful to retrieve the logs from a previously failed deploy.
 
-You can retrieve these logs by using the `logs:failed` command
+You can retrieve these logs by using the `logs:failed` command.
 
 ```shell
 dokku logs:failed node-js-app
 ```
 
-You can also retrieve the failed logs for each app:
+You may also fetch all failed app logs by using the `--all` flag.
 
 ```shell
-dokku logs:failed node-js-app
+dokku logs:failed --all
 ```
+
+### Docker Log Retention
+
+Docker log retention can be specified via the `logs:set` command by specifying a value for `max-size`. Log retention is set via injected docker options for all applications, but is also available via the `logs-get-property` trigger for alternative schedulers.
+
+```shell
+dokku logs:set node-js-app max-size 20m
+```
+
+The default value may be set by passing an empty value for the option:
+
+```shell
+dokku logs:set node-js-app max-size
+```
+
+Valid values include any integer number followed by a unit of measure (`k`, `m`, or `g`) or the string `unlimited`. Setting to `unlimited` will result in Dokku omitting the log option.
+
+The `max-size` property can also be set globally. The global default is `10m`, and the global value is used when no app-specific value is set.
+
+```shell
+dokku logs:set --global max-size 20m
+```
+
+The default value may be set by passing an empty value for the option.
+
+```shell
+dokku logs:set --global max-size
+```
+
+### Vector Logging Shipping
+
+> New as of 0.22.6
+
+Vector is an open-source, lightweight and ultra-fast tool for building observability pipelines. Dokku integrates with it for shipping container logs for the `docker-local` scheduler. Users may configure log-shipping on a per-app or global basis, neither of which interfere with the `dokku logs` commands.
+
+#### Starting the Vector container
+
+> Warning: While the default vector image may be updated over time, this will not impact running vector containers. Users are encouraged to view any Dokku and Vector changelogs to ensure their system will continue running as expected.
+
+Vector may be started via the `logs:vector-start` command.
+
+```shell
+dokku logs:vector-start
+```
+
+This will start a new container named `vector` with Dokku's vector config mounted and ready for use. If a running container already exists, this command will do nothing. Additionally, if a container exists but is not running, this command will attempt to start the container.
+
+While the default vector image is hardcoded, users may specify an alternative via the `--vector-image` flag:
+
+```shell
+dokku logs:vector-start --vector-image timberio/vector:latest-debian
+```
+
+The `vector` container will be started with the following volume mounts:
+
+- `/var/lib/dokku/data/logs/vector.json:/etc/vector/vector.json`
+- `/var/run/docker.sock:/var/run/docker.sock`
+- `/var/log/dokku/apps:/var/log/dokku/apps`
+
+The final volume mount - `/var/log/dokku/apps` - may be used for users that wish to ship logs to a file on disk that may be later logrotated. This directory is owned by the `dokku` user and group, with permissions set to `0755`. At this time, log-rotation is not configured for this directory.
+
+#### Stopping the Vector container
+
+Vector may be stopped via the `logs:vector-stop` command.
+
+```shell
+dokku logs:vector-stop
+```
+
+The `vector` container will be stopped and removed from the system. If the container is not running, this command will do nothing.
+
+#### Configuring a log sink
+
+Vector uses the concept of log "sinks" to send logs to a given endpoint. Log sinks may be configured globally or on a per-app basis by specifying a `vector-sink` in DSN form with the `logs:set` command. Specifying a sink value will reload any running vector container.
+
+```shell
+# setting the sink value in quotes is encouraged to avoid
+# issues with ampersand encoding in shell commands
+dokku logs:set node-js-app sink "console://?encoding[codec]=json"
+```
+
+A sink may be removed by setting an empty value, which will also reload the running vector container.
+
+```shell
+dokku logs:set node-js-app vector-sink
+```
+
+Only one sink may be specified on a per-app basis at a given time.
+
+Log sinks can also be specified globally by specifying the `--global` flag to `logs:set` with no app name specified:
+
+```shell
+dokku logs:set --global vector-sink "console://?encoding[codec]=json"
+```
+
+As with app-specific sink settings, the global value may also be cleared by setting no value.
+
+```shell
+dokku logs:set --global vector-sink
+```
+
+##### Log Sink DSN Format
+
+The DSN form of a sink is as follows:
+
+```
+SINK_TYPE://?SINK_OPTIONS
+```
+
+Valid values for `SINK_TYPE` include all log vector log sinks, while `SINK_OPTIONS` is a query-string form for the sink's options. The following is a short description on how to set various values:
+
+- `bool`: form: `key=bool`
+- `string`: form: `key=string`
+- `int`: form: `key=int`
+- `[string]`: form: `key[]=string`
+- `[int]`: form: `key[]=int`
+- `table`: form: `option[key]=value
+
+Please read the [sink documentation](https://vector.dev/docs/reference/sinks/) for your sink of choice to configure the sink as desired.

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

@@ -0,0 +1,64 @@
+# 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/methods/herokuish.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
+
+To use this builder instead of either `Dockerfile` or `herokuish`, you must set the `DOKKU_CNB_EXPERIMENTAL` environment variable for your app to `1`.
+
+```shell
+dokku config:set --no-restart node-js-app DOKKU_CNB_EXPERIMENTAL=1
+```
+
+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
+```

docs/deployment/methods/dockerfiles.md

@@ -38,7 +38,7 @@ dokku docker-options:add node-js-app build '--file Dockerfile.dokku'
 Once set, the Dockerfile usage would be as follows:
 
 ```Dockerfile
-FROM debian:jessie
+FROM ubuntu:18.04
 
 # set the argument default
 ARG NODE_ENV=production
@@ -50,7 +50,7 @@ RUN echo $NODE_ENV
 You may also set the argument as an environment variable
 
 ```Dockerfile
-FROM debian:jessie
+FROM ubuntu:18.04
 
 # set the argument default
 ARG NODE_ENV=production
@@ -65,6 +65,10 @@ ENV NODE_ENV ${NODE_ENV}
 RUN echo $NODE_ENV
 ```
 
+## Building images with Docker Buildkit
+
+If your Dockerfile is using Docker engine's [buildkit](https://docs.docker.com/develop/develop-images/build_enhancements/) (not to be confused with buildpacks), then the `DOCKER_BUILDKIT=1` environment variable needs to be set. One way to do this is to edit `/etc/environment` on your dokku host and reboot your instance. Note, for complete build log output, you should also set `BUILDKIT_PROGRESS=plain` in the same file. 
+
 ## Customizing the run command
 
 By default no arguments are passed to `docker run` when deploying the container and the `CMD` or `ENTRYPOINT` defined in the `Dockerfile` are executed. You can take advantage of docker ability of overriding the `CMD` or passing parameters to your `ENTRYPOINT` setting `$DOKKU_DOCKERFILE_START_CMD`. Let's say for example you are deploying a base Node.js image, with the following `ENTRYPOINT`:
@@ -101,7 +105,7 @@ worker: bin/run-worker.sh
 And `Dockerfile`:
 
 ```Dockerfile
-FROM debian:jessie
+FROM ubuntu:18.04
 WORKDIR /app
 COPY . ./
 CMD ["bin/run-dev.sh"]
@@ -116,4 +120,4 @@ in your `Procfile` will be passed as arguments to the `ENTRYPOINT` script instea
 
 ## Exposed ports
 
-See the [port management documentation](/docs/networking/port-management.md).
+See the [port management documentation](/docs/networking/port-management.md) for more information on how Dokku exposes ports for applications and how you can configure these for your app.

docs/deployment/methods/git.md

@@ -3,12 +3,19 @@
 > Subcommands new as of 0.12.0
 
 ```
-git:initialize <app>                     # Initialize a git repository for an app
-git:report [<app>] [<flag>]              # Displays a git report for one or more apps
-git:set <app> <key> (<value>)            # Set or clear a git property for an app
+git:allow-host <host>                              # Adds a host to known_hosts
+git:sync [--build] <app> <repository> [<git-ref>] # Clone or fetch an app from remote git repo
+git:initialize <app>                               # Initialize a git repository for an app
+git:public-key                                     # Outputs the dokku public deploy key
+git:report [<app>] [<flag>]                        # Displays a git report for one or more apps
+git:set <app> <key> (<value>)                      # Set or clear a git property for an app
 ```
 
-Git-based deployment has been the traditional method of deploying applications in Dokku. As of v0.12.0, Dokku introduces a few ways to customize the experience of deploying via `git push`. A Git-based deployment currently supports building applications via both [Buildpack](/docs/deployment/methods/buildpacks.md) and [Dockerfile](/docs/deployment/methods/dockerfiles.md). 
+Git-based deployment has been the traditional method of deploying applications in Dokku. As of v0.12.0, Dokku introduces a few ways to customize the experience of deploying via `git push`. A Git-based deployment currently supports building applications via:
+
+- [Cloud Native Buildpacks](/docs/deployment/methods/cloud-native-buildpacks.md)
+- [Herokuish Buildpack](/docs/deployment/methods/herokuish-buildpacks.md)
+- [Dockerfiles](/docs/deployment/methods/dockerfiles.md)
 
 ## Usage
 
@@ -76,3 +83,75 @@ This behavior can be disabled entirely on a per-app basis by setting the `rev-en
 # override for a specific app
 dokku git:set node-js-app rev-env-var ""
 ```
+
+### Keeping the `.git` directory
+
+By default, Dokku will remove the contents of the `.git` before triggering a build for a given app. This is generally a safe default as shipping the entire source code history of your app in the deployed image artifact is unnecessary as it increases bloat and potentially can leak information if there are any security issues with your app code.
+
+To enable the `.git` directory, run the `git:set` command as follows:
+
+```shell
+# on the Dokku host
+
+# keep the .git directory during builds
+dokku git:set node-js-app keep-git-dir true
+```
+
+The default behavior is to delete this directory and it's contents. To revert to the default behavior, the `keep-git-dir` value can be set to either an empty string or `false`.
+
+```shell
+# on the Dokku host
+
+# delete the .git directory during builds (default)
+dokku git:set node-js-app keep-git-dir false
+
+# delete the .git directory during builds (default)
+dokku git:set node-js-app keep-git-dir ""
+```
+
+### Initializing an app repository from a remote repository
+
+> The application must exist before the repository can be initialized
+
+A Dokku app repository can be initialized or updated from a remote git repository via the `git:sync` command. This command will either clone or fetch updates from a remote repository and has undefined behavior if the history cannot be fast-fowarded to the referenced repository reference. Any repository that can be cloned by the `dokku` user can be specified.
+
+```shell
+dokku git:sync node-js-app https://github.com/heroku/node-js-getting-started.git
+```
+
+The `git:sync` command optionally takes an optional third parameter containing a git reference, which may be a branch, tag, or specific commit.
+
+```shell
+# specify a branch
+dokku git:sync node-js-app https://github.com/heroku/node-js-getting-started.git main
+
+# specify a tag
+dokku git:sync node-js-app https://github.com/heroku/node-js-getting-started.git 1
+
+# specify a commit
+dokku git:sync node-js-app https://github.com/heroku/node-js-getting-started.git 97e6c72491c7531507bfc5413903e0e00e31e1b0
+```
+
+By default, this command does not trigger an application build. To do so during a `git:sync`, specify the `--build` flag.
+
+```shell
+dokku git:sync --build node-js-app https://github.com/heroku/node-js-getting-started.git
+```
+
+### Allowing remote repository hosts
+
+By default, the Dokku host may not have access to a server containing the remote repository. This can be initialized via the `git:allow-host` command.
+
+```shell
+dokku git:allow-host github.com
+```
+
+Note that this command is currently not idempotent and may add duplicate entries to the `~dokku/.ssh/known_hosts` file.
+
+### Verifying the cloning public key
+
+In order to clone a remote repository, the remote server should have the Dokku host's public key configured. This plugin does not currently create this key, but if there is one available, it can be shown via the `git:public-key` command.
+
+```shell
+dokku git:public-key
+```

docs/deployment/methods/herokuish-buildpacks.md

@@ -1,14 +1,15 @@
-# Buildpack Deployment
+# Herokuish Buildpack Deployment
 
 > Subcommands new as of 0.15.0
 
 ```
-buildpacks:add [--index 1] <app> <buildpack>  # Add new app buildpack while inserting into list of buildpacks if necessary
-buildpacks:clear <app>                        # Clear all buildpacks set on the app
-buildpacks:list <app>                         # List all buildpacks for an app
-buildpacks:remove <app> <buildpack>           # Remove a buildpack set on the app
-buildpacks:report [<app>] [<flag>]            # Displays a buildpack report for one or more apps
-buildpacks:set [--index 1] <app> <buildpack>  # Set new app buildpack at a given position defaulting to the first buildpack if no index is specified
+buildpacks:add [--index 1] <app> <buildpack>            # Add new app buildpack while inserting into list of buildpacks if necessary
+buildpacks:clear <app>                                  # Clear all buildpacks set on the app
+buildpacks:list <app>                                   # List all buildpacks for an app
+buildpacks:remove <app> <buildpack>                     # Remove a buildpack set on the app
+buildpacks:report [<app>] [<flag>]                      # Displays a buildpack report for one or more apps
+buildpacks:set [--index 1] <app> <buildpack>            # Set new app buildpack at a given position defaulting to the first buildpack if no index is specified
+buildpacks:set-property [--global|<app>] <key> <value>  # Set or clear a buildpacks property for an app
 ```
 
 > Warning: If using the `buildpacks` plugin, be sure to unset any `BUILDPACK_URL` and remove any such entries from a committed `.env` file. A specified `BUILDPACK_URL` will always override a `.buildpacks` file or the buildpacks plugin.
@@ -123,6 +124,34 @@ The `buildpacks:clear` command can be used to clear all configured buildpacks fo
 dokku buildpacks:clear node-js-app
 ```
 
+### Customizing the Buildpack stack builder
+
+> New as of 0.23.0
+
+The default stack builder in use by Herokuish buildpacks in Dokku is based on `gliderlabs/herokuish:latest`. Typically, this is installed via an OS package which pulls the requisite Docker image. 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 gliderlabs/herokuish:latest
+```
+
+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_IMAGE` environment variable (`gliderlabs/herokuish:latest` by default).
+
+```shell
+# set globally
+dokku buildpacks:set-property --global stack gliderlabs/herokuish:latest
+
+# unset globally
+dokku buildpacks:set-property --global stack
+```
+
 ### Displaying buildpack reports for an app
 
 You can get a report about the app's buildpacks status using the `buildpacks:report` command:
@@ -133,11 +162,20 @@ dokku buildpacks:report
 
 ```
 =====> node-js-app buildpacks information
-       Buildpacks list:               https://github.com/heroku/heroku-buildpack-nodejs.git
+       Buildpacks computed stack:  gliderlabs/herokuish:v0.5.23-20
+       Buildpacks global stack:    gliderlabs/herokuish:latest
+       Buildpacks list:            https://github.com/heroku/heroku-buildpack-nodejs.git
+       Buildpacks stack:           gliderlabs/herokuish:v0.5.23-20
 =====> python-sample buildpacks information
-       Buildpacks list:               https://github.com/heroku/heroku-buildpack-nodejs.git,https://github.com/heroku/heroku-buildpack-python.git
+       Buildpacks computed stack:  gliderlabs/herokuish:v0.5.23-20
+       Buildpacks global stack:    gliderlabs/herokuish:latest
+       Buildpacks list:            https://github.com/heroku/heroku-buildpack-nodejs.git,https://github.com/heroku/heroku-buildpack-python.git
+       Buildpacks stack:
 =====> ruby-sample buildpacks information
+       Buildpacks computed stack:  gliderlabs/herokuish:v0.5.23-20
+       Buildpacks global stack:    gliderlabs/herokuish:latest
        Buildpacks list:
+       Buildpacks stack:
 ```
 
 You can run the command for a specific app also.
@@ -164,7 +202,7 @@ dokku buildpacks:report node-js-app --buildpacks-list
 If an application was previously deployed via Dockerfile, the following commands should be run before a buildpack deploy will succeed:
 
 ```shell
-dokku config:unset --no-restart node-js-app DOKKU_DOCKERFILE_CMD DOKKU_DOCKERFILE_ENTRYPOINT DOKKU_PROXY_PORT_MAP
+dokku config:unset --no-restart node-js-app DOKKU_PROXY_PORT_MAP
 ```
 
 ### Using a specific buildpack version
@@ -224,4 +262,4 @@ dokku config:set --global CURL_CONNECT_TIMEOUT=180
 
 ### Clearing buildpack cache
 
-See the [repository management documentation](/docs/advanced-usage/repository-management.md#clearing-app-cache).
+See the [repository management documentation](/docs/advanced-usage/repository-management.md#clearing-app-cache) for more information on how to clear buildpack build cache for an application.

docs/deployment/methods/images.md

@@ -22,7 +22,7 @@ The Dokku tags plugin allows you to add Docker image tags to the currently deplo
 
 ### Exposed ports
 
-See the [port management documentation](/docs/networking/port-management.md).
+See the [port management documentation](/docs/networking/port-management.md) for more information on how Dokku exposes ports for applications and how you can configure these for your app.
 
 ### Listing tags for an application
 
@@ -92,7 +92,6 @@ dokku tags:deploy node-js-app v1
 -----> Running post-deploy
 -----> Configuring node-js-app.dokku.me...
 -----> Creating http nginx.conf
------> Running nginx-pre-reload
        Reloading nginx
 -----> Shutting down old containers in 60 seconds
 =====> 025eec3fa3b442fded90933d58d8ed8422901f0449f5ea0c23d00515af5d3137

docs/deployment/one-off-processes.md

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

docs/deployment/process-management.md

@@ -1,224 +0,0 @@
-# Process and Container Management
-
-> New as of 0.3.14, Enhanced in 0.7.0
-
-```
-ps <app>                                       # List processes running in app container(s)
-ps:inspect <app>                               # Displays a sanitized version of docker inspect for an app
-ps:rebuild <app>                               # Rebuild an app from source
-ps:rebuildall                                  # Rebuild all apps from source
-ps:report [<app>] [<flag>]                     # Displays a process report for one or more apps
-ps:restart <app>                               # Restart app container(s)
-ps:restart-policy <app>                        # Shows the restart-policy for an app
-ps:restartall                                  # Restart all deployed app containers
-ps:scale <app> <proc>=<count> [<proc>=<count>] # Get/Set how many instances of a given process to run
-ps:set-restart-policy <app> <policy>           # Sets app restart-policy
-ps:start <app>                                 # Start app container(s)
-ps:startall                                    # Start all deployed app containers
-ps:stop <app>                                  # Stop app container(s)
-ps:stopall                                     # Stop all app container(s)
-```
-
-By default, Dokku will only start a single `web` process - if defined - though process scaling can be managed by the `ps` plugin or [via a custom `DOKKU_SCALE` file](/docs/deployment/process-management.md#manually-managing-process-scaling).
-
-> The `web` proctype is the only proctype that will invoke custom checks as defined by a `CHECKS` file. It is also the only process type that will be launched in a container that is either proxied via nginx or bound to an external port.
-
-## Usage
-
-### Listing processes running in an app container
-
-To find out if your application's containers are running the commands you expect, simply run the `ps` command against that application.
-
-```shell
-dokku ps node-js-app
-```
-
-### Inspecting app containers
-
-> New as of 0.13.0
-
-A common administrative task to perform is calling `docker inspect` on the containers that are running for an application. This can be an error-prone task to perform, and may also reveal sensitive environment variables if not done correctly. Dokku provides a wrapper around this command via the `ps:inspect` command:
-
-```shell
-dokku ps:inspect node-js-app
-```
-
-This command will gather all the running container IDs for your application and call `docker inspect`, sanitizing the output data so it can be copy-pasted elsewhere safely.
-
-### Rebuilding applications
-
-There are some Dokku commands which will not automatically rebuild an application's environment, or which can be told to skip a rebuild. For instance, you may wish to run multiple `config:set` commands without a restart so as to speed up configuration. In these cases, you can ultimately trigger an application rebuild using `ps:rebuild`
-
-```shell
-dokku ps:rebuild node-js-app
-```
-
-You may also rebuild all applications at once, which is useful when enabling/disabling a plugin that modifies all applications:
-
-```shell
-dokku ps:rebuildall
-```
-
-> The `ps:rebuild` and `ps:rebuildall` commands only work for applications for which there is a source, and thus
-> will only always work deterministically for Git-deployed application. Please see
-> the [images documentation](/docs/deployment/methods/images.md) and [tar documentation](/docs/deployment/methods/tar.md)
-> in for more information concerning rebuilding those applications.
-
-### Restarting applications
-
-Applications can be restarted, which is functionally identical to calling the `release_and_deploy` function on an application. Please note that any linked containers *must* be started before the application in order to have a successful boot.
-
-```shell
-dokku ps:restart node-js-app
-```
-
-You may also trigger a restart on all applications at one time:
-
-```shell
-dokku ps:restartall
-```
-
-### `ps:scale` command
-
-Dokku can also manage scaling itself via the `ps:scale` command. This command can be used to scale multiple process types at the same time.
-
-```shell
-dokku ps:scale node-js-app web=1
-```
-
-Multiple process types can be scaled at once:
-
-```shell
-dokku ps:scale node-js-app web=1 worker=1
-```
-
-Issuing the `ps:scale` command with no process type argument will output the current scaling settings for an application:
-
-```shell
-dokku ps:scale node-js-app
-```
-
-```
------> Scaling for node-js-app
------> proctype           qty
------> --------           ---
------> web                1
------> worker             1
-```
-
-### Stopping applications
-
-Deployed applications can be stopped using the `ps:stop` command. This turns off all running containers for an application, and will result in a **502 Bad Gateway** response for the default nginx proxy implementation.
-
-```shell
-dokku ps:stop node-js-app
-```
-
-You may also stop all applications at once:
-
-```shell
-dokku ps:stopall
-```
-
-### Starting applications
-
-All stopped containers can be started using the `ps:start` command. This is similar to running `ps:restart`, except no action will be taken if the application containers are running.
-
-```shell
-dokku ps:start node-js-app
-```
-
-### Starting all applications
-
-In some cases, it may be necessary to start all applications from scratch - e.g. if all Docker containers have been manually stopped. This can be executed via the `ps:startall` command, which supports parallelism in the same manner `ps:rebuildall`, `ps:restartall`, and `ps:stopall` do.
-
-Be aware that no action will be taken if the application containers are running.
-
-```shell
-dokku ps:startall
-```
-
-## Restart policies
-
-> New as of 0.7.0
-
-By default, Dokku will automatically restart containers that exit with a non-zero status up to 10 times via the [on-failure Docker restart policy](https://docs.docker.com/engine/reference/run/#restart-policies-restart).
-
-### Showing the current restart policy
-
-The `ps:restart-policy` command will show the currently configured restart policy for an application. The default policy is `on-failure:10`
-
-```shell
-dokku ps:restart-policy node-js-app
-```
-
-```
-=====> node-js-app restart-policy:
-on-failure:10
-```
-
-### Setting the restart policy
-
-You can configure this via the `ps:set-restart-policy` command:
-
-```shell
-# always restart an exited container
-dokku ps:set-restart-policy node-js-app always
-```
-
-```
------> Setting restart policy: always
-```
-
-```shell
-# never restart an exited container
-dokku ps:set-restart-policy node-js-app no
-```
-
-```
------> Setting restart policy: no
-```
-
-```shell
-# only restart it on Docker restart if it was not manually stopped
-dokku ps:set-restart-policy node-js-app unless-stopped
-```
-
-```
------> Setting restart policy: unless-stopped
-```
-
-```shell
-# restart only on non-zero exit status
-dokku ps:set-restart-policy node-js-app on-failure
-```
-
-```
------> Setting restart policy: on-failure
-```
-
-```shell
-# restart only on non-zero exit status up to 20 times
-dokku ps:set-restart-policy node-js-app on-failure:20
-```
-
-```
------> Setting restart policy: on-failure:20
-```
-
-Restart policies have no bearing on server reboot, and Dokku will always attempt to restart your applications at that point unless they were manually stopped.
-
-## Manually managing process scaling
-
-You can optionally *commit* a `DOKKU_SCALE` file to the root of your repository - *not* to the `/home/dokku/APP` directory. Dokku expects this file to contain one line for every process defined in your Procfile.
-
-Example:
-
-```Procfile
-web=1
-worker=2
-```
-
-If it is not committed to the repository, the `DOKKU_SCALE` file will otherwise be automatically generated based on your `ps:scale` settings.
-
-> *NOTE*: Dokku will always use the `DOKKU_SCALE` file that ships with the repo to override any local settings.

docs/deployment/remote-commands.md

@@ -21,8 +21,75 @@ in order to avoid SSH interpretting Dokku arguments for itself.
 --force                force flag. currently used in apps:destroy and other ":destroy" commands
 ```
 
-## Clients
+## Official Client
 
-You may optionally use a client to connect to your Dokku server. Most clients use the configured `git remote` to locate the Dokku server, though some allow for overriding this via an environment variable or flag.
+You may optionally use the official client when connecting to the Dokku server.
 
-Please refer to the [clients](/docs/community/clients.md) list for more details.
+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.
+
+It can be installed either via the [Homebrew](https://brew.sh) package manager (macOS only), or manually.
+
+### Installation via Homebrew
+
+To install, simply run the following command:
+
+```shell
+brew install dokku/repo/dokku
+```
+
+### Manual installation
+
+To install manually, 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'
+```
+
+### Usage
+
+All commands have the application name automatically set via the `--app` flag on the remote server, and thus the app name does not need to be specified manually for core plugins.
+
+The client supports several environment variables:
+
+- `DOKKU_HOST` (default: `dokku` git remote): Used to interact with a specific remote server. Can be overriden via `--remote` flag.
+- `DOKKU_PORT` (default: `22`): Used to specify a port to connect to the Dokku server on.
+
+It also supports several flags (all flags unspecified here are passed as is to the server):
+
+- `--app`: Override the remote app in use.
+- `--trace`: Enable trace mode.
+- `--remote`: Override the remote server.
+- `--global`: Unsets the "app" value. May not be supported for the specified command.
+
+In addition, the following commands have special local side-effects:
+
+- `apps:create`:
+  - If no local `--app` flag is specified or detected from a `dokku` git remote, a random name is generated and used for the app.
+  - The `dokku` git remote is set if not already set.
+- `apps:destroy`:
+  - Removes the local `dokku` git remote if set.
+
+## Unofficial Clients
+
+Please refer to the [community clients](/docs/community/clients.md) list for more details.

docs/deployment/user-management.md

@@ -3,9 +3,9 @@
 > New as of 0.7.0
 
 ```
-ssh-keys:add <name> [/path/to/key]             # Add a new public key by pipe or path
-ssh-keys:list                                  # List of all authorized Dokku public ssh keys
-ssh-keys:remove <name>                         # Remove SSH public key by name
+ssh-keys:add <name> [/path/to/key]                 # Add a new public key by pipe or path
+ssh-keys:list [--format text|json] [<name>]        # List of all authorized Dokku public ssh keys
+ssh-keys:remove [--fingerprint fingerprint|<name>] # Remove SSH public key by name
 ```
 
 When pushing to Dokku, SSH key-based authorization is the preferred authentication method, for ease of use and increased security.
@@ -25,7 +25,7 @@ dokku ssh-keys:list
 ```
 
 ```
-61:21:1f:88:7f:86:d4:3a:68:9f:18:aa:41:4f:bc:3d NAME="admin" SSHCOMMAND_ALLOWED_KEYS="no-agent-forwarding,no-user-rc,no-X11-forwarding,no-port-forwarding"
+SHA256:ABC123ABC123+abc123abc123Zabc123abcZ123abc NAME="admin" SSHCOMMAND_ALLOWED_KEYS="no-agent-forwarding,no-user-rc,no-X11-forwarding,no-port-forwarding"
 ```
 
 The output contains the following information:
@@ -34,6 +34,28 @@ The output contains the following information:
 - The `KEY_NAME`.
 - A comma separated list of SSH options under the `SSHCOMMAND_ALLOWED_KEYS` name.
 
+> New as of 0.20.2
+
+The keys for a specific user may be listed by specifying a second argument to the `ssh-keys:list` command:
+
+```shell
+dokku ssh-keys:list admin
+```
+
+> 0.22.3
+
+The output format may be specified via the `--format` flag. Supported values include `json` and `text`.
+
+```shell
+dokku ssh-keys:list --format json
+```
+
+This can additionally be used to filter to keys for a particular user:
+
+```shell
+dokku ssh-keys:list --format json admin
+```
+
 ### Adding SSH keys
 
 You can add your public key to Dokku with the `ssh-keys:add` command. The output will be the fingerprint of the SSH key:
@@ -43,7 +65,7 @@ dokku ssh-keys:add KEY_NAME path/to/id_rsa.pub
 ```
 
 ```
-b7:76:27:4f:30:90:21:ae:d4:1e:70:20:35:3f:06:d6
+SHA256:ABC123ABC123+abc123abc123Zabc123abcZ123abc
 ```
 
 `KEY_NAME` is the name you want to use to refer to this particular key. Including the word `admin` in the name will grant the user privileges to add additional keys remotely.
@@ -66,13 +88,20 @@ cat ~/.ssh/id_rsa.pub | make vagrant-acl-add
 
 As key names are unique, they can be used to remove a public SSH key.
 
-```SHELL
+```shell
 dokku ssh-keys:remove KEY_NAME
 ```
 
+An SSH Key can also be removed by fingerprint.
+
+```shell
+dokku ssh-keys:remove --fingerprint FINGERPRINT
+```
+
 ## Scoping commands to specific users
 
-Keys are given unique names, which can be used in conjunction with the [user-auth](/docs/development/plugin-triggers.md#user-auth) plugin trigger to handle command authorization. Please see the documentation on that trigger for more information.
+Support for scoping commands to specific users can be added through plugins that take advantage of the [user-auth](/docs/development/plugin-triggers.md#user-auth) plugin trigger to handle command authorization.
+See also the list of [community-provided plugins](/docs/community/plugins.md).
 
 ## Granting other Unix user accounts Dokku access
 

docs/deployment/zero-downtime-deploys.md

@@ -3,7 +3,6 @@
 > New as of 0.5.0
 
 ```
-checks <app>                             Show zero-downtime status
 checks:disable <app> [process-type(s)]   Disable zero-downtime deployment for all processes (or comma-separated process-type list) ***WARNING: this will cause downtime during deployments***
 checks:enable <app> [process-type(s)]    Enable zero-downtime deployment for all processes (or comma-separated process-type list)
 checks:report [<app>] [<flag>]           Displays a checks report for one or more apps
@@ -11,7 +10,7 @@ checks:run <app> [process-type(s)]       Runs zero-downtime checks for all proce
 checks:skip <app> [process-type(s)]      Skip zero-downtime checks for all processes (or comma-separated process-type list)
 ```
 
-By default, Dokku will wait `10` seconds after starting each container before assuming it is up and proceeding with the deploy. Once this has occurred for all containers started by for an application, traffic will be switched to point to your new containers. Dokku will also wait a further `60` seconds *after* the deploy is complete before terminating old containers in order to give time for long running connections to terminate. In either case, you may have more than one container running for a given application.
+By default, Dokku will wait `10` seconds after starting each container before assuming it is up and proceeding with the deploy. Once this has occurred for all containers started by an application, traffic will be switched to point to your new containers. Dokku will also wait a further `60` seconds *after* the deploy is complete before terminating old containers in order to give time for long running connections to terminate. In either case, you may have more than one container running for a given application.
 
 You may both create user-defined checks for web processes using a `CHECKS` file, as well as customize any and all parts of this experience using the checks plugin.
 
@@ -81,13 +80,13 @@ dokku checks:report
 ```
 
 ```
-=====> search checks information
+=====> node-js-app checks information
        Checks disabled list: none
        Checks skipped list: none          
-=====> python-sample checks information
+=====> python-app checks information
        Checks disabled list: none
        Checks skipped list: none          
-=====> ruby-sample checks information
+=====> ruby-app checks information
        Checks disabled list: _all_
        Checks skipped list: none          
 ```
@@ -95,11 +94,11 @@ dokku checks:report
 You can run the command for a specific app also.
 
 ```shell
-dokku checks:report node-js-sample
+dokku checks:report node-js-app
 ```
 
 ```
-=====> node-js-sample checks information
+=====> node-js-app checks information
        Checks disabled list: none
        Checks skipped list: none          
 ```
@@ -107,7 +106,7 @@ dokku checks:report node-js-sample
 You can pass flags which will output only the value of the specific information you want. For example:
 
 ```shell
-dokku checks:report node-js-sample --checks-disabled-list
+dokku checks:report node-js-app --checks-disabled-list
 ```
 
 ## Customizing checks
@@ -123,7 +122,7 @@ To specify checks, add a `CHECKS` file to the root of your project directory. Th
 - comments (lines starting with #)
 - empty lines
 
-> For Dockerfile-based deploys, the file *must* be in `/app/CHECKS` within the container. `/app` is used by default as the root container directory for buildpack-based deploys.
+> For Dockerfile and Docker Image based deploys, the file *must* be in the `WORKDIR` directory of the built image. `/app` is used by default as the root container directory for buildpack-based deploys.
 
 ### Check instructions
 
@@ -158,6 +157,38 @@ https://static.dokku.me/logo.png
 
 While a full URL may be used in order to invoke checks, if you are using relative URLs, the port *must* be omitted.
 
+> Changed as of 0.22.5
+
+Please note that dollar sign bracket characters (`{` and `}`) must be escaped when used within a `CHECKS` file. Escaping follows golang template rules. The proper way to do this is via one of the following methods:
+
+```
+# escaping the `{` character
+# using double-quotes
+{{"{"}}
+
+# using raw string constants
+{{`{`}}
+
+# escaping the `}` character
+# using double-quotes
+{{"}"}}
+
+# using raw string constants
+{{`}`}}
+```
+
+### Templating Checks Files
+
+> New as of 0.22.5
+
+An app's `CHECKS` file is sent through a single pass of the [`sigil`](https://github.com/gliderlabs/sigil/) templating tool. This enables usage of Golang templating within application `CHECKS` files. In addition to general templating access, access to app environment variables is also allowed via the `var` function:
+
+```
+{{ var "SOME_ENV_VAR" }}
+```
+
+This may be useful if certain zero-downtime checks require access to an app-specific value, such as a domain name.
+
 ### Check settings
 
 The default behavior is to wait for `5` seconds before running the checks, to timeout the checks after `30` seconds, and to attempt the checks `5` times. If the checks fail `5` times, the deployment is considered failed and the old container will continue serving traffic.
@@ -327,7 +358,6 @@ curl: (7) Failed to connect to 172.17.0.155 port 5000: Connection refused
 -----> Running post-deploy
 -----> Configuring myapp.dokku.me...
 -----> Creating http nginx.conf
------> Running nginx-pre-reload
        Reloading nginx
 -----> Shutting down old container in 60 seconds
 =====> Application deployed:

docs/development/plugin-creation.md

@@ -2,96 +2,282 @@
 
 A plugin can be a simple implementation of [triggers](/docs/development/plugin-triggers.md) or can implement a command structure of its own. Dokku has no restrictions on the language in which a plugin is implemented; it only cares that the plugin implements the appropriate [commands](/docs/development/plugin-creation.md#command-api) or [triggers](/docs/development/plugin-triggers.md) for the API. **NOTE:** any file that implements triggers or uses the command API must be executable.
 
-If you create your own plugin:
+When creating custom plugins:
 
 1. Take a look at [the plugins shipped with Dokku](/docs/community/plugins.md) and hack away!
-2. Check out the [list of triggers](/docs/development/plugin-triggers.md) your plugin can implement
-3. Upload your plugin to GitHub with a repository name following the `dokku-<name>` convention (e.g. `dokku-mariadb`)
-4. Edit [this page](/docs/community/plugins.md) and add a link to your plugin
+2. Check out the [list of triggers](/docs/development/plugin-triggers.md) the plugin can implement
+3. Upload the plugin to GitHub with a repository name following the `dokku-<name>` convention (e.g. `dokku-mariadb`)
+4. Edit [this page](/docs/community/plugins.md) and add a link to the plugin
 5. Subscribe to the [dokku development blog](http://progrium.com) to be notified about API changes and releases
 
-
 ## Compilable plugins (Golang, Java(?), C, etc.)
-When developing a plugin, you must implement the `install` trigger such that it outputs the built executable(s) using a directory structure that implements the plugin's desired command and/or triggers the API. See the [smoke-test-plugin](https://github.com/dokku/smoke-test-plugin) for an example.
 
+When developing a plugin, the `install` trigger must be implemented such that it outputs the built executable(s) using a directory structure that implements the plugin's desired command and/or triggers the API. See the [smoke-test-plugin](https://github.com/dokku/smoke-test-plugin) for an example.
 
 ## Command API
+
 There are 3 main integration points: `commands`, `subcommands/default`, and `subcommands/<command-name>`.
 
 ### `commands`
+
 Primarily used to supply the plugin's usage/help output. (i.e. [plugin help](https://github.com/dokku/dokku/tree/master/plugins/plugin/commands)).
 
 ### `subcommands/default`
+
 Implements the plugin's default command behavior. (i.e. [`dokku plugin`](https://github.com/dokku/dokku/tree/master/plugins/plugin/subcommands/default)).
 
 ### `subcommands/<command-name>`
+
 Implements the additional command interface and will translate to `dokku plugin:cmd` on the command line. (i.e. [`dokku plugin:install`](https://github.com/dokku/dokku/tree/master/plugins/plugin/subcommands/install)).
 
+# Plugin Building Tips
+
+## Always create a `plugin.toml`
+
+The `plugin.toml` file is used to describe the plugin in help output, and helps users understand the purpose of the plugin. This _must_ have a description and a version. The version _should_ be bumped at every plugin release.
+
+```toml
+[plugin]
+description = "dokku example plugin"
+version = "0.1.0"
+[plugin.config]
+```
+
+## Files should be executable
+
+Commands, subcommands, triggers and source shell scripts should all be executable. On a Unix-like machine, the following command can be used to make them executable:
+
+```shell
+chmod +x path/to/file
+```
+
+Non-executable commands, subcommands, and triggers will be ignored.
+
+## Use the `pipefail` bash option
+
+Consider whether to include the `set -eo pipefail` option. Look at the following example:
+
+```shell
+IMAGE=$(docker images | grep "user/repo" | awk '{print $3}')
+if [[ -z $IMAGE ]]; then
+  dokku_log_fail "user/repo image not found... Did you run 'dokku plugin:install'?"
+fi
+```
+
+If `user/repo` doesn't exist, Dokku exits just before the `awk` command and the `dokku_log_fail` message will never go to `STDOUT`. printed with echo. The `set -e` option should be used in this case.
+
+Here is the `help` entry for `set`:
+
+```
+help set
+Options:
+  -e  Exit immediately if a command exits with a non-zero status.
+  -o option-name
+      pipefail     the return value of a pipeline is the status of
+                   the last command to exit with a non-zero status,
+                   or zero if no command exited with a non-zero status
+```
+
+## Support trace mode
+
+Trace mode is useful for getting debugging output from plugins when the `--trace` flag is specified or `dokku trace:on` is triggered. This should be done at the top of each shell script:
+
+```shell
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+```
+
+In the above example, the third line enables bash's debug mode, which prints command traces before executing command.
+
+## Verify the existence of dependencies
+
+If a plugin depends on a specific command-line tool, check whether that tool exists before utilizing it. Either `command -v` or `which` may be used to do so:
+
+```shell
+# `command -v` example
+if ! command -v "nginx" &>/dev/null; then
+  dokku_log_fail "Missing nginx, install it"
+fi
+
+# `which` example
+if ! which nginx >/dev/null 2>&1; then
+  dokku_log_fail "Missing nginx, install it"
+fi
+```
+
+In cases where a dependency should be installed before the plugin can be used at all, use the `dependencies` plugin trigger to install the dependency.
+
+## Implement a help command
+
+For plugins which expose commands, implement a `help` command. This may be empty, but should contain a listing of all available commands.
+
+Commas - `,` - are used in the help output for columnizing output. Verify that the plugin conforms to the spec by running `dokku help --all` and manually verifying the output.
+
+See the sample plugin below for an example.
+
+## Namespace commands
+
+All commands *should* be namespaced. In cases where a core plugin is overriden, the plugin _may_ utilize the a namespace in use by the core, but generally this should be avoided to reduce confusion as to where the command is implemented.
+
+## Implement a proper catch-all command
+
+As of 0.3.3, a catch-all should be implemented that exits with a `DOKKU_NOT_IMPLEMENTED_EXIT` code. This allows Dokku to output a `command not found` message.
+
+See the sample plugin below for an example.
+
+## Set app config without restarting
+
+In the case that a plugin needs to set app configuration settings and a restart should be avoided (default Heroku-style behavior) these "internal" commands provide this functionality:
+
+```shell
+config_set --no-restart node-js-app KEY1=VALUE1 [KEY2=VALUE2 ...]
+config_unset --no-restart node-js-app KEY1 [KEY2 ...]
+```
+
+## Expose functionality in a `functions` file
+
+To allow other plugins access to (some of) a plugin's functionality, functions can expose by including a `functions` file in the plugin for others to source. All functions in that file should be considered publicly accessible by other plugins.
+
+Any functions that must be kept private should reside in the plugin's `trigger/` or `commands/` directories. Other files may also be used to hide private functions; the official convention for hiding private functions is to place them an `internal-functions` file.
+
+## Use helper functions to fetch app images
+
+> New as of 0.4.0
+
+Dokku allows image tagging and deployment of tagged images. This means hard-coding the `$IMAGE` as `dokku/$APP` is no longer sufficient.
+
+Plugins should use `get_running_image_tag()` and `get_app_image_name()` as sourced from `common/functions`. See the [plugin triggers](/docs/development/plugin-triggers.md) doc for examples.
+
+> **Note:** This is only for plugins that are not `pre/post-build-*` plugins
+
+## Use `$DOCKER_BIN` instead of `docker` directly
+
+> New as of 0.17.5
+
+Certain systems may require a wrapper function around the `docker` binary for proper execution. Utilizing the `$DOCKER_BIN` environment variable when calling docker for those functions is preferred.
+
+```shell
+# good
+"$DOCKER_BIN" container run -d $IMAGE /bin/bash -e -c "$COMMAND"
+
+# bad
+docker run -d $IMAGE /bin/bash -e -c "$COMMAND"
+```
+
+## Include labels for all temporary containers and images
+
+> New as of 0.5.0
+
+As of 0.5.0, labels are used to help cleanup intermediate containers with `dokku cleanup`. Plugins that create containers and images should add the correct labels to the `build`, `commit`, and `run` docker commands.
+
+Note that where possible, a label `com.dokku.app-name=$APP` - where `$APP` is the name of the app - should also be included. This enables `dokku cleanup APP` to cleanup the specific containers for a given app.
+
+```shell
+# `docker build` example
+"$DOCKER_BIN" image build "--label=com.dokku.app-name=${APP}" $DOKKU_GLOBAL_BUILD_ARGS ...
+
+# `docker commit` example
+# Note that the arguments must be set as a local array
+# as arrays cannot be exported in shell
+local DOKKU_COMMIT_ARGS=("--change" "LABEL org.label-schema.schema-version=1.0" "--change" "LABEL org.label-schema.vendor=dokku" "--change" "LABEL $DOKKU_CONTAINER_LABEL=")
+"$DOCKER_BIN" container commit --change "LABEL com.dokku.app-name=$APP" "${DOKKU_COMMIT_ARGS[@]}" ...
+
+# `docker run` example
+"$DOCKER_BIN" container run "--label=com.dokku.app-name=${APP}" $DOKKU_GLOBAL_RUN_ARGS ...
+```
+
+## Copy files from the built image using `copy_from_image`
+
+Avoid copying files from running containers as these files may change over time. Instead copy files from the image built during the deploy process. This can be done via the `copy_from_image` helper function. This will correctly handle various corner cases in copying files from an image.
+
+```shell
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+local TMP_FILE=$(mktemp "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
+trap "rm -rf '$TMP_FILE' >/dev/null" RETURN INT TERM
+
+local IMAGE_TAG="$(get_running_image_tag "$APP")"
+local IMAGE=$(get_deploying_app_image_name "$APP" "$IMAGE_TAG")
+copy_from_image "$IMAGE" "file-being-copied" "$TMP_FILE" 2>/dev/null
+```
+
+Files are copied from the `/app` directory - for images built via buildpacks - or `WORKDIR` - for images built via Dockerfile.
+
+## Avoid calling the `dokku` binary directly
+
+> New as of 0.6.0
+
+Plugins should **not** call the `dokku` binary directly from within plugins because clients using the `--app` argument are potentially broken when doing so.
+
+Plugins should instead source the `functions` file for a given plugin when attempting to call Dokku internal functions. In cases where plugin functions cannot be sourced (eg if a plugin is implemented in Golang), then call the relevant [plugin triggers](/docs/development/plugin-triggers.md) instead.
 
 # Sample plugin
+
 The below plugin is a dummy `dokku hello` plugin.
 
+Each plugin requires a `plugin.toml` descriptor file with the following required fields:
+
+```toml
+[plugin]
+description = "dokku hello plugin"
+version = "0.1.0"
+[plugin.config]
+```
+
 `hello/subcommands/default`
 
 ```shell
 #!/usr/bin/env bash
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 
-hello_main_cmd() {
+cmd-hello-default() {
   declare desc="prints Hello \$APP"
-  local cmd="hello"
+  declare cmd="hello"
+  [[ "$1" == "$cmd" ]] && shift 1
   # Support --app/$DOKKU_APP_NAME flag
   # Use the following lines to reorder args into "$cmd $DOKKU_APP_NAME $@""
-  local argv=("$@")
-  [[ ${argv[0]} == "$cmd" ]] && shift 1
   [[ -n $DOKKU_APP_NAME ]] && set -- $DOKKU_APP_NAME $@
   set -- $cmd $@
-  ##
+  #
+  declare APP="$1"
 
-  [[ -z $2 ]] && dokku_log_fail "Please specify an app to run the command on"
-  verify_app_name "$2"
-  local APP="$2";
+  [[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
+  verify_app_name "$APP"
 
   echo "Hello $APP"
 }
 
-hello_main_cmd "$@"
+cmd-hello-default "$@"
 ```
 
 `hello/subcommands/world`
 
 ```shell
 #!/usr/bin/env bash
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 
-hello_world_cmd() {
-  declare desc="prints Hello World"
-  local cmd="hello:world"
-  # Support --app/$DOKKU_APP_NAME flag
-  # Use the following lines to reorder args into "$cmd $DOKKU_APP_NAME $@""
-  local argv=("$@")
-  [[ ${argv[0]} == "$cmd" ]] && shift 1
-  [[ -n $DOKKU_APP_NAME ]] && set -- $DOKKU_APP_NAME $@
-  set -- $cmd $@
-  ##
-
-  [[ -z $2 ]] && dokku_log_fail "Please specify an app to run the command on"
-  verify_app_name "$2"
-  local APP="$2";
+cmd-hello-world() {
+  declare desc="prints Hello world"
+  declare cmd="hello:world"
+  [[ "$1" == "$cmd" ]] && shift 1
 
   echo "Hello world"
 }
 
-hello_world_cmd "$@"
+cmd-hello-world "$@"
 ```
 
 `hello/commands`
 
 ```shell
 #!/usr/bin/env bash
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 
 case "$1" in
   help | hello:help)
@@ -126,58 +312,3 @@ help_content
 
 esac
 ```
-
-Each plugin requires a `plugin.toml` descriptor file with the following required fields:
-
-```toml
-[plugin]
-description = "dokku hello plugin"
-version = "0.1.0"
-[plugin.config]
-```
-
-# A few notes:
-
-- Remember to `chmod +x` your executable files
-- Always support `DOKKU_TRACE` as per the 2nd line of the above example
-- If your command depends on an application, include a check for whether that application exists (see the above example)
-- You must implement a `help` command, though you may leave it empty. Also, you must use commas (`,`) in the command syntax to support output in columns
-- Commands **should** be namespaced
-- As of 0.3.3, a catch-all should be implemented that exits with a `DOKKU_NOT_IMPLEMENTED_EXIT` code. This allows Dokku to output a `command not found` message.
-- Consider whether you want to include the `set -eo pipefail` option. Look at the following example :
-
-    ```shell
-    IMAGE=$(docker images | grep "user/repo" | awk '{print $3}')
-    if [[ -z $IMAGE ]]; then
-        dokku_log_fail "user/repo image not found... Did you run 'dokku plugin:install'?"
-    fi
-    ```
-
-  If `user/repo` doesn't exist, Dokku exits just before the `awk` command and the `dokku_log_fail` message will never go to   `STDOUT`. printed with echo. You would want to use `set -e` in this case.
-
-  Here is the `help` entry for `set`:
-  ```
-  help set
-    Options:
-      -e  Exit immediately if a command exits with a non-zero status.
-      -o option-name
-          pipefail     the return value of a pipeline is the status of
-                       the last command to exit with a non-zero status,
-                       or zero if no command exited with a non-zero status
-  ```
-- In the case that your plugin needs to set application configuration settings and you want to avoid having to restart (default Heroku-style behavior) these "internal" commands provide this functionality:
-
-  ```shell
-  dokku config:set --no-restart node-js-app KEY1=VALUE1 [KEY2=VALUE2 ...]
-  dokku config:unset --no-restart node-js-app KEY1 [KEY2 ...]
-  ```
-- If you want to allow other plugins access to (some of) your plugin's functionality, you can expose this by including a `functions` file in your plugin for others to source
-  - You should consider all functions in that file to be publicly accessible by other plugins
-  - Any functions you want to keep private should reside in your plugin's `trigger/` or `commands/` directories
-- As of 0.4.0, Dokku allows image tagging and deployment of tagged images
-  - This means hard-coding the `$IMAGE` as `dokku/$APP` is no longer sufficient
-  - You should now use `get_running_image_tag()` and `get_app_image_name()` as sourced from `common/functions` (see the [plugin triggers](/docs/development/plugin-triggers.md) doc for examples). **Note:** This is only for plugins that are not `pre/post-build-*` plugins
-- As of 0.5.0, we use container labels to help cleanup intermediate containers with `dokku cleanup
-  - This means that if you manually call `docker run`, you should include `$DOKKU_GLOBAL_RUN_ARGS` to ensure your intermediate containers are labeled correctly
-- As of 0.6.0, you should not **not** call the `dokku` binary directly from within plugins because clients using the `--app` argument are potentially broken when doing so (as well as other issues)
-  - You should instead source the `functions` file for a given plugin when attempting to call Dokku internal functions

docs/development/release-process.md

@@ -29,7 +29,7 @@ The workflow looks like this:
 ```shell
 # having dokku-arch in ../dokku-arch
 vagrant up build-arch
-# wait for "==> build-arch: ==> Finished making: dokku 0.16.3-2 (Mon Feb 22 23:20:37 CET 2016)"
+# wait for "==> build-arch: ==> Finished making: dokku 0.23.2-2 (Mon Feb 22 23:20:37 CET 2016)"
 cd ../dokku-arch
 git add PKGBUILD .SRCINFO
 git commit -m 'Update to dokku 0.9.9'

docs/development/testing.md

@@ -1,6 +1,6 @@
-# Dokku test suite
+# Running Tests
 
-Dokku has a full test suite to assist in quick iterating development. These tests include a linter using [shellcheck](https://github.com/koalaman/shellcheck), functional unit tests using the [bats testing framework](https://github.com/sstephenson/bats), and a deployment suite of example apps that use the most popular languages and frameworks.
+Dokku has a full test suite to assist in quick iterating development. These tests include a linter using [shellcheck](https://github.com/koalaman/shellcheck), functional unit tests using the [Bats testing framework](https://github.com/bats-core/bats-core), and a deployment suite of example apps that use the most popular languages and frameworks.
 
 We maintain the Dokku test harness within the `tests` directory:
 
@@ -9,15 +9,15 @@ We maintain the Dokku test harness within the `tests` directory:
 
 ## Continuous Integration
 
-All pull requests have tests run against them on [CircleCI](https://circleci.com/), a continuous integration platform that provides Docker support for Ubuntu Trusty 14.04.
+All pull requests have tests run against them on [CircleCI](https://circleci.com/), a continuous integration platform that provides Docker support for Ubuntu Trusty 16.04.
 
-If you wish to skip tests for a particular commit - e.g. Documentation changes - you may add the `[ci skip]` designator to your commit message. Commits that *should* be tested but have the above designator will not be merged.
+If you wish to skip tests for a particular commit, e.g. documentation changes, you may add the `[ci skip]` designator to your commit message. Commits that _should_ be tested but have the above designator will not be merged.
 
-While we do provide official packages for a variety of platforms, as our test suite currently runs on Ubuntu Trusty 14.04, we only provide official installation support for that platform.
+While we do provide official packages for a variety of platforms, as our test suite currently runs on Ubuntu Trusty 16.04, we only provide official installation support for that platform and the latest LTS release of Ubuntu (currently 18.04).
 
 ## Local Test Execution
 
-- Setup Dokku in a [vagrant vm](/docs/getting-started/install/vagrant.md)
+- Setup Dokku in a [Vagrant VM](/docs/getting-started/install/vagrant.md).
 - Run the following to setup tests and execute them:
 
   ```shell
@@ -29,8 +29,8 @@ While we do provide official packages for a variety of platforms, as our test su
   # execute the entire test suite (linter, bats tests, and app deployment tests)
   make test
 
-  # run linter & update vagrant Dokku install from local git clone
-  make lint copyfiles
+  # run linter
+  make lint
 
   # execute all bats tests
   make unit-tests
@@ -39,6 +39,16 @@ While we do provide official packages for a variety of platforms, as our test su
   make deploy-tests
   ```
 
+After making changes to your local Dokku clone, don't forget to update the Vagrant Dokku install.
+
+```shell
+# update vagrant dokku install from local git clone
+make copyfiles
+
+# build a specific plugin
+make go-build-plugin copyplugin PLUGIN_NAME=apps
+```
+
 Additionally you may run a specific app deployment tests with a target similar to:
 
 ```shell
@@ -63,22 +73,16 @@ bats tests/unit/10_apps.bats tests/unit/10_certs.bats
 
 ## Executing a single test
 
-In order to increase testing velocity, a wrapper script around bats is available that can be used to run a single testcase within a suite.
+In order to increase testing velocity, a wrapper script around Bats is available that can be used to run a single test case within a suite.
 
-Tests within a suite may be listed by specifying the suite as a parameter to the `tests/bats-exec-test-single` script.
+Tests within a suite may be listed by specifying the suite as a parameter to `bats`.
 
 ```shell
-tests/bats-exec-test-single tests/unit/10_apps.bats
+bats tests/unit/10_apps.bats
 ```
 
-A single test can be specified as a second parameter. The test is selected by fuzzy-match, and only the first match is executed.
+A single test can be specified via the `--filter` argument. The tests are selected via regex match, and all matches are executed.
 
 ```shell
-tests/bats-exec-test-single tests/unit/10_apps.bats clone
-```
-
-Some special characters are translated in the test listing - specifically the characters `( ) :` - while others are not. The fuzzy matching happens on the test names listed when no second character is invoked, so executing a test with a more specific name will work as expected.
-
-```shell
-tests/bats-exec-test-single tests/unit/10_apps.bats clone_-2d-2dskip-2ddeploy
+bats --filter clone tests/unit/10_apps.bats
 ```

docs/getting-started/advanced-installation.md

@@ -46,7 +46,7 @@ sudo BUILD_STACK=true STACK_URL=https://github.com/gliderlabs/herokuish.git make
 
 ## Skipping Herokuish installation
 
-The Herokuish package is recommended but not required if not using Heroku buildpacks for deployment. Debian-based OS users can run the bootstrap installer via `sudo DOKKU_NO_INSTALL_RECOMMENDS=true bash bootstrap.sh` to skip the dependency. Please note that this will _also_ skip installation of other recommended dependencies.
+The Herokuish package is recommended but not required if not using Heroku buildpacks for deployment. Debian-based OS users can run the bootstrap installer via `sudo DOKKU_NO_INSTALL_RECOMMENDS=" --no-install-recommends " bash bootstrap.sh` to skip the dependency. Please note that this will _also_ skip installation of other recommended dependencies.
 
 ## Configuring an unattended installation