diff --git a/docker/README.md b/docker/README.md index f5a4c2b..6fb5135 100644 --- a/docker/README.md +++ b/docker/README.md @@ -27,19 +27,25 @@ e.g. `-v rpxy/ca-certificates:/usr/local/share/ca-certificates` Differences among tags are summarized as follows. -### Latest Builds +### Latest and versioned builds -- `latest`: Built from the `main` branch with default features, running on Ubuntu. -- `latest-slim`, `slim`: Built by `musl` from the `main` branch with default features, running on Alpine. -- `latest-s2n`, `s2n`: Built from the `main` branch with the `http3-s2n` feature, running on Ubuntu. -- `*-pq`: Built with the `post-quantum` feature. This feature supports the post-quantum key exchange using `rustls-post-quantum` crate. +Latest builds are shipped from the `main` branch when the new version is released. For example, when the version `x.y.z` is released, the following images are provided. -### Nightly Builds +- `latest`, `x.y.z`: Built with default features, running on Ubuntu. +- `latest-slim`, `slim`, `x.y.z-slim` : Built by `musl` with default features, running on Alpine. +- `latest-s2n`, `s2n`, `x.y.z-s2n`: Built with the `http3-s2n` feature, running on Ubuntu. -- `nightly`: Built from the `develop` branch with default features, running on Ubuntu. -- `nightly-slim`: Built by `musl` from the `develop` branch with default features, running on Alpine. -- `nightly-s2n`: Built from the `develop` branch with the `http3-s2n` feature, running on Ubuntu. -- `*-pq`: Built with the `post-quantum` feature. This feature supports the hybridized post-quantum key exchange using `rustls-post-quantum` crate. +Additionally, images built with `webpki-roots` are provided in a similar manner to the above (e.g., `latest-s2n-webpki-roots` and `s2n-webpki-roots` tagged for the same image). + +### Nightly builds + +Nightly builds are shipped from the `develop` branch for every push. + +- `nightly`: Built with default features, running on Ubuntu. +- `nightly-slim`: Built by `musl` with default features, running on Alpine. +- `nightly-s2n`: Built with the `http3-s2n` feature, running on Ubuntu. + +Additionally, images built with `webpki-roots` are provided in a similar manner to the above (e.g., `nightly-s2n-webpki-roots`). ## Caveats