Skip to content

Commit

Permalink
Merge pull request #5509 from austinvazquez/cherry-pick-2f2b16a96687e…
Browse files Browse the repository at this point in the history 
…50682497435a6de3b016ab1a5bc-to-27.x

[27.x backport] docs: fix inaccurate description of --restart=unless-stopped
  • Loading branch information
@thaJeztah
thaJeztah authored Oct 7, 2024
2 parents fa0bb9f + 6f5bfcb commit 011cb19
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/reference/commandline/container_run.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1157,12 +1157,12 @@ Use the `--restart` flag to specify a container's *restart policy*. A restart
policy controls whether the Docker daemon restarts a container after exit.
Docker supports the following restart policies:

| Policy | Result |
|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `no` | Do not automatically restart the container when it exits. This is the default. |
| `on-failure[:max-retries]` | Restart only if the container exits with a non-zero exit status. Optionally, limit the number of restart retries the Docker daemon attempts. |
| `unless-stopped` | Restart the container unless it's explicitly stopped or Docker itself is stopped or restarted. |
| `always` | Always restart the container regardless of the exit status. When you specify always, the Docker daemon tries to restart the container indefinitely. The container always starts on daemon startup, regardless of the current state of the container. |
| Flag | Description |
| :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `no` | Don't automatically restart the container. (Default) |
| `on-failure[:max-retries]` | Restart the container if it exits due to an error, which manifests as a non-zero exit code. Optionally, limit the number of times the Docker daemon attempts to restart the container using the `:max-retries` option. The `on-failure` policy only prompts a restart if the container exits with a failure. It doesn't restart the container if the daemon restarts. |
| `always` | Always restart the container if it stops. If it's manually stopped, it's restarted only when Docker daemon restarts or the container itself is manually restarted. |
| `unless-stopped` | Similar to `always`, except that when the container is stopped (manually or otherwise), it isn't restarted even after Docker daemon restarts. |

```console
$ docker run --restart=always redis
Expand Down

0 comments on commit 011cb19

Please sign in to comment.