From ef4eeab0292e98f8daf12d6f6ed5d8c883cd654f Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 6 Oct 2021 12:41:35 -0400 Subject: [PATCH] docs: clarify container option usage --- docs/advanced-usage/docker-options.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/advanced-usage/docker-options.md b/docs/advanced-usage/docker-options.md index 4fad3be56..16e82cd3e 100644 --- a/docs/advanced-usage/docker-options.md +++ b/docs/advanced-usage/docker-options.md @@ -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 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