Skip to content

Commit ceb00bf

Browse files
docs(docker): document multi-platform and multi-version base image tags
1 parent c3d0b38 commit ceb00bf

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

  • docs/user/nextclade-cli/installation

docs/user/nextclade-cli/installation/docker.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,17 @@ docker run -it --rm nextstrain/nextclade:3.0.0 nextclade --help
1919

2020
> ⚠️ Don't forget to mount necessary [docker volumes](https://docs.docker.com/storage/volumes/) to be able to supply the data into the container and to access the results. You may want to also add [`--user` argument](https://docs.docker.com/engine/reference/commandline/run/) to docker command, to run on behalf of a non-root user and group. This is not specific to Nextclade. Explanation of Docker containers is out of scope of this documentation - please refer to Docker documentation for more details.
2121
22+
All images are multi-platform (amd64 and arm64). Pulling on an ARM64 host (Apple Silicon, AWS Graviton, Raspberry Pi) gets a native image automatically.
23+
2224
Docker images are available based on the following images:
2325

24-
- `debian` (default): Nextclade executable + a set of basic Linux utilities, such as `bash`, `curl` and `wget`, to facilitate usage in workflows
25-
- `alpine`: pure Alpine Linux + Nextclade executable, for small size but and basic Linux distribution
26+
- `debian` (default): Nextclade executable + basic Linux utilities (`bash`, `curl`, `wget`) for use in workflows
27+
- `alpine`: Alpine Linux + Nextclade executable, for small image size
2628
- `scratch`: empty image + Nextclade executable, for minimal size
2729

28-
You can choose to use the latest available version (use tag `:latest` or no tag), or to freeze a specific version (e.g. `:3.0.0`) or only major version (e.g. `:3`), or a base image (e.g. `:debian`) or both version and base image (e.g. `:3.0.0-debian`), or mix and match. Tag `:latest` points to `:debian`. See the full list of tags [here](https://hub.docker.com/r/nextstrain/nextclade/tags).
30+
Each base is published for multiple versions (e.g., `debian13`, `debian12`, `debian11`, `alpine3.23`, `alpine3.18`). Unversioned tags (`:debian`, `:alpine`) point to the latest base version.
31+
32+
You can choose to use the latest available version (use tag `:latest` or no tag), or to freeze a specific version (e.g. `:3.0.0`) or only major version (e.g. `:3`), or a base image (e.g. `:debian`) or both version and base image (e.g. `:3.0.0-debian`), or a specific base version (e.g. `:3.0.0-debian13`), or mix and match. Tag `:latest` points to `:debian`. See the full list of tags [here](https://hub.docker.com/r/nextstrain/nextclade/tags).
2933

3034
### Example
3135

0 commit comments

Comments
 (0)