Release 1.41.2

docs: ensure --name flag is used in installation docs

.devcontainer/20_init_plugin

@@ -0,0 +1,24 @@
+#!/bin/bash
+set -eo pipefail
+
+log-info() {
+  declare desc="Log info formatter"
+  echo "    $*" 1>&2
+}
+
+log-fail() {
+  declare desc="Log fail formatter"
+  echo "!   $*" 1>&2
+  exit 1
+}
+
+main() {
+  dokku plugin:install
+
+  # built in the Dockerfile
+  PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")"
+  PLUGIN_VARIABLE="$(source /tmp/.env && echo "$PLUGIN_VARIABLE")"
+  echo "export ${PLUGIN_VARIABLE}_HOST_ROOT=${SERVICE_HOST_ROOT}/$PLUGIN_NAME" >/etc/default/dokku
+}
+
+main "$@"

.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 clean autoclean && \
+  apt-get autoremove --yes && \
+  rm -rf /var/lib/apt/lists/* && \
+  mkdir -p /mnt/dokku/home/dokku /mnt/dokku/var/lib/dokku/config /mnt/dokku/var/lib/dokku/data /mnt/dokku/var/lib/dokku/services && \
+  chown -R dokku:dokku /mnt/dokku/home/dokku /mnt/dokku/var/lib/dokku/config /mnt/dokku/var/lib/dokku/data /mnt/dokku/var/lib/dokku/services && \
+  echo "dokku.me" > /home/dokku/VHOST
+
+ADD https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem /mnt/dokku/etc/nginx/dhparam.pem
+
+COPY .devcontainer/20_init_plugin /etc/my_init.d/20_init_plugin
+COPY .devcontainer/bin/ /usr/local/bin/
+
+COPY . .
+
+RUN source /tmp/config && \
+  echo "export ${PLUGIN_DISABLE_PULL_VARIABLE}=true" > /tmp/.env && \
+  echo "export PLUGIN_NAME=${PLUGIN_COMMAND_PREFIX}" >> /tmp/.env && \
+  echo "export PLUGIN_VARIABLE=${PLUGIN_VARIABLE}" >> /tmp/.env
+
+RUN source /tmp/.env && \
+  dokku plugin:install file:///tmp --name $PLUGIN_NAME && \
+  make ci-dependencies

.devcontainer/bin/copy-file

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+main() {
+  PLUGIN_NAME="$(source /tmp/.env && echo "$PLUGIN_NAME")"
+  cp "$1" "/var/lib/dokku/plugins/enabled/$PLUGIN_NAME/$1"
+}
+
+main "$@"

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "containerEnv": {
+    "SERVICE_HOST_ROOT": "${localWorkspaceFolder}/tmp/data"
+  },
+  "initializeCommand": ["mkdir", "-p", "tmp/data"],
+  "mounts": [
+    "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind",
+    "source=${localWorkspaceFolder}/tmp/data/,target=/var/lib/dokku/services/,type=bind"
+  ],
+  "overrideCommand": false,
+  "runArgs": ["--init"]
+}

.github/dependabot.yml

@@ -0,0 +1,12 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

.github/workflows/ci.yml

@@ -0,0 +1,100 @@
+---
+name: CI
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: build-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  unit-tests-master:
+    name: unit-tests
+    runs-on: ubuntu-22.04
+    env:
+      DOKKU_VERSION: master
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.7.x'
+
+      - run: make setup
+
+      - run: sudo sysctl -w vm.max_map_count=262144
+
+      - run: |
+          git fetch -q origin master
+          changed=$(git --no-pager diff --name-only $GITHUB_SHA..origin/master)
+          if [ $changed = "Dockerfile" ]; then
+            echo "Please run 'make generate' to update the image version in the README.md"
+          else
+            make generate
+            if ! git diff --quiet README.md; then
+              echo "Please run 'make generate'"
+              git status --short
+              git --no-pager diff README.md
+              exit 1
+            fi
+          fi
+
+      - run: make test
+
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: tmp/test-results
+          path: test-results
+
+  unit-tests-0_19_0:
+    name: unit-tests-0.19.0
+    runs-on: ubuntu-22.04
+    env:
+      DOKKU_TAG: v0.19.0
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.7.x'
+
+      - run: make setup
+
+      - run: sudo sysctl -w vm.max_map_count=262144
+
+      - run: |
+          git fetch -q origin master
+          changed=$(git --no-pager diff --name-only $GITHUB_SHA..origin/master)
+          if [ $changed = "Dockerfile" ]; then
+            echo "Please run 'make generate' to update the image version in the README.md"
+          else
+            make generate
+            if ! git diff --quiet README.md; then
+              echo "Please run 'make generate'"
+              git status --short
+              git --no-pager diff README.md
+              exit 1
+            fi
+          fi
+
+      - run: make test
+
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: tmp/test-results
+          path: test-results

.github/workflows/tagged-release.yml

@@ -0,0 +1,19 @@
+---
+name: "tagged-release"
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  tagged-release:
+    name: tagged-release
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: "marvinpinto/action-automatic-releases@v1.2.1"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          prerelease: false

.gitignore

@@ -1,2 +1,3 @@
 /tmp
 .vagrant
+bootstrap.sh

.travis.yml

@@ -1,9 +0,0 @@
-dist: trusty
-language: bash
-env:
-  - DOKKU_VERSION=master
-  - DOKKU_VERSION=v0.14.0
-  - DOKKU_VERSION=v0.12.0
-install: make setup
-script: make test
-after_failure: make report

Dockerfile

@@ -0,0 +1 @@
+FROM mysql:9.2.0

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (C) 2018 Jose Diaz-Gonzalez
+Copyright (C) 2020 Jose Diaz-Gonzalez
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Makefile

@@ -1,5 +1,10 @@
 HARDWARE = $(shell uname -m)
 SYSTEM_NAME  = $(shell uname -s | tr '[:upper:]' '[:lower:]')
+ARCH = $(shell dpkg --print-architecture)
+SHFMT_VERSION = 3.0.2
+XUNIT_TO_GITHUB_VERSION = 0.3.0
+XUNIT_READER_VERSION = 0.1.0
+
 
 bats:
 ifeq ($(SYSTEM_NAME),darwin)
@@ -7,7 +12,7 @@ ifneq ($(shell bats --version >/dev/null 2>&1 ; echo $$?),0)
 	brew install bats-core
 endif
 else
-	git clone https://github.com/josegonzalez/bats-core.git /tmp/bats
+	git clone https://github.com/bats-core/bats-core.git /tmp/bats
 	cd /tmp/bats && sudo ./install.sh /usr/local
 	rm -rf /tmp/bats
 endif
@@ -17,7 +22,11 @@ ifneq ($(shell shellcheck --version >/dev/null 2>&1 ; echo $$?),0)
 ifeq ($(SYSTEM_NAME),darwin)
 	brew install shellcheck
 else
-	sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu trusty-backports main restricted universe multiverse'
+ifeq ($(ARCH),arm64)
+  sudo add-apt-repository 'deb http://ports.ubuntu.com/ubuntu-ports jammy-backports main restricted universe multiverse'
+else
+  sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu jammy-backports main restricted universe multiverse'
+endif
 	sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean
 	sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck
 endif
@@ -28,7 +37,7 @@ ifneq ($(shell shfmt --version >/dev/null 2>&1 ; echo $$?),0)
 ifeq ($(shfmt),Darwin)
 	brew install shfmt
 else
-	wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v2.6.2/shfmt_v2.6.2_linux_amd64
+	wget -qO /tmp/shfmt https://github.com/mvdan/sh/releases/download/v$(SHFMT_VERSION)/shfmt_v$(SHFMT_VERSION)_linux_amd64
 	chmod +x /tmp/shfmt
 	sudo mv /tmp/shfmt /usr/local/bin/shfmt
 endif
@@ -59,13 +68,13 @@ unit-tests:
 	@echo running unit tests...
 	@mkdir -p tmp/test-results/bats
 	@cd tests && echo "executing tests: $(shell cd tests ; ls *.bats | xargs)"
-	cd tests && bats --formatter bats-format-junit -e -T -o ../tmp/test-results/bats *.bats
+	cd tests && bats --report-formatter junit --timing -o ../tmp/test-results/bats *.bats
 
-tmp/xunit-to-github:
+tmp/xunit-reader:
 	mkdir -p tmp
-	curl -o tmp/xunit-to-github.tgz -sL https://github.com/josegonzalez/go-xunit-to-github/releases/download/v0.3.0/xunit-to-github_0.3.0_$(SYSTEM_NAME)_$(HARDWARE).tgz
+	curl -o tmp/xunit-reader.tgz -sL https://github.com/josegonzalez/go-xunit-reader/releases/download/v$(XUNIT_READER_VERSION)/xunit-reader_$(XUNIT_READER_VERSION)_$(SYSTEM_NAME)_$(HARDWARE).tgz
-	tar xf tmp/xunit-to-github.tgz -C tmp
+	tar xf tmp/xunit-reader.tgz -C tmp
-	chmod +x tmp/xunit-to-github
+	chmod +x tmp/xunit-reader
 
 setup:
 	bash tests/setup.sh
@@ -73,11 +82,17 @@ setup:
 
 test: lint unit-tests
 
-report: tmp/xunit-to-github
+report: tmp/xunit-reader
-ifdef TRAVIS_REPO_SLUG
+	tmp/xunit-reader -p 'tmp/test-results/bats/*.xml'
-ifdef GITHUB_ACCESS_TOKEN
+	tmp/xunit-reader -p 'tmp/test-results/shellcheck/*.xml'
-ifneq ($(TRAVIS_PULL_REQUEST),false)
+
-	tmp/xunit-to-github --skip-ok --job-url "$(TRAVIS_JOB_WEB_URL)" --pull-request-id "$(TRAVIS_PULL_REQUEST)" --repository-slug "$(TRAVIS_REPO_SLUG)" --title "DOKKU_VERSION=$(DOKKU_VERSION)" tmp/test-results/bats tmp/test-results/shellcheck
+.PHONY: clean
-endif
+clean:
-endif
+	rm -f README.md
-endif
+
+.PHONY: generate
+generate: clean README.md
+
+.PHONY: README.md
+README.md:
+	bin/generate

README.md

@@ -1,247 +1,774 @@
-# dokku mysql [![Build Status](https://img.shields.io/travis/dokku/dokku-mysql.svg?branch=master "Build Status")](https://travis-ci.org/dokku/dokku-mysql) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg "IRC Freenode")](https://webchat.freenode.net/?channels=dokku)
+# dokku mysql [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-mysql/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-mysql/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)
 
-Official mysql plugin for dokku. Currently defaults to installing [mysql 5.7.25](https://hub.docker.com/_/mysql/).
+Official mysql plugin for dokku. Currently defaults to installing [mysql 9.2.0](https://hub.docker.com/_/mysql/).
 
-## requirements
+## Requirements
 
-- dokku 0.12.x+
+- dokku 0.19.x+
 - docker 1.8.x
 
-## installation
+## Installation
 
 ```shell
-# on 0.12.x+
+# on 0.19.x+
-sudo dokku plugin:install https://github.com/dokku/dokku-mysql.git mysql
+sudo dokku plugin:install https://github.com/dokku/dokku-mysql.git --name mysql
 ```
 
-## commands
+## Commands
 
 ```
-mysql:app-links <app>          List all mysql service links for a given app
+mysql:app-links <app>                              # list all mysql service links for a given app
-mysql:backup <name> <bucket> (--use-iam) Create a backup of the mysql service to an existing s3 bucket
+mysql:backup <service> <bucket-name> [--use-iam]   # create a backup of the mysql service to an existing s3 bucket
-mysql:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) Sets up authentication for backups on the mysql service
+mysql:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url> # set up authentication for backups on the mysql service
-mysql:backup-deauth <name>     Removes backup authentication for the mysql service
+mysql:backup-deauth <service>                      # remove backup authentication for the mysql service
-mysql:backup-schedule <name> <schedule> <bucket> Schedules a backup of the mysql service
+mysql:backup-schedule <service> <schedule> <bucket-name> [--use-iam] # schedule a backup of the mysql service
-mysql:backup-schedule-cat <name> Cat the contents of the configured backup cronfile for the service
+mysql:backup-schedule-cat <service>                # cat the contents of the configured backup cronfile for the service
-mysql:backup-set-encryption <name> <passphrase> Set a GPG passphrase for backups
+mysql:backup-set-encryption <service> <passphrase> # set encryption for all future backups of mysql service
-mysql:backup-unschedule <name> Unschedules the backup of the mysql service
+mysql:backup-set-public-key-encryption <service> <public-key-id> # set GPG Public Key encryption for all future backups of mysql service
-mysql:backup-unset-encryption <name> Removes backup encryption for future backups of the mysql service
+mysql:backup-unschedule <service>                  # unschedule the backup of the mysql service
-mysql:clone <name> <new-name>  Create container <new-name> then copy data from <name> into <new-name>
+mysql:backup-unset-encryption <service>            # unset encryption for future backups of the mysql service
-mysql:connect <name>           Connect via mysql to a mysql service
+mysql:backup-unset-public-key-encryption <service> # unset GPG Public Key encryption for future backups of the mysql service
-mysql:create <name>            Create a mysql service with environment variables
+mysql:clone <service> <new-service> [--clone-flags...] # create container <new-name> then copy data from <name> into <new-name>
-mysql:destroy <name>           Delete the service, delete the data and stop its container if there are no links left
+mysql:connect <service>                            # connect to the service via the mysql connection tool
-mysql:enter <name> [command]   Enter or run a command in a running mysql service container
+mysql:create <service> [--create-flags...]         # create a mysql service
-mysql:exists <service>         Check if the mysql service exists
+mysql:destroy <service> [-f|--force]               # delete the mysql service/data/container if there are no links left
-mysql:export <name> > <file>   Export a dump of the mysql service database
+mysql:enter <service>                              # enter or run a command in a running mysql service container
-mysql:expose <name> [port]     Expose a mysql service on custom port if provided (random port otherwise)
+mysql:exists <service>                             # check if the mysql service exists
-mysql:import <name> < <file>   Import a dump into the mysql service database
+mysql:export <service>                             # export a dump of the mysql service database
-mysql:info <name>              Print the connection information
+mysql:expose <service> <ports...>                  # expose a mysql service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
-mysql:link <name> <app>        Link the mysql service to the app
+mysql:import <service>                             # import a dump into the mysql service database
-mysql:linked <name> <app>      Check if the mysql service is linked to an app
+mysql:info <service> [--single-info-flag]          # print the service information
-mysql:list                     List all mysql services
+mysql:link <service> <app> [--link-flags...]       # link the mysql service to the app
-mysql:logs <name> [-t]         Print the most recent log(s) for this service
+mysql:linked <service> <app>                       # check if the mysql service is linked to an app
-mysql:promote <name> <app>     Promote service <name> as DATABASE_URL in <app>
+mysql:links <service>                              # list all apps linked to the mysql service
-mysql:restart <name>           Graceful shutdown and restart of the mysql service container
+mysql:list                                         # list all mysql services
-mysql:start <name>             Start a previously stopped mysql service
+mysql:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
-mysql:stop <name>              Stop a running mysql service
+mysql:pause <service>                              # pause a running mysql service
-mysql:unexpose <name>          Unexpose a previously exposed mysql service
+mysql:promote <service> <app>                      # promote service <service> as DATABASE_URL in <app>
-mysql:unlink <name> <app>      Unlink the mysql service from the app
+mysql:restart <service>                            # graceful shutdown and restart of the mysql service container
-mysql:upgrade <name>           Upgrade service <service> to the specified version
+mysql:set <service> <key> <value>                  # set or clear a property for a service
+mysql:start <service>                              # start a previously stopped mysql service
+mysql:stop <service>                               # stop a running mysql service
+mysql:unexpose <service>                           # unexpose a previously exposed mysql service
+mysql:unlink <service> <app>                       # unlink the mysql service from the app
+mysql:upgrade <service> [--upgrade-flags...]       # upgrade service <service> to the specified versions
 ```
 
-## usage
+## Usage
+
+Help for any commands can be displayed by specifying the command as an argument to mysql:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `mysql:help` command for any undocumented commands.
+
+### Basic Usage
+
+### create a mysql service
 
 ```shell
-# create a mysql service named lolipop
+# usage
-dokku mysql:create lolipop
+dokku mysql:create <service> [--create-flags...]
+```
 
-# you can also specify the image and image
+flags:
-# version to use for the service
+
-# it *must* be compatible with the
+- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
-# official mysql image
+- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
+- `-i|--image IMAGE`: the image name to start the service with
+- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
+- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
+- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
+- `-p|--password PASSWORD`: override the user-level service password
+- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
+- `-r|--root-password PASSWORD`: override the root-level service password
+- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
+- `-s|--shm-size SHM_SIZE`: override shared memory size for mysql docker container
+
+Create a mysql service named lollipop:
+
+```shell
+dokku mysql:create lollipop
+```
+
+You can also specify the image and image version to use for the service. It *must* be compatible with the mysql image.
+
+```shell
 export MYSQL_IMAGE="mysql"
-export MYSQL_IMAGE_VERSION="5.5"
+export MYSQL_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
-dokku mysql:create lolipop
+dokku mysql:create lollipop
+```
 
-# you can also specify custom environment
+You can also specify custom environment variables to start the mysql service in semicolon-separated form.
-# variables to start the mysql service
+
-# in semi-colon separated form
+```shell
 export MYSQL_CUSTOM_ENV="USER=alpha;HOST=beta"
-dokku mysql:create lolipop
+dokku mysql:create lollipop
+```
 
-# get connection information as follows
+### print the service information
-dokku mysql:info lolipop
 
-# you can also retrieve a specific piece of service info via flags
+```shell
-dokku mysql:info lolipop --config-dir
+# usage
-dokku mysql:info lolipop --data-dir
+dokku mysql:info <service> [--single-info-flag]
-dokku mysql:info lolipop --dsn
+```
-dokku mysql:info lolipop --exposed-ports
-dokku mysql:info lolipop --id
-dokku mysql:info lolipop --internal-ip
-dokku mysql:info lolipop --links
-dokku mysql:info lolipop --service-root
-dokku mysql:info lolipop --status
-dokku mysql:info lolipop --version
 
-# a bash prompt can be opened against a running service
+flags:
-# filesystem changes will not be saved to disk
-dokku mysql:enter lolipop
 
-# you may also run a command directly against the service
+- `--config-dir`: show the service configuration directory
-# filesystem changes will not be saved to disk
+- `--data-dir`: show the service data directory
-dokku mysql:enter lolipop ls -lah /
+- `--dsn`: show the service DSN
+- `--exposed-ports`: show service exposed ports
+- `--id`: show the service container id
+- `--internal-ip`: show the service internal ip
+- `--initial-network`: show the initial network being connected to
+- `--links`: show the service app links
+- `--post-create-network`: show the networks to attach to after service container creation
+- `--post-start-network`: show the networks to attach to after service container start
+- `--service-root`: show the service root directory
+- `--status`: show the service running status
+- `--version`: show the service image version
 
-# a mysql service can be linked to a
+Get connection information as follows:
-# container this will use native docker
-# links via the docker-options plugin
-# here we link it to our 'playground' app
-# NOTE: this will restart your app
-dokku mysql:link lolipop playground
 
-# the following environment variables will be set automatically by docker (not
+```shell
-# on the app itself, so they won’t be listed when calling dokku config)
+dokku mysql:info lollipop
-#
+```
-#   DOKKU_MYSQL_LOLIPOP_NAME=/lolipop/DATABASE
-#   DOKKU_MYSQL_LOLIPOP_PORT=tcp://172.17.0.1:3306
-#   DOKKU_MYSQL_LOLIPOP_PORT_3306_TCP=tcp://172.17.0.1:3306
-#   DOKKU_MYSQL_LOLIPOP_PORT_3306_TCP_PROTO=tcp
-#   DOKKU_MYSQL_LOLIPOP_PORT_3306_TCP_PORT=3306
-#   DOKKU_MYSQL_LOLIPOP_PORT_3306_TCP_ADDR=172.17.0.1
-#
-# and the following will be set on the linked application by default
-#
-#   DATABASE_URL=mysql://mysql:SOME_PASSWORD@dokku-mysql-lolipop:3306/lolipop
-#
-# NOTE: the host exposed here only works internally in docker containers. If
-# you want your container to be reachable from outside, you should use `expose`.
 
-# another service can be linked to your app
+You can also retrieve a specific piece of service info via flags:
+
+```shell
+dokku mysql:info lollipop --config-dir
+dokku mysql:info lollipop --data-dir
+dokku mysql:info lollipop --dsn
+dokku mysql:info lollipop --exposed-ports
+dokku mysql:info lollipop --id
+dokku mysql:info lollipop --internal-ip
+dokku mysql:info lollipop --initial-network
+dokku mysql:info lollipop --links
+dokku mysql:info lollipop --post-create-network
+dokku mysql:info lollipop --post-start-network
+dokku mysql:info lollipop --service-root
+dokku mysql:info lollipop --status
+dokku mysql:info lollipop --version
+```
+
+### list all mysql services
+
+```shell
+# usage
+dokku mysql:list
+```
+
+List all services:
+
+```shell
+dokku mysql:list
+```
+
+### print the most recent log(s) for this service
+
+```shell
+# usage
+dokku mysql:logs <service> [-t|--tail] <tail-num-optional>
+```
+
+flags:
+
+- `-t|--tail [<tail-num>]`: do not stop when end of the logs are reached and wait for additional output
+
+You can tail logs for a particular service:
+
+```shell
+dokku mysql:logs lollipop
+```
+
+By default, logs will not be tailed, but you can do this with the --tail flag:
+
+```shell
+dokku mysql:logs lollipop --tail
+```
+
+The default tail setting is to show all logs, but an initial count can also be specified:
+
+```shell
+dokku mysql:logs lollipop --tail 5
+```
+
+### link the mysql service to the app
+
+```shell
+# usage
+dokku mysql:link <service> <app> [--link-flags...]
+```
+
+flags:
+
+- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
+- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
+- `-n|--no-restart "false"`: whether or not to restart the app on link (default: true)
+
+A mysql service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.
+
+> NOTE: this will restart your app
+
+```shell
+dokku mysql:link lollipop playground
+```
+
+The following environment variables will be set automatically by docker (not on the app itself, so they won’t be listed when calling dokku config):
+
+```
+DOKKU_MYSQL_LOLLIPOP_NAME=/lollipop/DATABASE
+DOKKU_MYSQL_LOLLIPOP_PORT=tcp://172.17.0.1:3306
+DOKKU_MYSQL_LOLLIPOP_PORT_3306_TCP=tcp://172.17.0.1:3306
+DOKKU_MYSQL_LOLLIPOP_PORT_3306_TCP_PROTO=tcp
+DOKKU_MYSQL_LOLLIPOP_PORT_3306_TCP_PORT=3306
+DOKKU_MYSQL_LOLLIPOP_PORT_3306_TCP_ADDR=172.17.0.1
+```
+
+The following will be set on the linked application by default:
+
+```
+DATABASE_URL=mysql://mysql:SOME_PASSWORD@dokku-mysql-lollipop:3306/lollipop
+```
+
+The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:
+
+```shell
 dokku mysql:link other_service playground
-
-# since DATABASE_URL is already in use, another environment variable will be
-# generated automatically
-#
-#   DOKKU_MYSQL_BLUE_URL=mysql://mysql:ANOTHER_PASSWORD@dokku-mysql-other-service:3306/other_service
-
-# you can then promote the new service to be the primary one
-# NOTE: this will restart your app
-dokku mysql:promote other_service playground
-
-# this will replace DATABASE_URL with the url from other_service and generate
-# another environment variable to hold the previous value if necessary.
-# you could end up with the following for example:
-#
-#   DATABASE_URL=mysql://mysql:ANOTHER_PASSWORD@dokku-mysql-other_service:3306/other_service
-#   DOKKU_MYSQL_BLUE_URL=mysql://mysql:ANOTHER_PASSWORD@dokku-mysql-other-service:3306/other_service
-#   DOKKU_MYSQL_SILVER_URL=mysql://mysql:SOME_PASSWORD@dokku-mysql-lolipop:3306/lolipop
-
-# you can also unlink a mysql service
-# NOTE: this will restart your app and unset related environment variables
-dokku mysql:unlink lolipop playground
-
-# you can tail logs for a particular service
-dokku mysql:logs lolipop
-dokku mysql:logs lolipop -t # to tail
-
-# you can dump the database
-dokku mysql:export lolipop > lolipop.sql
-
-# you can import a dump
-dokku mysql:import lolipop < database.sql
-
-# you can clone an existing database to a new one
-dokku mysql:clone lolipop new_database
-
-# finally, you can destroy the container
-dokku mysql:destroy lolipop
 ```
 
-## Changing database adapter
+It is possible to change the protocol for `DATABASE_URL` by setting the environment variable `MYSQL_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
 
-It's possible to change the protocol for DATABASE_URL by setting
+```shell
-the environment variable MYSQL_DATABASE_SCHEME on the app:
-
-```
 dokku config:set playground MYSQL_DATABASE_SCHEME=mysql2
-dokku mysql:link lolipop playground
+dokku mysql:link lollipop playground
 ```
 
-Will cause DATABASE_URL to be set as
+This will cause `DATABASE_URL` to be set as:
-mysql2://mysql:SOME_PASSWORD@dokku-mysql-lolipop:3306/lolipop
 
-CAUTION: Changing MYSQL_DATABASE_SCHEME after linking will cause dokku to
+```
-believe the service is not linked when attempting to use `dokku mysql:unlink`
+mysql2://mysql:SOME_PASSWORD@dokku-mysql-lollipop:3306/lollipop
-or `dokku mysql:promote`.
+```
-You should be able to fix this by
 
-- Changing DATABASE_URL manually to the new value.
+### unlink the mysql service from the app
 
-OR
+```shell
+# usage
+dokku mysql:unlink <service> <app>
+```
 
-- Set MYSQL_DATABASE_SCHEME back to its original setting
+flags:
-- Unlink the service
-- Change MYSQL_DATABASE_SCHEME to the desired setting
-- Relink the service
 
-## Configuration
+- `-n|--no-restart "false"`: whether or not to restart the app on unlink (default: true)
 
-It is possible to add custom configuration settings.
+You can unlink a mysql service:
-`/etc/mysql/conf.d` is mapped to the output of `dokku mysql:info SERVICE --config-dir`
 
-Any files placed in this folder will be loaded. If a file is changed you will need
+> NOTE: this will restart your app and unset related environment variables
-to reload your database for the changes to take effect.
 
-For more information on configuration options see https://dev.mysql.com/doc/refman/5.7/en/option-files.html
+```shell
+dokku mysql:unlink lollipop playground
+```
 
-> Note: This plugin mounts a host directory into the container under `/etc/mysql/conf.d`. Custom images that have files in this directory will have those files overwritten by the mount.
+### set or clear a property for a service
+
+```shell
+# usage
+dokku mysql:set <service> <key> <value>
+```
+
+Set the network to attach after the service container is started:
+
+```shell
+dokku mysql:set lollipop post-create-network custom-network
+```
+
+Set multiple networks:
+
+```shell
+dokku mysql:set lollipop post-create-network custom-network,other-network
+```
+
+Unset the post-create-network value:
+
+```shell
+dokku mysql:set lollipop post-create-network
+```
+
+### Service Lifecycle
+
+The lifecycle of each service can be managed through the following commands:
+
+### connect to the service via the mysql connection tool
+
+```shell
+# usage
+dokku mysql:connect <service>
+```
+
+Connect to the service via the mysql connection tool:
+
+> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
+
+```shell
+dokku mysql:connect lollipop
+```
+
+### enter or run a command in a running mysql service container
+
+```shell
+# usage
+dokku mysql:enter <service>
+```
+
+A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
+
+> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
+
+```shell
+dokku mysql:enter lollipop
+```
+
+You may also run a command directly against the service. Filesystem changes will not be saved to disk.
+
+```shell
+dokku mysql:enter lollipop touch /tmp/test
+```
+
+### expose a mysql service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
+
+```shell
+# usage
+dokku mysql:expose <service> <ports...>
+```
+
+Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
+
+```shell
+dokku mysql:expose lollipop 3306
+```
+
+Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):
+
+```shell
+dokku mysql:expose lollipop 127.0.0.1:3306
+```
+
+### unexpose a previously exposed mysql service
+
+```shell
+# usage
+dokku mysql:unexpose <service>
+```
+
+Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
+
+```shell
+dokku mysql:unexpose lollipop
+```
+
+### promote service <service> as DATABASE_URL in <app>
+
+```shell
+# usage
+dokku mysql:promote <service> <app>
+```
+
+If you have a mysql service linked to an app and try to link another mysql service another link environment variable will be generated automatically:
+
+```
+DOKKU_DATABASE_BLUE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-mysql-other-service:3306/other_service
+```
+
+You can promote the new service to be the primary one:
+
+> NOTE: this will restart your app
+
+```shell
+dokku mysql:promote other_service playground
+```
+
+This will replace `DATABASE_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:
+
+```
+DATABASE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-mysql-other-service:3306/other_service
+DOKKU_DATABASE_BLUE_URL=mysql://other_service:ANOTHER_PASSWORD@dokku-mysql-other-service:3306/other_service
+DOKKU_DATABASE_SILVER_URL=mysql://lollipop:SOME_PASSWORD@dokku-mysql-lollipop:3306/lollipop
+```
+
+### start a previously stopped mysql service
+
+```shell
+# usage
+dokku mysql:start <service>
+```
+
+Start the service:
+
+```shell
+dokku mysql:start lollipop
+```
+
+### stop a running mysql service
+
+```shell
+# usage
+dokku mysql:stop <service>
+```
+
+Stop the service and removes the running container:
+
+```shell
+dokku mysql:stop lollipop
+```
+
+### pause a running mysql service
+
+```shell
+# usage
+dokku mysql:pause <service>
+```
+
+Pause the running container for the service:
+
+```shell
+dokku mysql:pause lollipop
+```
+
+### graceful shutdown and restart of the mysql service container
+
+```shell
+# usage
+dokku mysql:restart <service>
+```
+
+Restart the service:
+
+```shell
+dokku mysql:restart lollipop
+```
+
+### upgrade service <service> to the specified versions
+
+```shell
+# usage
+dokku mysql:upgrade <service> [--upgrade-flags...]
+```
+
+flags:
+
+- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
+- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
+- `-i|--image IMAGE`: the image name to start the service with
+- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
+- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
+- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
+- `-R|--restart-apps "true"`: whether or not to force an app restart (default: false)
+- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
+- `-s|--shm-size SHM_SIZE`: override shared memory size for mysql docker container
+
+You can upgrade an existing service to a new image or image-version:
+
+```shell
+dokku mysql:upgrade lollipop
+```
+
+### Service Automation
+
+Service scripting can be executed using the following commands:
+
+### list all mysql service links for a given app
+
+```shell
+# usage
+dokku mysql:app-links <app>
+```
+
+List all mysql services that are linked to the `playground` app.
+
+```shell
+dokku mysql:app-links playground
+```
+
+### create container <new-name> then copy data from <name> into <new-name>
+
+```shell
+# usage
+dokku mysql:clone <service> <new-service> [--clone-flags...]
+```
+
+flags:
+
+- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
+- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
+- `-i|--image IMAGE`: the image name to start the service with
+- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
+- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
+- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
+- `-p|--password PASSWORD`: override the user-level service password
+- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
+- `-r|--root-password PASSWORD`: override the root-level service password
+- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
+- `-s|--shm-size SHM_SIZE`: override shared memory size for mysql docker container
+
+You can clone an existing service to a new one:
+
+```shell
+dokku mysql:clone lollipop lollipop-2
+```
+
+### check if the mysql service exists
+
+```shell
+# usage
+dokku mysql:exists <service>
+```
+
+Here we check if the lollipop mysql service exists.
+
+```shell
+dokku mysql:exists lollipop
+```
+
+### check if the mysql service is linked to an app
+
+```shell
+# usage
+dokku mysql:linked <service> <app>
+```
+
+Here we check if the lollipop mysql service is linked to the `playground` app.
+
+```shell
+dokku mysql:linked lollipop playground
+```
+
+### list all apps linked to the mysql service
+
+```shell
+# usage
+dokku mysql:links <service>
+```
+
+List all apps linked to the `lollipop` mysql service.
+
+```shell
+dokku mysql:links lollipop
+```
+
+### Data Management
+
+The underlying service data can be imported and exported with the following commands:
+
+### import a dump into the mysql service database
+
+```shell
+# usage
+dokku mysql:import <service>
+```
+
+Import a datastore dump:
+
+```shell
+dokku mysql:import lollipop < data.dump
+```
+
+### export a dump of the mysql service database
+
+```shell
+# usage
+dokku mysql:export <service>
+```
+
+By default, datastore output is exported to stdout:
+
+```shell
+dokku mysql:export lollipop
+```
+
+You can redirect this output to a file:
+
+```shell
+dokku mysql:export lollipop > data.dump
+```
 
 ### Backups
 
 Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).
 
-You may skip the `backup-auth` step if your dokku install is running within EC2
+You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.
-and has access to the bucket via an IAM profile. In that case, use the `--use-iam`
-option with the `backup` command.
 
 Backups can be performed using the backup commands:
 
-```
+### set up authentication for backups on the mysql service
-# setup s3 backup authentication
-dokku mysql:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
 
-# remove s3 authentication
+```shell
-dokku mysql:backup-deauth lolipop
+# usage
-
+dokku mysql:backup-auth <service> <aws-access-key-id> <aws-secret-access-key> <aws-default-region> <aws-signature-version> <endpoint-url>
-# backup the `lolipop` service to the `BUCKET_NAME` bucket on AWS
-dokku mysql:backup lolipop BUCKET_NAME
-
-# schedule a backup
-# CRON_SCHEDULE is a crontab expression, eg. "0 3 * * *" for each day at 3am
-dokku mysql:backup-schedule lolipop CRON_SCHEDULE BUCKET_NAME
-
-# cat the contents of the configured backup cronfile for the service
-dokku mysql:backup-schedule-cat lolipop
-
-# remove the scheduled backup from cron
-dokku mysql:backup-unschedule lolipop
 ```
 
-Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio):
+Setup s3 backup authentication:
- 
+
-```
+```shell
-# setup s3 backup authentication with different region
+dokku mysql:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
-dokku mysql:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
- 
-# setup s3 backup authentication with different signature version and endpoint
-dokku mysql:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
- 
-# more specific example for minio auth
-dokku mysql:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
 ```
 
-## Disabling `docker pull` calls
+Setup s3 backup authentication with different region:
 
-If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `MYSQL_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
+```shell
+dokku mysql:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
+```
 
-Please ensure the proper images are in place when `docker pull` is disabled.
+Setup s3 backup authentication with different signature version and endpoint:
+
+```shell
+dokku mysql:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
+```
+
+More specific example for minio auth:
+
+```shell
+dokku mysql:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
+```
+
+### remove backup authentication for the mysql service
+
+```shell
+# usage
+dokku mysql:backup-deauth <service>
+```
+
+Remove s3 authentication:
+
+```shell
+dokku mysql:backup-deauth lollipop
+```
+
+### create a backup of the mysql service to an existing s3 bucket
+
+```shell
+# usage
+dokku mysql:backup <service> <bucket-name> [--use-iam]
+```
+
+flags:
+
+- `-u|--use-iam`: use the IAM profile associated with the current server
+
+Backup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:`
+
+```shell
+dokku mysql:backup lollipop my-s3-bucket --use-iam
+```
+
+Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
+
+```shell
+dokku mysql:import lollipop < backup-folder/export
+```
+
+### set encryption for all future backups of mysql service
+
+```shell
+# usage
+dokku mysql:backup-set-encryption <service> <passphrase>
+```
+
+Set the GPG-compatible passphrase for encrypting backups for backups:
+
+```shell
+dokku mysql:backup-set-encryption lollipop
+```
+
+### set GPG Public Key encryption for all future backups of mysql service
+
+```shell
+# usage
+dokku mysql:backup-set-public-key-encryption <service> <public-key-id>
+```
+
+Set the `GPG` Public Key for encrypting backups:
+
+```shell
+dokku mysql:backup-set-public-key-encryption lollipop
+```
+
+### unset encryption for future backups of the mysql service
+
+```shell
+# usage
+dokku mysql:backup-unset-encryption <service>
+```
+
+Unset the `GPG` encryption passphrase for backups:
+
+```shell
+dokku mysql:backup-unset-encryption lollipop
+```
+
+### unset GPG Public Key encryption for future backups of the mysql service
+
+```shell
+# usage
+dokku mysql:backup-unset-public-key-encryption <service>
+```
+
+Unset the `GPG` Public Key encryption for backups:
+
+```shell
+dokku mysql:backup-unset-public-key-encryption lollipop
+```
+
+### schedule a backup of the mysql service
+
+```shell
+# usage
+dokku mysql:backup-schedule <service> <schedule> <bucket-name> [--use-iam]
+```
+
+flags:
+
+- `-u|--use-iam`: use the IAM profile associated with the current server
+
+Schedule a backup:
+
+> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
+
+```shell
+dokku mysql:backup-schedule lollipop "0 3 * * *" my-s3-bucket
+```
+
+Schedule a backup and authenticate via iam:
+
+```shell
+dokku mysql:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
+```
+
+### cat the contents of the configured backup cronfile for the service
+
+```shell
+# usage
+dokku mysql:backup-schedule-cat <service>
+```
+
+Cat the contents of the configured backup cronfile for the service:
+
+```shell
+dokku mysql:backup-schedule-cat lollipop
+```
+
+### unschedule the backup of the mysql service
+
+```shell
+# usage
+dokku mysql:backup-unschedule <service>
+```
+
+Remove the scheduled backup from cron:
+
+```shell
+dokku mysql:backup-unschedule lollipop
+```
+
+### Disabling `docker image pull` calls
+
+If you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `MYSQL_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.
+
+Please ensure the proper images are in place when `docker image pull` is disabled.

Vagrantfile

@@ -1,7 +1,7 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-18.04"
+BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-22.04"
 BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
 DOKKU_VERSION = "master"
 

bin/generate

@@ -0,0 +1,677 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import os
+import re
+
+
+def compile(
+    service,
+    version,
+    variable,
+    alias,
+    image,
+    scheme,
+    ports,
+    sponsors,
+    options,
+    unimplemented,
+    dokku_version,
+):
+    prefix = "\n\n".join(
+        [
+            header(service),
+            description(service, image, version),
+        ]
+    )
+
+    if len(sponsors) > 0:
+        prefix += "\n\n"
+        prefix += sponsors_section(service, sponsors)
+
+    return (
+        "\n\n".join(
+            [
+                prefix,
+                requirements_section(dokku_version),
+                installation_section(service, dokku_version),
+                commands_section(
+                    service, variable, alias, image, scheme, ports, unimplemented
+                ),
+                usage_section(
+                    service,
+                    variable,
+                    alias,
+                    image,
+                    scheme,
+                    ports,
+                    options,
+                    unimplemented,
+                ),
+            ]
+        )
+        .replace("\n\n\n\n\n", "\n")
+        .replace("\n\n\n\n", "\n")
+        .replace("\n\n\n", "\n\n")
+    )
+
+
+def header(service):
+    return " ".join(
+        [
+            f"# dokku {service}",
+            f'[![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-{service}/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-{service}/actions/workflows/ci.yml?query=branch%3Amaster)',
+            f'[![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)',
+        ]
+    )
+
+
+def description(service, full_image, version):
+    base = "_"
+    image = full_image
+    if "/" in full_image:
+        base = "r/" + full_image.split("/")[0]
+        image = full_image.split("/")[1]
+
+    return f"Official {service} plugin for dokku. Currently defaults to installing [{full_image} {version}](https://hub.docker.com/{base}/{image}/)."
+
+
+def sponsors_section(service, sponsors):
+    if len(sponsors) == 0:
+        return ""
+
+    sponsor_data = [
+        "## Sponsors",
+        "",
+        f"The {service} plugin was generously sponsored by the following:",
+        "",
+    ]
+    sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])
+
+    return "\n".join(sponsor_data)
+
+
+def requirements_section(dokku_version):
+    return "\n".join(
+        [
+            "## Requirements",
+            "",
+            f"- dokku {dokku_version}",
+            "- docker 1.8.x",
+        ]
+    )
+
+
+def installation_section(service, dokku_version):
+    return "\n".join(
+        [
+            "## Installation",
+            "",
+            "```shell",
+            f"# on {dokku_version}",
+            f"sudo dokku plugin:install https://github.com/dokku/dokku-{service}.git --name {service}",
+            "```",
+        ]
+    )
+
+
+def commands_section(service, variable, alias, image, scheme, ports, unimplemented):
+    content = [
+        "## Commands",
+        "",
+        "```",
+    ]
+
+    subcommands = os.listdir("subcommands")
+    subcommands.sort()
+
+    command_list = []
+    descriptions = []
+    for filename in subcommands:
+        if filename in unimplemented:
+            continue
+        data = command_data(filename, service, variable, alias, image, scheme, ports)
+        description = data["description"]
+        arguments = data["arguments_string"]
+
+        command_list.append(f"{service}:{filename} {arguments}")
+        descriptions.append(description)
+
+    maxlen = max(map(len, command_list))
+    if maxlen > 50:
+        maxlen = 50
+    for command, description in zip(command_list, descriptions):
+        space_count = maxlen - len(command)
+        content.append("{0}{1} # {2}".format(command, " " * space_count, description))
+
+    content.append("```")
+    return "\n".join(content)
+
+
+def usage_section(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    return "\n\n".join(
+        [
+            "## Usage",
+            f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
+            usage_intro(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_lifecycle(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_automation(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_data_management(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_backup(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_docker_pull(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+        ]
+    )
+
+
+def usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented):
+    commands = ["create", "info", "list", "logs", "link", "unlink", "set"]
+    content = ["### Basic Usage"]
+
+    return fetch_commands_content(
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
+    )
+
+
+def usage_lifecycle(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    commands = [
+        "connect",
+        "enter",
+        "expose",
+        "unexpose",
+        "promote",
+        "start",
+        "stop",
+        "pause",
+        "restart",
+        "upgrade",
+    ]
+    content = [
+        "### Service Lifecycle",
+        "",
+        "The lifecycle of each service can be managed through the following commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
+    )
+
+
+def usage_automation(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    commands = ["app-links", "clone", "exists", "linked", "links"]
+    content = [
+        "### Service Automation",
+        "",
+        "Service scripting can be executed using the following commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
+    )
+
+
+def usage_data_management(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    commands = ["import", "export"]
+    content = [
+        "### Data Management",
+        "",
+        "The underlying service data can be imported and exported with the following commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
+    )
+
+
+def usage_backup(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    commands = [
+        "backup-auth",
+        "backup-deauth",
+        "backup",
+        "backup-set-encryption",
+        "backup-set-public-key-encryption",
+        "backup-unset-encryption",
+        "backup-unset-public-key-encryption",
+        "backup-schedule",
+        "backup-schedule-cat",
+        "backup-unschedule",
+    ]
+    content = [
+        "### Backups",
+        "",
+        "Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).",
+        "",
+        "You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.",
+        "",
+        "Backups can be performed using the backup commands:",
+        "",
+    ]
+
+    return fetch_commands_content(
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
+    )
+
+
+def usage_docker_pull(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    service_prefix = service.upper()
+    return "\n".join(
+        [
+            "### Disabling `docker image pull` calls",
+            "",
+            f"If you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `{service_prefix}_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.",
+            "",
+            "Please ensure the proper images are in place when `docker image pull` is disabled.",
+        ]
+    )
+
+
+def fetch_commands_content(
+    service,
+    variable,
+    alias,
+    image,
+    scheme,
+    ports,
+    options,
+    unimplemented,
+    commands,
+    content,
+):
+    i = 0
+    for command in commands:
+        output = command_help(
+            command,
+            service,
+            variable,
+            alias,
+            image,
+            scheme,
+            ports,
+            options,
+            unimplemented,
+        )
+        if output == "":
+            continue
+        content.append(output)
+        i += 1
+
+    if i == 0:
+        return ""
+
+    return "\n".join(content)
+
+
+def parse_args(line):
+    line = line.strip()
+    arguments = []
+    for arg in re.findall("([A-Z_]+)", line):
+        arg = arg.replace("_", "-").lower()
+        if arg.endswith("optional-flag"):
+            arg = arg.replace("-optional-flag", "")
+            arguments.append(f"[--{arg}]")
+        elif arg.endswith("-flag"):
+            if arg == "info-flag":
+                arguments.append(f"[--single-info-flag]")
+            else:
+                arg = arg.replace("-flag", "")
+                first_letter = arg[0]
+                arguments.append(f"[-{first_letter}|--{arg}]")
+        elif arg.endswith("-flags-list"):
+            arg = arg.replace("-list", "")
+            arguments.append(f"[--{arg}...]")
+        elif arg.endswith("list"):
+            arg = arg.replace("-list", "")
+            arguments.append(f"<{arg}...>")
+        else:
+            arguments.append(f"<{arg}>")
+    return " ".join(arguments)
+
+
+def command_help(
+    command, service, variable, alias, image, scheme, ports, options, unimplemented
+):
+    if command in unimplemented:
+        return ""
+
+    data = command_data(command, service, variable, alias, image, scheme, ports)
+    content = [
+        f"### {data['description']}",
+        "",
+        "```shell",
+        "# usage",
+        f"dokku {service}:{command} {data['arguments_string']}".strip(),
+        "```",
+    ]
+
+    # if len(data["arguments"]) > 0:
+    #     content.append("")
+    #     content.append("arguments:")
+    #     content.append("")
+    # for argument in data["arguments"]:
+    #     content.append(f"- {argument}")
+
+    if len(data["flags"]) > 0:
+        content.append("")
+        content.append("flags:")
+        content.append("")
+    for flag in data["flags"]:
+        if "--config-options" in flag and options != "":
+            flag = f"{flag} (default: `{options}`)"
+        content.append(f"- {flag}")
+
+    if len(data["examples"]) > 0:
+        content.append("")
+        content.append(data["examples"])
+
+    doc_file = os.path.join("docs", f"{command}.md")
+    if os.path.isfile(doc_file):
+        content.append("")
+        with open(doc_file) as f:
+            content.append(f.read())
+
+    return "\n" + "\n".join(content)
+
+
+def command_data(command, service, variable, alias, image, scheme, ports):
+    description = None
+    arguments = []
+    arguments_string = ""
+    example_lines = []
+    flags = []
+    with open(os.path.join("subcommands", command)) as f:
+        for line in f.readlines():
+            line = line.strip()
+            line = line.replace("$PLUGIN_SERVICE", service)
+            line = line.replace("$PLUGIN_COMMAND_PREFIX", service)
+            line = line.replace("${PLUGIN_COMMAND_PREFIX}", service)
+            line = line.replace("${PLUGIN_VARIABLE}", variable)
+            line = line.replace("${PLUGIN_DEFAULT_ALIAS}", alias)
+            line = line.replace("${PLUGIN_IMAGE}", image)
+            line = line.replace("${PLUGIN_SCHEME}", scheme)
+            line = line.replace("${PLUGIN_DATASTORE_PORTS[0]}", ports[0])
+            line = line.replace("${PLUGIN_DATASTORE_PORTS[@]}", " ".join(ports))
+
+            if "declare desc" in line:
+                description = re.search('"(.+)"', line).group(1)
+            elif "$1" in line:
+                arguments_string = parse_args(line)
+            elif line.startswith("#A "):
+                argument = line.replace("#A ", "")
+                parts = [a.strip() for a in argument.split(",", 1)]
+                arguments.append(f"`{parts[0]}`: {parts[1]}")
+            elif line.startswith("#F "):
+                flag = line.replace("#F ", "")
+                parts = [a.strip() for a in flag.split(",", 1)]
+                flags.append(f"`{parts[0]}`: {parts[1]}")
+            elif line.startswith("#E "):
+                example_lines.append(line.replace("#E ", ""))
+
+    examples = []
+    sentence_lines = []
+    command_lines = []
+    codeblock_lines = []
+    blockquote_lines = []
+    for line in example_lines:
+        if line.startswith("export") or line.startswith("dokku"):
+            if len(blockquote_lines) > 0:
+                examples.append("\n" + process_blockquote(blockquote_lines))
+                blockquote_lines = []
+            if len(codeblock_lines) > 0:
+                examples.append("\n" + process_codeblock(codeblock_lines))
+                codeblock_lines = []
+            if len(sentence_lines) > 0:
+                examples.append("\n" + process_sentence(sentence_lines))
+                sentence_lines = []
+
+            command_lines.append(line)
+        elif line.startswith("    "):
+            if len(blockquote_lines) > 0:
+                examples.append("\n" + process_blockquote(blockquote_lines))
+                blockquote_lines = []
+            if len(command_lines) > 0:
+                examples.append("\n" + process_command(command_lines))
+                command_lines = []
+            if len(sentence_lines) > 0:
+                examples.append("\n" + process_sentence(sentence_lines))
+                sentence_lines = []
+
+            codeblock_lines.append(line.strip())
+        elif line.startswith(">"):
+            if len(codeblock_lines) > 0:
+                examples.append("\n" + process_codeblock(codeblock_lines))
+                codeblock_lines = []
+            if len(command_lines) > 0:
+                examples.append("\n" + process_command(command_lines))
+                command_lines = []
+            if len(sentence_lines) > 0:
+                examples.append("\n" + process_sentence(sentence_lines))
+                sentence_lines = []
+
+            blockquote_lines.append(line)
+        else:
+            if len(blockquote_lines) > 0:
+                examples.append("\n" + process_blockquote(blockquote_lines))
+                blockquote_lines = []
+            if len(codeblock_lines) > 0:
+                examples.append("\n" + process_codeblock(codeblock_lines))
+                codeblock_lines = []
+            if len(command_lines) > 0:
+                examples.append("\n" + process_command(command_lines))
+                command_lines = []
+
+            sentence_lines.append(line)
+
+    if len(blockquote_lines) > 0:
+        examples.append("\n" + process_blockquote(blockquote_lines))
+        blockquote_lines = []
+    if len(codeblock_lines) > 0:
+        examples.append("\n" + process_codeblock(codeblock_lines))
+        codeblock_lines = []
+    if len(command_lines) > 0:
+        examples.append("\n" + process_command(command_lines))
+        command_lines = []
+    if len(sentence_lines) > 0:
+        examples.append("\n" + process_sentence(sentence_lines))
+        sentence_lines = []
+
+    return {
+        "description": description,
+        "arguments_string": arguments_string,
+        "arguments": arguments,
+        "flags": flags,
+        "examples": "\n".join(examples).strip(),
+    }
+
+
+def process_sentence(sentence_lines):
+    sentence_lines = " ".join(sentence_lines)
+    sentences = ". ".join(
+        upperfirst(i.strip()) for i in sentence_lines.split(". ")
+    ).strip()
+    if not sentences.endswith(".") and not sentences.endswith(":"):
+        sentences += ":"
+
+    text = []
+    for sentence in sentences.split(". "):
+        parts = []
+        for word in sentence.strip().split(" "):
+            if word.isupper() and len(word) > 1:
+                for ending in [":", "."]:
+                    if word.endswith(ending):
+                        word = "`{0}`{1}".format(word[:-1], ending)
+                else:
+                    word = "`{0}`".format(word)
+            parts.append(word)
+        text.append(" ".join(parts))
+
+    text = ". ".join(text)
+
+    # some cleanup
+    text = text.replace("(0.0.0.0)", "(`0.0.0.0`)")
+    text = text.replace("'", "`")
+    text = text.replace("`s", "'s")
+    text = text.replace("``", "`")
+    text = text.strip(" ")
+
+    return text
+
+
+def upperfirst(x):
+    return x[:1].upper() + x[1:]
+
+
+def process_blockquote(blockquote_lines):
+    return "\n".join(blockquote_lines)
+
+
+def process_command(command_lines):
+    command_lines = "\n".join(command_lines)
+    return f"```shell\n{command_lines}\n```"
+
+
+def process_codeblock(codeblock_lines):
+    codeblock_lines = "\n".join(codeblock_lines)
+    return f"```\n{codeblock_lines}\n```"
+
+
+def main():
+    service = None
+    version = None
+    variable = None
+    image = None
+    alias = None
+    options = None
+    unimplemented = []
+
+    with open("Dockerfile") as f:
+        for line in f.readlines():
+            if "FROM " in line:
+                image, version = line.split(" ")[1].split(":")
+                image = image.strip()
+                version = version.strip()
+
+    with open("config") as f:
+        for line in f.readlines():
+            if "PLUGIN_COMMAND_PREFIX=" in line:
+                service = re.search('"(.+)"', line).group(1)
+            if "PLUGIN_DEFAULT_ALIAS=" in line:
+                alias = re.search('"(.+)"', line).group(1)
+            if "PLUGIN_VARIABLE=" in line:
+                variable = re.search('"(.+)"', line).group(1)
+            if "PLUGIN_SCHEME=" in line:
+                scheme = re.search('"(.+)"', line).group(1)
+            if "PLUGIN_DATASTORE_PORTS=" in line:
+                ports = re.search("\((.+)\)", line).group(1).split(" ")
+            if "PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=" in line:
+                match = re.search("\((.+)\)", line)
+                if match is not None:
+                    unimplemented = [s.strip('"') for s in match.group(1).split(" ")]
+
+    with open("config") as f:
+        for line in f.readlines():
+            if f"{variable}_CONFIG_OPTIONS" in line:
+                match = re.search('"(.+)"', line)
+                if match is not None:
+                    options = match.group(1)
+
+    sponsors = []
+    with open("plugin.toml") as f:
+        for line in f.readlines():
+            if line.startswith("sponsors"):
+                sponsors = re.search('\[(["\w\s,_-]+)\]', line).group(1)
+                sponsors = [s.strip('"') for s in sponsors.split(",")]
+
+    text = compile(
+        service,
+        version,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        sponsors,
+        options,
+        unimplemented,
+        "0.19.x+",
+    )
+
+    base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+    readme_file = os.path.join(base_path, "README.md")
+    with open(readme_file, "w") as f:
+        f.write(text + "\n")
+
+
+if __name__ == "__main__":
+    main()

commands

@@ -1,8 +1,10 @@
 #!/usr/bin/env bash
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
 [[ " help $PLUGIN_COMMAND_PREFIX:help $PLUGIN_COMMAND_PREFIX $PLUGIN_COMMAND_PREFIX:default " == *" $1 "* ]] || [[ "$1" == "$PLUGIN_COMMAND_PREFIX:"* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
-source "$PLUGIN_BASE_PATH/common/functions"
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/help-functions"
 

config

@@ -1,8 +1,10 @@
 #!/usr/bin/env bash
-export MYSQL_IMAGE=${MYSQL_IMAGE:="mysql"}
+_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-export MYSQL_IMAGE_VERSION=${MYSQL_IMAGE_VERSION:="5.7.25"}
+export MYSQL_IMAGE=${MYSQL_IMAGE:="$(awk -F '[ :]' '{print $2}' "${_DIR}/Dockerfile")"}
+export MYSQL_IMAGE_VERSION=${MYSQL_IMAGE_VERSION:="$(awk -F '[ :]' '{print $3}' "${_DIR}/Dockerfile")"}
 export MYSQL_ROOT=${MYSQL_ROOT:="$DOKKU_LIB_ROOT/services/mysql"}
-export MYSQL_HOST_ROOT=${MYSQL_HOST_ROOT:=$MYSQL_ROOT}
+export DOKKU_LIB_HOST_ROOT=${DOKKU_LIB_HOST_ROOT:=$DOKKU_LIB_ROOT}
+export MYSQL_HOST_ROOT=${MYSQL_HOST_ROOT:="$DOKKU_LIB_HOST_ROOT/services/mysql"}
 
 export PLUGIN_UNIMPLEMENTED_SUBCOMMANDS=()
 export PLUGIN_COMMAND_PREFIX="mysql"
@@ -21,10 +23,14 @@ export PLUGIN_SCHEME="mysql"
 export PLUGIN_SERVICE="MySQL"
 export PLUGIN_VARIABLE="MYSQL"
 export PLUGIN_BASE_PATH="$PLUGIN_PATH"
+export PLUGIN_CONFIG_SUFFIX="config"
 if [[ -n $DOKKU_API_VERSION ]]; then
   export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
 fi
 
-if [[ -d "$PLUGIN_DATA_ROOT/*" ]]; then
+export PLUGIN_BUSYBOX_IMAGE=${PLUGIN_BUSYBOX_IMAGE:=busybox:1.37.0-uclibc}
-  rm -rf "${PLUGIN_DATA_ROOT:?}/*"
+export PLUGIN_AMBASSADOR_IMAGE=${PLUGIN_AMBASSADOR_IMAGE:=dokku/ambassador:0.8.2}
-fi
+export PLUGIN_S3BACKUP_IMAGE=${PLUGIN_S3BACKUP_IMAGE:=dokku/s3backup:0.18.0}
+export PLUGIN_WAIT_IMAGE=${PLUGIN_WAIT_IMAGE:=dokku/wait:0.9.3}
+
+export MYSQL_CONFIG_OPTIONS=${MYSQL_CONFIG_OPTIONS:=""}

docs/README.md

@@ -0,0 +1,4 @@
+# Extra Documentation
+
+The documentation in this folder is supplemental to using this plugin. It is injected automatically into the plugin's readme during documentation generation.
+

functions

@@ -1,8 +1,10 @@
 #!/usr/bin/env bash
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
-source "$PLUGIN_BASE_PATH/common/functions"
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
 source "$PLUGIN_AVAILABLE_PATH/config/functions"
 if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then
   source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
@@ -12,11 +14,12 @@ service_connect() {
   local SERVICE="$1"
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
+  local DATABASE_NAME="$(get_database_name "$SERVICE")"
+  local PASSWORD="$(service_password "$SERVICE")"
   local SERVICE_TTY_OPTS
   has_tty && SERVICE_TTY_OPTS="-t"
 
-  docker exec -i $SERVICE_TTY_OPTS "$SERVICE_NAME" mysql --user=mysql --password="$PASSWORD" --database="$SERVICE"
+  "$DOCKER_BIN" container exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" mysql --user=mysql --password="$PASSWORD" --database="$DATABASE_NAME"
 }
 
 service_create() {
@@ -24,27 +27,29 @@ service_create() {
   is_valid_service_name "$SERVICE" || dokku_log_fail "Please specify a valid name for the service. Valid characters are: [A-Za-z0-9_]+"
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   [[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] || dokku_log_fail "$PLUGIN_SERVICE service $SERVICE already exists"
-  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  LINKS_FILE="$SERVICE_ROOT/LINKS"
 
   service_parse_args "${@:2}"
 
   if ! service_image_exists "$SERVICE"; then
     if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
       dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
-      dokku_log_warn "   docker pull ${IMAGE}" 1>&2
+      dokku_log_warn "   docker image pull ${IMAGE}" 1>&2
       dokku_log_warn "$PLUGIN_SERVICE service creation failed"
       exit 1
     fi
-    docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
+    "$DOCKER_BIN" image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
   fi
 
+  plugn trigger service-action pre-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
   mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory"
-  mkdir -p "$SERVICE_ROOT/config" || dokku_log_fail "Unable to create service config directory"
+  mkdir -p "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX" || dokku_log_fail "Unable to create service config directory"
   touch "$LINKS_FILE"
 
-  echo -e "[mysqld]\nperformance_schema = 0" > "$SERVICE_ROOT/config/disable_performance_schema.cnf"
+  echo -e "[mysqld]\nperformance_schema = 0" >"$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/disable_performance_schema.cnf"
-  echo -e "[mysqld]\ncharacter-set-server = utf8\ncollation-server = utf8_general_ci" > "$SERVICE_ROOT/config/charset_utf8.cnf"
+  echo -e "[mysqld]\ncharacter-set-server = utf8\ncollation-server = utf8_general_ci" >"$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX/charset_utf8.cnf"
   ROOTPASSWORD=$(openssl rand -hex 8)
   PASSWORD=$(openssl rand -hex 8)
   if [[ -n "$SERVICE_PASSWORD" ]]; then
@@ -55,17 +60,15 @@ service_create() {
     ROOTPASSWORD="$SERVICE_ROOT_PASSWORD"
     dokku_log_warn "Specified root password may not be as secure as the auto-generated root password"
   fi
-  echo "$ROOTPASSWORD" > "$SERVICE_ROOT/ROOTPASSWORD"
+  echo "$ROOTPASSWORD" >"$SERVICE_ROOT/ROOTPASSWORD"
-  echo "$PASSWORD" > "$SERVICE_ROOT/PASSWORD"
+  echo "$PASSWORD" >"$SERVICE_ROOT/PASSWORD"
   chmod 640 "$SERVICE_ROOT/ROOTPASSWORD" "$SERVICE_ROOT/PASSWORD"
 
-  [[ -n "$SERVICE_CUSTOM_ENV" ]] && MYSQL_CUSTOM_ENV="$SERVICE_CUSTOM_ENV"
+  service_commit_config "$SERVICE"
-  if [[ -n $MYSQL_CUSTOM_ENV ]]; then
+  write_database_name "$SERVICE"
-    echo "$MYSQL_CUSTOM_ENV" | tr ';' "\n" > "$SERVICE_ROOT/ENV"
+  plugn trigger service-action post-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
-  else
-    echo "" > "$SERVICE_ROOT/ENV"
-  fi
   service_create_container "$SERVICE"
+  plugn trigger service-action post-create-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
 }
 
 service_create_container() {
@@ -73,14 +76,88 @@ service_create_container() {
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local ROOTPASSWORD="$(cat "$SERVICE_ROOT/ROOTPASSWORD")"
+  local ROOTPASSWORD="$(service_root_password "$SERVICE")"
-  local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
+  local PASSWORD="$(service_password "$SERVICE")"
+  local DATABASE_NAME="$(get_database_name "$SERVICE")"
+  local MEMORY_LIMIT=""
 
-  ID=$(docker run --name "$SERVICE_NAME" -v "$SERVICE_HOST_ROOT/data:/var/lib/mysql" -v "$SERVICE_HOST_ROOT/config:/etc/mysql/conf.d" -e "MYSQL_ROOT_PASSWORD=$ROOTPASSWORD" -e MYSQL_USER=mysql -e "MYSQL_PASSWORD=$PASSWORD" -e "MYSQL_DATABASE=$SERVICE" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=mysql "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION")
+  if [[ -f "$SERVICE_ROOT/CONFIG_OPTIONS" ]]; then
-  echo "$ID" > "$SERVICE_ROOT/ID"
+    export CONFIG_OPTIONS="$(cat "$SERVICE_ROOT/CONFIG_OPTIONS")"
+  fi
+
+  local network_alias="$(service_dns_hostname "$SERVICE")"
+
+  rm -f "$SERVICE_ROOT/ID"
+  declare -a DOCKER_ARGS
+  DOCKER_ARGS=()
+  DOCKER_ARGS+=("--cidfile=$SERVICE_ROOT/ID")
+  DOCKER_ARGS+=("--env-file=$SERVICE_ROOT/ENV")
+  DOCKER_ARGS+=("--env=MYSQL_DATABASE=$DATABASE_NAME")
+  DOCKER_ARGS+=("--env=MYSQL_PASSWORD=$PASSWORD")
+  DOCKER_ARGS+=("--env=MYSQL_ROOT_PASSWORD=$ROOTPASSWORD")
+  DOCKER_ARGS+=("--env=MYSQL_USER=mysql")
+  DOCKER_ARGS+=("--hostname=$SERVICE_NAME")
+  DOCKER_ARGS+=("--label=dokku.service=$PLUGIN_COMMAND_PREFIX")
+  DOCKER_ARGS+=("--label=dokku=service")
+  DOCKER_ARGS+=("--name=$SERVICE_NAME")
+  DOCKER_ARGS+=("--restart=always")
+  DOCKER_ARGS+=("--volume=$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/etc/mysql/conf.d")
+  DOCKER_ARGS+=("--volume=$SERVICE_HOST_ROOT/data:/var/lib/mysql")
+
+  declare -a LINK_CONTAINER_DOCKER_ARGS
+  LINK_CONTAINER_DOCKER_ARGS=()
+  LINK_CONTAINER_DOCKER_ARGS+=("--rm")
+  LINK_CONTAINER_DOCKER_ARGS+=("--link")
+  LINK_CONTAINER_DOCKER_ARGS+=("$SERVICE_NAME:$network_alias")
+
+  [[ -f "$SERVICE_ROOT/SERVICE_MEMORY" ]] && SERVICE_MEMORY="$(cat "$SERVICE_ROOT/SERVICE_MEMORY")"
+  if [[ -n "$SERVICE_MEMORY" ]]; then
+    DOCKER_ARGS+=("--memory=${SERVICE_MEMORY}m")
+  fi
+
+  [[ -f "$SERVICE_ROOT/SHM_SIZE" ]] && SERVICE_SHM_SIZE="$(cat "$SERVICE_ROOT/SHM_SIZE")"
+  if [[ -n "$SERVICE_SHM_SIZE" ]]; then
+    DOCKER_ARGS+=("--shm-size=${SERVICE_SHM_SIZE}")
+  fi
+
+  [[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
+  [[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
+
+  local network="$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "initial-network")"
+  if [[ -n "$network" ]]; then
+    DOCKER_ARGS+=("--network=${network}")
+    DOCKER_ARGS+=("--network-alias=${network_alias}")
+    LINK_CONTAINER_DOCKER_ARGS+=("--network=${network}")
+  fi
+
+  # shellcheck disable=SC2086
+  suppress_output "$DOCKER_BIN" container create "${DOCKER_ARGS[@]}" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" $CONFIG_OPTIONS
+
+  if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network")" ]]; then
+    dokku_log_verbose_quiet "Connecting to networks after container create"
+    while read -r line || [[ -n "$line" ]]; do
+      dokku_log_verbose_quiet "- $line"
+      "$DOCKER_BIN" network connect --alias "$network_alias" "$line" "$SERVICE_NAME"
+    done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network" | tr "," "\n")
+  fi
+  suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
+  service_port_reconcile_status "$SERVICE"
+
+  if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network")" ]]; then
+    dokku_log_verbose_quiet "Connecting to networks after container start"
+    while read -r line || [[ -n "$line" ]]; do
+      dokku_log_verbose_quiet "- $line"
+      "$DOCKER_BIN" network connect --alias "$network_alias" "$line" "$SERVICE_NAME"
+    done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network" | tr "," "\n")
+  fi
 
   dokku_log_verbose_quiet "Waiting for container to be ready"
-  docker run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" dokku/wait:0.3.0 -p "$PLUGIN_DATASTORE_WAIT_PORT" > /dev/null
+  if ! suppress_output "$DOCKER_BIN" container run "${LINK_CONTAINER_DOCKER_ARGS[@]}" "$PLUGIN_WAIT_IMAGE" -c "$network_alias:$PLUGIN_DATASTORE_WAIT_PORT"; then
+    dokku_log_info2_quiet "Start of $SERVICE container output"
+    dokku_container_log_verbose_quiet "$SERVICE_NAME"
+    dokku_log_info2_quiet "End of $SERVICE container output"
+    return 1
+  fi
 
   dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE"
   service_info "$SERVICE"
@@ -90,12 +167,11 @@ service_export() {
   local SERVICE="$1"
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
+  local DATABASE_NAME="$(get_database_name "$SERVICE")"
+  local ROOTPASSWORD="$(service_root_password "$SERVICE")"
 
   [[ -n $SSH_TTY ]] && stty -opost
-  docker exec "$SERVICE_NAME" bash -c "printf '[client]\npassword=$PASSWORD\n' > /root/credentials.cnf"
+  "$DOCKER_BIN" container exec "$SERVICE_NAME" mysqldump --default-character-set=utf8mb4 --user=root --password="$ROOTPASSWORD" --single-transaction --no-tablespaces --quick "$DATABASE_NAME"
-  docker exec "$SERVICE_NAME" mysqldump --defaults-extra-file=/root/credentials.cnf --user=mysql "$SERVICE"
-  docker exec "$SERVICE_NAME" rm /root/credentials.cnf
   status=$?
   [[ -n $SSH_TTY ]] && stty opost
   exit $status
@@ -106,12 +182,13 @@ service_import() {
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
   local SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
-  local ROOTPASSWORD="$(cat "$SERVICE_ROOT/ROOTPASSWORD")"
+  local DATABASE_NAME="$(get_database_name "$SERVICE")"
+  local ROOTPASSWORD="$(service_root_password "$SERVICE")"
 
   if [[ -t 0 ]]; then
     dokku_log_fail "No data provided on stdin."
   fi
-  docker exec -i "$SERVICE_NAME" mysql --user=root --password="$ROOTPASSWORD" "$SERVICE"
+  "$DOCKER_BIN" container exec -i "$SERVICE_NAME" mysql --user=root --password="$ROOTPASSWORD" "$DATABASE_NAME"
 }
 
 service_start() {
@@ -119,32 +196,42 @@ service_start() {
   local QUIET="$2"
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local ID=$(docker ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
+  local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$") || true
   if [[ -n $ID ]]; then
     [[ -z $QUIET ]] && dokku_log_warn "Service is already started"
+    if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then
+      [[ -z $QUIET ]] && dokku_log_warn "Updating local container ID"
+      echo "$ID" >"$SERVICE_ROOT/ID"
+    fi
     return 0
   fi
 
   dokku_log_info2_quiet "Starting container"
-  local PREVIOUS_ID=$(docker ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
+  local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$") || true
-  local ROOTPASSWORD="$(cat "$SERVICE_ROOT/ROOTPASSWORD")"
+  local ROOTPASSWORD="$(service_root_password "$SERVICE")"
-  local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
+  local PASSWORD="$(service_password "$SERVICE")"
 
   if [[ -n $PREVIOUS_ID ]]; then
-    docker start "$PREVIOUS_ID" > /dev/null
+    "$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null
-    service_port_unpause "$SERVICE"
+    service_port_reconcile_status "$SERVICE"
     dokku_log_info2 "Container started"
   elif service_image_exists "$SERVICE" && [[ -n "$ROOTPASSWORD" ]] && [[ -n "$PASSWORD" ]]; then
     service_create_container "$SERVICE"
   else
-    dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE"
+    if ! service_image_exists "$SERVICE"; then
+      [[ -f "$SERVICE_ROOT/IMAGE" ]] && PLUGIN_IMAGE="$(cat "$SERVICE_ROOT/IMAGE")"
+      [[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")"
+      dokku_log_verbose_quiet "Missing image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION for $SERVICE"
+    else
+      dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE"
+    fi
   fi
 }
 
 service_url() {
   local SERVICE="$1"
-  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
-  local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
   local SERVICE_DNS_HOSTNAME="$(service_dns_hostname "$SERVICE")"
-  echo "$PLUGIN_SCHEME://mysql:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}/$SERVICE"
+  local DATABASE_NAME="$(get_database_name "$SERVICE")"
+  local PASSWORD="$(service_password "$SERVICE")"
+  echo "$PLUGIN_SCHEME://mysql:$PASSWORD@$SERVICE_DNS_HOSTNAME:${PLUGIN_DATASTORE_PORTS[0]}/$DATABASE_NAME"
 }

help-functions

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
 export SUBCOMMAND_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/subcommands"
 
@@ -13,7 +14,7 @@ fn-help() {
     exit 0
   fi
 
-  pushd "$SUBCOMMAND_ROOT" > /dev/null 2>&1
+  pushd "$SUBCOMMAND_ROOT" >/dev/null 2>&1
   for cmd in *; do
     if [[ "$CMD" == "${PLUGIN_COMMAND_PREFIX}:$cmd" ]]; then
       "$SUBCOMMAND_ROOT/$cmd" "$@"
@@ -21,7 +22,7 @@ fn-help() {
       exit "$EXIT_CODE"
     fi
   done
-  popd > /dev/null 2>&1
+  popd >/dev/null 2>&1
 
   exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
 }
@@ -31,7 +32,7 @@ fn-help-all() {
   local CMD_OUTPUT BLUE BOLD FULL_OUTPUT NORMAL
   FULL_OUTPUT=true
 
-  if [[ "$CMD" = "$PLUGIN_COMMAND_PREFIX:help" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX:default" ]] ; then
+  if [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX:help" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX" ]] || [[ "$CMD" == "$PLUGIN_COMMAND_PREFIX:default" ]]; then
     BOLD="$(fn-help-fancy-tput bold)"
     NORMAL="$(fn-help-fancy-color "\033[m")"
     BLUE="$(fn-help-fancy-color "\033[0;34m")"
@@ -58,7 +59,7 @@ fn-help-all() {
   elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
     fn-help-contents
   else
-    cat<<help_desc
+    cat <<help_desc
     $PLUGIN_COMMAND_PREFIX, Plugin for managing $PLUGIN_SERVICE services
 help_desc
   fi
@@ -67,7 +68,7 @@ help_desc
 }
 
 fn-help-contents() {
-  pushd "$SUBCOMMAND_ROOT" > /dev/null 2>&1
+  pushd "$SUBCOMMAND_ROOT" >/dev/null 2>&1
   for cmd in *; do
     fn-help-contents-subcommand "$cmd" || true
   done
@@ -75,13 +76,13 @@ fn-help-contents() {
 
 fn-help-contents-subcommand() {
   declare SUBCOMMAND="$1" FULL_OUTPUT="$2"
-  local TMPDIR=$(mktemp -d)
+  local HELP_TMPDIR=$(mktemp -d --tmpdir)
-  local UNCLEAN_FILE="${TMPDIR}/cmd-unclean" CLEAN_FILE="${TMPDIR}/cmd-clean"
+  local UNCLEAN_FILE="${HELP_TMPDIR}/cmd-unclean" CLEAN_FILE="${HELP_TMPDIR}/cmd-clean"
   local BOLD CMD_OUTPUT CYAN EXAMPLE LIGHT_GRAY NORMAL
-  trap 'rm -rf "$TMPDIR" > /dev/null' RETURN INT TERM EXIT
+  trap 'rm -rf "$HELP_TMPDIR" > /dev/null' RETURN INT TERM EXIT
 
   rm -rf "$UNCLEAN_FILE" "$CLEAN_FILE"
-  cat "$SUBCOMMAND_ROOT/$SUBCOMMAND" > "$UNCLEAN_FILE"
+  cat "$SUBCOMMAND_ROOT/$SUBCOMMAND" >"$UNCLEAN_FILE"
 
   fn-help-subcommand-sanitize "$UNCLEAN_FILE" "$CLEAN_FILE"
   if ! is_implemented_command "$SUBCOMMAND"; then
@@ -140,9 +141,9 @@ fn-help-contents-subcommand() {
 }
 
 fn-help-fancy-tput() {
-  declare desc="A wrapper around tput"
+  declare desc="a wrapper around tput"
 
-  if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" = "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
+  if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
     return
   fi
 
@@ -150,9 +151,9 @@ fn-help-fancy-tput() {
 }
 
 fn-help-fancy-color() {
-  declare desc="A wrapper around colors"
+  declare desc="a wrapper around colors"
 
-  if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" = "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
+  if [[ -n "$DOKKU_NO_COLOR" ]] || [[ "$TERM" == "unknown" ]] || [[ "$TERM" == "dumb" ]]; then
     return
   fi
 
@@ -162,9 +163,9 @@ fn-help-fancy-color() {
 fn-help-list-example() {
   # shellcheck disable=SC2034
   declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content"
-  cat<<help_list
+  cat <<help_list
-      NAME, VERSION, STATUS, EXPOSED PORTS, LINKS
+      $PLUGIN_SERVICE services
-      service-name, $PLUGIN_COMMAND_PREFIX:$PLUGIN_IMAGE_VERSION, running, -, app-name
+      service-name
 help_list
 }
 
@@ -190,7 +191,7 @@ fn-help-subcommand-args() {
     if [[ "$arg" == *_FLAG ]]; then
       arg="${arg/_FLAG/}"
       if [[ $arg == "INFO" ]]; then
-        arg="SINGLE_INFO_FLAG..."
+        arg="SINGLE_INFO_FLAG"
         args+=" ${BLUE}[--${arg//_/-}]${NORMAL}"
       else
         args+=" ${BLUE}[-${arg:0:1}|--${arg//_/-}]${NORMAL}"
@@ -201,6 +202,9 @@ fn-help-subcommand-args() {
     elif [[ "$arg" == *_LIST ]]; then
       arg=${arg%_*}
       args+=" <${arg//_/-}...>"
+    elif [[ "$arg" == *_OPTIONAL ]]; then
+      argName="${arg/_OPTIONAL/}"
+      args+=" [<${argName//_/-}>]"
     else
       args+=" <${arg//_/-}>"
     fi
@@ -295,20 +299,20 @@ fn-help-subcommand-sanitize() {
     fi
 
     if [[ "$FUNCTION_FOUND" == true ]]; then
-      echo "$p" >> "$OUTGOING_FUNC_FILE"
+      echo "$p" >>"$OUTGOING_FUNC_FILE"
       continue
     fi
 
     if [[ "$p" == *"()"* ]]; then
       FUNCTION_FOUND=true
-      echo "$p" >> "$OUTGOING_FUNC_FILE"
+      echo "$p" >>"$OUTGOING_FUNC_FILE"
       continue
     fi
-  done < "$FUNC_FILE"
+  done <"$FUNC_FILE"
 }
 
 _fn-help-apply-shell-expansion() {
-  declare desc="Expand environment variables for a shell command"
+  declare desc="expand environment variables for a shell command"
   declare data="$1"
   declare delimiter="__apply_shell_expansion_delimiter__"
   declare command="cat <<$delimiter"$'\n'"$data"$'\n'"$delimiter"

install

@@ -1,37 +1,41 @@
 #!/usr/bin/env bash
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 
 plugin-install() {
   pull-docker-image() {
     declare IMAGE="$1"
     if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
       echo " !     ${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
-      echo " !        docker pull ${IMAGE}" 1>&2
+      echo " !        docker image pull ${IMAGE}" 1>&2
       return
     fi
-    if [[ "$(docker images -q "${IMAGE}" 2> /dev/null)" == "" ]]; then
+    if [[ "$("$DOCKER_BIN" image ls -q "${IMAGE}" 2>/dev/null)" == "" ]]; then
-      docker pull "${IMAGE}"
+      "$DOCKER_BIN" image pull "${IMAGE}"
     fi
   }
 
+  fn-plugin-property-setup "$PLUGIN_COMMAND_PREFIX"
   pull-docker-image "${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION}"
-  pull-docker-image "dokku/ambassador:0.2.0"
+  pull-docker-image "$PLUGIN_BUSYBOX_IMAGE"
-  pull-docker-image "dokku/wait:0.3.0"
+  pull-docker-image "$PLUGIN_AMBASSADOR_IMAGE"
-  pull-docker-image "dokku/s3backup:0.9.4"
+  pull-docker-image "$PLUGIN_S3BACKUP_IMAGE"
-  pull-docker-image "busybox:1.30.1-uclibc"
+  pull-docker-image "$PLUGIN_WAIT_IMAGE"
 
   mkdir -p "$PLUGIN_DATA_ROOT" || echo "Failed to create $PLUGIN_SERVICE data directory"
-  chown dokku:dokku "$PLUGIN_DATA_ROOT"
+  chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$PLUGIN_DATA_ROOT"
 
   mkdir -p "$PLUGIN_CONFIG_ROOT" || echo "Failed to create $PLUGIN_SERVICE config directory"
-  chown dokku:dokku "$PLUGIN_CONFIG_ROOT"
+  chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$PLUGIN_CONFIG_ROOT"
 
   rm -f "/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}*"
   _SUDOERS_FILE="/etc/sudoers.d/dokku-${PLUGIN_COMMAND_PREFIX}"
 
   touch "$_SUDOERS_FILE"
-  cat > "$_SUDOERS_FILE" <<EOL
+  cat >"$_SUDOERS_FILE" <<EOL
 %dokku ALL=(ALL) NOPASSWD:/bin/rm -f /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
 %dokku ALL=(ALL) NOPASSWD:/bin/chown root\:root /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
 %dokku ALL=(ALL) NOPASSWD:/bin/chmod 644 /etc/cron.d/dokku-${PLUGIN_COMMAND_PREFIX}-*
@@ -41,6 +45,25 @@ plugin-install() {
 EOL
 
   chmod 0440 "$_SUDOERS_FILE"
+
+  for SERVICE in $(fn-services-list false); do
+    local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+
+    if [[ ! -f "$SERVICE_ROOT/IMAGE" ]] || [[ ! -f "$SERVICE_ROOT/IMAGE_VERSION" ]]; then
+      local image="$(service_version "$SERVICE")"
+      if [[ "$image" == *":"* ]]; then
+        echo "${image%:*}" >"$SERVICE_ROOT/IMAGE"
+        echo "${image##*:}" >"$SERVICE_ROOT/IMAGE_VERSION"
+      fi
+    fi
+
+    chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$SERVICE_ROOT/IMAGE" "$SERVICE_ROOT/IMAGE_VERSION"
+
+    if [[ -f "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" ]]; then
+      mv "$SERVICE_ROOT/${PLUGIN_VARIABLE}_CONFIG_OPTIONS" "$SERVICE_ROOT/CONFIG_OPTIONS"
+      chown "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "$SERVICE_ROOT/CONFIG_OPTIONS"
+    fi
+  done
 }
 
 plugin-install "$@"

plugin.toml

@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku mysql service plugin"
-version = "1.7.0"
+version = "1.41.2"
 [plugin.config]

post-app-clone-setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+plugin-post-app-clone-setup() {
+  declare OLD_APP_NAME="$1" NEW_APP_NAME="$2"
+
+  for SERVICE in $(fn-services-list false); do
+    if in_links_file "$SERVICE" "$OLD_APP_NAME"; then
+      add_to_links_file "$SERVICE" "$NEW_APP_NAME"
+    fi
+  done
+}
+
+plugin-post-app-clone-setup "$@"

post-app-rename-setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+plugin-post-app-rename-setup() {
+  declare OLD_APP_NAME="$1" NEW_APP_NAME="$2"
+
+  for SERVICE in $(fn-services-list false); do
+    if in_links_file "$SERVICE" "$OLD_APP_NAME"; then
+      add_to_links_file "$SERVICE" "$NEW_APP_NAME"
+    fi
+  done
+}
+
+plugin-post-app-rename-setup "$@"

pre-delete

@@ -1,20 +1,13 @@
 #!/usr/bin/env bash
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
-source "$PLUGIN_BASE_PATH/common/functions"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
-
-PLUGIN_BASE_PATH="$PLUGIN_PATH"
-if [[ -n $DOKKU_API_VERSION ]]; then
-  PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
-fi
-source "$PLUGIN_BASE_PATH/common/functions"
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
 
 APP="$1"
-pushd "$PLUGIN_DATA_ROOT" > /dev/null
+for SERVICE in $(fn-services-list false); do
-for SERVICE in *; do
+  [[ -n "$SERVICE" ]] || continue
   dokku_log_verbose_quiet "Unlinking from $SERVICE"
   remove_from_links_file "$(basename "$SERVICE")" "$APP"
 done
-popd >/dev/null 2>&1 || pushd "/tmp" >/dev/null
-exit 0

pre-restore

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+plugin-pre-restore() {
+  declare SCHEDULER="$1" APP="$2"
+  local status
+
+  if [[ "$SCHEDULER" != "docker-local" ]]; then
+    return
+  fi
+
+  for SERVICE in $(fn-services-list false); do
+    if ! in_links_file "$SERVICE" "$APP"; then
+      continue
+    fi
+
+    status="$(service_status "$SERVICE")"
+    if [[ "$status" == "running" ]]; then
+      continue
+    fi
+
+    if [[ "$status" == "restarting" ]]; then
+      dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is restarting and may cause issues with linked app $APP"
+      continue
+    fi
+
+    dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is not running, issuing service start"
+    service_start "$SERVICE"
+  done
+}
+
+plugin-pre-restore "$@"

pre-start

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+plugin-pre-start() {
+  declare APP="$1"
+  local status
+
+  for SERVICE in $(fn-services-list false); do
+    if ! in_links_file "$SERVICE" "$APP"; then
+      continue
+    fi
+
+    status="$(service_status "$SERVICE")"
+    if [[ "$status" == "running" ]]; then
+      continue
+    fi
+
+    if [[ "$status" == "restarting" ]]; then
+      dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is restarting and may cause issues with linked app $APP"
+      continue
+    fi
+
+    dokku_log_warn "$PLUGIN_SERVICE service $SERVICE is not running, issuing service start"
+    service_start "$SERVICE"
+  done
+}
+
+plugin-pre-start "$@"

service-list

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+plugin-service-list() {
+  declare desc="allows listing all services for use by other dokku plugins"
+  declare SERVICE_TYPE="$1"
+
+  if [[ -n "$SERVICE_TYPE" ]] && [[ "$SERVICE_TYPE" != "$PLUGIN_COMMAND_PREFIX" ]]; then
+    return
+  fi
+
+  for service in $(fn-services-list false); do
+    echo "$PLUGIN_COMMAND_PREFIX:$service"
+  done
+}
+
+plugin-service-list "$@"

subcommands/app-links

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-app-links-cmd() {
@@ -9,7 +10,8 @@ service-app-links-cmd() {
   #E dokku $PLUGIN_COMMAND_PREFIX:app-links playground
   #A app, app to run command against
   declare desc="list all $PLUGIN_SERVICE service links for a given app"
-  local cmd="$PLUGIN_COMMAND_PREFIX:app-links" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:app-links" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare APP="$1"
   APP=${APP:="$DOKKU_APP_NAME"}
 

subcommands/backup

@@ -1,17 +1,21 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-cmd() {
-  #E backup the 'lolipop' service to the 'my-s3-bucket' bucket on AWS
+  #E backup the 'lollipop' service to the 'my-s3-bucket' bucket on AWS
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup lolipop my-s3-bucket --use-iam
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup lollipop my-s3-bucket --use-iam
+  #E restore a backup file (assuming it was extracted via 'tar -xf backup.tgz')
+  #E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < backup-folder/export
   #F -u|--use-iam, use the IAM profile associated with the current server
   #A service, service to run command against
   #A bucket-name, name of the s3 bucket to upload backups to
-  declare desc="creates a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"
+  declare desc="create a backup of the $PLUGIN_SERVICE service to an existing s3 bucket"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" BUCKET_NAME="$2" USE_IAM_OPTIONAL_FLAG="$3"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-auth

@@ -1,26 +1,28 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-auth-cmd() {
   #E setup s3 backup authentication
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
   #E setup s3 backup authentication with different region
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
   #E setup s3 backup authentication with different signature version and endpoint
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
   #E more specific example for minio auth
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
   #A service, service to run command against
   #A access-key-id, an amazon AWS_ACCESS_KEY_ID
   #A aws-secret-access-key, an amazon AWS_SECRET_ACCESS_KEY
   #A aws-default-region, (optional) a valid amazon S3 region
   #A aws-signature-version, (optional) the AWS signature version to use when signing S3 requests
   #A endpoint-url, (optional) an aws endpoint to upload to
-  declare desc="sets up authentication for backups on the $PLUGIN_SERVICE service"
+  declare desc="set up authentication for backups on the $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-auth" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-auth" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" AWS_ACCESS_KEY_ID="$2" AWS_SECRET_ACCESS_KEY="$3" AWS_DEFAULT_REGION="$4" AWS_SIGNATURE_VERSION="$5" ENDPOINT_URL="$6"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-deauth

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-deauth-cmd() {
   #E remove s3 authentication
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lollipop
   #A service, service to run command against
-  declare desc="removes backup authentication for the $PLUGIN_SERVICE service"
+  declare desc="remove backup authentication for the $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-schedule

@@ -1,21 +1,23 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-schedule-cmd() {
   #E schedule a backup
   #E > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket
   #E schedule a backup and authenticate via iam
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
   #F -u|--use-iam, use the IAM profile associated with the current server
   #A service, service to run command against
   #A schedule, a cron schedule to run backups on
   #A bucket-name, name of the s3 bucket to upload backups to
-  declare desc="schedules a backup of the $PLUGIN_SERVICE service"
+  declare desc="schedule a backup of the $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" SCHEDULE="$2" BUCKET_NAME="$3" USE_IAM_OPTIONAL_FLAG="$4"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-schedule-cat

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-schedule-cat-cmd() {
   #E cat the contents of the configured backup cronfile for the service
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lollipop
   #A service, service to run command against
   declare desc="cat the contents of the configured backup cronfile for the service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"

subcommands/backup-set-encryption

@@ -1,16 +1,18 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-set-encryption-cmd() {
-  #E set a GPG passphrase for backups
+  #E set the GPG-compatible passphrase for encrypting backups for backups
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lollipop
   #A service, service to run command against
   #A passphrase, a GPG-compatible passphrase
-  declare desc="sets encryption for all future backups of $PLUGIN_SERVICE service"
+  declare desc="set encryption for all future backups of $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" PASSPHRASE="$2"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-set-public-key-encryption

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
+
+service-backup-set-public-key-encryption-cmd() {
+  #E set the GPG Public Key for encrypting backups
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-public-key-encryption lollipop
+  #A service, service to run command against
+  #A public-key-id, a GPG Public Key ID (or fingerprint) to use for encryption. Must be uploaded to the GPG keyserver beforehand.
+  declare desc="set GPG Public Key encryption for all future backups of $PLUGIN_SERVICE service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-public-key-encryption" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1" PUBLIC_KEY_ID="$2"
+  is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
+  [[ -z "$PUBLIC_KEY_ID" ]] && dokku_log_fail "Please specify a valid GPG Public Key ID (or fingerprint)"
+  verify_service_name "$SERVICE"
+  service_backup_set_public_key_encryption "$SERVICE" "$PUBLIC_KEY_ID"
+}
+
+service-backup-set-public-key-encryption-cmd "$@"

subcommands/backup-unschedule

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-unschedule-cmd() {
   #E remove the scheduled backup from cron
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lollipop
   #A service, service to run command against
-  declare desc="unschedules the backup of the $PLUGIN_SERVICE service"
+  declare desc="unschedule the backup of the $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-unset-encryption

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-backup-unset-encryption-cmd() {
-  #E unset a GPG encryption key for backups
+  #E unset the GPG encryption passphrase for backups
-  #E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lollipop
   #A service, service to run command against
-  declare desc="unsets encryption for future backups of the $PLUGIN_SERVICE service"
+  declare desc="unset encryption for future backups of the $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-encryption" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-encryption" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/backup-unset-public-key-encryption

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
+
+service-backup-unset-public-key-encryption-cmd() {
+  #E unset the GPG Public Key encryption for backups
+  #E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-public-key-encryption lollipop
+  #A service, service to run command against
+  declare desc="unset GPG Public Key encryption for future backups of the $PLUGIN_SERVICE service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-public-key-encryption" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1"
+  is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"  # TODO: [22.03.2024 by Mykola]
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
+  verify_service_name "$SERVICE"
+  service_backup_unset_public_key_encryption "$SERVICE"  # TODO: [22.03.2024 by Mykola]
+}
+
+service-backup-unset-encryption-cmd "$@"

subcommands/clone

@@ -1,41 +1,52 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-clone-cmd() {
   #E you can clone an existing service to a new one
-  #E dokku $PLUGIN_COMMAND_PREFIX:clone lolipop lolipop-2
+  #E dokku $PLUGIN_COMMAND_PREFIX:clone lollipop lollipop-2
   #A service, service to run command against
   #A new-service, name of new service
+  #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
   #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
   #F -i|--image IMAGE, the image name to start the service with
   #F -I|--image-version IMAGE_VERSION, the image version to start the service with
+  #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
+  #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
   #F -p|--password PASSWORD, override the user-level service password
+  #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
   #F -r|--root-password PASSWORD, override the root-level service password
+  #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
+  #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
   declare desc="create container <new-name> then copy data from <name> into <new-name>"
-  local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" NEW_SERVICE="$2" CLONE_FLAGS_LIST=("${@:3}")
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   [[ -z "$NEW_SERVICE" ]] && dokku_log_fail "Please specify a name for the new service"
   verify_service_name "$SERVICE"
+  if service_exists "$NEW_SERVICE"; then
+    dokku_log_fail "Invalid service name $NEW_SERVICE. Verify the service name is not already in use."
+  fi
 
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local ID="$(cat "$SERVICE_ROOT/ID")"
   is_container_status "$ID" "Running" || dokku_log_fail "Service ${SERVICE} container is not running"
 
-  PLUGIN_IMAGE=$(service_version "$SERVICE" |  grep -o "^.*:" | sed -r "s/://g")
+  PLUGIN_IMAGE=$(service_version "$SERVICE" | grep -o "^.*:" | sed -r "s/://g")
-  PLUGIN_IMAGE_VERSION=$(service_version "$SERVICE" |  grep -o ":.*$" | sed -r "s/://g")
+  PLUGIN_IMAGE_VERSION=$(service_version "$SERVICE" | grep -o ":.*$" | sed -r "s/://g")
 
   service_parse_args "${@:3}"
 
   dokku_log_info2 "Cloning $SERVICE to $NEW_SERVICE @ $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
   service_create "$NEW_SERVICE" "${@:3}"
   dokku_log_info1 "Copying data from $SERVICE to $NEW_SERVICE"
-  service_export "$SERVICE" | service_import "$NEW_SERVICE" > /dev/null 2>&1 || true
+  service_export "$SERVICE" | service_import "$NEW_SERVICE" >/dev/null 2>&1 || true
   dokku_log_info2 "Done"
 }
 

subcommands/connect

@@ -1,15 +1,18 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-connect-cmd() {
   #E connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool
-  #E dokku $PLUGIN_COMMAND_PREFIX:connect lolipop
+  #E > NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
+  #E dokku $PLUGIN_COMMAND_PREFIX:connect lollipop
   #A service, service to run command against
   declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool"
-  local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/create

@@ -1,29 +1,37 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-create-cmd() {
-  #E create a $PLUGIN_COMMAND_PREFIX service named lolipop
+  #E create a $PLUGIN_COMMAND_PREFIX service named lollipop
-  #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
   #E you can also specify the image and image version to use for the service.
   #E it *must* be compatible with the ${PLUGIN_IMAGE} image.
-  #E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE="${PLUGIN_IMAGE}"
+  #E export ${PLUGIN_VARIABLE}_IMAGE="${PLUGIN_IMAGE}"
-  #E export ${PLUGIN_DEFAULT_ALIAS}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
+  #E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
-  #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
-  #E you can also specify custom environment variables to start 
+  #E you can also specify custom environment variables to start
-  #E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
+  #E the ${PLUGIN_COMMAND_PREFIX} service in semicolon-separated form.
-  #E export ${PLUGIN_DEFAULT_ALIAS}_CUSTOM_ENV="USER=alpha;HOST=beta"
+  #E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
-  #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
   #A service, service to run command against
+  #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
   #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
   #F -i|--image IMAGE, the image name to start the service with
   #F -I|--image-version IMAGE_VERSION, the image version to start the service with
+  #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
+  #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
   #F -p|--password PASSWORD, override the user-level service password
+  #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
   #F -r|--root-password PASSWORD, override the root-level service password
+  #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
+  #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
   declare desc="create a $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" CREATE_FLAGS_LIST=("${@:2}")
 
   service_create "$SERVICE" "${@:2}"

subcommands/destroy

@@ -1,21 +1,24 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-destroy-cmd() {
   #E destroy the service, it's data, and the running container
-  #E dokku $PLUGIN_COMMAND_PREFIX:destroy lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:destroy lollipop
   #A service, service to run command against
   #F -f|--force, force destroy without asking for confirmation
   declare desc="delete the $PLUGIN_SERVICE service/data/container if there are no links left"
-  local cmd="$PLUGIN_COMMAND_PREFIX:destroy" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:destroy" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" FORCE_FLAG="$2"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   verify_service_name "$SERVICE"
-  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  LINKS_FILE="$SERVICE_ROOT/LINKS"
   SERVICE_HOST_ROOT="$PLUGIN_DATA_HOST_ROOT/$SERVICE"
   SERVICE_NAME="$(get_service_name "$SERVICE")"
 
@@ -38,13 +41,17 @@ service-destroy-cmd() {
   fi
 
   dokku_log_info2_quiet "Deleting $SERVICE"
+  plugn trigger service-action pre-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   service_backup_unschedule "$SERVICE"
   service_container_rm "$SERVICE"
 
   dokku_log_verbose_quiet "Removing data"
-  docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/config:/config" busybox:1.30.1-uclibc chmod 777 -R /config /data
+  "$DOCKER_BIN" container run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data
   rm -rf "$SERVICE_ROOT"
 
+  fn-plugin-property-destroy "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
+
+  plugn trigger service-action post-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
 }
 

subcommands/enter

@@ -1,21 +1,25 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-enter-cmd() {
   #E a bash prompt can be opened against a running service.
   #E filesystem changes will not be saved to disk.
-  #E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop
+  #E > NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098
+  #E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop
   #E you may also run a command directly against the service.
   #E filesystem changes will not be saved to disk.
-  #E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop touch /tmp/test
+  #E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop touch /tmp/test
   #A service, service to run command against
   declare desc="enter or run a command in a running $PLUGIN_SERVICE service container"
-  local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
+  verify_service_name "$SERVICE"
   dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
   service_enter "$SERVICE" "${@:2}"
 }

subcommands/exists

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-exists-cmd() {
-  #E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service exists.
+  #E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service exists.
-  #E dokku $PLUGIN_COMMAND_PREFIX:exists lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:exists lollipop
   #A service, service to run command against
   declare desc="check if the $PLUGIN_SERVICE service exists"
-  local cmd="$PLUGIN_COMMAND_PREFIX:exists" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:exists" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"

subcommands/export

@@ -1,17 +1,19 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-export-cmd() {
   #E by default, datastore output is exported to stdout
-  #E dokku $PLUGIN_COMMAND_PREFIX:export lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:export lollipop
   #E you can redirect this output to a file
-  #E dokku $PLUGIN_COMMAND_PREFIX:export lolipop > lolipop.dump
+  #E dokku $PLUGIN_COMMAND_PREFIX:export lollipop > data.dump
   #A service, service to run command against
   declare desc="export a dump of the $PLUGIN_SERVICE service database"
-  local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/expose

@@ -1,16 +1,20 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-expose-cmd() {
   #E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0)
-  #E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
+  #E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop ${PLUGIN_DATASTORE_PORTS[@]}
+  #E expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1)
+  #E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]}
   #A service, service to run command against
   #A ports, a list of ports to run against
-  declare desc="expose a $PLUGIN_SERVICE service on custom port if provided (random port otherwise)"
+  declare desc="expose a $PLUGIN_SERVICE service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)"
-  local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" PORTS_LIST=("${@:2}")
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"

subcommands/import

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-import-cmd() {
   #E import a datastore dump
-  #E dokku $PLUGIN_COMMAND_PREFIX:import lolipop < database.dump
+  #E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < data.dump
   #A service, service to run command against
   declare desc="import a dump into the $PLUGIN_SERVICE service database"
-  local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
   is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
 

subcommands/info

@@ -1,23 +1,27 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-info-cmd() {
   #E get connection information as follows:
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop
   #E you can also retrieve a specific piece of service info via flags:
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --config-dir
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --config-dir
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --data-dir
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --data-dir
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --dsn
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --dsn
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --exposed-ports
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --exposed-ports
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --id
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --id
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --internal-ip
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --internal-ip
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --links
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --initial-network
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --service-root
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --links
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --status
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --post-create-network
-  #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --version
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --post-start-network
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --service-root
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --status
+  #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --version
   #A service, service to run command against
   #F --config-dir, show the service configuration directory
   #F --data-dir, show the service data directory
@@ -25,12 +29,16 @@ service-info-cmd() {
   #F --exposed-ports, show service exposed ports
   #F --id, show the service container id
   #F --internal-ip, show the service internal ip
+  #F --initial-network, show the initial network being connected to
   #F --links, show the service app links
+  #F --post-create-network, show the networks to attach to after service container creation
+  #F --post-start-network, show the networks to attach to after service container start
   #F --service-root, show the service root directory
   #F --status, show the service running status
   #F --version, show the service image version
-  declare desc="print the connection information"
+  declare desc="print the service information"
-  local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" INFO_FLAG="$2"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"

subcommands/link

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-link-cmd() {
@@ -9,40 +10,42 @@ service-link-cmd() {
   #E this will use native docker links via the docker-options plugin.
   #E here we link it to our 'playground' app.
   #E > NOTE: this will restart your app
-  #E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
+  #E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
   #E the following environment variables will be set automatically by docker
   #E (not on the app itself, so they won’t be listed when calling dokku config):
   #E
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_NAME=/lolipop/DATABASE
+  #E     DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_NAME=/lollipop/DATABASE
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
+  #E     DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
+  #E     DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]}
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
+  #E     DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
+  #E     DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]}
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
+  #E     DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1
   #E
   #E the following will be set on the linked application by default:
   #E
-  #E     ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
+  #E     ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://mysql:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
   #E
   #E the host exposed here only works internally in docker containers.
   #E if you want your container to be reachable from outside, you should
   #E use the 'expose' subcommand. another service can be linked to your app:
   #E dokku $PLUGIN_COMMAND_PREFIX:link other_service playground
   #E it is possible to change the protocol for ${PLUGIN_DEFAULT_ALIAS}_URL by setting the
-  #E environment variable ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME on the app. doing so will
+  #E environment variable ${PLUGIN_VARIABLE}_DATABASE_SCHEME on the app. doing so will
   #E after linking will cause the plugin to think the service is not
   #E linked, and we advise you to unlink before proceeding.
-  #E dokku config:set playground ${PLUGIN_DEFAULT_ALIAS}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
+  #E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2
-  #E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground
+  #E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground
   #E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as:
   #E
-  #E     ${PLUGIN_SCHEME}2://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
+  #E     ${PLUGIN_SCHEME}2://mysql:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
   #A service, service to run command against
   #A app, app to run command against
   #F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable
   #F -q|--querystring "pool=5", ampersand delimited querystring arguments to append to the service link
+  #F -n|--no-restart "false", whether or not to restart the app on link (default: true)
   declare desc="link the $PLUGIN_SERVICE service to the app"
-  local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" APP="$2" LINK_FLAGS_LIST=("${@:3}")
   APP=${APP:="$DOKKU_APP_NAME"}
 

subcommands/linked

@@ -1,16 +1,18 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-linked-cmd() {
-  #E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app.
+  #E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app.
-  #E dokku $PLUGIN_COMMAND_PREFIX:linked lolipop playground
+  #E dokku $PLUGIN_COMMAND_PREFIX:linked lollipop playground
   #A service, service to run command against
   #A app, app to run command against
   declare desc="check if the $PLUGIN_SERVICE service is linked to an app"
-  local cmd="$PLUGIN_COMMAND_PREFIX:linked" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:linked" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" APP="$2"
   APP=${APP:="$DOKKU_APP_NAME"}
 

subcommands/links

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
+
+service-links-cmd() {
+  #E list all apps linked to the 'lollipop' $PLUGIN_COMMAND_PREFIX service.
+  #E dokku $PLUGIN_COMMAND_PREFIX:links lollipop
+  #A service, service to run command against
+  declare desc="list all apps linked to the $PLUGIN_SERVICE service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:links" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1"
+  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  local LINKS_FILE="$SERVICE_ROOT/LINKS"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
+  verify_service_name "$SERVICE"
+  service_links "$SERVICE"
+}
+
+service-links-cmd "$@"

subcommands/list

@@ -1,14 +1,16 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-list-cmd() {
   #E list all services
   #E dokku $PLUGIN_COMMAND_PREFIX:list
   declare desc="list all $PLUGIN_SERVICE services"
-  local cmd="$PLUGIN_COMMAND_PREFIX:list" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:list" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
 
   service_list
 }

subcommands/logs

@@ -1,23 +1,27 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-logs-cmd() {
   #E you can tail logs for a particular service:
-  #E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop
   #E by default, logs will not be tailed, but you can do this with the --tail flag:
-  #E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop --tail
+  #E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail
+  #E the default tail setting is to show all logs, but an initial count can also be specified
+  #E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail 5
   #A service, service to run command against
-  #F -t|--tail, do not stop when end of the logs are reached and wait for additional output
+  #F -t|--tail [<tail-num>], do not stop when end of the logs are reached and wait for additional output
   declare desc="print the most recent log(s) for this service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@")
-  declare SERVICE="$1" TAIL_FLAG="$2"
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1" TAIL_FLAG="$2" TAIL_NUM_OPTIONAL="${3:-all}"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   verify_service_name "$SERVICE"
-  service_logs "$SERVICE" "$TAIL_FLAG"
+  service_logs "$SERVICE" "$TAIL_FLAG" "$TAIL_NUM_OPTIONAL"
 }
 
 service-logs-cmd "$@"

subcommands/pause

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
+
+service-pause-cmd() {
+  #E pause the running container for the service
+  #E dokku $PLUGIN_COMMAND_PREFIX:pause lollipop
+  #A service, service to run command against
+  declare desc="pause a running $PLUGIN_SERVICE service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:pause" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
+  verify_service_name "$SERVICE"
+  service_pause "$SERVICE"
+}
+
+service-pause-cmd "$@"

subcommands/promote

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-promote-cmd() {
@@ -19,11 +20,12 @@ service-promote-cmd() {
   #E
   #E     ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
   #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service
-  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop
+  #E     DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop
   #A service, service to run command against
   #A app, app to run command against
   declare desc="promote service <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"
-  local cmd="$PLUGIN_COMMAND_PREFIX:promote" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:promote" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" APP="$2"
   APP=${APP:="$DOKKU_APP_NAME"}
 

subcommands/restart

@@ -1,20 +1,22 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-restart-cmd() {
   #E restart the service
-  #E dokku $PLUGIN_COMMAND_PREFIX:restart lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:restart lollipop
   #A service, service to run command against
   declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container"
-  local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   verify_service_name "$SERVICE"
-  service_stop "$SERVICE"
+  service_pause "$SERVICE"
   service_start "$SERVICE"
   dokku_log_info1 "Please call dokku ps:restart on all linked apps"
 }

subcommands/set

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/property-functions"
+source "$(cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")" && pwd)/common-functions"
+
+service-set-cmd() {
+  #E set the network to attach after the service container is started
+  #E dokku $PLUGIN_COMMAND_PREFIX:set lollipop post-create-network custom-network
+  #E set multiple networks
+  #E dokku $PLUGIN_COMMAND_PREFIX:set lollipop post-create-network custom-network,other-network
+  #E unset the post-create-network value
+  #E dokku $PLUGIN_COMMAND_PREFIX:set lollipop post-create-network
+  #A service, service to run command against
+  #A key, property name to set
+  #A value, optional property value to set or empty to unset key
+  declare desc="set or clear a property for a service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:set" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1" KEY="$2" VALUE="$3"
+  local VALID_KEYS=("initial-network" "post-create-network" "post-start-network")
+  verify_service_name "$SERVICE"
+
+  [[ -z "$KEY" ]] && dokku_log_fail "No key specified"
+
+  if ! fn-in-array "$KEY" "${VALID_KEYS[@]}"; then
+    dokku_log_fail "Invalid key specified, valid keys include: initial-network, post-create-network, post-start-network"
+  fi
+
+  if [[ -n "$VALUE" ]]; then
+    dokku_log_info2_quiet "Setting ${KEY} to ${VALUE}"
+    fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$KEY" "$VALUE"
+  else
+    dokku_log_info2_quiet "Unsetting ${KEY}"
+    if [[ "$KEY" == "rev-env-var" ]]; then
+      fn-plugin-property-write "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$KEY" "$VALUE"
+    else
+      fn-plugin-property-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$KEY"
+    fi
+  fi
+}
+
+service-set-cmd "$@"

subcommands/start

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-start-cmd() {
   #E start the service
-  #E dokku $PLUGIN_COMMAND_PREFIX:start lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:start lollipop
   #A service, service to run command against
   declare desc="start a previously stopped $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"

subcommands/stop

@@ -1,20 +1,22 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-stop-cmd() {
-  #E stop the service and the running container
+  #E stop the service and removes the running container
-  #E dokku $PLUGIN_COMMAND_PREFIX:stop lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop
   #A service, service to run command against
   declare desc="stop a running $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   verify_service_name "$SERVICE"
-  service_stop "$SERVICE"
+  service_container_rm "$SERVICE"
 }
 
 service-stop-cmd "$@"

subcommands/unexpose

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-unexpose-cmd() {
   #E unexpose the service, removing access to it from the public interface (0.0.0.0)
-  #E dokku $PLUGIN_COMMAND_PREFIX:unexpose lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:unexpose lollipop
   #A service, service to run command against
   declare desc="unexpose a previously exposed $PLUGIN_SERVICE service"
-  local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"

subcommands/unlink

@@ -1,17 +1,20 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-unlink-cmd() {
   #E you can unlink a $PLUGIN_COMMAND_PREFIX service
   #E > NOTE: this will restart your app and unset related environment variables
-  #E dokku $PLUGIN_COMMAND_PREFIX:unlink lolipop playground
+  #E dokku $PLUGIN_COMMAND_PREFIX:unlink lollipop playground
   #A service, service to run command against
   #A app, app to run command against
+  #F -n|--no-restart "false", whether or not to restart the app on unlink (default: true)
   declare desc="unlink the $PLUGIN_SERVICE service from the app"
-  local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" APP="$2"
   APP=${APP:="$DOKKU_APP_NAME"}
 

subcommands/upgrade

@@ -1,20 +1,27 @@
 #!/usr/bin/env bash
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+set -eo pipefail
-source "$PLUGIN_BASE_PATH/common/functions"
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 source "$PLUGIN_AVAILABLE_PATH/ps/functions"
 
 service-upgrade-cmd() {
   #E you can upgrade an existing service to a new image or image-version
-  #E dokku $PLUGIN_COMMAND_PREFIX:upgrade lolipop
+  #E dokku $PLUGIN_COMMAND_PREFIX:upgrade lollipop
   #A service, service to run command against
+  #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command
   #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
   #F -i|--image IMAGE, the image name to start the service with
   #F -I|--image-version IMAGE_VERSION, the image version to start the service with
-  #F -R|--restart-apps "true", whether to force an app restart
+  #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
+  #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
+  #F -R|--restart-apps "true", whether or not to force an app restart (default: false)
+  #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
+  #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
   declare desc="upgrade service <service> to the specified versions"
-  local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1" UPGRADE_FLAGS_LIST=("${@:2}")
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
@@ -24,8 +31,14 @@ service-upgrade-cmd() {
 
   service_parse_args "${@:2}"
 
-  if ! service_image_exists "$SERVICE"; then
+  if ! service_image_exists "$SERVICE" "$PLUGIN_IMAGE" "$PLUGIN_IMAGE_VERSION"; then
-    dokku_log_fail "Unable to proceed with upgrade, image ${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION} does not exist"
+    if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
+      dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
+      dokku_log_warn "   docker image pull ${IMAGE}" 1>&2
+      dokku_log_warn "$PLUGIN_SERVICE service $SERVICE upgrade failed"
+      exit 1
+    fi
+    "$DOCKER_BIN" image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
   fi
 
   local NEW_PLUGIN_IMAGE_TAG="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
@@ -34,6 +47,8 @@ service-upgrade-cmd() {
     return
   fi
 
+  service_commit_config "$SERVICE"
+
   dokku_log_info2 "Upgrading $SERVICE to $NEW_PLUGIN_IMAGE_TAG"
   if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
     dokku_log_info2 "Stopping all linked services"

tests/hook_pre_delete.bats

@@ -2,18 +2,19 @@
 load test_helper
 
 setup() {
-  dokku apps:create my_app
+  dokku apps:create my-app
-  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ls
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app >&2
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
 }
 
 teardown() {
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app >&2
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app >&2
-  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
+  dokku --force apps:destroy my-app || true
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:hook:pre-delete) removes app from links file when destroying app" {
-  [[ -n $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
+  [[ -n $(<"$PLUGIN_DATA_ROOT/ls/LINKS") ]]
-  dokku --force apps:destroy my_app
+  dokku --force apps:destroy my-app
-  [[ -z $(< "$PLUGIN_DATA_ROOT/l/LINKS") ]]
+  [[ -z $(<"$PLUGIN_DATA_ROOT/ls/LINKS") ]]
 }

tests/link_networks.bats

@@ -0,0 +1,289 @@
+#!/usr/bin/env bats
+load test_helper
+
+setup() {
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ls
+  dokku network:create custom-network
+}
+
+teardown() {
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls || true
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" lsa || true
+  dokku network:destroy --force custom-network
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:set) set initial-network" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:set" ls initial-network custom-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --initial-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "custom-network"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network 0
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge 0
+  assert_output_contains custom-network
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.ls"
+  assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-ls"
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:set" ls initial-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --initial-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_output ""
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network 0
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:set) set post-create-network" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-create-network custom-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-create-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "custom-network"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network 0
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains custom-network
+  assert_output_contains bridge
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.ls"
+  assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-ls"
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-create-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-create-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_output ""
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network 0
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:set) set an post-start-network" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-start-network custom-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-start-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_output "custom-network"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network 0
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.ls"
+  assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-ls"
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:set" ls post-start-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:info" ls --post-start-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_output ""
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:stop" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:start" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network 0
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:create) flags" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:create" lsa --initial-network custom-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect "dokku.$PLUGIN_COMMAND_PREFIX.lsa" -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge 0
+  assert_output_contains custom-network
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:destroy" lsa --force
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:create" lsa --post-create-network custom-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect "dokku.$PLUGIN_COMMAND_PREFIX.lsa" -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network
+
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains "alias:dokku.$PLUGIN_COMMAND_PREFIX.lsa"
+  assert_output_contains "alias:dokku-$PLUGIN_COMMAND_PREFIX-lsa"
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:destroy" lsa --force
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:create" lsa --post-start-network custom-network
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run docker inspect "dokku.$PLUGIN_COMMAND_PREFIX.lsa" -f '{{range $net,$v := .NetworkSettings.Networks}}{{printf "%s\n" $net}}{{end}}'
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_output_contains bridge
+  assert_output_contains custom-network
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:destroy" lsa --force
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+}

tests/service_clone.bats

@@ -30,7 +30,7 @@ teardown() {
 @test "($PLUGIN_COMMAND_PREFIX:clone) error when new service already exists" {
   dokku "$PLUGIN_COMMAND_PREFIX:create" new_service
   run dokku "$PLUGIN_COMMAND_PREFIX:clone" l new_service
-  assert_contains "${lines[*]}" "service new_service already exists"
+  assert_contains "${lines[*]}" "Invalid service name new_service"
   assert_failure
 
   dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service

tests/service_create.bats

@@ -7,6 +7,15 @@ load test_helper
   dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
 }
 
+@test "($PLUGIN_COMMAND_PREFIX:create) service with dashes" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:create" service-with-dashes
+  assert_contains "${lines[*]}" "container created: service-with-dashes"
+  assert_contains "${lines[*]}" "dokku-$PLUGIN_COMMAND_PREFIX-service-with-dashes"
+  assert_contains "${lines[*]}" "service_with_dashes"
+
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" service-with-dashes
+}
+
 @test "($PLUGIN_COMMAND_PREFIX:create) error when there are no arguments" {
   run dokku "$PLUGIN_COMMAND_PREFIX:create"
   assert_contains "${lines[*]}" "Please specify a valid name for the service"
@@ -15,7 +24,4 @@ load test_helper
 @test "($PLUGIN_COMMAND_PREFIX:create) error when there is an invalid name specified" {
   run dokku "$PLUGIN_COMMAND_PREFIX:create" d.erp
   assert_failure
-
-  run dokku "$PLUGIN_COMMAND_PREFIX:create" d-erp
-  assert_failure
 }

tests/service_export.bats

@@ -20,7 +20,10 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:export) success with SSH_TTY" {
-  export SSH_TTY=`tty`
+  if [[ -n "$GITHUB_WORKFLOW" ]]; then
+    skip "No tty is available on Github Actions"
+  fi
+  export SSH_TTY=$(tty)
   run dokku "$PLUGIN_COMMAND_PREFIX:export" l
   echo "output: $output"
   echo "status: $status"

tests/service_expose.bats

@@ -2,29 +2,65 @@
 load test_helper
 
 setup() {
-  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ls
 }
 
 teardown() {
-  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:expose) error when there are no arguments" {
   run dokku "$PLUGIN_COMMAND_PREFIX:expose"
+  echo "output: $output"
+  echo "status: $status"
+  assert_failure
   assert_contains "${lines[*]}" "Please specify a valid name for the service"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:expose) error when service does not exist" {
   run dokku "$PLUGIN_COMMAND_PREFIX:expose" not_existing_service
+  echo "output: $output"
+  echo "status: $status"
+  assert_failure
   assert_contains "${lines[*]}" "service not_existing_service does not exist"
 }
 
+@test "($PLUGIN_COMMAND_PREFIX:expose) error when already exposed" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_failure
+  assert_contains "${lines[*]}" "Service ls already exposed on port(s)"
+
+  run sudo rm "$PLUGIN_DATA_ROOT/ls/PORT"
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_contains "${lines[*]}" "Service ls has an untracked expose container, removing"
+}
+
 @test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:expose" l
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
   [[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls 4242
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
   assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 3306->4242"
 }

tests/service_import.bats

@@ -24,13 +24,16 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:import) error when data is not provided" {
+  if [[ -n "$GITHUB_WORKFLOW" ]]; then
+    skip "No tty is available on Github Actions"
+  fi
   run dokku "$PLUGIN_COMMAND_PREFIX:import" l
   assert_contains "${lines[*]}" "No data provided on stdin"
   assert_failure
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:import) success" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:import" l < "/tmp/fake.sql"
+  run dokku "$PLUGIN_COMMAND_PREFIX:import" l <"/tmp/fake.sql"
   echo "output: $output"
   echo "status: $status"
   assert_success

tests/service_link.bats

@@ -2,18 +2,17 @@
 load test_helper
 
 setup() {
-  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ls
-  dokku "$PLUGIN_COMMAND_PREFIX:create" m
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ms
-  dokku apps:create my_app
+  dokku apps:create my-app
 }
 
 teardown() {
-  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" m
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ms
-  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
-  dokku --force apps:destroy my_app
+  dokku --force apps:destroy my-app
 }
 
-
 @test "($PLUGIN_COMMAND_PREFIX:link) error when there are no arguments" {
   run dokku "$PLUGIN_COMMAND_PREFIX:link"
   echo "output: $output"
@@ -23,7 +22,7 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) error when the app argument is missing" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:link" l
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls
   echo "output: $output"
   echo "status: $status"
   assert_contains "${lines[*]}" "Please specify an app to run the command on"
@@ -31,7 +30,7 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) error when the app does not exist" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:link" l not_existing_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls not_existing_app
   echo "output: $output"
   echo "status: $status"
   assert_contains "${lines[*]}" "App not_existing_app does not exist"
@@ -39,7 +38,7 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) error when the service does not exist" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:link" not_existing_service my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" not_existing_service my-app
   echo "output: $output"
   echo "status: $status"
   assert_contains "${lines[*]}" "service not_existing_service does not exist"
@@ -47,73 +46,97 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) error when the service is already linked to app" {
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
-  run dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
   echo "output: $output"
   echo "status: $status"
   assert_contains "${lines[*]}" "Already linked as DATABASE_URL"
   assert_failure
 
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) exports DATABASE_URL to app" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
   echo "output: $output"
   echo "status: $status"
-  url=$(dokku config:get my_app DATABASE_URL)
+  url=$(dokku config:get my-app DATABASE_URL)
-  password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
+  password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
-  assert_contains "$url" "mysql://mysql:$password@dokku-mysql-l:3306/l"
+  assert_contains "$url" "mysql://mysql:$password@dokku-mysql-ls:3306/ls"
   assert_success
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) generates an alternate config url when DATABASE_URL already in use" {
-  dokku config:set my_app DATABASE_URL=mysql://user:pass@host:3306/db
+  dokku config:set my-app DATABASE_URL=mysql://user:pass@host:3306/db
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
-  run dokku config my_app
+  run dokku config my-app
   assert_contains "${lines[*]}" "DOKKU_MYSQL_AQUA_URL"
   assert_success
 
-  dokku "$PLUGIN_COMMAND_PREFIX:link" m my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ms my-app
-  run dokku config my_app
+  run dokku config my-app
   assert_contains "${lines[*]}" "DOKKU_MYSQL_BLACK_URL"
   assert_success
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" m my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ms my-app
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) links to app with docker-options" {
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
-  run dokku docker-options my_app
+  run dokku docker-options:report my-app
-  assert_contains "${lines[*]}" "--link dokku.mysql.l:dokku-mysql-l"
+  assert_contains "${lines[*]}" "--link dokku.mysql.ls:dokku-mysql-ls"
   assert_success
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) uses apps MYSQL_DATABASE_SCHEME variable" {
-  dokku config:set my_app MYSQL_DATABASE_SCHEME=mysql2
+  dokku config:set my-app MYSQL_DATABASE_SCHEME=mysql2
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
-  url=$(dokku config:get my_app DATABASE_URL)
+  url=$(dokku config:get my-app DATABASE_URL)
-  password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
+  password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
-  assert_contains "$url" "mysql2://mysql:$password@dokku-mysql-l:3306/l"
+  assert_contains "$url" "mysql2://mysql:$password@dokku-mysql-ls:3306/ls"
   assert_success
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) adds a querystring" {
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app --querystring "pool=5"
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --querystring "pool=5"
-  url=$(dokku config:get my_app DATABASE_URL)
+  url=$(dokku config:get my-app DATABASE_URL)
   assert_contains "$url" "?pool=5"
   assert_success
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:link) uses a specified config url when alias is specified" {
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app --alias "ALIAS"
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --alias "ALIAS"
-  url=$(dokku config:get my_app ALIAS_URL)
+  url=$(dokku config:get my-app ALIAS_URL)
-  password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
+  password="$(sudo cat "$PLUGIN_DATA_ROOT/ls/PASSWORD")"
-  assert_contains "$url" "mysql://mysql:$password@dokku-mysql-l:3306/l"
+  assert_contains "$url" "mysql://mysql:$password@dokku-mysql-ls:3306/ls"
+  assert_success
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:link) respects --no-restart" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_contains "Skipping restart of linked app" 0
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app --no-restart
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_contains "Skipping restart of linked app"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
+  echo "output: $output"
+  echo "status: $status"
   assert_success
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
 }

tests/service_list.bats

@@ -10,27 +10,13 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:list) with no exposed ports, no linked apps" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:list"
+  run dokku --quiet "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     mysql:5.7.25  running  -              -"
+  assert_output "l"
-}
-
-@test "($PLUGIN_COMMAND_PREFIX:list) with exposed ports" {
-  dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
-  run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     mysql:5.7.25  running  3306->4242     -"
-}
-
-@test "($PLUGIN_COMMAND_PREFIX:list) with linked app" {
-  dokku apps:create my_app
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
-  run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     mysql:5.7.25  running  -              my_app"
-  dokku --force apps:destroy my_app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:list) when there are no services" {
   dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
   run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "There are no MySQL services"
+  assert_output "${lines[*]}" "There are no $PLUGIN_SERVICE services"
   dokku "$PLUGIN_COMMAND_PREFIX:create" l
 }

tests/service_pause.bats

@@ -0,0 +1,25 @@
+#!/usr/bin/env bats
+load test_helper
+
+setup() {
+  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+}
+
+teardown() {
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:pause) error when there are no arguments" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:pause"
+  assert_contains "${lines[*]}" "Please specify a valid name for the service"
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:pause) error when service does not exist" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:pause" not_existing_service
+  assert_contains "${lines[*]}" "service not_existing_service does not exist"
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:pause) success" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:pause" l
+  assert_success
+}

tests/service_promote.bats

@@ -3,14 +3,14 @@ load test_helper
 
 setup() {
   dokku "$PLUGIN_COMMAND_PREFIX:create" l
-  dokku apps:create my_app
+  dokku apps:create my-app
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:link" l my-app
 }
 
 teardown() {
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my-app
   dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
-  dokku --force apps:destroy my_app
+  dokku --force apps:destroy my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:promote) error when there are no arguments" {
@@ -29,35 +29,35 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:promote) error when the service does not exist" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:promote" not_existing_service my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:promote" not_existing_service my-app
   assert_contains "${lines[*]}" "service not_existing_service does not exist"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:promote) error when the service is already promoted" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
   assert_contains "${lines[*]}" "already promoted as DATABASE_URL"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:promote) changes DATABASE_URL" {
   password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
-  dokku config:set my_app "DATABASE_URL=mysql://u:p@host:3306/db" "DOKKU_MYSQL_BLUE_URL=mysql://mysql:$password@dokku-mysql-l:3306/l"
+  dokku config:set my-app "DATABASE_URL=mysql://u:p@host:3306/db" "DOKKU_MYSQL_BLUE_URL=mysql://mysql:$password@dokku-mysql-l:3306/l"
-  dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
-  url=$(dokku config:get my_app DATABASE_URL)
+  url=$(dokku config:get my-app DATABASE_URL)
   assert_equal "$url" "mysql://mysql:$password@dokku-mysql-l:3306/l"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:promote) creates new config url when needed" {
   password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
-  dokku config:set my_app "DATABASE_URL=mysql://u:p@host:3306/db" "DOKKU_MYSQL_BLUE_URL=mysql://mysql:$password@dokku-mysql-l:3306/l"
+  dokku config:set my-app "DATABASE_URL=mysql://u:p@host:3306/db" "DOKKU_MYSQL_BLUE_URL=mysql://mysql:$password@dokku-mysql-l:3306/l"
-  dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
-  run dokku config my_app
+  run dokku config my-app
   assert_contains "${lines[*]}" "DOKKU_MYSQL_"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:promote) uses MYSQL_DATABASE_SCHEME variable" {
   password="$(sudo cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
-  dokku config:set my_app "MYSQL_DATABASE_SCHEME=mysql2" "DATABASE_URL=mysql://u:p@host:3306/db" "DOKKU_MYSQL_BLUE_URL=mysql2://mysql:$password@dokku-mysql-l:3306/l"
+  dokku config:set my-app "MYSQL_DATABASE_SCHEME=mysql2" "DATABASE_URL=mysql://u:p@host:3306/db" "DOKKU_MYSQL_BLUE_URL=mysql2://mysql:$password@dokku-mysql-l:3306/l"
-  dokku "$PLUGIN_COMMAND_PREFIX:promote" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:promote" l my-app
-  url=$(dokku config:get my_app DATABASE_URL)
+  url=$(dokku config:get my-app DATABASE_URL)
   assert_contains "$url" "mysql2://mysql:$password@dokku-mysql-l:3306/l"
 }

tests/service_restart.bats

@@ -23,4 +23,3 @@ teardown() {
   run dokku "$PLUGIN_COMMAND_PREFIX:restart" l
   assert_success
 }
-

tests/service_start.bats

@@ -23,4 +23,3 @@ teardown() {
   run dokku "$PLUGIN_COMMAND_PREFIX:start" l
   assert_success
 }
-

tests/service_stop.bats

@@ -23,4 +23,3 @@ teardown() {
   run dokku "$PLUGIN_COMMAND_PREFIX:stop" l
   assert_success
 }
-

tests/service_unexpose.bats

@@ -25,4 +25,3 @@ teardown() {
   [[ ! -f $PLUGIN_DATA_ROOT/PORT ]]
   assert_contains "${lines[*]}" "Service l unexposed"
 }
-

tests/service_unlink.bats

@@ -2,13 +2,13 @@
 load test_helper
 
 setup() {
-  dokku apps:create my_app
+  dokku apps:create my-app
-  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ls
 }
 
 teardown() {
-  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
-  dokku --force apps:destroy my_app
+  dokku --force apps:destroy my-app
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) error when there are no arguments" {
@@ -17,37 +17,61 @@ teardown() {
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app argument is missing" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls
   assert_contains "${lines[*]}" "Please specify an app to run the command on"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) error when the app does not exist" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l not_existing_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls not_existing_app
   assert_contains "${lines[*]}" "App not_existing_app does not exist"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) error when the service does not exist" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" not_existing_service my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" not_existing_service my-app
   assert_contains "${lines[*]}" "service not_existing_service does not exist"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) error when service not linked to app" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
-  assert_contains "${lines[*]}" "Not linked to app my_app"
+  assert_contains "${lines[*]}" "Not linked to app my-app"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) removes link from docker-options" {
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app >&2
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
 
   check_value="Docker options build: Docker options deploy: --restart=on-failure:10 Docker options run:"
-  options=$(dokku --quiet docker-options:report my_app | xargs)
+  options=$(dokku --quiet docker-options:report my-app | xargs)
   assert_equal "$options" "$check_value"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:unlink) unsets config url from app" {
-  dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app >&2
+  dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app >&2
-  dokku "$PLUGIN_COMMAND_PREFIX:unlink" l my_app
+  dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
-  config=$(dokku config:get my_app DATABASE_URL || true)
+  config=$(dokku config:get my-app DATABASE_URL || true)
   assert_equal "$config" ""
 }
+
+@test "($PLUGIN_COMMAND_PREFIX:unlink) respects --no-restart" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_contains "Skipping restart of linked app" 0
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:link" ls my-app
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:unlink" ls my-app --no-restart
+  echo "output: $output"
+  echo "status: $status"
+  assert_output_contains "Skipping restart of linked app"
+  assert_success
+}

tests/setup.sh

@@ -1,5 +1,14 @@
 #!/usr/bin/env bash
-set -eo pipefail; [[ $TRACE ]] && set -x
+set -eo pipefail
+[[ $TRACE ]] && set -x
+sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 762E3157
+echo "deb http://nginx.org/packages/ubuntu $(lsb_release -cs) nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
+curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add -
+
+sudo mkdir -p /etc/nginx
+sudo curl https://raw.githubusercontent.com/dokku/dokku/master/tests/dhparam.pem -o /etc/nginx/dhparam.pem
+
+echo "dokku dokku/skip_key_file boolean true" | sudo debconf-set-selections
 wget https://raw.githubusercontent.com/dokku/dokku/master/bootstrap.sh
 if [[ "$DOKKU_VERSION" == "master" ]]; then
   sudo bash bootstrap.sh
@@ -10,11 +19,15 @@ echo "Dokku version $DOKKU_VERSION"
 
 export DOKKU_LIB_ROOT="/var/lib/dokku"
 export DOKKU_PLUGINS_ROOT="$DOKKU_LIB_ROOT/plugins/available"
-source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+pushd "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")" >/dev/null
+source "config"
+popd >/dev/null
 sudo rm -rf "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX"
-sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands"
+sudo mkdir -p "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates"
 sudo find ./ -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX" \;
-sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \;
+[[ -d "./scripts" ]] && sudo find ./scripts -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/scripts" \;
+[[ -d "./subcommands" ]] && sudo find ./subcommands -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/subcommands" \;
+[[ -d "./templates" ]] && sudo find ./templates -maxdepth 1 -type f -exec cp '{}' "$DOKKU_PLUGINS_ROOT/$PLUGIN_COMMAND_PREFIX/templates" \;
 sudo mkdir -p "$PLUGIN_CONFIG_ROOT" "$PLUGIN_DATA_ROOT"
 sudo dokku plugin:enable "$PLUGIN_COMMAND_PREFIX"
 sudo dokku plugin:install

tests/shellcheck-exclude

@@ -1,3 +1,8 @@
 # SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
+# SC1091 - Not following - <https://github.com/koalaman/shellcheck/wiki/SC1091>
 # SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
 # SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
+# SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206
+# SC2207 - Prefer mapfile or read -a to split command output (or quote to avoid splitting) - https://github.com/koalaman/shellcheck/wiki/SC2207
+# SC2220 - Invalid flags are not handled. Add a *) case - https://github.com/koalaman/shellcheck/wiki/SC2220
+# SC2230 - which is non-standard. Use builtin 'command -v' instead - https://github.com/koalaman/shellcheck/wiki/SC2230

tests/shellcheck-to-junit

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 from __future__ import print_function
 import argparse

tests/test_helper.bash

@@ -3,8 +3,11 @@ export DOKKU_LIB_ROOT="/var/lib/dokku"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
 
 flunk() {
-  { if [ "$#" -eq 0 ]; then cat -
+  {
-    else echo "$*"
+    if [ "$#" -eq 0 ]; then
+      cat -
+    else
+      echo "$*"
     fi
   }
   return 1
@@ -12,7 +15,8 @@ flunk() {
 
 assert_equal() {
   if [ "$1" != "$2" ]; then
-    { echo "expected: $1"
+    {
+      echo "expected: $1"
       echo "actual:   $2"
     } | flunk
   fi
@@ -59,8 +63,24 @@ assert_contains() {
 # shellcheck disable=SC2154
 assert_output() {
   local expected
-  if [ $# -eq 0 ]; then expected="$(cat -)"
+  if [ $# -eq 0 ]; then
-  else expected="$1"
+    expected="$(cat -)"
+  else
+    expected="$1"
   fi
   assert_equal "$expected" "$output"
 }
+
+# ShellCheck doesn't know about $output from Bats
+# shellcheck disable=SC2154
+assert_output_contains() {
+  local input="$output"
+  local expected="$1"
+  local count="${2:-1}"
+  local found=0
+  until [ "${input/$expected/}" = "$input" ]; do
+    input="${input/$expected/}"
+    found=$((found + 1))
+  done
+  assert_equal "$count" "$found"
+}