Release 0.27.1

# History

## 0.27.1

Install/update via the bootstrap script:

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

### Bug Fixes

- #5095: @josegonzalez Ensure we properly clone and rename common properties
- #5094: @josegonzalez Handle case when apps:clone is run in a directory the dokku user does not have access to
- #5093: @josegonzalez Fix deploy branch setting
- #5068: @josegonzalez Properly set cron-id from flag

### New Features

- #5092: @josegonzalez Warn and exit non-zero when attempting to rebuild from a non-existent branch
- #5103: @naveensrinivasan Included githubactions in the dependabot config

### Documentation

- #5090: @josegonzalez Clarify the exact command that is run once a day by cron tasks
- #5085: @josegonzalez Use issue template form functionality on github
- #5076: @stamp-cmd Lint Markdown, Remove unused links
- #5070: @josegonzalez Add discord as support channel

### Other

- #5107: @dependabot[bot] chore(deps): bump actions/checkout from 2 to 3
- #5105: @dependabot[bot] chore(deps): bump ibiqlik/action-yamllint from 3.0.4 to 3.1
- #5109: @dependabot[bot] chore(deps): bump actions/upload-artifact from 2 to 3
- #5108: @dependabot[bot] chore(deps): bump hadolint/hadolint-action from 1.6.0 to 2.1.0
- #5110: @dependabot[bot] chore(deps-dev): bump heroku/heroku-buildpack-php from 215 to 216 in /tests/apps/php
- #5104: @dependabot[bot] chore(deps-dev): bump heroku/heroku-buildpack-php from 214 to 215 in /tests/apps/php
- #5097: @dependabot[bot] chore(deps): bump werkzeug from 2.1.0 to 2.1.1 in /tests/apps/python-flask
- #5098: @dependabot[bot] chore(deps-dev): bump heroku/heroku-buildpack-php from 213 to 214 in /tests/apps/php
- #5096: @dependabot[bot] chore(deps): bump jetty-servlet from 11.0.8 to 11.0.9 in /tests/apps/java
- #5091: @josegonzalez Update all dependencies for multi test app
- #5089: @dependabot[bot] chore(deps): bump minimist from 1.2.5 to 1.2.6 in /tests/apps/multi
- #5081: @dependabot[bot] chore(deps): bump jinja2 from 3.0.3 to 3.1.1 in /tests/apps/python-flask
- #5071: @dependabot[bot] chore(deps): bump monolog/monolog from 1.26.1 to 1.27.0 in /tests/apps/php
- #5075: @dependabot[bot] chore(deps-dev): bump heroku/heroku-buildpack-php from 212 to 213 in /tests/apps/php
- #5082: @dependabot[bot] chore(deps): bump werkzeug from 2.0.3 to 2.1.0 in /tests/apps/python-flask
- #5086: @dependabot[bot] chore(deps): bump flask from 2.0.3 to 2.1.1 in /tests/apps/multi
- #5087: @dependabot[bot] chore(deps): bump flask from 2.0.3 to 2.1.1 in /tests/apps/python-flask
- #5067: @dependabot[bot] chore(deps): bump maven-dependency-plugin from 3.2.0 to 3.3.0 in /tests/apps/java

.circleci/config.yml

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

.codacy.yml

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

.devcontainer/Dockerfile

@@ -0,0 +1,26 @@
+FROM dokku/dokku:latest
+
+RUN apt-get update
+RUN apt-get install --no-install-recommends -y build-essential file nano && \
+  apt-get install --no-install-recommends -y help2man shellcheck uuid-runtime wget xmlstarlet && \
+  apt-get clean autoclean && \
+  apt-get autoremove --yes && \
+  rm -rf /var/lib/apt/lists/*
+
+RUN wget https://dl.google.com/go/go1.16.10.linux-amd64.tar.gz && \
+  tar -xvf go1.16.10.linux-amd64.tar.gz && \
+  mv go /usr/local
+
+RUN GOROOT=/usr/local/go /usr/local/go/bin/go install golang.org/x/tools/gopls@latest 2>&1
+
+ADD https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem /mnt/dokku/etc/nginx/dhparam.pem
+
+COPY .devcontainer/bin/ /usr/local/bin/
+COPY ["tests.mk", "Makefile"]
+RUN make ci-dependencies
+
+COPY . .
+
+ENV DOKKU_HOSTNAME=dokku.me GOROOT=/usr/local/go PATH=/usr/local/go/bin:/root/go/bin:$PATH PLUGIN_MAKE_TARGET=build
+
+LABEL org.label-schema.schema-version=1.0 org.label-schema.vendor=dokku com.dokku.devcontainer=true

.devcontainer/bin/copy-plugin

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+main() {
+  declare PLUGIN_NAME="$1"
+
+  make go-build-plugin copyplugin PLUGIN_NAME=$PLUGIN_NAME PLUGIN_MAKE_TARGET=build
+}
+
+main "$@"

.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "containerEnv": {
+    "DOKKU_HOST_ROOT": "${localWorkspaceFolder}/tmp/data/home/dokku",
+    "GO_ROOT_MOUNT": "${localWorkspaceFolder}:/go/src/github.com/dokku/dokku"
+  },
+  "extensions": [
+    "golang.go",
+    "mads-hartmann.bash-ide-vscode",
+    "ms-vscode.makefile-tools"
+  ],
+  "initializeCommand": ["mkdir", "-p", "tmp/data"],
+  "mounts": [
+    "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind",
+    "source=${localWorkspaceFolder}/tmp/data/,target=/mnt/dokku/,type=bind"
+  ],
+  "overrideCommand": false,
+  "postCreateCommand": "make setup-deploy-tests",
+  "runArgs": ["--init"],
+  "workspaceFolder": "/root/go/src/github.com/dokku/dokku",
+  "workspaceMount": "type=bind,source=${localWorkspaceFolder},target=/root/go/src/github.com/dokku/dokku,consistency=cached"
+}

.dockerignore

@@ -0,0 +1,13 @@
+*Dockerfile
+.dockerignore
+.git
+.vagrant
+contrib
+build
+docs
+tests
+!build/package/*
+!tests/dhparam.pem
+!contrib/bash-completion
+!contrib/docker
+vendor

.editorconfig

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

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,66 @@
+---
+name: Bug Report
+description: File a bug report
+labels: ["needs: investigation", "type: bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Consider [sponsoring Dokku](https://github.com/sponsors/dokku). Sponsorship goes directly to supporting activities such as fixing bugs and general maintenance.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of problem
+      description: What happened? What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: What are the steps that we need to follow to reproduce this issue?
+    validations:
+      required: true
+  - type: textarea
+    id: report-output
+    attributes:
+      label: dokku report $APP_NAME
+      description: Please paste the output of the command `dokku report $APP_NAME`, where `$APP_NAME` is the name of your app
+    validations:
+      required: true
+  - type: textarea
+    id: additional-output
+    attributes:
+      label: Additional information
+      description: |
+        This information is useful for debugging app issues:
+
+        - 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
+        - The type of application being deployed (node, php, python, ruby, etc.)
+        - 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.
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Output of failing commands after running: dokku trace:off"
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    id: trace-logs
+    attributes:
+      label: "Output of failing commands after running: dokku trace:on"
+      description: |
+        **BEWARE**: `dokku trace:on` will cause some commands to print environment variables, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXX
+      render: shell
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/buildpack_issue.yaml

@@ -0,0 +1,71 @@
+---
+name: Buildpack Issue
+description: Is your deploy failing while building your application using buildpacks? Check this out.
+labels: ["upstream: buildpacks"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If your build is stuck downloading something, compiling a file, or seems to always fail around the same area, Github Issues is not a great place to debug. This is because these sorts of issues tend to take a lot of back and forth to figure out, and the code for buildpacks is not generally maintained by the Dokku project.
+
+        <details>
+        <summary>Debugging tips:</summary>
+
+        - If you see text that says `Killed` in your output, attempt to increase free memory by using a larger server or [add swap memory](https://dokku.com/docs/getting-started/troubleshooting/#build-fails-with-killed-message).
+        - Turn on buildpack trace mode via `dokku config:set $APP_NAME BUILDPACK_XTRACE=1` and retry your deploy. Not all buildpacks support this, but many will output extra debugging information.
+        - Your hosting provider may have issues accessing AWS S3. Verify a slow/stalled download works by directly curling the file from your host.
+        - Many buildpacks allow downloading a file from an alternative location specified via environment variable.
+        - [Increase curl timeouts](https://dokku.com/docs/getting-started/troubleshooting/#deployment-fails-because-of-slow-internet-connection-messages-s) if you see gzip download issues.
+        - If using multi-buildpack support but a buildpack is failing to apply, ensure you have any files necessary for the `bin/detect` script of the buildpack to `exit 0`. Selected buildpacks must still pass the detection phase in order to be used.
+        </details>
+
+        If you are still having issues, file a ticket here and then further discussing the ticket in one of our [Monitored Support Channels](https://dokku.com/docs/getting-started/where-to-get-help/#monitored-locations) (Discord, Github Discussions, Slack). Your filed ticket may be closed or locked, but any subsequent discovery will be posted to the ticket for posterity.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of problem
+      description: What happened? What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: report-output
+    attributes:
+      label: dokku report $APP_NAME
+      description: Please paste the output of the command `dokku report $APP_NAME`, where `$APP_NAME` is the name of your app.
+    validations:
+      required: true
+  - type: textarea
+    id: additional-output
+    attributes:
+      label: Additional information
+      description: |
+        This information is useful for debugging app issues:
+
+        - 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
+        - The type of application being deployed (node, php, python, ruby, etc.)
+        - If using buildpacks, which custom buildpacks are in use
+        - If it exists, the contents of your Procfile.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Output of failing deploy after running: dokku trace:off"
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: trace-logs
+    attributes:
+      label: "Output of failing deploy after running: dokku trace:on"
+      description: |
+        **BEWARE**: `dokku trace:on` will cause some commands to print environment variables, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXX
+      render: shell
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,18 @@
+---
+name: Feature Request
+description: Have an idea for a new feature? Ask away!
+labels: ["needs: plan", "type: enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        While pull requests are always welcome, feel free to fill this out with an idea of what you would like to happen and we can discuss if and how it should be implemented in Dokku.
+
+        Consider [sponsoring Dokku](https://github.com/sponsors/dokku). Sponsorship goes directly to supporting activities such as implementing new features and upgrading existing functionality.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of feature
+      description: When you perform what command or action, what do you think should happen?
+    validations:
+      required: true

.github/commands/bump-azure

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

.github/commands/ci-run

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

.github/commands/ci-setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+set -eo pipefail
+set -x
+
+echo "=====> set hostname"
+hostname
+internal_ip="$(ifconfig eth0 | grep 'inet ' | awk '{print $2}')"
+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/dependabot.yml

@@ -0,0 +1,112 @@
+---
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/tests/apps/ruby"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: bundler
+    directory: "/tests/apps/multi"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/checks-root"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/config"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/dockerfile-dokku-scale"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/dockerfile-noexpose"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/dockerfile-procfile-bad"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/dockerfile-procfile"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/dockerfile"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/gitsubmodules"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: gomod
+    directory: "/tests/apps/gogrpc"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    ignore:
+      - dependency-name: google.golang.org/grpc
+        versions:
+          - "> 1.29.1"
+  - package-ecosystem: pip
+    directory: "/tests/apps/multi"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: maven
+    directory: "/tests/apps/java"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/nodejs-express"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/nodejs-worker"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/nodejs-express-noappjson"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/nodejs-express-noprocfile"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: composer
+    directory: "/tests/apps/php"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: pip
+    directory: "/tests/apps/python-flask"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/tests/apps/.websocket.disabled"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

.github/linters/.markdown-lint.yml

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

.github/linters/.yamllint.yml

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

.github/workflows/ci.yml

@@ -0,0 +1,171 @@
+---
+name: CI
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-18.04
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    strategy:
+      fail-fast: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: set up qemu
+        uses: docker/setup-qemu-action@v1
+
+      - name: set up docker buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - 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@v3
+        with:
+          name: build
+          path: build
+
+  unit-tests:
+    name: unit.${{ matrix.index }}
+    needs: build
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix: ${{fromJson(needs.build.outputs.matrix)}}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: download packages
+        uses: actions/download-artifact@v1
+        with:
+          name: build
+
+      - name: ci-setup
+        run: ./.github/commands/ci-setup
+
+      # - name: start ssh session
+      #   uses: luchihoratiu/debug-via-ssh@main
+      #   with:
+      #     NGROK_AUTH_TOKEN: ${{ secrets.NGROK_AUTH_TOKEN }}
+      #     SSH_PASS: ${{ secrets.SSH_PASS }}
+
+      - name: run ci
+        timeout-minutes: 30
+        run: sudo -E ./.github/commands/ci-run ${{ matrix.index }}
+        env:
+          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+          SYNC_GITHUB_PASSWORD: ${{ secrets.SYNC_GITHUB_PASSWORD }}
+          SYNC_GITHUB_USERNAME: ${{ secrets.SYNC_GITHUB_USERNAME }}
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: test-results-${{ matrix.index }}
+          path: test-results
+
+  docker-deploy-tests:
+    name: docker
+    needs: build
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - 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-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        index: [0, 1, 2, 3]
+    env:
+      GITHUB_NODE_INDEX: ${{ matrix.index }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - 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@v3
+        with:
+          name: coverage.${{ matrix.index }}
+          path: test-results/coverage
+
+  publish-test-results:
+    name: publish-test-results
+    needs: unit-tests
+    runs-on: ubuntu-18.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
+        with:
+          check_name: Unit Test Results
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          files: test-results/**/*.xml
+          comment_on_pr: false

.github/workflows/codeql-analysis.yml

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

.github/workflows/lint.yml

@@ -0,0 +1,74 @@
+---
+name: 'lint'
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  hadolint:
+    name: hadolint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+      - name: Run hadolint
+        uses: hadolint/hadolint-action@f988afea3da57ee48710a9795b6bb677cc901183
+        # v1.6.0 => d7b38582334d9ac11c12021c16f21d63015fa250
+
+  markdown-lint:
+    name: markdown-lint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+      - name: Run markdown-lint
+        uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb
+        # v1.5.0 => 04d43ee9191307b50935a753da3b775ab695eceb
+        with:
+          config: '.github/linters/.markdown-lint.yml'
+          args: './README.md'
+
+  shellcheck:
+    name: shellcheck
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+      - name: Run shellcheck
+        uses: ludeeus/action-shellcheck@94e0aab03ca135d11a35e5bfc14e6746dc56e7e9
+        # 1.1.0 => 94e0aab03ca135d11a35e5bfc14e6746dc56e7e9
+        env:
+          # keep in sync with tests/shellcheck-exclude
+          SHELLCHECK_OPTS: -e SC1001 -e SC1003 -e SC1090 -e SC1091 -e SC1117 -e SC2029 -e SC2030 -e SC2031 -e SC2034 -e SC2046 -e SC2064 -e SC2068 -e SC2086 -e SC2119 -e SC2120 -e SC2128 -e SC2148 -e SC2153 -e SC2154 -e SC2155 -e SC2162 -e SC2174 -e SC2179 -e SC2191 -e SC2199 -e SC2207 -e SC2219 -e SC2220 -e SC2230 -e SC2231 -e SC2235 -e SC2267 -e SC2295
+
+  shfmt:
+    name: shfmt
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+      - name: Run shfmt
+        uses: luizm/action-sh-checker@7f44869033b40ee4ffe7dc76c87a1bc66e3d025a
+        # v0.3.0 => 7f44869033b40ee4ffe7dc76c87a1bc66e3d025a
+        env:
+          SHFMT_OPTS: -l -bn -ci -i 2 -d
+        with:
+          sh_checker_shellcheck_disable: true
+
+  yamllint:
+    name: yamllint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+      - name: Run yamllint
+        uses: ibiqlik/action-yamllint@81e214fd484713882ce4237cb7cd264d550856cf
+        # v3.0.4 => ed2b6e911569708ed121c14b87d513860a7e36a7
+        with:
+          config_file: '.github/linters/.yamllint.yml'

.github/workflows/release.yml

@@ -0,0 +1,105 @@
+---
+name: 'release'
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: 'Release type [build, betafish, patch, minor, major]'
+        required: true
+        default: 'build'
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-20.04
+    env:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: login to docker hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: set up qemu
+        uses: docker/setup-qemu-action@v1
+
+      - name: set up docker buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: inspect builder
+        run: |
+          echo "Name:      ${{ steps.buildx.outputs.name }}"
+          echo "Endpoint:  ${{ steps.buildx.outputs.endpoint }}"
+          echo "Status:    ${{ steps.buildx.outputs.status }}"
+          echo "Flags:     ${{ steps.buildx.outputs.flags }}"
+          echo "Platforms: ${{ steps.buildx.outputs.platforms }}"
+
+      - name: install package_cloud
+        run: gem install package_cloud
+
+      - name: configure git
+        run: |
+          git config --global user.name 'Dokku Bot'
+          git config --global user.email no-reply@dokku.com
+
+      - name: build package
+        run: contrib/release-dokku ${{ github.event.inputs.release_type }}
+
+      - name: output version
+        id: version
+        run: echo "::set-output name=version::$(cat build/next-version)"
+
+      - name: upload packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: build
+          path: build
+
+  bump-azure:
+    name: bump-azure
+    runs-on: ubuntu-20.04
+    needs: release
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Bump Azure Template
+        env:
+          BOT_GITHUB_USERNAME: ${{ secrets.HOMEBREW_GITHUB_USERNAME }}
+          BOT_GITHUB_API_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }}
+        run: |
+          VERSION=${{ needs.release.outputs.version }}
+          git config --global user.name 'Dokku Bot'
+          git config --global user.email no-reply@dokku.com
+          .github/commands/bump-azure "${VERSION:1}" "$BOT_GITHUB_USERNAME" "$BOT_GITHUB_API_TOKEN"
+
+  bump-formula:
+    name: bump-formula
+    runs-on: macos-latest
+    needs: release
+    steps:
+      - name: Bump Homebrew Formula
+        env:
+          HOMEBREW_GITHUB_USERNAME: ${{ secrets.HOMEBREW_GITHUB_USERNAME }}
+          HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }}
+        run: |
+          git config --global user.name 'Dokku Bot'
+          git config --global user.email no-reply@dokku.com
+          curl -sSL https://github.com/dokku/netrc/releases/download/v0.4.1/netrc_0.4.1_darwin_x86_64.tgz | tar xvf -
+          mv netrc /usr/local/bin/netrc
+          netrc set github.com "$HOMEBREW_GITHUB_USERNAME" "$HOMEBREW_GITHUB_API_TOKEN"
+          brew tap dokku/repo
+          brew bump-formula-pr -f --no-browse --no-audit --no-fork --debug --verbose --url "https://github.com/dokku/dokku/archive/${{ needs.release.outputs.version }}.tar.gz" dokku/repo/dokku

.gitignore

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

.shellcheckrc

@@ -0,0 +1,9 @@
+# SC1091 - Not following: FILE: does not exist (No such file or directory) - https://github.com/koalaman/shellcheck/wiki/SC1091
+#        - used for sourcing function files throughout the codebase
+# SC2034 - VAR appears unused - https://github.com/koalaman/shellcheck/wiki/SC2034
+#        - used for declaring desc and deprecated function variables
+# SC2064 - Use single quotes, otherwise this expands now rather than when signalled. - https://github.com/koalaman/shellcheck/wiki/SC2064
+#        - used for traps
+# SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
+#        - used throughout the codebase
+disable=SC1091,SC2034,SC2064,SC2155

.stickler.yml

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

AUTHORS

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

CONTRIBUTING.md

@@ -0,0 +1,138 @@
+# How to contribute
+
+The Dokku project would love to welcome your contributions. There are
+several ways to help out:
+
+- Create an [issue](https://github.com/dokku/dokku/issues) on GitHub, if you have found a bug
+- Write [test cases](https://dokku.com/docs/development/testing/) for open bug issues
+- Write patches for open bug/feature issues, preferably with test cases included
+- Contribute to the [documentation](https://dokku.com/docs/)
+- Come up with new ways, non-commercial to show off our [lovely logo](https://avatars1.githubusercontent.com/u/13455795)
+- Blog about different ways you are using dokku
+- Sponsor the Dokku project financially on [Github](https://github.com/sponsors/dokku), [OpenCollective](https://opencollective.com/dokku#support) or [Patreon](https://www.patreon.com/dokku)
+
+There are a few guidelines that we need contributors to follow so that we have
+a chance of keeping on top of things.
+
+## Topics
+
+- [Reporting Security Issues](#reporting-security-issues)
+- [Reporting Issues](#reporting-other-issues)
+- [Contributing](#contributing)
+  - [Making Changes](#making-changes)
+  - [Which branch to base the work](#which-branch-to-base-the-work)
+  - [Submitting Changes](#submitting-changes)
+  - [When will my change be merged?](#when-will-my-change-be-merged)
+  - [Running tests locally](#running-tests-locally)
+- [Additional Resources](#additional-resources)
+
+## Reporting security issues
+
+The Dokku maintainers take security seriously. If you discover a security
+issue, please bring it to their attention right away!
+
+Please **DO NOT** file a public issue, instead send your report privately to
+[dokku@josediazgonzalez.com](mailto:dokku@josediazgonzalez.com),
+
+Security reports are greatly appreciated and we will publicly thank you for it.
+
+## Reporting other issues
+
+A great way to contribute to the project is to send a detailed report when you
+encounter an issue. We always appreciate a well-written, thorough bug report,
+and will thank you for it!
+
+Sometimes  Dokku  is missing a feature you need. In some cases, those features can
+be found in pre-existing [plugins](https://dokku.com/docs/plugins/),
+and we encourage our users to create and contribute such packages. From time to
+time, we will also pull plugins into the Dokku core when the task they solve is
+a common one for our users.
+
+Check that [our issue database](https://github.com/dokku/dokku/issues)
+doesn't already include that problem or suggestion before submitting an issue.
+If you find a match, add a quick "+1" or "I have this problem too." Doing this
+helps prioritize the most common problems and requests.
+
+When reporting issues, please include all the information we ask for in our
+[issue template](https://github.com/dokku/dokku/blob/master/ISSUE_TEMPLATE.md).
+Not doing so will prolongue the support period, making it more difficult to support
+you.
+
+## Contributing
+
+Before you contribute to the Dokku project, there are a few things that you'll
+need to do
+
+- Make sure you have a [GitHub account](https://github.com/signup/free).
+- Submit an [issue](https://github.com/dokku/dokku/issues), assuming one does not already exist.
+  - Clearly describe the issue including steps to reproduce when it is a bug.
+  - Make sure you fill in the earliest version that you know has the issue.
+- Fork the repository on GitHub.
+
+### Making Changes
+
+- Create a topic branch from where you want to base your work.
+  - This is usually the master branch.
+  - Only target an existing branch if you are certain your fix must be on that
+    branch.
+  - To quickly create a topic branch based on master; `git checkout -b my_contribution origin/master`.
+    It is best to avoid working directly on the `master` branch. Doing so will
+    help avoid conflicts if you pull in updates from origin.
+- Make commits of logical units. Implementing a new function and calling it in
+  another file constitute a single logical unit of work.
+  - Before you make a pull request, squash your commits into logical units of work
+    using `git rebase -i` and `git push -f`.
+  - A majority of submissions should have a single commit, so if in doubt,
+    squash your commits down to one commit.
+- Check for unnecessary whitespace with `git diff --check` before committing.
+- Use descriptive commit messages and reference the #issue number.
+- Core test cases should continue to pass. You can run tests locally or enable
+  [circle-ci](https://circleci.com/gh/dokku/dokku) for your fork, so all
+  tests and codesniffs will be executed.
+- Your work should apply the [Dokku coding standards](https://github.com/progrium/bashstyle)
+- Pull requests must be cleanly rebased on top of master without multiple branches
+  mixed into the PR.
+  - **Git tip**: If your PR no longer merges cleanly, use `rebase master` in your
+    feature branch to update your pull request rather than `merge master`.
+
+### Which branch to base the work
+
+All changes should be be based on the latest master commit.
+
+### Submitting Changes
+
+- Push your changes to a topic branch in your fork of the repository.
+- Submit a pull request to the repository on github, with the correct target
+  branch.
+
+### When will my change be merged?
+
+Be patient! The Dokku maintainers will review all pull requests and comment as
+quickly as possible. There may be some back and forth while the details of your
+pull request are discussed.
+
+In the unlikely event that your pull request does not get merged, the Dokku
+maintainers will either provide an alternative patch or guide you towards a
+better solution to the problem at hand.
+
+During our pre-1.0 cycle, we will follow these general rules when merging pull
+requests:
+
+- bugfix (patch)
+- security (patch/minor)
+- minor feature (patch)
+- backwards incompatible change (minor)
+- major feature (minor)
+
+### Running tests locally
+
+Please read the [testing docs](https://dokku.com/docs/development/testing/),
+which contains test setup information as well as tips for running tests.
+
+## Additional Resources
+
+- [Dokku coding standards](https://github.com/progrium/bashstyle)
+- [Existing issues](https://github.com/dokku/dokku/issues)
+- [General GitHub documentation](https://help.github.com/)
+- [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+- [Gliderlabs Slack in the #dokku channel](https://glider-slackin.herokuapp.com/)

Dockerfile

@@ -0,0 +1,58 @@
+FROM phusion/baseimage:focal-1.1.0
+
+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/package/ /tmp
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# hadolint ignore=DL3005,DL3008
+RUN echo "dokku dokku/hostname string $DOKKU_HOSTNAME" | debconf-set-selections \
+  && echo "dokku dokku/skip_key_file boolean $DOKKU_SKIP_KEY_FILE" | debconf-set-selections \
+  && echo "dokku dokku/vhost_enable boolean $DOKKU_VHOST_ENABLE" | debconf-set-selections \
+  && curl -sSL https://packagecloud.io/dokku/dokku/gpgkey | apt-key add - \
+  && echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ focal main" | tee /etc/apt/sources.list.d/dokku.list \
+  && mkdir -p /etc/nginx/ \
+  && cp /tmp/dhparam.pem /etc/nginx/dhparam.pem \
+  && apt-get update \
+  && apt-get upgrade -y \
+  && apt-get -y --no-install-recommends --only-upgrade install openssl openssh-server \
+  && apt-get -y --no-install-recommends install rsync "/tmp/dokku-$(dpkg --print-architecture).deb" \
+  && apt-get purge -y syslog-ng-core \
+  && apt-get autoremove -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

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

Makefile

@@ -1,10 +1,24 @@
-DOKKU_VERSION = master
+DOKKU_VERSION ?= master
 
-SSHCOMMAND_URL ?= https://raw.github.com/progrium/sshcommand/master/sshcommand
+DOCKER_IMAGE_LABELER_VERSION ?= 0.4.1
-PLUGINHOOK_URL ?= https://s3.amazonaws.com/progrium-pluginhook/pluginhook_0.1.0_amd64.deb
+HEROKUISH_VERSION ?= 0.5.34
+NETRC_VERSION ?= 0.5.1
+PLUGN_VERSION ?= 0.8.2
+PROCFILE_VERSION ?= 0.14.1
+SIGIL_VERSION ?= 0.8.1
+SSHCOMMAND_VERSION ?= 0.15.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_amd64.tgz
+NETRC_URL ?= https://github.com/dokku/netrc/releases/download/v${NETRC_VERSION}/netrc_${NETRC_VERSION}_linux_amd64.tgz
+PLUGN_URL ?= https://github.com/dokku/plugn/releases/download/v${PLUGN_VERSION}/plugn_${PLUGN_VERSION}_linux_amd64.tgz
+PROCFILE_UTIL_URL ?= https://github.com/josegonzalez/go-procfile-util/releases/download/v${PROCFILE_VERSION}/procfile-util_${PROCFILE_VERSION}_linux_amd64.tgz
+SIGIL_URL ?= https://github.com/gliderlabs/sigil/releases/download/v${SIGIL_VERSION}/gliderlabs-sigil_${SIGIL_VERSION}_linux_amd64.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
+PREBUILT_STACK_URL ?= gliderlabs/herokuish:latest-20
-PLUGINS_PATH ?= /var/lib/dokku/plugins
+DOKKU_LIB_ROOT ?= /var/lib/dokku
+PLUGINS_PATH ?= ${DOKKU_LIB_ROOT}/plugins
+CORE_PLUGINS_PATH ?= ${DOKKU_LIB_ROOT}/core-plugins
+PLUGIN_MAKE_TARGET ?= build-in-docker
 
 # If the first argument is "vagrant-dokku"...
 ifeq (vagrant-dokku,$(firstword $(MAKECMDGOALS)))
@@ -20,104 +34,175 @@ else
 	BUILD_STACK_TARGETS = build-in-docker
 endif
 
-.PHONY: all apt-update install copyfiles man-db version plugins dependencies sshcommand pluginhook docker aufs stack count dokku-installer vagrant-acl-add vagrant-dokku
+include common.mk
+
+.PHONY: all apt-update install version copyfiles copyplugin man-db plugins dependencies docker-image-labeler netrc sshcommand procfile-util plugn docker aufs stack count vagrant-acl-add vagrant-dokku go-build
 
 include tests.mk
+include package.mk
 include deb.mk
+include rpm.mk
+include arch.mk
 
 all:
 	# Type "make install" to install.
 
-install: dependencies copyfiles plugin-dependencies plugins version
+install: dependencies version copyfiles plugin-dependencies plugins
 
-release: deb-all package_cloud packer
-
-package_cloud:
-	package_cloud push dokku/dokku/ubuntu/trusty herokuish*.deb
-	package_cloud push dokku/dokku/ubuntu/trusty sshcommand*.deb
-	package_cloud push dokku/dokku/ubuntu/trusty pluginhook*.deb
-	package_cloud push dokku/dokku/ubuntu/trusty rubygem*.deb
-	package_cloud push dokku/dokku/ubuntu/trusty dokku*.deb
 
 packer:
 	packer build contrib/packer.json
 
+go-build:
+	basedir=$(PWD); \
+	for dir in plugins/*; do \
+		if [ -e $$dir/Makefile ]; then \
+			$(MAKE) -e -C $$dir $(PLUGIN_MAKE_TARGET) || exit $$? ;\
+		fi ;\
+	done
+
+
+go-build-plugin:
+ifndef PLUGIN_NAME
+	$(error PLUGIN_NAME not specified)
+endif
+	if [ -e plugins/$(PLUGIN_NAME)/Makefile ]; then \
+		$(MAKE) -e -C plugins/$(PLUGIN_NAME) $(PLUGIN_MAKE_TARGET) || exit $$? ;\
+	fi
+
+go-clean:
+	basedir=$(PWD); \
+	for dir in plugins/*; do \
+		if [ -e $$dir/Makefile ]; then \
+			$(MAKE) -e -C $$dir clean ;\
+		fi ;\
+	done
+
 copyfiles:
+	$(MAKE) go-build || exit 1
 	cp dokku /usr/local/bin/dokku
-	mkdir -p ${PLUGINS_PATH}
+	mkdir -p ${CORE_PLUGINS_PATH} ${PLUGINS_PATH}
-	find ${PLUGINS_PATH} -mindepth 2 -maxdepth 2 -name '.core' -printf '%h\0' | xargs -0 rm -Rf
+	rm -rf ${CORE_PLUGINS_PATH}/*
-	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do \
+	test -d ${CORE_PLUGINS_PATH}/enabled || PLUGIN_PATH=${CORE_PLUGINS_PATH} plugn init
-		rm -Rf ${PLUGINS_PATH}/$$plugin && \
+	test -d ${PLUGINS_PATH}/enabled || PLUGIN_PATH=${PLUGINS_PATH} plugn init
-		cp -R plugins/$$plugin ${PLUGINS_PATH} && \
+	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do $(MAKE) copyplugin PLUGIN_NAME=$$plugin; done
-		touch ${PLUGINS_PATH}/$$plugin/.core; \
+ifndef SKIP_GO_CLEAN
-		done
+	$(MAKE) go-clean
+endif
+	chown dokku:dokku -R ${PLUGINS_PATH} ${CORE_PLUGINS_PATH} || true
 	$(MAKE) addman
 
-addman:
+copyplugin:
+ifndef PLUGIN_NAME
+	$(error PLUGIN_NAME not specified)
+endif
+	rm -Rf ${CORE_PLUGINS_PATH}/available/$(PLUGIN_NAME) && \
+		rm -Rf ${PLUGINS_PATH}/available/$(PLUGIN_NAME) && \
+		rm -rf ${CORE_PLUGINS_PATH}/$(PLUGIN_NAME) && \
+		rm -rf ${PLUGINS_PATH}/$(PLUGIN_NAME) && \
+		cp -R plugins/$(PLUGIN_NAME) ${CORE_PLUGINS_PATH}/available && \
+		rm -rf ${CORE_PLUGINS_PATH}/available/$(PLUGIN_NAME)/src && \
+		ln -s ${CORE_PLUGINS_PATH}/available/$(PLUGIN_NAME) ${PLUGINS_PATH}/available; \
+		find /var/lib/dokku/ -xtype l -delete;\
+		PLUGIN_PATH=${CORE_PLUGINS_PATH} plugn enable $(PLUGIN_NAME) ;\
+		PLUGIN_PATH=${PLUGINS_PATH} plugn enable $(PLUGIN_NAME)
+	chown dokku:dokku -R ${PLUGINS_PATH} ${CORE_PLUGINS_PATH} || true
+
+addman: help2man man-db
 	mkdir -p /usr/local/share/man/man1
+ifneq ("$(wildcard /usr/local/share/man/man1/dokku.1-generated)","")
+	cp /usr/local/share/man/man1/dokku.1-generated /usr/local/share/man/man1/dokku.1
+else
 	help2man -Nh help -v version -n "configure and get information from your dokku installation" -o /usr/local/share/man/man1/dokku.1 dokku
+endif
 	mandb
 
 version:
-	git describe --tags > ~dokku/VERSION  2> /dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ~dokku/VERSION
+	mkdir -p ${DOKKU_LIB_ROOT}
+ifeq ($(DOKKU_VERSION),master)
+	git describe --tags > ${DOKKU_LIB_ROOT}/VERSION  2>/dev/null || echo '~${DOKKU_VERSION} ($(shell date -uIminutes))' > ${DOKKU_LIB_ROOT}/VERSION
+else
+	echo $(DOKKU_VERSION) > ${DOKKU_LIB_ROOT}/STABLE_VERSION
+endif
 
-plugin-dependencies: pluginhook
+plugin-dependencies: plugn procfile-util
-	dokku plugins-install-dependencies
+	sudo -E dokku plugin:install-dependencies --core
 
-plugins: pluginhook docker
+plugins: plugn procfile-util docker
-	dokku plugins-install
+	sudo -E dokku plugin:install --core
 
-dependencies: apt-update sshcommand pluginhook docker help2man man-db
+dependencies: apt-update docker-image-labeler netrc sshcommand plugn procfile-util docker help2man man-db sigil dos2unix jq parallel
 	$(MAKE) -e stack
 
 apt-update:
-	apt-get update
+	apt-get update -qq
+
+parallel:
+	apt-get -qq -y --no-install-recommends install parallel
+
+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
+	mv /usr/local/bin/docker-image-labeler-amd64 /usr/local/bin/docker-image-labeler
+
+netrc:
+	wget -qO /tmp/netrc_latest.tgz ${NETRC_URL}
+	tar xzf /tmp/netrc_latest.tgz -C /usr/local/bin
+	mv /usr/local/bin/netrc-amd64 /usr/local/bin/netrc
+
+procfile-util:
+	wget -qO /tmp/procfile-util_latest.tgz ${PROCFILE_UTIL_URL}
+	tar xzf /tmp/procfile-util_latest.tgz -C /usr/local/bin
+	mv /usr/local/bin/procfile-util-amd64 /usr/local/bin/procfile-util
+
+plugn:
+	wget -qO /tmp/plugn_latest.tgz ${PLUGN_URL}
+	tar xzf /tmp/plugn_latest.tgz -C /usr/local/bin
+	mv /usr/local/bin/plugn-amd64 /usr/local/bin/plugn
+
+sigil:
+	wget -qO /tmp/sigil_latest.tgz ${SIGIL_URL}
+	tar xzf /tmp/sigil_latest.tgz -C /usr/local/bin
+	mv /usr/local/bin/gliderlabs-sigil-amd64 /usr/local/bin/sigil
 
 sshcommand:
-	wget -qO /usr/local/bin/sshcommand ${SSHCOMMAND_URL}
+	wget -qO /tmp/sshcommand_latest.tgz ${SSHCOMMAND_URL}
-	chmod +x /usr/local/bin/sshcommand
+	tar xzf /tmp/sshcommand_latest.tgz -C /usr/local/bin
 	sshcommand create dokku /usr/local/bin/dokku
 
-pluginhook:
+docker:
-	wget -qO /tmp/pluginhook_0.1.0_amd64.deb ${PLUGINHOOK_URL}
+	apt-get -qq -y --no-install-recommends install curl
-	dpkg -i /tmp/pluginhook_0.1.0_amd64.deb
+	grep -i -E "^docker" /etc/group || groupadd docker
-
-docker: aufs
-	apt-get install -qq -y curl
-	egrep -i "^docker" /etc/group || groupadd docker
 	usermod -aG docker dokku
 ifndef CI
-	curl -sSL https://get.docker.com/gpg | apt-key add -
+	wget -nv -O - https://get.docker.com/ | sh
-	echo deb https://get.docker.io/ubuntu docker main > /etc/apt/sources.list.d/docker.list
-	apt-get update
 ifdef DOCKER_VERSION
-	apt-get install -qq -y lxc-docker-${DOCKER_VERSION}
+	apt-get -qq -y --no-install-recommends install docker-engine=${DOCKER_VERSION} || (apt-cache madison docker-engine ; exit 1)
-else
-	apt-get install -qq -y lxc-docker-1.6.2
 endif
 	sleep 2 # give docker a moment i guess
 endif
 
-aufs:
-ifndef CI
-	lsmod | grep aufs || modprobe aufs || apt-get install -qq -y linux-image-extra-`uname -r` > /dev/null
-endif
-
 stack:
 ifeq ($(shell test -e /var/run/docker.sock && touch -c /var/run/docker.sock && echo $$?),0)
 ifdef BUILD_STACK
 	@echo "Start building herokuish from source"
 	docker images | grep gliderlabs/herokuish || (git clone ${STACK_URL} /tmp/herokuish && cd /tmp/herokuish && IMAGE_NAME=gliderlabs/herokuish BUILD_TAG=latest VERSION=master make -e ${BUILD_STACK_TARGETS} && rm -rf /tmp/herokuish)
 else
-ifeq ($(shell echo ${PREBUILT_STACK_URL} | egrep -q 'http.*://' && 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 || curl --silent -L ${PREBUILT_STACK_URL} | gunzip -cd | docker import - gliderlabs/herokuish
+	docker images | grep gliderlabs/herokuish || wget -nv -O - ${PREBUILT_STACK_URL} | gunzip -cd | docker import - gliderlabs/herokuish
 else
 	@echo "Start pulling herokuish from ${PREBUILT_STACK_URL}"
 	docker images | grep gliderlabs/herokuish || docker pull ${PREBUILT_STACK_URL}
@@ -133,20 +218,8 @@ count:
 	@echo "Test lines:"
 	@find tests -type f -not -name .DS_Store | xargs cat | sed 's/^$$//g' | wc -l
 
-dokku-installer:
-	apt-get install -qq -y ruby
-	test -f /var/lib/dokku/.dokku-installer-created || gem install rack -v 1.5.2 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || gem install rack-protection -v 1.5.3 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || gem install sinatra -v 1.4.5 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || gem install tilt -v 1.4.1 --no-rdoc --no-ri
-	test -f /var/lib/dokku/.dokku-installer-created || ruby contrib/dokku-installer.rb onboot
-	test -f /var/lib/dokku/.dokku-installer-created || service dokku-installer start
-	test -f /var/lib/dokku/.dokku-installer-created || service nginx reload
-	test -f /var/lib/dokku/.dokku-installer-created || touch /var/lib/dokku/.dokku-installer-created
-
 vagrant-acl-add:
 	vagrant ssh -- sudo sshcommand acl-add dokku $(USER)
 
 vagrant-dokku:
 	vagrant ssh -- "sudo -H -u root bash -c 'dokku $(RUN_ARGS)'"
-

README.md

@@ -1,40 +1,118 @@
-# Dokku [![Build Status](https://img.shields.io/circleci/project/progrium/dokku.svg "Build Status")](https://circleci.com/gh/progrium/dokku/tree/master) [![Ubuntu Package](https://img.shields.io/badge/package-ubuntu-brightgreen.svg?style=flat-square "Ubuntu Package")](https://packagecloud.io/dokku/dokku) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg "IRC Freenode")](https://webchat.freenode.net/?channels=dokku) [![Documentation](https://img.shields.io/badge/docs-viewdocs-blue.svg "Viewdocs")](http://progrium.viewdocs.io/dokku/)
+# Dokku
 
-Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. Sponsored by our friends at [Deis](http://deis.io/).
+[![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/)
+[![Slack Group](https://img.shields.io/badge/irc-slack-blue.svg?style=flat-square "Slack Group")](https://glider-slackin.herokuapp.com/)
+[![Documentation](https://img.shields.io/badge/docs-site-blue.svg?style=flat-square "Site")](https://dokku.com/docs/getting-started/installation/)
+[![OpenCollective](https://opencollective.com/dokku/sponsors/badge.svg?style=flat-square)](#sponsors)
+[![OpenCollective](https://opencollective.com/dokku/backers/badge.svg?style=flat-square)](#backers)
+[![Patreon](https://img.shields.io/badge/patreon-donate-green.svg?style=flat-square)](https://www.patreon.com/dokku/)
 
-## Requirements
+Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen.
-
-- A fresh VM running Ubuntu `14.04 x64`
-
-## Installing
-
-To install the latest stable release, you can run the following commands as a user that has access to `sudo`:
-
-    wget https://raw.github.com/progrium/dokku/v0.3.26/bootstrap.sh
-    sudo DOKKU_TAG=v0.3.26 bash bootstrap.sh
-
-### Upgrading
-
-[View the docs for upgrading](http://progrium.viewdocs.io/dokku/upgrading) from an older version of Dokku.
-
-## Documentation
-
-Full documentation - including advanced installation docs - are available online at [docs](http://progrium.viewdocs.io/dokku/)
-
-## Support
-
-You can use [Github Issues](https://github.com/progrium/dokku/issues), check [Troubleshooting](http://progrium.viewdocs.io/dokku/troubleshooting) in the documentation, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku)
-
-## Contribution
-
-After checking [Github Issues](https://github.com/progrium/dokku/issues), the [Troubleshooting Guide](http://progrium.viewdocs.io/dokku/troubleshooting) or having a chat with us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku), feel free to fork and create a Pull Request.
-
-While we may not merge your PR as is, they serve to start conversations and improve the general dokku experience for all users.
 
 ## Sponsors
 
-Dokku is currently sponsored by the enterprise grade, multi-host PaaS project [Deis](http://deis.io/).
+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)]
+
+[![OpenCollective Sponsor 0](https://opencollective.com/dokku/sponsor/0/avatar.svg)](https://opencollective.com/dokku/sponsor/0/website)
+[![OpenCollective Sponsor 1](https://opencollective.com/dokku/sponsor/1/avatar.svg)](https://opencollective.com/dokku/sponsor/1/website)
+[![OpenCollective Sponsor 2](https://opencollective.com/dokku/sponsor/2/avatar.svg)](https://opencollective.com/dokku/sponsor/2/website)
+[![OpenCollective Sponsor 3](https://opencollective.com/dokku/sponsor/3/avatar.svg)](https://opencollective.com/dokku/sponsor/3/website)
+[![OpenCollective Sponsor 4](https://opencollective.com/dokku/sponsor/4/avatar.svg)](https://opencollective.com/dokku/sponsor/4/website)
+[![OpenCollective Sponsor 5](https://opencollective.com/dokku/sponsor/5/avatar.svg)](https://opencollective.com/dokku/sponsor/5/website)
+[![OpenCollective Sponsor 6](https://opencollective.com/dokku/sponsor/6/avatar.svg)](https://opencollective.com/dokku/sponsor/6/website)
+[![OpenCollective Sponsor 7](https://opencollective.com/dokku/sponsor/7/avatar.svg)](https://opencollective.com/dokku/sponsor/7/website)
+[![OpenCollective Sponsor 8](https://opencollective.com/dokku/sponsor/8/avatar.svg)](https://opencollective.com/dokku/sponsor/8/website)
+[![OpenCollective Sponsor 9](https://opencollective.com/dokku/sponsor/9/avatar.svg)](https://opencollective.com/dokku/sponsor/9/website)
+[![OpenCollective Sponsor 10](https://opencollective.com/dokku/sponsor/10/avatar.svg)](https://opencollective.com/dokku/sponsor/10/website)
+[![OpenCollective Sponsor 11](https://opencollective.com/dokku/sponsor/11/avatar.svg)](https://opencollective.com/dokku/sponsor/11/website)
+[![OpenCollective Sponsor 12](https://opencollective.com/dokku/sponsor/12/avatar.svg)](https://opencollective.com/dokku/sponsor/12/website)
+[![OpenCollective Sponsor 13](https://opencollective.com/dokku/sponsor/13/avatar.svg)](https://opencollective.com/dokku/sponsor/13/website)
+[![OpenCollective Sponsor 14](https://opencollective.com/dokku/sponsor/14/avatar.svg)](https://opencollective.com/dokku/sponsor/14/website)
+[![OpenCollective Sponsor 15](https://opencollective.com/dokku/sponsor/15/avatar.svg)](https://opencollective.com/dokku/sponsor/5/website)
+[![OpenCollective Sponsor 6](https://opencollective.com/dokku/sponsor/16/avatar.svg)](https://opencollective.com/dokku/sponsor/16/website)
+[![OpenCollective Sponsor 17](https://opencollective.com/dokku/sponsor/17/avatar.svg)](https://opencollective.com/dokku/sponsor/17/website)
+[![OpenCollective Sponsor 18](https://opencollective.com/dokku/sponsor/18/avatar.svg)](https://opencollective.com/dokku/sponsor/18/website)
+
+## Backers
+
+Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/dokku#backer)]
+
+[![OpenCollective Backer 0](https://opencollective.com/dokku/backer/0/avatar.svg)](https://opencollective.com/dokku/backer/0/website)
+[![OpenCollective Backer 1](https://opencollective.com/dokku/backer/1/avatar.svg)](https://opencollective.com/dokku/backer/1/website)
+[![OpenCollective Backer 2](https://opencollective.com/dokku/backer/2/avatar.svg)](https://opencollective.com/dokku/backer/2/website)
+[![OpenCollective Backer 3](https://opencollective.com/dokku/backer/3/avatar.svg)](https://opencollective.com/dokku/backer/3/website)
+[![OpenCollective Backer 4](https://opencollective.com/dokku/backer/4/avatar.svg)](https://opencollective.com/dokku/backer/4/website)
+[![OpenCollective Backer 5](https://opencollective.com/dokku/backer/5/avatar.svg)](https://opencollective.com/dokku/backer/5/website)
+[![OpenCollective Backer 6](https://opencollective.com/dokku/backer/6/avatar.svg)](https://opencollective.com/dokku/backer/6/website)
+[![OpenCollective Backer 7](https://opencollective.com/dokku/backer/7/avatar.svg)](https://opencollective.com/dokku/backer/7/website)
+[![OpenCollective Backer 8](https://opencollective.com/dokku/backer/8/avatar.svg)](https://opencollective.com/dokku/backer/8/website)
+[![OpenCollective Backer 9](https://opencollective.com/dokku/backer/9/avatar.svg)](https://opencollective.com/dokku/backer/9/website)
+[![OpenCollective Backer 10](https://opencollective.com/dokku/backer/10/avatar.svg)](https://opencollective.com/dokku/backer/10/website)
+[![OpenCollective Backer 11](https://opencollective.com/dokku/backer/11/avatar.svg)](https://opencollective.com/dokku/backer/11/website)
+[![OpenCollective Backer 12](https://opencollective.com/dokku/backer/12/avatar.svg)](https://opencollective.com/dokku/backer/12/website)
+[![OpenCollective Backer 13](https://opencollective.com/dokku/backer/13/avatar.svg)](https://opencollective.com/dokku/backer/13/website)
+[![OpenCollective Backer 14](https://opencollective.com/dokku/backer/14/avatar.svg)](https://opencollective.com/dokku/backer/14/website)
+[![OpenCollective Backer 15](https://opencollective.com/dokku/backer/15/avatar.svg)](https://opencollective.com/dokku/backer/15/website)
+[![OpenCollective Backer 16](https://opencollective.com/dokku/backer/16/avatar.svg)](https://opencollective.com/dokku/backer/16/website)
+[![OpenCollective Backer 17](https://opencollective.com/dokku/backer/17/avatar.svg)](https://opencollective.com/dokku/backer/17/website)
+[![OpenCollective Backer 18](https://opencollective.com/dokku/backer/18/avatar.svg)](https://opencollective.com/dokku/backer/18/website)
+[![OpenCollective Backer 19](https://opencollective.com/dokku/backer/19/avatar.svg)](https://opencollective.com/dokku/backer/19/website)
+[![OpenCollective Backer 20](https://opencollective.com/dokku/backer/20/avatar.svg)](https://opencollective.com/dokku/backer/20/website)
+[![OpenCollective Backer 21](https://opencollective.com/dokku/backer/21/avatar.svg)](https://opencollective.com/dokku/backer/21/website)
+[![OpenCollective Backer 22](https://opencollective.com/dokku/backer/22/avatar.svg)](https://opencollective.com/dokku/backer/22/website)
+[![OpenCollective Backer 23](https://opencollective.com/dokku/backer/23/avatar.svg)](https://opencollective.com/dokku/backer/23/website)
+[![OpenCollective Backer 24](https://opencollective.com/dokku/backer/24/avatar.svg)](https://opencollective.com/dokku/backer/24/website)
+[![OpenCollective Backer 25](https://opencollective.com/dokku/backer/25/avatar.svg)](https://opencollective.com/dokku/backer/25/website)
+[![OpenCollective Backer 26](https://opencollective.com/dokku/backer/26/avatar.svg)](https://opencollective.com/dokku/backer/26/website)
+[![OpenCollective Backer 27](https://opencollective.com/dokku/backer/27/avatar.svg)](https://opencollective.com/dokku/backer/27/website)
+[![OpenCollective Backer 28](https://opencollective.com/dokku/backer/28/avatar.svg)](https://opencollective.com/dokku/backer/28/website)
+[![OpenCollective Backer 29](https://opencollective.com/dokku/backer/29/avatar.svg)](https://opencollective.com/dokku/backer/29/website)
+
+## Requirements
+
+A fresh VM running any of the following operating systems:
+
+- Ubuntu 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.27.1/bootstrap.sh
+sudo DOKKU_TAG=v0.27.1 bash bootstrap.sh
+```
+
+You can then proceed to configure your server domain (via `dokku domains:set-global`) and user access (via `dokku ssh-keys:add`) to complete the installation.
+
+If you wish for a more unattended installation method, see [these](https://dokku.com/docs/getting-started/install/debian/#unattended-installation) docs.
+
+### Upgrade
+
+[View the docs](https://dokku.com/docs/getting-started/upgrading/) for upgrading from an older version of Dokku.
+
+## Documentation
+
+Full documentation - including advanced installation docs - are available online at <https://dokku.com/docs/getting-started/installation/>.
+
+## Support
+
+You can use [GitHub Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](https://dokku.com/docs/getting-started/troubleshooting/) in the documentation, or join us on [Gliderlabs Slack in the #dokku channel](https://glider-slackin.herokuapp.com/).
+
+## Contribution
+
+After checking [GitHub Issues](https://github.com/dokku/dokku/issues), the [Troubleshooting Guide](https://dokku.com/docs/getting-started/troubleshooting/) or having a chat with us on [Gliderlabs Slack in the #dokku channel](https://glider-slackin.herokuapp.com/), feel free to fork and create a Pull Request.
+
+While we may not merge your PR as is, they serve to start conversations and improve the general Dokku experience for all users.
 
 ## License
 
-MIT
+[MIT License](https://github.com/dokku/dokku/blob/master/LICENSE) © Jeff Lindsay

SPONSORS

@@ -1 +0,0 @@
-Deis	http://deis.io

Vagrantfile

@@ -1,7 +1,8 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-BOX_NAME = ENV["BOX_NAME"] || "chef/ubuntu-14.04"
+BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-18.04"
+BOX_CPUS = ENV["BOX_CPUS"] || "1"
 BOX_MEMORY = ENV["BOX_MEMORY"] || "1024"
 DOKKU_DOMAIN = ENV["DOKKU_DOMAIN"] || "dokku.me"
 DOKKU_IP = ENV["DOKKU_IP"] || "10.0.0.2"
@@ -18,40 +19,106 @@ Vagrant::configure("2") do |config|
   config.ssh.forward_agent = true
 
   config.vm.box = BOX_NAME
-  config.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
 
   config.vm.provider :virtualbox do |vb|
     vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
     # Ubuntu's Raring 64-bit cloud image is set to a 32-bit Ubuntu OS type by
     # default in Virtualbox and thus will not boot. Manually override that.
     vb.customize ["modifyvm", :id, "--ostype", "Ubuntu_64"]
+    vb.customize ["modifyvm", :id, "--cpus", BOX_CPUS]
     vb.customize ["modifyvm", :id, "--memory", BOX_MEMORY]
   end
 
+  config.vm.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
 
   config.vm.define "dokku", primary: true do |vm|
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
     vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
     vm.vm.hostname = "#{DOKKU_DOMAIN}"
     vm.vm.network :private_network, ip: DOKKU_IP
-    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update > /dev/null && apt-get -qq -y install git > /dev/null && cd /root/dokku && #{make_cmd}"
+
-    vm.vm.provision :shell, :inline => "cd /root/dokku && make dokku-installer"
+    # Use the same nameserver as the host machine in order to avoid the "too many redirects" problem.
+    vm.vm.provider :virtualbox do |vb|
+      vb.customize ["modifyvm", :id, "--natdnshostresolver1", "off"]
+      vb.customize ["modifyvm", :id, "--natdnsproxy1", "off"]
+      # enable NAT adapter cable https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=838999
+      vb.customize ["modifyvm", :id, "--cableconnected1", "on"]
+    end
+
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update -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 do |s|
+      s.inline = <<-EOT
+        echo '"\e[5~": history-search-backward' > /root/.inputrc
+        echo '"\e[6~": history-search-forward' >> /root/.inputrc
+        echo 'set show-all-if-ambiguous on' >> /root/.inputrc
+        echo 'set completion-ignore-case on' >> /root/.inputrc
+      EOT
+    end
+
+    if Pathname.new(PUBLIC_KEY_PATH).exist?
+      vm.vm.provision :shell, :inline => "echo 'Importing ssh key into dokku' && cat /root/.ssh/authorized_keys | dokku ssh-keys:add admin"
+    end
+  end
+
+  # For windows users. Sharing folder from windows creates problem with sym links and so, sync the repo instead from GOS.
+  config.vm.define "dokku-windows", autostart: false do |vm|
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+    vm.vm.provision :shell, :inline => "export DEBIAN_FRONTEND=noninteractive && apt-get update -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"
   end
 
   config.vm.define "dokku-deb", autostart: false do |vm|
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
     vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
     vm.vm.hostname = "#{DOKKU_DOMAIN}"
     vm.vm.network :private_network, ip: DOKKU_IP
     vm.vm.provision :shell, :inline => "cd /root/dokku && make install-from-deb"
   end
 
+  config.vm.define "dokku-rpm", autostart: false do |vm|
+    vm.vm.box = "centos/7"
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
+    vm.vm.network :forwarded_port, guest: 80, host: FORWARDED_PORT
+    vm.vm.hostname = "#{DOKKU_DOMAIN}"
+    vm.vm.network :private_network, ip: DOKKU_IP
+    vm.vm.provision :shell, :inline => "cd /root/dokku && bash bootstrap.sh"
+  end
+
   config.vm.define "build", autostart: false do |vm|
-    vm.vm.provision :shell, :inline => "apt-get update > /dev/null && DEBIAN_FRONTEND=noninteractive apt-get -qq -y install git > /dev/null && cd /root/dokku && #{make_cmd}"
+    vm.vm.synced_folder File.dirname(__FILE__), "/root/dokku"
-    vm.vm.provision :shell, :inline => "cd /root/dokku && make deb-all"
+    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 -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"
+    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
+    vm.vm.provision :shell, :inline => "cd /dokku && make arch-all", privileged: false
   end
 
   if Pathname.new(PUBLIC_KEY_PATH).exist?
     config.vm.provision :file, source: PUBLIC_KEY_PATH, destination: '/tmp/id_rsa.pub'
-    config.vm.provision :shell, :inline => "rm -f /root/.ssh/authorized_keys && mkdir -p /root/.ssh && sudo cp /tmp/id_rsa.pub /root/.ssh/authorized_keys"
+    config.vm.provision :shell, :inline => "echo 'Copying ssh key into vm' && rm -f /root/.ssh/authorized_keys && mkdir -p /root/.ssh && sudo cp /tmp/id_rsa.pub /root/.ssh/authorized_keys"
   end
 end

arch.mk

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

bootstrap.sh

@@ -1,86 +1,282 @@
-#!/bin/bash
+#!/usr/bin/env bash
-#
+set -eo pipefail
-# A script to bootstrap dokku.
+[[ $TRACE ]] && set -x
-# It expects to be run on Ubuntu 14.04 via 'sudo'
-# If installing a tag higher than 0.3.13, it may install dokku via a package (so long as the package is higher than 0.3.13)
-# It checks out the dokku source code from Github into ~/dokku and then runs 'make install' from dokku source.
 
-# We wrap this whole script in a function, so that we won't execute
+# A script to bootstrap dokku.
+# It expects to be run on Ubuntu 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.
+
+# We wrap this whole script in functions, so that we won't execute
 # until the entire script is downloaded.
-# That's good because it prevents our output overlapping with curl's.
+# 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, 11], CentOS [7], Fedora (partial) [33, 34], Ubuntu [18.04, 20.04]"
 
-bootstrap () {
+log-fail() {
-
+  declare desc="log fail formatter"
-
+  echo "$@" 1>&2
-set -eo pipefail
-export DEBIAN_FRONTEND=noninteractive
-export DOKKU_REPO=${DOKKU_REPO:-"https://github.com/progrium/dokku.git"}
-
-echo "Preparing to install $DOKKU_TAG from $DOKKU_REPO..."
-if ! command -v apt-get &>/dev/null; then
-  echo "This installation script requires apt-get. For manual installation instructions, consult http://progrium.viewdocs.io/dokku/advanced-installation ."
   exit 1
-fi
+}
 
-apt-get update
+ensure-environment() {
-which curl > /dev/null || apt-get install -qq -y curl
+  local FREE_MEMORY
-[[ $(lsb_release -sr) == "12.04" ]] && apt-get install -qq -y python-software-properties
+  if [[ -z "$DOKKU_TAG" ]]; then
+    echo "Preparing to install $DOKKU_REPO..."
+  else
+    echo "Preparing to install $DOKKU_TAG from $DOKKU_REPO..."
+  fi
 
-dokku_install_source() {
+  hostname -f >/dev/null 2>&1 || {
-  apt-get install -qq -y git make software-properties-common
+    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: https://dokku.com/docs/getting-started/advanced-installation/#vms-with-less-than-1-gb-of-memory"
+  fi
+}
+
+install-requirements() {
+  echo "--> Ensuring we have the proper dependencies"
+
+  case "$DOKKU_DISTRO" in
+    debian)
+      if ! dpkg -l | grep -q gpg-agent; then
+        apt-get update -qq >/dev/null
+        apt-get -qq -y --no-install-recommends install gpg-agent
+      fi
+      if ! dpkg -l | grep -q software-properties-common; then
+        apt-get update -qq >/dev/null
+        apt-get -qq -y --no-install-recommends install software-properties-common
+      fi
+      ;;
+    ubuntu)
+      if ! dpkg -l | grep -q gpg-agent; then
+        apt-get update -qq >/dev/null
+        apt-get -qq -y --no-install-recommends install gpg-agent
+      fi
+      if ! dpkg -l | grep -q software-properties-common; then
+        apt-get update -qq >/dev/null
+        apt-get -qq -y --no-install-recommends install software-properties-common
+      fi
+
+      add-apt-repository universe >/dev/null
+      apt-get update -qq >/dev/null
+      ;;
+  esac
+}
+
+install-dokku() {
+  if ! command -v dokku &>/dev/null; then
+    echo "--> Note: Installing dokku for the first time will result in removal of"
+    echo "    files in the nginx 'sites-enabled' directory. Please manually"
+    echo "    restore any files that may be removed after the installation and"
+    echo "    web setup is complete."
+    echo ""
+    echo "    Installation will continue in 10 seconds."
+    sleep 10
+  fi
+
+  if [[ -n $DOKKU_BRANCH ]]; then
+    install-dokku-from-source "origin/$DOKKU_BRANCH"
+  elif [[ -n $DOKKU_TAG ]]; then
+    local DOKKU_SEMVER="${DOKKU_TAG//v/}"
+    major=$(echo "$DOKKU_SEMVER" | awk '{split($0,a,"."); print a[1]}')
+    minor=$(echo "$DOKKU_SEMVER" | awk '{split($0,a,"."); print a[2]}')
+    patch=$(echo "$DOKKU_SEMVER" | awk '{split($0,a,"."); print a[3]}')
+
+    use_plugin=false
+    # 0.4.0 implemented a `plugin` plugin
+    if [[ "$major" -eq "0" ]] && [[ "$minor" -ge "4" ]] && [[ "$patch" -ge "0" ]]; then
+      use_plugin=true
+    elif [[ "$major" -ge "1" ]]; then
+      use_plugin=true
+    fi
+
+    # 0.3.13 was the first version with a debian package
+    if [[ "$major" -eq "0" ]] && [[ "$minor" -eq "3" ]] && [[ "$patch" -ge "13" ]]; then
+      install-dokku-from-package "$DOKKU_SEMVER"
+      echo "--> Running post-install dependency installation"
+      dokku plugins-install-dependencies
+    elif [[ "$use_plugin" == "true" ]]; then
+      install-dokku-from-package "$DOKKU_SEMVER"
+      echo "--> Running post-install dependency installation"
+      sudo -E dokku plugin:install-dependencies --core
+    else
+      install-dokku-from-source "$DOKKU_TAG"
+    fi
+  else
+    install-dokku-from-package
+    echo "--> Running post-install dependency installation"
+    sudo -E dokku plugin:install-dependencies --core
+  fi
+}
+
+install-dokku-from-source() {
+  local DOKKU_CHECKOUT="$1"
+
+  if ! command -v apt-get &>/dev/null; then
+    log-fail "This installation script requires apt-get. For manual installation instructions, consult https://dokku.com/docs/getting-started/advanced-installation/"
+  fi
+
+  apt-get -qq -y --no-install-recommends install sudo git make software-properties-common
   cd /root
-  if [ ! -d /root/dokku ]; then
+  if [[ ! -d /root/dokku ]]; then
-    git clone $DOKKU_REPO /root/dokku
+    git clone "$DOKKU_REPO" /root/dokku
   fi
 
   cd /root/dokku
   git fetch origin
-  git checkout $DOKKU_CHECKOUT
+  [[ -n $DOKKU_CHECKOUT ]] && git checkout "$DOKKU_CHECKOUT"
   make install
 }
 
-dokku_install_package() {
+install-dokku-from-package() {
-  curl -sSL https://get.docker.io/gpg | apt-key add -
+  case "$DOKKU_DISTRO" in
-  curl -sSL https://packagecloud.io/gpg.key | apt-key add -
+    debian | ubuntu)
+      install-dokku-from-deb-package "$@"
+      ;;
+    centos | fedora | rhel)
+      install-dokku-from-rpm-package "$@"
+      ;;
+    *)
+      log-fail "Unsupported Linux distribution. For manual installation instructions, consult https://dokku.com/docs/getting-started/advanced-installation/"
+      ;;
+  esac
+}
 
-  apt-get update > /dev/null
+in-array() {
-  apt-get install -qq -y "linux-image-extra-$(uname -r)" apt-transport-https
+  declare desc="return true if value ($1) is in list (all other arguments)"
 
-  echo "deb https://get.docker.io/ubuntu docker main" > /etc/apt/sources.list.d/docker.list
+  local e
-  echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ trusty main" > /etc/apt/sources.list.d/dokku.list
+  for e in "${@:2}"; do
+    [[ "$e" == "$1" ]] && return 0
+  done
+  return 1
+}
 
-  apt-get update > /dev/null
+install-dokku-from-deb-package() {
+  local DOKKU_CHECKOUT="$1"
+  local NO_INSTALL_RECOMMENDS=${DOKKU_NO_INSTALL_RECOMMENDS:=""}
+  local OS_ID
+
+  if ! in-array "$DOKKU_DISTRO_VERSION" "18.04" "20.04" "9" "10" "11"; 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 --no-install-recommends install apt-transport-https
+
+  if ! command -v docker &>/dev/null; then
+    echo "--> Installing docker"
+    if uname -r | grep -q linode; then
+      echo "--> NOTE: Using Linode? Docker may complain about missing AUFS support."
+      echo "    You can safely ignore this warning."
+      echo ""
+      echo "    Installation will continue in 10 seconds."
+      sleep 10
+    fi
+    export CHANNEL=stable
+    wget -nv -O - https://get.docker.com/ | sh
+  fi
+
+  OS_ID="$(lsb_release -cs 2>/dev/null || echo "bionic")"
+  if ! in-array "$DOKKU_DISTRO" "debian" "ubuntu" "raspbian"; then
+    DOKKU_DISTRO="ubuntu"
+    OS_ID="bionic"
+  fi
+
+  if [[ "$DOKKU_DISTRO" == "ubuntu" ]]; then
+    OS_IDS=("bionic" "focal")
+    if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
+      OS_ID="bionic"
+    fi
+  elif [[ "$DOKKU_DISTRO" == "debian" ]]; then
+    OS_IDS=("stretch" "buster" "bullseye")
+    if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
+      OS_ID="bullseye"
+    fi
+  elif [[ "$DOKKU_DISTRO" == "raspbian" ]]; then
+    OS_IDS=("buster" "bullseye")
+    if ! in-array "$OS_ID" "${OS_IDS[@]}"; then
+      OS_ID="bullseye"
+    fi
+  fi
+
+  echo "--> Installing dokku"
+  wget -nv -O - https://packagecloud.io/dokku/dokku/gpgkey | apt-key add -
+  echo "deb https://packagecloud.io/dokku/dokku/$DOKKU_DISTRO/ $OS_ID main" | tee /etc/apt/sources.list.d/dokku.list
+  apt-get update -qq >/dev/null
+
+  [[ -n $DOKKU_VHOST_ENABLE ]] && echo "dokku dokku/vhost_enable boolean $DOKKU_VHOST_ENABLE" | sudo debconf-set-selections
+  [[ -n $DOKKU_HOSTNAME ]] && echo "dokku dokku/hostname string $DOKKU_HOSTNAME" | sudo debconf-set-selections
+  [[ -n $DOKKU_SKIP_KEY_FILE ]] && echo "dokku dokku/skip_key_file boolean $DOKKU_SKIP_KEY_FILE" | sudo debconf-set-selections
+  [[ -n $DOKKU_KEY_FILE ]] && echo "dokku dokku/key_file string $DOKKU_KEY_FILE" | sudo debconf-set-selections
+  [[ -n $DOKKU_NGINX_ENABLE ]] && echo "dokku dokku/nginx_enable string $DOKKU_NGINX_ENABLE" | sudo debconf-set-selections
 
   if [[ -n $DOKKU_CHECKOUT ]]; then
-    apt-get install -qq -y dokku=$DOKKU_CHECKOUT
+    # shellcheck disable=SC2086
+    apt-get -qq -y $NO_INSTALL_RECOMMENDS install "dokku=$DOKKU_CHECKOUT"
   else
-    apt-get install -qq -y dokku
+    # shellcheck disable=SC2086
+    apt-get -qq -y $NO_INSTALL_RECOMMENDS install dokku
   fi
 }
 
-if [[ -n $DOKKU_BRANCH ]]; then
+install-dokku-from-rpm-package() {
-  export DOKKU_CHECKOUT="origin/$DOKKU_BRANCH"
+  local DOKKU_CHECKOUT="$1"
-  dokku_install_source
-elif [[ -n $DOKKU_TAG ]]; then
-  export DOKKU_SEMVER="${DOKKU_TAG//v}"
-  major=$(echo $DOKKU_SEMVER | awk '{split($0,a,"."); print a[1]}')
-  minor=$(echo $DOKKU_SEMVER | awk '{split($0,a,"."); print a[2]}')
-  patch=$(echo $DOKKU_SEMVER | awk '{split($0,a,"."); print a[3]}')
 
-  # 0.3.13 was the first version with a debian package
+  if ! in-array "$DOKKU_DISTRO_VERSION" "7"; then
-  if [[ "$major" -eq "0" ]] && [[ "$minor" -lt "4" ]] && [[ "$patch" -lt "13" ]]; then
+    log-fail "Unsupported Linux distribution. Only the following versions are supported: $SUPPORTED_VERSIONS"
-    export DOKKU_CHECKOUT="$DOKKU_TAG"
-    dokku_install_source
-  else
-    export DOKKU_CHECKOUT="$DOKKU_SEMVER"
-    dokku_install_package
   fi
-else
-  dokku_install_package
-fi
 
+  echo "--> Installing docker"
+  curl -fsSL https://get.docker.com/ | sh
+
+  echo "--> Installing epel for nginx packages to be available"
+  yum install -y epel-release
+
+  echo "--> Installing herokuish and dokku"
+  curl -s https://packagecloud.io/install/repositories/dokku/dokku/script.rpm.sh | bash
+  if [[ -n $DOKKU_CHECKOUT ]]; then
+    yum -y install herokuish "dokku-$DOKKU_CHECKOUT"
+  else
+    yum -y install herokuish dokku
+  fi
+
+  echo "--> Enabling docker and nginx on system startup"
+  systemctl enable docker
+  systemctl enable nginx
+
+  echo "--> Starting nginx"
+  systemctl start nginx
 }
 
-bootstrap
+main() {
+  export DOKKU_DISTRO DOKKU_DISTRO_VERSION
+  # shellcheck disable=SC1091
+  DOKKU_DISTRO=$(. /etc/os-release && echo "$ID")
+  # shellcheck disable=SC1091
+  DOKKU_DISTRO_VERSION=$(. /etc/os-release && echo "$VERSION_ID")
+
+  export DEBIAN_FRONTEND=noninteractive
+  export DOKKU_REPO=${DOKKU_REPO:-"https://github.com/dokku/dokku.git"}
+
+  ensure-environment
+  install-requirements
+  install-dokku
+
+  if [[ -f /etc/update-motd.d/99-dokku ]]; then
+    /etc/update-motd.d/99-dokku || true
+  fi
+}
+
+main "$@"

circle.yml

@@ -1,13 +0,0 @@
-machine:
-  services:
-    - docker
-dependencies:
-  cache_directories:
-    - "~/docker"
-  override:
-    - ./tests/ci/parallel_runner.sh setup: { timeout: 300 }
-  post:
-    - sudo -E make -e lint
-test:
-  override:
-    - ./tests/ci/parallel_runner.sh testing: { parallel: true, timeout: 1800 }

common.mk

@@ -0,0 +1,48 @@
+GO_ARGS ?=
+GO_PLUGIN_MAKE_TARGET ?= build
+GO_REPO_ROOT := /go/src/github.com/dokku/dokku
+BUILD_IMAGE := golang:1.16.10
+GO_BUILD_CACHE ?= /tmp/dokku-go-build-cache
+GO_MOD_CACHE   ?= /tmp/dokku-go-mod-mod
+GO_ROOT_MOUNT  ?= $$PWD/../..:$(GO_REPO_ROOT)
+GOARCH         ?= amd64
+
+.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 $(GO_ROOT_MOUNT) \
+		-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)' CGO_ENABLED=0 GOOS=linux GOARCH=$(GOARCH) make -j4 $(GO_PLUGIN_MAKE_TARGET)" || exit $$?
+
+clean:
+	rm -rf $(BUILD)
+	find . -xtype l -delete
+
+commands: **/**/commands.go
+	go build -ldflags="-s -w" $(GO_ARGS) -o commands src/commands/commands.go
+
+subcommands:
+	go build -ldflags="-s -w" $(GO_ARGS) -o subcommands/subcommands src/subcommands/subcommands.go
+	$(MAKE) $(SUBCOMMANDS)
+
+subcommands/%:
+	ln -sf subcommands $@
+
+src-clean:
+	rm -rf .gitignore src vendor Makefile *.go glide.* go.sum go.mod
+
+triggers:
+	go build -ldflags="-s -w" $(GO_ARGS) -o triggers src/triggers/triggers.go
+	$(MAKE) $(TRIGGERS)
+
+triggers/%:
+	ln -sf triggers $(shell echo $@ | cut -d '/' -f2)

contrib/bash-completion

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

contrib/build-base.Dockerfile

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

contrib/build-dokku.Dockerfile

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

contrib/copy-packages

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

contrib/dokku-docker-bin.sh

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

contrib/dokku-installer.rb

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

contrib/dokku_client.sh

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

contrib/packer.json

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

contrib/release-dokku

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

contrib/release-plugin

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

contrib/stackscript.sh

@@ -1,183 +0,0 @@
-#!/bin/bash
-# <UDF name="hostname" default="" label="Hostname for dokku instance" example="example.com">
-# <UDF name="ssh_key" default="" label="Public SSH Key for root user" example="Sets the root user's public ssh key, which is also automatically imported into the dokku installer">
-# <UDF name="notify_email" default="" Label="Send Finish Notification To" example="Email address to send notification to when finished." />
-
-function logit {
-  # Simple logging function that prepends an easy-to-find marker '=> ' and a timestamp to a message
-  TIMESTAMP=$(date -u +'%m/%d %H:%M:%S')
-  MSG="=> ${TIMESTAMP} $1"
-  echo ${MSG}
-}
-
-function set_ssh_key {
-  if [ -n "${SSH_KEY}" ]; then
-    logit "Setting root ssh key"
-    mkdir -p /root/.ssh
-    chmod 700 /root/.ssh
-    echo "$SSH_KEY" > /root/.ssh/authorized_keys
-    chmod 600 /root/.ssh/authorized_keys
-    chown -R root:root /root/.ssh
-  fi
-}
-
-function set_passwordless_ssh {
-  logit "Turn off password authentication and root login for SSH"
-  echo 'PasswordAuthentication no' >> /etc/ssh/sshd_config
-  service ssh restart
-}
-
-function system_primary_ip {
-  # returns the primary IP assigned to eth0
-  ifconfig eth0 | awk -F: '/inet addr:/ {print $2}' | awk '{ print $1 }'
-}
-
-function set_hostname {
-  logit "Set up hostname"
-  if [ -n "${HOSTNAME}" ]; then
-    echo $HOSTNAME > /etc/hostname
-    echo $IPADDR $FQDN $HOSTNAME >> /etc/hosts
-  else
-    system_primary_ip > /etc/hostname
-    echo "$(system_primary_ip) localhost" >> /etc/hosts
-  fi
-
-  IPADDR=$(/sbin/ifconfig eth0 | awk '/inet / { print $2 }' | sed 's/addr://')
-  hostname -F /etc/hostname
-}
-
-function postfix_install_loopback_only {
-  logit "Installing and configuring Postfix"
-  # Installs postfix and configure to listen only on the local interface. Also
-  # allows for local mail delivery
-
-  echo "postfix postfix/destinations string localhost.localdomain, localhost" | debconf-set-selections
-  echo "postfix postfix/mailname string localhost" | debconf-set-selections
-  echo "postfix postfix/main_mailer_type select Internet Site" | debconf-set-selections
-  echo "postfix postfix/myhostname string localhost" | debconf-set-selections
-  sudo apt-get install -qq -y postfix > /dev/null 2>&1
-  /usr/sbin/postconf -e "inet_interfaces = loopback-only"
-  #/usr/sbin/postconf -e "local_transport = error:local delivery is disabled"
-
-  touch /tmp/restart-postfix
-}
-
-function notify_install_via_email {
-  if [ -n "${NOTIFY_EMAIL}" ]; then
-    logit "Sending notification email to ${NOTIFY_EMAIL}"
-    /usr/sbin/sendmail "${NOTIFY_EMAIL}" <<EOD
-To: ${NOTIFY_EMAIL}
-Subject: Dokku installation is complete
-From: Dokku StackScript <no-reply@${HOSTNAME}>
-
-Your Dokku installation is complete and now ready to be configured: http://$(system_primary_ip) . Please visit this url to complete the setup of your Dokku instance.
-
-Enjoy using Dokku!
-EOD
-  fi
-}
-
-function notify_restart_via_email {
-  if [ -n "${NOTIFY_EMAIL}" ]; then
-    logit "Sending notification email to ${NOTIFY_EMAIL} of required restart"
-    /usr/sbin/sendmail "${NOTIFY_EMAIL}" <<EOD
-To: ${NOTIFY_EMAIL}
-Subject: Dokku Linode instance must be restarted
-From: Dokku StackScript <no-reply@${HOSTNAME}>
-
-The following linode instance must be restarted:
-
-    ${LINODE_LISHUSERNAME}
-
-Before restarting, please go to this url:
-
-    https://manager.linode.com/linodes/dashboard/${LINODE_LISHUSERNAME}
-
-Then click "Edit" next to the selected configuration profile and make the following changes:
-
-- Change the "Kernel" option to the current "pv-grub" release
-- Set the "Xenify Distro" option to "no"
-
-Then save your changes. Next, reboot the instance from the Linode Dashboard. You'll receive an email once the instance is available to continue the dokku installation.
-EOD
-  fi
-}
-
-function setup_linode {
-  logit "Installing via linode"
-  DEBIAN_FRONTEND=noninteractive apt-get install -qq -y linux-virtual
-  DEBIAN_FRONTEND=noninteractive apt-get purge -qq -y grub2 grub-pc
-  DEBIAN_FRONTEND=noninteractive apt-get install -qq -y grub
-  mkdir -p /boot/grub
-  update-grub -y
-  sed -i 's/kopt=root=UUID=.* ro/kopt=root=\/dev\/xvda console=hvc0 ro quiet/g' /boot/grub/menu.lst
-  sed -i 's/# groot=(hd0,0)/# groot=(hd0)/g' /boot/grub/menu.lst
-  update-grub
-
-  cp /etc/rc.local /etc/rc.local-bak
-  cat << "EOF" > /etc/rc.local
-#!/bin/sh -e
-sudo apt-get update >> /root/setup_linode.txt 2>&1
-sudo apt-get install -y linux-image-extra-"$(uname -r)" >> /root/setup_linode.txt 2>&1
-modprobe aufs >> /root/setup_linode.txt 2>&1
-
-sudo apt-get install -y apparmor cgroup-lite >> /root/setup_linode.txt 2>&1
-
-sudo apt-get install -y dokku >> /root/setup_linode.txt 2>&1
-
-# Clean up this script so it only runs once
-rm -f /etc/rc.local
-mv /etc/rc.local-bak /etc/rc.local
-exit 0
-EOF
-  chmod +x /etc/rc.local
-}
-
-function install_prerequisites {
-  sudo apt-get install -qq -y curl > /dev/null 2>&1
-
-  logit "Installing docker gpg key"
-  curl -sSL https://get.docker.com/gpg 2> /dev/null | apt-key add - > /dev/null 2>&1
-
-  logit "Installing dokku gpg key"
-  curl -sSL https://packagecloud.io/gpg.key 2> /dev/null | apt-key add - > /dev/null 2>&1
-
-  logit "Running apt-get update"
-  sudo apt-get update > /dev/null
-
-  logit "Installing pre-requisites"
-  sudo apt-get install -qq -y apt-transport-https > /dev/null 2>&1
-
-  logit "Setting up apt repositories"
-  echo "deb https://get.docker.io/ubuntu docker main" > /etc/apt/sources.list.d/docker.list
-  echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ trusty main" > /etc/apt/sources.list.d/dokku.list
-
-  logit "Running apt-get update"
-  sudo apt-get update > /dev/null
-}
-
-function install_dokku {
-  logit "Installing pre-requisites"
-  sudo apt-get install -qq -y linux-image-extra-"$(uname -r)" > /dev/null 2>&1
-
-  logit "Installing dokku"
-  sudo apt-get install -qq -y dokku > /dev/null 2>&1
-
-  logit "Done!"
-}
-
-exec &> /root/stackscript.log
-
-set_ssh_key
-set_passwordless_ssh
-postfix_install_loopback_only
-set_hostname
-install_prerequisites
-
-if [ -n "$LINODE_ID" ]; then
-  setup_linode
-  notify_restart_via_email
-else
-  install_dokku
-  notify_install_via_email
-fi

deb.mk

@@ -1,166 +1,52 @@
-HEROKUISH_DESCRIPTION = 'Herokuish uses Docker and Buildpacks to build applications like Heroku'
+BUILD_DIRECTORY    ?= /tmp
-HEROKUISH_REPO_NAME ?= gliderlabs/herokuish
+DOKKU_DESCRIPTION   = 'Docker powered PaaS that helps you build and manage the lifecycle of applications'
-HEROKUISH_VERSION ?= 0.0.1
+DOKKU_REPO_NAME    ?= dokku/dokku
-HEROKUISH_ARCHITECTURE = amd64
+DOKKU_ARCHITECTURE ?= amd64
-HEROKUISH_PACKAGE_NAME = herokuish_$(HEROKUISH_VERSION)_$(HEROKUISH_ARCHITECTURE).deb
 
-DOKKU_DESCRIPTION = 'Docker powered mini-Heroku in around 100 lines of Bash'
+ifndef IS_RELEASE
-DOKKU_REPO_NAME ?= progrium/dokku
+	IS_RELEASE = true
-DOKKU_ARCHITECTURE = amd64
+endif
 
-PLUGINHOOK_DESCRIPTION = 'Simple dispatcher and protocol for shell-based plugins, an improvement to hook scripts'
-PLUGINHOOK_REPO_NAME ?= progrium/pluginhook
-PLUGINHOOK_VERSION ?= 0.2.0
-PLUGINHOOK_ARCHITECTURE = amd64
-PLUGINHOOK_PACKAGE_NAME = pluginhook_$(PLUGINHOOK_VERSION)_$(PLUGINHOOK_ARCHITECTURE).deb
 
-SSHCOMMAND_DESCRIPTION = 'Turn SSH into a thin client specifically for your app'
+.PHONY: install-from-deb deb-all deb-dokku deb-setup
-SSHCOMMAND_REPO_NAME ?= progrium/sshcommand
-SSHCOMMAND_VERSION ?= 0.0.1
-SSHCOMMAND_ARCHITECTURE = amd64
-SSHCOMMAND_PACKAGE_NAME = sshcommand_$(SSHCOMMAND_VERSION)_$(SSHCOMMAND_ARCHITECTURE).deb
-
-GEM_ARCHITECTURE = amd64
-
-GOROOT = /usr/lib/go
-GOBIN = /usr/bin/go
-GOPATH = /home/vagrant/gocode
-
-.PHONY: install-from-deb deb-all deb-herokuish deb-dokku deb-gems deb-pluginhook deb-setup deb-sshcommand
 
 install-from-deb:
-	echo "--> Initial apt-get update"
+	@echo "--> Initial apt-get update"
-	sudo apt-get update > /dev/null
+	sudo apt-get update -qq >/dev/null
-	sudo apt-get install -y apt-transport-https curl
+	sudo apt-get -qq -y --no-install-recommends install apt-transport-https
 
-	echo "--> Installing docker gpg key"
+	@echo "--> Installing docker"
-	curl -sSL https://get.docker.com/gpg | apt-key add -
+	wget -nv -O - https://get.docker.com/ | sh
 
-	echo "--> Installing dokku gpg key"
+	@echo "--> Installing dokku"
-	curl --silent https://packagecloud.io/gpg.key 2> /dev/null | apt-key add - 2>&1 >/dev/null
+	wget -nv -O - https://packagecloud.io/dokku/dokku/gpgkey | apt-key add -
+	@echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ $(shell lsb_release -cs 2>/dev/null || echo "bionic") main" | sudo tee /etc/apt/sources.list.d/dokku.list
+	sudo apt-get update -qq >/dev/null
+	sudo DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true apt-get -qq -y --no-install-recommends install dokku
 
-	echo "--> Setting up apt repositories"
+deb-all: deb-setup deb-dokku
-	echo "deb https://get.docker.io/ubuntu docker main" > /etc/apt/sources.list.d/docker.list
+	mv $(BUILD_DIRECTORY)/*.deb .
-	echo "deb https://packagecloud.io/dokku/dokku/ubuntu/ trusty main" > /etc/apt/sources.list.d/dokku.list
+	@echo "Done"
-
-	echo "--> Running apt-get update"
-	sudo apt-get update > /dev/null
-
-	echo "--> Installing pre-requisites"
-	sudo apt-get install -y linux-image-extra-`uname -r`
-
-	echo "--> Installing dokku"
-	sudo apt-get install -y dokku
-
-	echo "--> Done!"
-
-deb-all: deb-herokuish deb-dokku deb-gems deb-pluginhook deb-sshcommand
-	mv /tmp/*.deb .
-	echo "Done"
 
 deb-setup:
-	echo "-> Updating deb repository and installing build requirements"
+	@echo "-> Updating deb repository and installing build requirements"
-	sudo apt-get update > /dev/null
+	@sudo apt-get update -qq >/dev/null
-	sudo apt-get install -qq -y gcc git ruby1.9.1-dev 2>&1 > /dev/null
+	@sudo DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true apt-get -qq -y --no-install-recommends install gcc git build-essential wget ruby-dev ruby1.9.1 lintian >/dev/null 2>&1
-	command -v fpm > /dev/null || sudo gem install fpm --no-ri --no-rdoc
+	@command -v fpm >/dev/null || sudo gem install fpm --no-ri --no-rdoc
-	ssh -o StrictHostKeyChecking=no git@github.com || true
+	@ssh -o StrictHostKeyChecking=no git@github.com || true
 
-deb-herokuish: deb-setup
+deb-dokku: /tmp/build-dokku/var/lib/dokku/GIT_REV
-	rm -rf /tmp/tmp /tmp/build $(HEROKUISH_PACKAGE_NAME)
+	rm -f $(BUILD_DIRECTORY)/dokku_*_$(DOKKU_ARCHITECTURE).deb
-	mkdir -p /tmp/tmp /tmp/build
 
-	echo "-> Creating deb files"
+	cat /tmp/build-dokku/var/lib/dokku/VERSION | cut -d '-' -f 1 | cut -d 'v' -f 2 > /tmp/build-dokku/var/lib/dokku/STABLE_VERSION
-	echo "#!/usr/bin/env bash" >> /tmp/tmp/post-install
+ifneq (,$(findstring false,$(IS_RELEASE)))
-	echo "sleep 5" >> /tmp/tmp/post-install
+	sed -i.bak -e "s/^/`date +%s`:/" /tmp/build-dokku/var/lib/dokku/STABLE_VERSION && rm /tmp/build-dokku/var/lib/dokku/STABLE_VERSION.bak
-	echo "count=\`sudo docker images | grep gliderlabs/herokuish | wc -l\`" >> /tmp/tmp/post-install
+endif
-	echo 'if [ "$$count" -ne 0 ]; then' >> /tmp/tmp/post-install
-	echo "  echo 'Removing old herokuish image'" >> /tmp/tmp/post-install
-	echo "  sudo docker rmi gliderlabs/herokuish" >> /tmp/tmp/post-install
-	echo "fi" >> /tmp/tmp/post-install
-	echo "echo 'Importing herokuish into docker (around 5 minutes)'" >> /tmp/tmp/post-install
-	echo "sudo docker build -t gliderlabs/herokuish /var/lib/herokuish 1> /dev/null" >> /tmp/tmp/post-install
 
-	echo "-> Cloning repository"
+	cp -r debian /tmp/build-dokku/DEBIAN
-	git clone -q "git@github.com:$(HEROKUISH_REPO_NAME).git" /tmp/tmp/herokuish > /dev/null
+	sed -i.bak "s/^Architecture: .*/Architecture: $(DOKKU_ARCHITECTURE)/g" /tmp/build-dokku/DEBIAN/control && rm  /tmp/build-dokku/DEBIAN/control.bak
-	rm -rf /tmp/tmp/herokuish/.git /tmp/tmp/herokuish/.gitignore
+	rm -f /tmp/build-dokku/DEBIAN/lintian-overrides
-
+	cp debian/lintian-overrides /tmp/build-dokku/usr/share/lintian/overrides/dokku
-	echo "-> Copying files into place"
+	sed -i.bak "s/^Version: .*/Version: `cat /tmp/build-dokku/var/lib/dokku/STABLE_VERSION`/g" /tmp/build-dokku/DEBIAN/control && rm /tmp/build-dokku/DEBIAN/control.bak
-	mkdir -p "/tmp/build/var/lib"
+	dpkg-deb --build /tmp/build-dokku "$(BUILD_DIRECTORY)/dokku_`cat /tmp/build-dokku/var/lib/dokku/VERSION`_$(DOKKU_ARCHITECTURE).deb"
-	cp -rf /tmp/tmp/herokuish /tmp/build/var/lib/herokuish
+	lintian "$(BUILD_DIRECTORY)/dokku_`cat /tmp/build-dokku/var/lib/dokku/VERSION`_$(DOKKU_ARCHITECTURE).deb" || true
-
-	echo "-> Creating $(HEROKUISH_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n herokuish -v $(HEROKUISH_VERSION) -a $(HEROKUISH_ARCHITECTURE) -p $(HEROKUISH_PACKAGE_NAME) --deb-pre-depends 'lxc-docker-1.6.2' --after-install /tmp/tmp/post-install --url "https://github.com/$(HEROKUISH_REPO_NAME)" --description $(HEROKUISH_DESCRIPTION) --license 'MIT License' .
-	mv *.deb /tmp
-
-deb-dokku: deb-setup
-	rm -rf /tmp/tmp /tmp/build dokku_*_$(DOKKU_ARCHITECTURE).deb
-	mkdir -p /tmp/tmp /tmp/build
-
-	cp -r debian /tmp/build/DEBIAN
-	mkdir -p /tmp/build/usr/local/bin
-	mkdir -p /tmp/build/var/lib/dokku
-	mkdir -p /tmp/build/usr/local/share/man/man1
-	mkdir -p /tmp/build/usr/local/share/dokku/contrib
-
-	cp dokku /tmp/build/usr/local/bin
-	cp -r plugins /tmp/build/var/lib/dokku
-	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do touch /tmp/build/var/lib/dokku/plugins/$$plugin/.core; done
-	$(MAKE) help2man
-	$(MAKE) addman
-	cp /usr/local/share/man/man1/dokku.1 /tmp/build/usr/local/share/man/man1/dokku.1
-	cp contrib/dokku-installer.rb /tmp/build/usr/local/share/dokku/contrib
-	git describe --tags > /tmp/build/var/lib/dokku/VERSION
-	cat /tmp/build/var/lib/dokku/VERSION | cut -d '-' -f 1 | cut -d 'v' -f 2 > /tmp/build/var/lib/dokku/STABLE_VERSION
-	git rev-parse HEAD > /tmp/build/var/lib/dokku/GIT_REV
-	sed -i "s/^Version: .*/Version: `cat /tmp/build/var/lib/dokku/STABLE_VERSION`/g" /tmp/build/DEBIAN/control
-	dpkg-deb --build /tmp/build "/vagrant/dokku_`cat /tmp/build/var/lib/dokku/STABLE_VERSION`_$(DOKKU_ARCHITECTURE).deb"
-	mv *.deb /tmp
-
-deb-gems: deb-setup
-	rm -rf /tmp/tmp /tmp/build rubygem-*.deb
-	mkdir -p /tmp/tmp /tmp/build
-
-	gem install --quiet --no-verbose --no-ri --no-rdoc --install-dir /tmp/tmp rack -v 1.5.2 > /dev/null
-	gem install --quiet --no-verbose --no-ri --no-rdoc --install-dir /tmp/tmp rack-protection -v 1.5.3 > /dev/null
-	gem install --quiet --no-verbose --no-ri --no-rdoc --install-dir /tmp/tmp sinatra -v 1.4.5 > /dev/null
-	gem install --quiet --no-verbose --no-ri --no-rdoc --install-dir /tmp/tmp tilt -v 1.4.1 > /dev/null
-
-	find /tmp/tmp/cache -name '*.gem' | xargs -rn1 fpm -d ruby -d ruby --prefix /var/lib/gems/1.9.1 -s gem -t deb -a $(GEM_ARCHITECTURE)
-	mv *.deb /tmp
-
-deb-pluginhook: deb-setup
-	rm -rf /tmp/tmp /tmp/build $(PLUGINHOOK_PACKAGE_NAME)
-	mkdir -p /tmp/tmp /tmp/build
-
-	echo "-> Cloning repository"
-	git clone -q "git@github.com:$(PLUGINHOOK_REPO_NAME).git" /tmp/tmp/pluginhook > /dev/null
-	rm -rf /tmp/tmp/pluginhook/.git /tmp/tmp/pluginhook/.gitignore
-
-	echo "-> Copying files into place"
-	mkdir -p /tmp/build/usr/local/bin $(GOPATH)
-	sudo apt-get update > /dev/null
-	sudo apt-get install -qq -y git golang mercurial 2>&1 > /dev/null
-	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH) && go get "golang.org/x/crypto/ssh/terminal"
-	export PATH=$(PATH):$(GOROOT)/bin:$(GOPATH)/bin && export GOROOT=$(GOROOT) && export GOPATH=$(GOPATH) && cd /tmp/tmp/pluginhook && go build -o pluginhook
-	mv /tmp/tmp/pluginhook/pluginhook /tmp/build/usr/local/bin/pluginhook
-
-	echo "-> Creating $(PLUGINHOOK_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n pluginhook -v $(PLUGINHOOK_VERSION) -a $(PLUGINHOOK_ARCHITECTURE) -p $(PLUGINHOOK_PACKAGE_NAME) --url "https://github.com/$(PLUGINHOOK_REPO_NAME)" --description $(PLUGINHOOK_DESCRIPTION) --license 'MIT License' .
-	mv *.deb /tmp
-
-deb-sshcommand: deb-setup
-	rm -rf /tmp/tmp /tmp/build $(SSHCOMMAND_PACKAGE_NAME)
-	mkdir -p /tmp/tmp /tmp/build
-
-	echo "-> Cloning repository"
-	git clone -q "git@github.com:$(SSHCOMMAND_REPO_NAME).git" /tmp/tmp/sshcommand > /dev/null
-	rm -rf /tmp/tmp/sshcommand/.git /tmp/tmp/sshcommand/.gitignore
-
-	echo "-> Copying files into place"
-	mkdir -p "/tmp/build/usr/local/bin"
-	cp /tmp/tmp/sshcommand/sshcommand /tmp/build/usr/local/bin/sshcommand
-	chmod +x /tmp/build/usr/local/bin/sshcommand
-
-	echo "-> Creating $(SSHCOMMAND_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n sshcommand -v $(SSHCOMMAND_VERSION) -a $(SSHCOMMAND_ARCHITECTURE) -p $(SSHCOMMAND_PACKAGE_NAME) --url "https://github.com/$(SSHCOMMAND_REPO_NAME)" --description $(SSHCOMMAND_DESCRIPTION) --license 'MIT License' .
-	mv *.deb /tmp

debian/config

@@ -1,18 +1,16 @@
-#!/bin/sh -e
+#!/bin/bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
-. /usr/share/debconf/confmodule
+if [[ -e /usr/share/debconf/confmodule ]]; then
+  # shellcheck disable=SC1091
+  . /usr/share/debconf/confmodule
+fi
 
 readonly ACTION="${1:-configure}"
 readonly VERSION="${2:-dev}"
 
-db_input "high" "dokku/web_config" || true
+db_input "high" "dokku/nginx_enable" || true
-db_go || true
-
-db_get "dokku/web_config"
-if [ $RET = "true" ]; then
-    exit 0
-fi
-
 db_input "high" "dokku/hostname" || true
 db_input "high" "dokku/vhost_enable" || true
 if [ "$ACTION" != "reconfigure" ]; then

debian/control

@@ -1,9 +1,12 @@
 Package: dokku
-Version: 0.3.12
+Version: 0.27.1
-Section: base
+Section: web
 Priority: optional
 Architecture: amd64
-Depends: locales, git, make, curl, software-properties-common, lxc-docker-1.6.2, gcc, python-software-properties, man-db, herokuish, sshcommand, pluginhook
+Depends: locales, git, cpio, curl, man-db, netcat, sshcommand (>= 0.12.0), docker-engine-cs (>= 17.05.0) | docker-engine (>= 17.05.0) | docker-io (>= 17.05.0) | docker.io (>= 17.05.0) | docker-ce (>= 17.05.0) | docker-ee (>= 17.05.0) | moby-engine, docker-image-labeler (>= 0.2.2), net-tools, netrc, software-properties-common, parallel, procfile-util (>= 0.11.0), python-software-properties | python3-software-properties, rsync, rsyslog, dos2unix, jq, unzip
-Pre-Depends: nginx, dnsutils, ruby, ruby-dev, rubygem-rack, rubygem-rack-protection, rubygem-sinatra, rubygem-tilt, apparmor, cgroup-lite
+Recommends: herokuish (>= 0.3.4), bash-completion, 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 mini-Heroku in around 100 lines of Bash
+Description: Docker-powered PaaS that helps build and manage the lifecycle of applications
+ Dokku is an extensible, open source Platform as a Service
+ that runs on a single server of your choice.

debian/lintian-overrides

@@ -0,0 +1,12 @@
+dokku: command-with-path-in-maintainer-script postinst:22 /usr/bin/sshcommand
+dokku: maintainer-script-calls-systemctl postinst:98
+dokku: changelog-file-missing-in-native-package
+dokku: statically-linked-binary
+dokku: unstripped-binary-or-object
+
+# The Go compiler is currently unable to produce read-only relocations
+# (it produces static binaries).
+dokku: hardening-no-relro
+
+# Built golang binaries link to libc
+dokku: missing-dependency-on-libc

debian/postinst

@@ -1,49 +1,144 @@
-#!/bin/sh
+#!/bin/bash
-set -e
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
-. /usr/share/debconf/confmodule
+if [[ -e /usr/share/debconf/confmodule ]]; then
+  # shellcheck disable=SC1091
+  . /usr/share/debconf/confmodule
+fi
+
+if [[ -r /etc/default/dokku ]]; then
+  # shellcheck disable=SC1091
+  source /etc/default/dokku
+fi
 
 readonly DOKKU_ROOT="${DOKKU_ROOT:-/home/dokku}"
+readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
 
-case "$1" in
+call-sshcommand() {
-  abort-upgrade|abort-remove|abort-deconfigure)
+  if [[ -x /usr/local/bin/sshcommand ]]; then
-    ;;
+    /usr/local/bin/sshcommand "$@"
+  elif [[ -x /usr/bin/sshcommand ]]; then
+    /usr/bin/sshcommand "$@"
+  else
+    echo "Unable to find sshcommand binary" 1>&2
+    exit 1
+  fi
+}
 
-  configure)
+setup-user() {
-    mandb
+  echo "Setting up dokku user"
-    [ ! -x /usr/bin/docker.io ] || ln -sf /usr/bin/docker.io /usr/local/bin/docker
+  call-sshcommand create dokku /usr/bin/dokku
-    modprobe aufs || echo "WARNING: Restart server to finish installing dokku!"
+  grep -i -E "^docker" /etc/group || groupadd docker
-    sshcommand create dokku /usr/local/bin/dokku
+  usermod -aG docker dokku
-    egrep -i "^docker" /etc/group || groupadd docker
+  mkdir -p "$DOKKU_ROOT/.ssh" "$DOKKU_ROOT/.dokkurc"
-    usermod -aG docker dokku
+  touch "$DOKKU_ROOT/.ssh/authorized_keys"
-    dokku plugins-install
+  chown -R dokku:dokku "$DOKKU_ROOT/.ssh" "${DOKKU_ROOT}/.dokkurc"
-    rm -f /home/dokku/VERSION
+}
-    cp /var/lib/dokku/STABLE_VERSION /home/dokku/VERSION
 
-    if [ -f /etc/init/dokku-installer.conf ] && service dokku-installer status 2> /dev/null | grep waiting; then
+setup-storage() {
-        sudo service dokku-installer start
+  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 "Deleting invalid plugins"
+  if [ -f "${DOKKU_LIB_ROOT}/core-plugins/available/" ]; then
+    find "${DOKKU_LIB_ROOT}/core-plugins/available/" -type d -empty -delete
+  fi
+  if [ -f "${DOKKU_LIB_ROOT}/core-plugins/enabled/" ]; then
+    find "${DOKKU_LIB_ROOT}/core-plugins/enabled/" -type d -empty -delete
+  fi
+  if [ -f "${DOKKU_LIB_ROOT}/plugins/available/" ]; then
+    find "${DOKKU_LIB_ROOT}/plugins/available/" -type d -empty -delete
+  fi
+  if [ -f "${DOKKU_LIB_ROOT}/plugins/enabled/" ]; then
+    find "${DOKKU_LIB_ROOT}/plugins/enabled/" -type d -empty -delete
+  fi
+
+  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/web_config"
+  db_get "dokku/nginx_enable"
-    if [ "$RET" = "true" ]; then
+  echo "Enabling all core plugins"
-      exit 0
+  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
+}
+
+dpkg-handling() {
+  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" 
+      db_get "dokku/hostname"
-        echo "$RET" > "${DOKKU_ROOT}/VHOST"
+      echo "Setting VHOST contents to $RET"
-    else
+      echo "$RET" >"${DOKKU_ROOT}/VHOST"
-        rm -f "${DOKKU_ROOT}/VHOST"
+    fi
+  fi
+
+  if [ -z "${DEBCONF_RECONFIGURE}" ]; then
+    db_get "dokku/key_file"
+    if [ -f "$RET" ]; then
+      call-sshcommand acl-add dokku default <"$RET" || true
+    fi
+  fi
+}
+
+case "$1" in
+  abort-upgrade | abort-remove | abort-deconfigure) ;;
+
+  \
+    configure)
+    mandb
+    [ ! -x /usr/bin/docker.io ] || ln -sf /usr/bin/docker.io /usr/local/bin/docker
+    if [[ -f /sbin/modprobe ]]; then
+      modprobe aufs || echo "WARNING: Restart server to finish installing dokku!"
     fi
 
-    db_get "dokku/hostname"
+    setup-user
-    echo "$RET" > "${DOKKU_ROOT}/HOSTNAME"
+    setup-storage
 
-    if [ -z "${DEBCONF_RECONFIGURE}" ]; then
+    dpkg-handling
-      db_get "dokku/key_file"
+    setup-plugins
-      sshcommand acl-add dokku default < "$RET"
+    setup-sshcommand
-    fi
     ;;
 
   *)
@@ -52,4 +147,5 @@ case "$1" in
     ;;
 esac
 
+db_stop
 exit 0

debian/postrm

@@ -0,0 +1,61 @@
+#!/bin/bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
+
+if [[ -e /usr/share/debconf/confmodule ]]; then
+  # shellcheck disable=SC1091
+  . /usr/share/debconf/confmodule
+fi
+
+readonly DOKKU_ROOT="${DOKKU_ROOT:-/home/dokku}"
+readonly DOKKU_LIB_ROOT="${DOKKU_LIB_PATH:-/var/lib/dokku}"
+readonly DOKKU_LOGS_DIR="${DOKKU_LOGS_DIR:="/var/log/dokku"}"
+
+main() {
+  if [[ -f /etc/systemd/system/dokku-installer.service ]] || [[ -f /etc/init/dokku-installer.conf ]]; then
+    service dokku-installer stop || true
+  fi
+
+  rm -f /etc/init/dokku-installer.conf
+  rm -f /etc/init/dokku-redeploy.conf
+  rm -f /etc/systemd/system/dokku-installer.service
+  rm -f /etc/systemd/system/dokku-redeploy.service
+  rm -f /etc/update-motd.d/99-dokku
+
+  db_get "dokku/nginx_enable"
+  if [ "$RET" = "true" ]; then
+    (nginx -t && service nginx reload) || true
+  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 -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
+    rm -rf ${DOKKU_LIB_ROOT}/core-plugins
+
+    rm -f ${DOKKU_LIB_ROOT}/plugins/config.toml
+    if [[ -d ${DOKKU_LIB_ROOT} ]]; then
+      find -L ${DOKKU_LIB_ROOT} -type l -delete
+      find ${DOKKU_LIB_ROOT} -type d -empty -delete
+    fi
+
+    if [[ -d ${DOKKU_ROOT} ]]; then
+      find -L ${DOKKU_ROOT} -type l -delete
+      find ${DOKKU_ROOT} -type d -empty -delete
+    fi
+
+    rm -rf "${DOKKU_LOGS_DIR}"
+
+    deluser dokku || true
+    delgroup dokku || true
+
+    db_purge
+  fi
+}
+
+main "$@"

debian/preinst

@@ -1,56 +1,32 @@
-#!/bin/sh
+#!/bin/bash
-set -e
+set -eo pipefail
+[[ $TRACE ]] && set -x
 
-. /usr/share/debconf/confmodule
+if [[ -e /usr/share/debconf/confmodule ]]; then
+  # shellcheck disable=SC1091
+  . /usr/share/debconf/confmodule
+fi
 
 case "$1" in
   install)
-    db_get "dokku/web_config"
+    db_get "dokku/skip_key_file"
-    if [ "$RET" = "true" ]; then
+    if [ -z "${DEBCONF_RECONFIGURE}" ] && [ "$RET" != "true" ]; then
-      INIT_CONF="/etc/init/dokku-installer.conf"
-      NGINX_CONF="/etc/nginx/conf.d/dokku-installer.conf"
-
-      rm -f $INIT_CONF
-      touch $INIT_CONF
-      echo 'start on runlevel [2345]' >> $INIT_CONF
-      echo 'exec /usr/local/share/dokku/contrib/dokku-installer.rb selfdestruct' >> $INIT_CONF
-
-      rm -f $NGINX_CONF
-      touch $NGINX_CONF
-
-      {
-        echo 'upstream dokku-installer { server 127.0.0.1:2000; }'
-        echo 'server {'
-        echo '  listen      80;'
-        echo '  location    / {'
-        echo '    proxy_pass  http://dokku-installer;'
-        echo '  }'
-        echo '}'
-      } >> $NGINX_CONF
-
-      rm -f /etc/nginx/sites-enabled/*
-      service nginx reload || /etc/init.d/nginx reload
-      exit 0
-    fi
-
-    if [ -z "${DEBCONF_RECONFIGURE}" ]; then
       db_get "dokku/key_file"
       if [ ! -f "$RET" ]; then
-          echo "Error: keyfile '$RET' not found."
+        echo "Error: keyfile '$RET' not found." >&2
-          echo "       you can enter a new keyfile path when you restart the installation."
+        echo "       To deploy, you will need to generate a keypair and add with 'dokku ssh-keys:add'." >&2
-          db_reset "dokku/key_file"
+        db_reset "dokku/key_file"
-          exit 1
       fi
     fi
     ;;
 
-  upgrade)
+  upgrade) ;;
-    ;;
 
-  abort-upgrade)
+  \
-    ;;
+    abort-upgrade) ;;
 
-  *)
+  \
+    *)
     echo "preinst called with unknown argument \`$1'" >&2
     exit 1
     ;;

debian/prerm

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

debian/templates

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

docker/etc/cron.d/dokku-retire

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

docker/etc/logrotate.d/services

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

docker/etc/my_init.d/10_dokku_init

@@ -0,0 +1,90 @@
+#!/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
+}
+
+support-userns() {
+  chown 0:0 /usr/bin/sudo
+  chmod 4755 /usr/bin/sudo
+  chown 0:0 /usr/lib/sudo/sudoers.so
+  chown -R 0:0 /etc/sudoers
+  chown -R 0:0 /etc/sudoers.d
+  chown -R 0:0 /run/sshd
+}
+
+main() {
+  local NGINX_ROOT
+
+  support-userns
+
+  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
+
+  if [[ -n "$DOKKU_HOST_ROOT" ]]; then
+    touch /etc/default/dokku
+    echo "export DOKKU_HOST_ROOT=$DOKKU_HOST_ROOT" >>/etc/default/dokku
+    chown dokku:dokku /etc/default/dokku
+  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,/usr/bin/pack,/usr/bin/crontab

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/bin/pack

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $TRACE ]] && set -x
+
+main() {
+  declare desc="re-runs pack commands as sudo"
+  local PACK_BIN=""
+  if [[ -x "/usr/bin/pack" ]]; then
+    PACK_BIN="/usr/bin/pack"
+  fi
+
+  if [[ -z "$PACK_BIN" ]]; then
+    echo "!   No pack binary found" 1>&2
+    exit 1
+  fi
+
+  sudo -E "$PACK_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-installation.md

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

docs/advanced-usage/backup-recovery.md

@@ -0,0 +1,106 @@
+# Backup and Recovery
+
+> The backup plugin was deprecated in 0.4.x, below are backup recommendations for 0.5.x and later.
+
+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 apps can be rebuilt. Please consult the [process management documentation](/docs/processes/process-management.md#rebuilding-apps) for more information on how to rebuild apps.
+
+## 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.
+
+```shell
+git remote rm dokku
+git remote add dokku dokku@[dokku.me:dokku.me]
+git push dokku [master]
+```
+
+### Docker Networks
+
+Docker networks generated by Dokku should be recreated. Running `dokku network:report` will output all networks in use by various apps, which can then be used to recreate them via `dokku network:create $NETWORK`.
+
+Networks created by tools other than Dokku may be created as they initially were.
+
+### Docker Image and Tar-based Apps
+
+These apps 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.
+
+For [dokku-postgres](https://github.com/dokku/dokku-postgres), use:
+
+```shell
+dokku postgres:export [db_name] > [db_name].dump
+dokku postgres:import [db_name] < [db_name].dump
+```
+
+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.
+
+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 app.
+
+## Recovering app code
+
+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 !$
+git init && git remote add dokku dokku@[dokku.me:app-name]
+git pull dokku/master && git checkout dokku/master
+```

docs/advanced-usage/deployment-tasks.md

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

docs/advanced-usage/docker-options.md

@@ -0,0 +1,127 @@
+# Docker Container Options
+
+> New as of 0.3.17
+
+Pass [container options](https://docs.docker.com/engine/reference/run/) to the `docker run` command  during Dokku's `build`, `deploy` and `run` phases
+
+```
+docker-options:add <app> <phase(s)> OPTION    # Add Docker option to app for phase (comma-separated phase list)
+docker-options:clear <app> [<phase(s)>...]    # Clear a docker options from application
+docker-options:remove <app> <phase(s)> OPTION # Remove Docker option from app for phase (comma-separated phase list)
+docker-options:report [<app>] [<flag>]        # Displays a docker options report for one or more apps
+```
+
+> When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so:
+>
+> ```shell
+> dokku docker-options:add node-js-app deploy,run "-v /var/log/node-js-app:/app/logs"
+> ```
+
+## About Dokku phases
+
+Dokku deploys your application in multiple "phases" and the `docker-options` plugin allows you to pass arguments to their underlying docker container:
+
+- `build`: the container that executes the appropriate buildpack
+- `deploy`: the container that executes your running/deployed application
+- `run`: the container that executes any arbitrary command via `dokku run`
+
+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/.
+
+Container options configured via the `docker-options` plugin are not used to modify the process a container runs. Container options are the `[OPTIONS]` portion of the following, where `[CONTAINER_COMMAND]` and `[ARG]` are the process and the arguments passed to it that are launched in the created container: `docker run [OPTIONS] [CONTAINER_COMMAND] [ARG...]`. Please see the documentation for [customizing the run command](/docs/deployment/builders/dockerfiles.md#customizing-the-run-command) or use a [Procfile](/docs/deployment/builders/dockerfiles.md#procfiles-and-multiple-processes) to modify the command used by a Dockerfile-based container.
+
+## Examples
+
+### Add Docker options
+
+Add some options for the deployed/running app and when executing [`dokku run`](/docs/processes/one-off-tasks.md):
+
+```shell
+# Mount a host volume in a Docker container: "-v /host/path:/container/path"
+dokku docker-options:add node-js-app deploy "-v /var/log/node-js-app:/app/logs"
+dokku docker-options:add node-js-app run "-v /var/log/node-js-app:/app/logs"
+```
+
+> Note: When [mounting a host directory](https://docs.docker.com/engine/reference/run/#volume-shared-filesystems) in a Dokku app you should first create that directory as user `dokku` and then mount the directory under `/app` in the container using `docker-options` as above. Otherwise the app will lack write permission in the directory.
+
+### Remove a Docker option
+
+```shell
+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
+
+You can get a report about the app's docker-options status using the `docker-options:report` command:
+
+```shell
+dokku docker-options:report
+```
+
+```
+=====> node-js-app docker options information
+       Docker options build:
+       Docker options deploy: -v /var/log/node-js-app:/app/logs
+       Docker options run:  -v /var/log/node-js-app:/app/logs
+=====> python-sample docker options information
+       Docker options build:
+       Docker options deploy:
+       Docker options run:
+=====> ruby-sample docker options information
+       Docker options build:
+       Docker options deploy:
+       Docker options run:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku docker-options:report node-js-app
+```
+
+```
+=====> node-js-app docker options information
+       Docker options build:
+       Docker options deploy: -v /var/log/node-js-app:/app/logs
+       Docker options run:  -v /var/log/node-js-app:/app/logs
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku docker-options:report node-js-app --docker-options-build
+```

docs/advanced-usage/event-logs.md

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

docs/advanced-usage/persistent-storage.md

@@ -0,0 +1,178 @@
+# Persistent Storage
+
+> New as of 0.5.0
+
+The preferred method to mount external containers to a Dokku managed container, is to use the Dokku storage plugin.
+
+```
+storage:ensure-directory [--chown option] <directory>  # Creates a persistent storage directory in the recommended storage path
+storage:list <app>                                     # List bind mounts for app's container(s) (host:container)
+storage:mount <app> <host-dir:container-dir>           # Create a new bind mount
+storage:report [<app>] [<flag>]                        # Displays a checks report for one or more apps
+storage:unmount <app> <host-dir:container-dir>         # Remove an existing bind mount
+```
+
+> The storage plugin is compatible with storage mounts created with the docker-options. The storage plugin will only list mounts from the deploy/run phase.
+
+The storage plugin supports the following mount points:
+
+- explicit paths that exist on the host
+- docker volumes
+
+## Usage
+
+### Creating storage directories
+
+> New as of 0.25.5
+
+A storage directory can be created with the `storage:ensure-directory` command. This command will create a subdirectory in the recommended `/var/lib/dokku/data/storage` path - created during Dokku installation - and prepare it for use with an app.
+
+```shell
+dokku storage:ensure-directory lollipop
+```
+
+```
+-----> Ensuring /var/lib/dokku/data/storage/lollipop exists
+       Setting directory ownership to 32767:32767
+       Directory ready for mounting
+```
+
+By default, permissions are set for usage with Herokuish buildpacks. These permissions can be changed via the `--chown` option according to the following table:
+
+- `--chown herokuish` (default): Use `32767:32767` as the folder permissions.
+  - This is used for apps deployed with Buildpacks via Herokuish.
+- `--chown heroku`: Use `1000:1000` as the folder permissions.
+  - This is used for apps deployed with Cloud Native Buildpacks using the `heroku/buildpacks` builder.
+- `--chown packeto`: Use `2000:2000` as the folder permissions.
+  - This is used for apps deployed with Cloud Native Buildpacks using the `cloudfoundry/cnb` or `packeto` builders.
+- `--chown false`: Skips the `chown` call.
+
+Users deploying via Dockerfile will want to specify `--chown false` and manually `chown` the created directory if the user and/or group id  of the runnning process in the deployed container do not correspond to any of the above options.
+
+> Warning: Failing to set the correct directory ownership may result in issues in persisting files written to the mounted storage directory.
+
+### Mounting storage into apps
+
+Dokku supports mounting both explicit host paths as well as docker volumes via the `storage:mount` command. This takes two arguments, an app name and a `host-path:container-path` or `docker-volume:container-path` combination.
+
+```shell
+# mount the directory into your container's /app/storage directory, relative to the container root (/)
+# explicit host paths _must_ exist prior to usage.
+dokku storage:mount node-js-app /var/lib/dokku/data/storage/node-js-app:/app/storage
+
+# mount the docker volume into your container's /app/storage directory, relative to the container root (/)
+# docker volumes _must_ exist prior to usage.
+dokku storage:mount node-js-app some-docker-volume:/app/storage
+```
+
+In the first example, Dokku will then mount the shared contents of `/var/lib/dokku/data/storage/node-js-app` to `/app/storage` inside the container.  The mount point is *not* relative to your app's working directory, and is instead relative to the root (`/`) of the container. Mounts are only available for containers created via `run` and by the deploy process, and not during the build process. In addition, the host path is never auto-created by either Dokku or Docker, and should be an explicit path, not one relative to the current working directory.
+
+> If the `/storage` path within the container had pre-existing content, the container files will be over-written. This may be an issue for users that create assets at build time but then mount a directory at the same place during runtime. Files are not merged.
+
+Once persistent storage is mounted, the app requires a restart. See the [process scaling documentation](/docs/processes/process-management.md) for more information.
+
+```shell
+dokku ps:restart app-name
+```
+
+### Unmounting storage
+
+If an app no longer requires a mounted volume or directory, the `storage:unmount` command can be called. This takes the same arguments as the `storage:mount` command, an app name and a `host-path:container-path` or `docker-volume:container-path` combination.
+
+```shell
+# unmount the directory from your container's /app/storage directory, relative to the container root (/)
+dokku storage:unmount node-js-app /var/lib/dokku/data/storage/node-js-app:/app/storage
+
+# unmount the docker volume from your container's /app/storage directory, relative to the container root (/)
+dokku storage:unmount node-js-app some-docker-volume:/app/storage
+```
+
+Once persistent storage is unmounted, the app requires a restart. See the [process scaling documentation](/docs/processes/process-management.md) for more information.
+
+```shell
+dokku ps:restart app-name
+```
+
+### Displaying storage reports for an app
+
+> New as of 0.8.1
+
+You can get a report about the app's storage status using the `storage:report` command:
+
+```shell
+dokku storage:report
+```
+
+```
+=====> node-js-app storage information
+       Storage build mounts:
+       Storage deploy mounts: -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+       Storage run mounts:  -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+=====> python-sample storage information
+       Storage build mounts:
+       Storage deploy mounts:
+       Storage run mounts:
+=====> ruby-sample storage information
+       Storage build mounts:
+       Storage deploy mounts:
+       Storage run mounts:
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku storage:report node-js-app
+```
+
+```
+=====> node-js-app storage information
+       Storage build mounts:
+       Storage deploy mounts: -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+       Storage run mounts:  -v /var/lib/dokku/data/storage/node-js-app:/app/storage
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+
+```shell
+dokku storage:report node-js-app --storage-deploy-mounts
+```
+
+## Use Cases
+
+### Sharing storage across deploys
+
+Dokku is powered by Docker containers, which recommends in their [best practices](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#containers-should-be-ephemeral) that containers be treated as ephemeral. In order to manage persistent storage for web apps, like user uploads or large binary assets like images, a directory outside the container should be mounted.
+
+### Shared storage between containers
+
+When scaling your app, you may require a common location to access shared assets between containers, a storage mount can be used in this situation.
+
+### Shared storage across environments
+
+Your app may be used in a cluster that requires containers or resources not running on the same host access your data. Mounting a shared file service (like S3FS or EFS) inside your container will give you great flexibility.
+
+### Backing up
+
+Your app may have services that are running in memory and need to be backed up locally (like a key store). Mount a non ephemeral storage mount will allow backups that are not lost when the app is shut down.
+
+### Build phase
+
+By default, Dokku will only bind storage mounts during the deploy and run phases. Under certain conditions, one might want to bind a storage mount during the build phase. This can be accomplished by using the `docker-options` plugin directly.
+
+```shell
+dokku docker-options:add node-js-app build "-v /tmp/python-test:/opt/test"
+```
+
+You cannot use mounted volumes during the build phase of a Dockerfile deploy. This is because Docker does not support volumes when executing `docker build`.
+
+> Note: **This can cause data loss** if you bind a mount under `/app` in buildpack apps as herokuish will attempt to remove the original app path during the build phase.
+
+## App User and Persistent Storage file ownership (buildpack apps only)
+
+> New as of 0.7.1
+
+By default, Dokku will execute your buildpack app processes as the `herokuishuser` user. You may override this by setting the `DOKKU_APP_USER` config variable.
+
+> NOTE: this user must exist in your herokuish image.
+
+Additionally, 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

@@ -0,0 +1,208 @@
+# Plugin Management
+
+> New as of 0.4.0
+
+```
+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
+```
+
+```shell
+# for 0.3.x
+cd /var/lib/dokku/plugins
+git clone <git url>
+dokku plugins-install
+```
+
+> These commands require `root` permissions as the `install` and `install-dependencies` plugin triggers may utilize commands such as `apt-get`. For non-core plugins, please inspect those plugins before running the following command as `root` user.
+
+## Usage
+
+### Listing Plugins
+
+Installed plugins can be listed via the `plugin:list` command:
+
+```shell
+dokku plugin:list
+```
+
+```
+plugn: dev
+  00_dokku-standard    0.27.1 enabled    dokku core standard plugin
+  20_events            0.27.1 enabled    dokku core events logging plugin
+  app-json             0.27.1 enabled    dokku core app-json plugin
+  apps                 0.27.1 enabled    dokku core apps plugin
+  build-env            0.27.1 enabled    dokku core build-env plugin
+  buildpacks           0.27.1 enabled    dokku core buildpacks plugin
+  certs                0.27.1 enabled    dokku core certificate management plugin
+  checks               0.27.1 enabled    dokku core checks plugin
+  common               0.27.1 enabled    dokku core common plugin
+  config               0.27.1 enabled    dokku core config plugin
+  docker-options       0.27.1 enabled    dokku core docker-options plugin
+  domains              0.27.1 enabled    dokku core domains plugin
+  enter                0.27.1 enabled    dokku core enter plugin
+  git                  0.27.1 enabled    dokku core git plugin
+  logs                 0.27.1 enabled    dokku core logs plugin
+  network              0.27.1 enabled    dokku core network plugin
+  nginx-vhosts         0.27.1 enabled    dokku core nginx-vhosts plugin
+  plugin               0.27.1 enabled    dokku core plugin plugin
+  proxy                0.27.1 enabled    dokku core proxy plugin
+  ps                   0.27.1 enabled    dokku core ps plugin
+  repo                 0.27.1 enabled    dokku core repo plugin
+  resource             0.27.1 enabled    dokku core resource plugin
+  scheduler-docker-local 0.27.1 enabled    dokku core scheduler-docker-local plugin
+  shell                0.27.1 enabled    dokku core shell plugin
+  ssh-keys             0.27.1 enabled    dokku core ssh-keys plugin
+  storage              0.27.1 enabled    dokku core storage plugin
+  tags                 0.27.1 enabled    dokku core tags plugin
+  tar                  0.27.1 enabled    dokku core tar plugin
+  trace                0.27.1 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
+```
+
+```
+-----> Cloning plugin repo https://github.com/dokku/dokku-postgres.git to /var/lib/dokku/plugins/available/postgres
+Cloning into 'postgres'...
+remote: Counting objects: 646, done.
+remote: Total 646 (delta 0), reused 0 (delta 0), pack-reused 646
+Receiving objects: 100% (646/646), 134.24 KiB | 0 bytes/s, done.
+Resolving deltas: 100% (406/406), done.
+Checking connectivity... done.
+-----> Plugin postgres enabled
+```
+
+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
+```
+
+```
+-----> Plugin postgres uninstalled
+```
+
+### 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
+```
+
+```
+-----> Plugin postgres disabled
+```
+
+### Enabling a plugin
+
+Disabled plugins can be re-enabled via the `plugin:enable` command.
+
+```shell
+dokku plugin:enable postgres
+```
+
+```
+-----> Plugin postgres enabled
+```
+
+### 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:trigger some-internal-trigger args-go-here
+```

docs/advanced-usage/registry-management.md

@@ -0,0 +1,126 @@
+# Registry Management
+
+> New as of 0.25.0
+
+```
+registry:login [--password-stdin] <server> <username> [<password>] # Login to a docker registry
+registry:report [<app>] [<flag>]                                   # Displays a registry report for one or more apps
+registry:set <app> <key> (<value>)                                 # Set or clear a registry property for an app
+```
+
+The registry plugin enables interacting with remote registries, which is useful when either deploying images via `git:from-image` or when interacting with custom schedulers to deploy built image artifacts.
+
+## Usage
+
+### Logging into a registry
+
+The `registry:login` command can be used to log into a docker registry. The following are examples for logging into various common registries:
+
+```shell
+# hub.docker.com
+dokku registry:login docker.io $USERNAME $PASSWORD
+
+# digitalocean
+# the username and password are both defined as the same api token
+dokku registry:login registry.digitalocean.com $DIGITALOCEAN_API_TOKEN $DIGITALOCEAN_API_TOKEN
+
+# github container registry
+# see the following link for information on retrieving a personal access token
+#   https://docs.github.com/en/packages/guides/pushing-and-pulling-docker-images#authenticating-to-github-container-registry
+dokku registry:login ghcr.io $USERNAME $REGISTRY_PAT_TOKEN
+
+# quay
+# a robot user may be used to login
+dokku registry:login quay.io $USERNAME $PASSWORD
+```
+
+For security reasons, the password may also be specified as stdin by specifying the `--password-stdin` flag. This is supported regardless of the registry being logged into.
+
+```shell
+echo "$PASSWORD" | dokku registry:login --password-stdin docker.io $USERNAME
+```
+
+For certain Docker registries - such as Amazon ECR or Google's GCR registries - users may instead wish to use a docker credential helper to automatically authenticate against a server; please see the documentation regarding the credential helper in question for further setup instructions.
+
+### Setting a remote server
+
+To specify a remote server registry for pushes, set the `server` property via the `registry:set` command. The default value for this property is empty string. Setting the value to `docker.io` or `hub.docker.com` will result in the computed value being empty string (as that is the default, implicit registry), while any non-zero length value will have a `/` appended to it if there is not one already.
+
+```shell
+dokku registry:set node-js-app server docker.io
+```
+
+This property can be set for a single app or globally via the `--global` flag. When set globally, the app-specific value will always overide the global value. The default global value for this property is empty string.
+
+```shell
+dokku registry:set --global server docker.io
+```
+
+Setting the property value to an empty string will reset the value to the system default. Resetting the value can be done per app or globally.
+
+```shell
+# per-app
+dokku registry:set node-js-app server
+
+# globally
+dokku registry:set --global server
+```
+
+The following are the values that should be used for common remote servers:
+
+- Amazon Elastic Container Registry:
+  - value: `$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/`
+  - notes: The `$AWS_ACCOUNT_ID` and `$AWS_REGION` should match the values for your account and region, respectively. Additionally, an IAM profile that allows `push` access to the repository specified by `image-repo` should be attached to your Dokku server.
+- Azure Container Registry:
+  - value `$REGISTRY_NAME.azurecr.io/`
+  - notes: The `$AKS_REGISTRY_NAME` should match the name of the registry created on your account.
+- Docker Hub:
+  - value: `docker.io/`
+  - notes: Requires owning the namespace used in the `image-repo` value.
+- Digitalocean:
+  - value: `registry.digitalocean.com/`
+  - notes: Requires setting the correct `image-repo` value for your registry.
+- Github Container Registry:
+  - value: `ghcr.io/`
+  - notes: Requires that the authenticated user has access to the namespace used in the `image-repo` value.
+- Quay.io:
+  - value: `quay.io/`
+
+### Specifying an image repository name
+
+By default, Dokku uses the value `dokku/$APP_NAME` as the image repository that is pushed and deployed. For certain registries, the `dokku` namespace may not be available to your user. In these cases, the value can be set by changing the value of the `image-repo` property via the `registry:set` command.
+
+```shell
+dokku registry:set node-js-app image-repo my-awesome-prefix/node-js-app
+```
+
+Setting the property value to an empty string will reset the value to the system default. Resetting the value has to be done per-app.
+
+```shell
+# per-app
+dokku registry:set node-js-app push-on-release
+```
+
+### Pushing images on build
+
+To push the image on release, set the `push-on-release` property to `true` via the `registry:set` command. The default value for this property is `false`. Setting the property to `true` will result in the image being tagged with an ID that is incremented with every release. This tag will be what is used for running app code.
+
+```shell
+dokku registry:set node-js-app push-on-release true
+```
+
+This property can be set for a single app or globally via the `--global` flag. When set globally, the app-specific value will always overide the global value. The default global value for this property is `false`.
+
+```shell
+dokku registry:set --global push-on-release true
+```
+
+Setting the property value to an empty string will reset the value to the system default. Resetting the value can be done per app or globally.
+
+```shell
+# per-app
+dokku registry:set node-js-app push-on-release
+
+# globally
+dokku registry:set --global push-on-release
+```

docs/advanced-usage/repository-management.md

@@ -0,0 +1,36 @@
+# Repository Management
+
+> New as of 0.6.0
+
+```
+repo:gc <app>                            # Runs 'git gc --aggressive' against the application's repo
+repo:purge-cache <app>                   # Deletes the contents of the build cache stored in the repository
+```
+
+The repository plugin is meant to allow users to perform management commands against a repository.
+
+## Usage
+
+### Git Garbage Collection
+
+This will run a git gc --aggressive against the applications repo. This is performed on the Dokku host, and not within an application container.
+
+```shell
+dokku repo:gc node-js-app
+```
+
+```
+Counting objects: 396, done.
+Delta compression using up to 2 threads.
+Compressing objects: 100% (365/365), done.
+Writing objects: 100% (396/396), done.
+Total 396 (delta 79), reused 315 (delta 0)
+```
+
+### Clearing Application cache
+
+Building containers with buildpacks currently results in a persistent `cache` directory between deploys. If you need to clear this cache directory for any reason, you may do so by running the following shell command:
+
+```shell
+dokku repo:purge-cache node-js-app
+```

docs/advanced-usage/resource-management.md

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

docs/appendices/0.10.0-migration-guide.md

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

docs/appendices/0.20.0-migration-guide.md

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

docs/appendices/0.21.0-migration-guide.md

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

docs/appendices/0.22.0-migration-guide.md

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

docs/appendices/0.23.0-migration-guide.md

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

docs/appendices/0.24.0-migration-guide.md

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

docs/appendices/0.25.0-migration-guide.md

@@ -0,0 +1,35 @@
+# 0.25.0 Migration Guide
+
+## Registry Plugin
+
+The [dokku-registry](https://github.com/dokku/dokku-registry) plugin is now built-in. This comes with a few changes:
+
+- Builder plugins should call `post-release-builder` at the end of the build.
+- The `push` and `pull` command are not implemented. Users wishing to deploy a remote image should use `git:from-image`. Image pushing is not available at this time.
+- At this time, remote docker repositories are not automatically created for AWS, and users must create those repositories for their applications as necessary. This may be implemented in the future.
+- Docker images are only pushed when configured to do so. See the [registry management documentation](/docs/deployment/registry-management.md) for more details.
+
+## Other
+
+### Changes
+
+- The network plugin can now set an `initial-network` for all containers on creation. This is a replacement for specifying the `--network` flag via the `docker-options` plugin. Please see the [network documentation](/docs/networking/network.md#attaching-an-app-to-a-network) for more information.
+- The `dokku run` command now always removes the ephemeral container on exit. Users that need a persistent container should instead specify a `console` process type in their `Procfile` specifying an available shell (usually either `bash` or `sh`) and scale that container appropriately.
+- The `pre-deploy` plugin trigger is now called internally by Dokku. Scheduler plugins should avoid calling this trigger, as any image changes introduced by subsequent trigger calls will be ignored.
+- The default image used for Herokuish Buildpack builds is now `gliderlabs/herokuish:latest-20`, and is based on both the `heroku-20` stack as well as Ubuntu 20.04. Users that wish to stick with the old, `heroku-18`/Ubuntu 18.04 builder may specify `gliderlabs/herokuish:latest-18` as their builder image. Please see the [herokuish buildpack deployment documentation](/docs/deployment/builders/herokuish-buildpacks.md#customizing-the-buildpack-stack-builder) for more information on how to specify a custom buildpack stack builder.
+  - This change does not impact any users of Cloud Native Buildpacks.
+- We fixed an issue that required extracting Procfiles at the beginning of a deploy. Due to this change, a `Dockerfile` app contains a `Procfile` that does not specify a `web` process will fail to start. Usage of a `Procfile` with _only_ a `release` command should be replaced with a `scripts.dokku.postdeploy` deployment task in the `app.json` file. The alternative is to define the `web` process in the `Procfile`. See the [deployment task documentation](/docs/advanced-usage/deployment-tasks.md) for more information.
+
+### Deprecations
+
+- In previous versions of Dokku, the only way to specify a custom `Dockerfile` was to use the `docker-options` plugin to set the `--file` flag for a docker build. As of 0.25.0, the `builder-dockerfile:set` command should be used instead, as outlined in the [docs here](/docs/deployment/builders/dockerfiles.md#changingthe-dockerfile-location). Usage of the old method should be migrated to the new method.
+- The `--rm` and `--rm-container` flags may be specified but no longer have any effect on `dokku run`.
+- The `--detach` flag is deprecated in favor of the `run:detached` command.
+- The `DOKKU_SCALE` file is deprecated. Please see the [process management documentation](/docs/processes/process-management.md#manually-managing-process-scaling) for more information on it's replacement with the `formation` key of the `app.json` file.
+- The hooks `post-release-buildpack`, `post-release-dockerfile`, and `post-release-pack` are deprecated in favor of `post-release-builder`. See the [plugin triggers documentation](https://dokku.com/docs/development/plugin-triggers/#post-release-builder) for more details.
+
+## Removals
+
+- As of April 2021, Ubuntu 16.04 is no longer an LTS release, and support has been removed. Packages may still install on older versions of Ubuntu, but are no longer tested, and therefore no support will be provided.
+- The web installer has been removed. Users are now required to setup Dokku via cli commands. This change was made to combat potential security issues where users ignored the web installer, allowing unauthorized users to add their keys to the host.
+- The `scheduler-docker-cleanup` plugin trigger has been removed from the scheduler interface, and is no longer invoked.

docs/appendices/0.26.0-migration-guide.md

@@ -0,0 +1,12 @@
+# 0.26.0 Migration Guide
+
+## Removals
+
+- The `tags` plugin - deprecated in [0.24.0](/docs/appendices/0.24.0-migration-guide.md) - was removed. Users are highly encouraged to switch their workflows to `git:from-image`.
+- The `tar` plugin - deprecated in [0.24.0](/docs/appendices/0.24.0-migration-guide.md) - was removed. Users are highly encouraged to switch their workflows to `git:from-archive`.
+
+## Changes
+
+- The `scheduler` plugin now controls the scheduler in use for deploys. Apps will have their `DOKKU_SCHEDULER` environment variables migrated to the scheduler plugin, after which that value will be removed from said app. Please see the [scheduler documentation](/docs/deployment/schedulers/scheduler-management.md) for more information.
+- The `deploy-source` metadata from `apps:report` is now no longer computed on the fly, but hydrated at deploy time via the `deploy-source-set` trigger. This value may be empty until your next deploy.
+  - Additionally, the `deploy-source` trigger has now been removed.

docs/appendices/0.27.0-migration-guide.md

@@ -0,0 +1,13 @@
+# 0.27.0 Migration Guide
+
+## Changes
+
+- Renaming an application will now only rename domains that are associated with global domains. As an example:
+    ```shell
+    dokku domains:set-global dokku.me
+    dokku apps:create node-js-app
+    dokku domains:set node-js-app node-js-app.dokku.me node-js-app.dokku.com
+    dokku apps:rename node-js-app other-name
+    dokku domains:report node-js-app --domains-app-vhosts
+    # output: other-name.dokku.me node-js-app.dokku.com
+    ```

docs/appendices/0.5.0-migration-guide.md

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

docs/appendices/0.6.0-migration-guide.md

@@ -0,0 +1,32 @@
+# 0.6.0 Migration Guide
+
+## Zero-downtime deployment
+
+- You can now **actually** disable zero-downtime deployments per-app and per-process-type
+  - Some config variables have been moved around
+    - `DOKKU_CHECKS_ENABLED` has been migrated to `DOKKU_CHECKS_SKIPPED`
+    - `DOKKU_CHECKS_DISABLED` is now a thing
+    - The values for the above can be a comma-separated list of process-types or the literal string `_all_`
+  - See the [updated `checks`](/docs/deployment/zero-downtime-deploys.md) docs for more info
+
+## Proxy port mapping
+
+- You can now configure host -> container proxy port mappings
+  - The UI is handled by the [proxy](/docs/networking/proxy-management.md) interface plugin by setting the `DOKKU_PROXY_PORT_MAP` config variable in the format of `scheme:host-port:container-port`. The default `nginx-vhosts` proxy plugin supports both the `http` and `https` schemes.
+- Default port mappings
+  - buildpack apps will be set to `http:80:5000` and will also include `https:443:5000` if SSL is enabled.
+  - dockerfile apps with explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on each exposed port that proxies to the same port of the deployed application container.
+    - You may override this behavior with the [`proxy:ports-*` commands](/docs/networking/proxy-management.md) or by directly setting `DOKKU_PROXY_PORT_MAP` with the `config:set` command
+    - dockerfile apps without explicitly exposed ports will behave the same as a buildpack app
+  - NOTE: These defaults **are not** automatically changed on subsequent pushes and must be manipulated with the aforementioned commands
+
+## Calling the `dokku` binary
+
+- Plugins should *not* call the `dokku` binary directly. Clients using the `--app` argument are potentially broken, amongst others, when doing so. Instead, please source the `functions` file for a given plugin when attempting to call Dokku internal functions. As a result, the following Dokku commands are no longer publicly exposed:
+  - `dokku build`
+  - `dokku receive`
+  - `dokku release`
+  - `dokku tar:build`
+  - `dokku tar:build-locked`
+  - `dokku git:build`
+  - `dokku git:build-locked`

docs/appendices/0.7.0-migration-guide.md

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

docs/appendices/0.8.0-migration-guide.md

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

docs/appendices/0.9.0-migration-guide.md

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

docs/application-deployment.md

@@ -1,160 +0,0 @@
-# Deploy an App
-
-Now you can deploy apps on your Dokku. Let's deploy the [Heroku Node.js sample app](https://github.com/heroku/node-js-sample). All you have to do is add a remote to name the app. It's created on-the-fly.
-
-```
-$ cd node-js-sample
-$ git remote add dokku dokku@dokku.me:node-js-app
-$ git push dokku master
-Counting objects: 296, done.
-Delta compression using up to 4 threads.
-Compressing objects: 100% (254/254), done.
-Writing objects: 100% (296/296), 193.59 KiB, done.
-Total 296 (delta 25), reused 276 (delta 13)
------> Building node-js-app ...
-       Node.js app detected
------> Resolving engine versions
-
-... blah blah blah ...
-
------> Application deployed:
-       http://node-js-app.dokku.me
-```
-
-You're done!
-
-Dokku only supports deploying from its master branch, so if you'd like to deploy a different local branch use: ```git push dokku <local branch>:master```
-
-Right now Herokuish supports buildpacks for Node.js, Ruby, Python, [and more](https://github.com/gliderlabs/herokuish#buildpacks).
-Please check the documentation for your particular build pack as you may need to include configuration files (such as a Procfile) in your project root.
-
-## Deploying to server over SSH
-
-Pushing to the dokku remote may prompt you to input a password for the dokku user. It's preferable, however, to use key-based authentication, and you can add your public key to the dokku user's authorized_keys file with:
-
-```
-cat ~/.ssh/id_rsa.pub | ssh [sudouser]@[yourdomain].com "sudo sshcommand acl-add dokku [description]"
-```
-
-## Deploying with private git submodules
-
-Dokku uses git locally (i.e. not a docker image) to build its own copy of your app repo, including submodules. This is done as the `dokku` user. Therefore, in order to deploy private git submodules, you'll need to drop your deploy key in `~dokku/.ssh` and potentially add github.com (or your VCS host key) into `~dokku/.ssh/known_hosts`. A decent test like this should help confirm you've done it correctly.
-
-```
-su - dokku
-ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
-ssh -T git@github.com
-```
-
-## Specifying a custom buildpack
-
-If buildpack detection isn't working well for you or you want to specify a custom buildpack for one repository you can create & commit a file in the root of your git repository named `.env` containing `export BUILDPACK_URL=<repository>` before pushing. This will tell herokuish to fetch the specified buildpack and use it instead of relying on the built-in buildpacks & their detection methods.
-
-## Dockerfile deployment
-
-Deployment of `Dockerfile` repos is supported as of v0.3.15. Simply place a Dockerfile in the root of your repo and push to dokku. If you are converting from a heroku/dokku buildpack deployment, ensure you are not setting `$BUILDPACK_URL` or including a `.buildpacks` file in the root of your repo.
-
-By default, we will extract the first `EXPOSE` port and tell nginx to proxy your app to that port. Alternatively, you can set `$DOCKERFILE_PORT` in your app's dokku configuration.
-
-By default no arguments are passed to `docker run` when deploying the container and the `CMD` or `ENTRYPOINT` defined in the `Dockerfile` are executed. You can take advantage of docker ability of overriding the `CMD` or passing parameters to your `ENTRYPOINT` setting `$DOKKU_DOCKERFILE_START_CMD`. Let's say for example you are deploying a base nodejs image, with the following `ENTRYPOINT`:
-
-```
-ENTRYPOINT ["node"]
-```
-
-You can do:
-
-```
-dokku config:set DOKKU_DOCKERFILE_START_CMD="--harmony server.js"
-```
-
-To tell docker what to run.
-
-Setting `$DOKKU_DOCKERFILE_CACHE_BUILD` to `true` or `false` will enable or disable docker's image layer cache. Lastly, for more granular build control, you may also pass any `docker build` option to `docker`, by setting `$DOKKU_DOCKER_BUILD_OPTS`.
-
-## Default vhost
-
-You might notice the default vhost for Nginx will be one of the apps. If an app doesn't exist, it will use this vhost and it may be confusing for it to go to another app. You can create a default vhost using a configuration under `sites-enabled`. You just have to change one thing in the main nginx.conf:
-
-Swap both conf.d include line and the sites-enabled include line. From:
-```
-include /etc/nginx/conf.d/*.conf;
-include /etc/nginx/sites-enabled/*;
-```
-to
-```
-include /etc/nginx/sites-enabled/*;
-include /etc/nginx/conf.d/*.conf;
-```
-
-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.
-
-## Deploying to subdomains
-
-The name of remote repository is used as the name of application to be deployed, as for example above:
-
-    $ git remote add dokku dokku@dokku.me:node-js-app
-    $ git push dokku master
-
-Is deployed to,
-
-    remote: -----> Application deployed:
-    remote:        http://node-js-app.dokku.me
-
-You can also specify fully qualified names, say `app.dokku.me`, as
-
-    $ git remote add dokku dokku@dokku.me:app.dokku.me
-    $ git push dokku master
-
-So, after deployment the application will be available at,
-
-    remote: -----> Application deployed:
-    remote:        http://app.dokku.me
-
-This is in particular useful, then you want to deploy to root domain, as
-
-    $ git remote add dokku dokku@dokku.me:dokku.me
-    $ git push dokku master
-
-    ... deployment ...
-
-    remote: -----> Application deployed:
-    remote:        http://dokku.me
-
-# Zero downtime deploy
-
-Following a deploy, dokku will now wait `DOKKU_DEFAULT_CHECKS_WAIT` seconds (default: `10`), and if the container is still running, then route traffic to the new container.
-
-This can be problematic for applications whose boot up time can vary and can lead to `502 Bad Gateway` errors.
-
-Dokku provides a way to run a set of more precise checks against the new container, and only switch traffic over if all checks complete successfully.
-
-To specify checks, add a `CHECKS` file to the root of your project directory. This is a text file with one line per check. Empty lines and lines starting with `#` are ignored.
-
-A check is a relative URL and may be followed by expected content from the page, for example:
-
-```
-/about      Our Amazing Team
-```
-
-Dokku will wait `DOKKU_CHECKS_WAIT` seconds (default: `5`) before running the checks to give server time to start. For shorter/longer wait, change the `DOKKU_CHECKS_WAIT` environment variable.  This can also be overridden in the CHECKS file by setting WAIT=nn.
-
-Dokku will wait `DOKKU_WAIT_TO_RETIRE` seconds (default: `60`) before stopping the old container such that no existing connections to it are dropped.
-
-Dokku will retry the checks DOKKU_CHECKS_ATTEMPTS times until the checks are successful or DOKKU_CHECKS_ATTEMPTS is exceeded.  In the latter case, the deployment is considered failed. This can be overridden in the CHECKS file by setting ATTEMPTS=nn.
-
-Checks can be skipped entirely by setting `DOKKU_SKIP_ALL_CHECKS` to `true` either globally or per application. You can choose to skip only default checks by setting `DOKKU_SKIP_DEFAULT_CHECKS` to `true` either globally or per application.
-
-See [checks-examples.md](checks-examples.md) for examples and output.
-
-# Removing a deployed app
-
-SSH onto the server, then execute:
-
-```shell
-dokku apps:destroy myapp
-```
-
-# Dokku/Docker Container Management Compatibility
-
-Dokku is, at it's core, a docker container manager. Thus, it does not necessarily play well with other out-of-band processes interacting with the docker daemon. One thing to note as in [issue #1220](https://github.com/progrium/dokku/issues/1220), dokku executes a cleanup function prior to every deployment. This function removes all exited containers and all 'unattached' images.