index : static-web-server.git

031931f2f4040dc335a5bf98ba119b020987176f [patch]

98f1747933d0e3182a61be6112a15c99cf14f4bb

eb2887f8dfa0d850d274eed8087eaa07722acebb

031931f2f4040dc335a5bf98ba119b020987176f.tar.gz

docs: ghcr docker images description [skip ci]

it complements 4a10635

Diff

 docs/content/features/docker.md | 28 ++++++++++++++++++++--------
 docs/mkdocs.yml                 |  2 +-
 2 files changed, 21 insertions(+), 9 deletions(-)

diff --git a/docs/content/features/docker.md b/docs/content/features/docker.md
index 96ba3ac..32fd2a7 100644
--- a/docs/content/features/docker.md
+++ b/docs/content/features/docker.md
@@ -4,6 +4,8 @@

It is provided in three Docker image variants such as [Scratch](https://hub.docker.com/_/scratch), [Alpine](https://hub.docker.com/_/alpine) and [Debian](https://hub.docker.com/_/debian) images.

All images are available on [Docker Hub](https://hub.docker.com/r/joseluisq/static-web-server/) and [GitHub Container Registry](https://github.com/orgs/static-web-server/packages?repo_name=static-web-server)

## OS/Arch

All Docker images are [Multi-Arch](https://www.docker.com/blog/how-to-rapidly-build-multi-architecture-images-with-buildx/) and the following operating systems and architectures are supported.
@@ -17,8 +19,6 @@ All Docker images are [Multi-Arch](https://www.docker.com/blog/how-to-rapidly-bu
!!! tip "SWS statically-linked binary"
    All the Docker images use the SWS statically-linked binary, meaning that the binary is highly-optimized, performant, and dependency-free thanks to [musl libc](https://www.musl-libc.org/).

View all images on [Docker Hub](https://hub.docker.com/r/joseluisq/static-web-server/).

## Run a container

To give the server a quick try then just run the following commands.
@@ -29,22 +29,28 @@ To give the server a quick try then just run the following commands.

To run SWS, there are several Docker image variants that you can use.

**Scratch** image variant (just the binary)
**Scratch** (just the binary)

```sh
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2 -g info
# or
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2 -g info
```

**Alpine** Docker image variant
**Alpine**

```sh
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-alpine -g info
# or
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-alpine -g info
```

**Debian** Docker image variant
**Debian**

```sh
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-debian -g info
# or
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-debian -g info
```

## Dockerfile
@@ -55,26 +61,32 @@ Extending the **Scratch** Docker image (just the binary)

```Dockerfile
FROM joseluisq/static-web-server:2
# or
FROM ghcr.io/static-web-server/static-web-server:2
# do stuff...
```

Or the **Alpine** Docker image variant
Or the **Alpine**

```Dockerfile
FROM joseluisq/static-web-server:2-alpine
# or
FROM ghcr.io/static-web-server/static-web-server:2-alpine
# do stuff...
```

Or the **Debian** Docker image variant
Or the **Debian**

```Dockerfile
FROM joseluisq/static-web-server:2-debian
# or
FROM ghcr.io/static-web-server/static-web-server:2-debian
# do stuff...
```

## Docker Compose

Below a [Docker Compose](https://docs.docker.com/compose/) example using the [Traefik Proxy](https://traefik.io/traefik/).
Below is a [Docker Compose](https://docs.docker.com/compose/) example using the [Traefik Proxy](https://traefik.io/traefik/).

```yaml
version: "3.3"
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 4d24609..c60149e 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -129,8 +129,8 @@ plugins:
# Content Navigation
nav:
  - 'Overview': 'index.md'
  - 'Download and Install': 'download-and-install.md'
  - 'Getting Started': 'getting-started.md'
  - 'Download and Install': 'download-and-install.md'
  - 'Configuration':
    - 'Command Line Arguments': 'configuration/command-line-arguments.md'
    - 'Environment Variables': 'configuration/environment-variables.md'