From 21c863939722209e861c5258e5e0e6b392829948 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 6 Sep 2020 13:18:34 -0400 Subject: [PATCH 1/2] docs: drop advanced usage Dokku internals shouldn't be exposed in docs. Additionally, the internals here are likely to change in the future as this moves to the upcoming prop binary, so having incorrect docs will hinder that move. --- docs/advanced-usage/docker-options.md | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/docs/advanced-usage/docker-options.md b/docs/advanced-usage/docker-options.md index 9414eb187..9a38931ec 100644 --- a/docs/advanced-usage/docker-options.md +++ b/docs/advanced-usage/docker-options.md @@ -119,25 +119,3 @@ You can pass flags which will output only the value of the specific information ```shell dokku docker-options:report node-js-app --docker-options-build ``` - -## Advanced usage - -In your applications folder `/home/dokku/app_name` create a file called `DOCKER_OPTIONS_RUN` (or `DOCKER_OPTIONS_BUILD` or `DOCKER_OPTIONS_DEPLOY`). - -Inside this file list one Docker option per line. For example: - -```shell ---link container_name:alias --v /host/path:/container/path --v /another/container/path -``` - -The above example will result in the following options being passed to Docker during `dokku run`: - -```shell ---link container_name:alias -v /host/path:/container/path -v /another/container/path -``` - -You may also include comments (lines beginning with a #) and blank lines in the DOCKER_OPTIONS file. - -More information on Docker options can be found here: https://docs.docker.com/engine/reference/commandline/run/. From 8d96be73b7fd9e416a4faef63a41c68065dc9179 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 6 Sep 2020 13:20:34 -0400 Subject: [PATCH 2/2] docs: note that docker options require app rebuilds Closes #4101 --- docs/advanced-usage/docker-options.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/advanced-usage/docker-options.md b/docs/advanced-usage/docker-options.md index 9a38931ec..cc5a06610 100644 --- a/docs/advanced-usage/docker-options.md +++ b/docs/advanced-usage/docker-options.md @@ -25,6 +25,10 @@ Dokku deploys your application in multiple "phases" and the `docker-options` plu - `deploy`: the container that executes your running/deployed application - `run`: the container that executes any arbitrary command via `dokku run` +Manipulation of docker options will not restart running containers. This enables multiple options to be set/unset before final application. As such, changing an app's docker options must be followed by a `dokku ps:rebuild` in order to take effect. + +More information on supported Docker options can be found here: https://docs.docker.com/engine/reference/commandline/run/. + ## Examples ### Add Docker options