github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: clarify container option usage

Browse Source
This commit is contained in:
Jose Diaz-Gonzalez
2021-10-06 12:41:35 -04:00
committed by GitHub
parent c335eb9ad6
commit ef4eeab029
1 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/advanced-usage/docker-options.md
View File

@@ -2,7 +2,7 @@
> New as of 0.3.17
Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases
Pass [container options](https://docs.docker.com/engine/reference/run/) to the `docker run` command during Dokku's `build`, `deploy` and `run` phases
```
docker-options:add <app> <phase(s)> OPTION # Add Docker option to app for phase (comma-separated phase list)
@@ -29,9 +29,7 @@ Manipulation of docker options will not restart running containers. This enables
More information on supported Docker options can be found here: https://docs.docker.com/engine/reference/commandline/run/.
> Note: `docker-options` are not to be confused with the arguments passed to the container (`[COMMAND] [ARG...]`).
Please use the [`DOKKU_DOCKERFILE_START_CMD`](/docs/deployment/builders/dockerfiles.md#customizing-the-run-command) environment variable
or a [Procfile](/docs/deployment/builders/dockerfiles.md#procfiles-and-multiple-processes) instead.
Container options configured via the `docker-options` plugin are not used to modify the process a container runs. Container options are the `[OPTIONS]` portion of the following, where `[CONTAINER_COMMAND]` and `[ARG]` are the process and the arguments passed to it that are launched in the created container: `docker run [OPTIONS] [CONTAINER_COMMAND] [ARG...]`. Please see the documentation for [customizing the run command](/docs/deployment/builders/dockerfiles.md#customizing-the-run-command) or use a [Procfile](/docs/deployment/builders/dockerfiles.md#procfiles-and-multiple-processes) to modify the command used by a Dockerfile-based container.
## Examples