diff --git a/nats/variant-alpine.md b/nats/variant-alpine.md new file mode 100644 index 000000000000..8d25595c5d13 --- /dev/null +++ b/nats/variant-alpine.md @@ -0,0 +1,5 @@ +## `%%IMAGE%%:-alpine` + +This image is based on the popular [Alpine Linux project](https://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Unlike the default image, it includes a shell and the `apk` package manager, at the cost of a larger image. The default configuration is at `/etc/nats/nats-server.conf`. + +This variant uses [musl libc](https://musl.libc.org), but `nats-server` itself is statically linked, so this rarely matters unless you add other software on top. To keep the image small, it is uncommon for additional related tools (such as `git` or `bash`) to be included; add what you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar). diff --git a/nats/variant.md b/nats/variant.md new file mode 100644 index 000000000000..c9300c30d784 --- /dev/null +++ b/nats/variant.md @@ -0,0 +1,7 @@ +# Image Variants + +The `%%IMAGE%%` images come in many flavors, each designed for a specific use case. + +## `%%IMAGE%%:` + +This is the default image. If you are unsure about what your needs are, you probably want to use this one. It is built `FROM scratch` and contains only the statically linked `nats-server` binary and a default configuration at `/nats-server.conf`, which makes it the smallest variant. It has no shell or other tools, so use one of the other variants if you need to `exec` into the container or install additional software.