index : static-web-server.git

eb482a44a573759e55c7944f2ee0a23682c1b01e [patch]

299809fe7ddb8c6917aab0c25701c4e99c917a70

91164ac6869e2037091a887e45e4c3ffde26500a

eb482a44a573759e55c7944f2ee0a23682c1b01e.tar.gz

docs: docker multi-arch images and new targets [skip ci]

Diff

 docs/content/features/docker.md         | 43 ++++++++++++++++++++++++++++------
 docs/content/getting-started.md         |  2 +-
 docs/content/platforms-architectures.md |  7 +++++-
 3 files changed, 43 insertions(+), 9 deletions(-)

diff --git a/docs/content/features/docker.md b/docs/content/features/docker.md
index 1a22b74..5197665 100644
--- a/docs/content/features/docker.md
+++ b/docs/content/features/docker.md
@@ -2,26 +2,55 @@

`SWS` has first-class [Docker](https://docs.docker.com/get-started/overview/) support. It provides a [Scratch](https://hub.docker.com/_/scratch) as well as the latest [Alpine Linux](https://hub.docker.com/_/alpine) Docker images.

🐋 View on [Docker Hub](https://hub.docker.com/r/joseluisq/static-web-server/).
## OS/Arch

Only the following operating systems and architectures are supported.

- `linux/386`
- `linux/amd64`
- `linux/arm/v6`
- `linux/arm/v7`
- `linux/arm64`

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 just run the following commands.

!!! info "Tips"
    - [Server CLI arguments](/configuration/command-line-arguments/) can be provided directly to the container or omitted as shown below.
    - It can specify a Docker volume like `-v $HOME/my-public-dir:/public` in order to overwrite the default root directory. See [Docker examples](features/docker.md) for more details.


Run the scratch Docker image (just the binary)

```sh
# Scratch image (just the binary)
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2 -g info
```

# Or Alpine image
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-alpine
Or run the Alpine Docker image variant

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

## Dockerfile

SWS Docker images can be extended as needed.

Extending the scratch Docker image (just the binary)

```Dockerfile
# Scratch image (just the binary)
FROM joseluisq/static-web-server:2
# do stuff...
```

Or the Alpine Docker image variant

# Or Alpine image
```Dockerfile
FROM joseluisq/static-web-server:2-alpine
# do stuff...
```

## Docker Compose
diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md
index 03ce250..7b7a3c1 100644
--- a/docs/content/getting-started.md
+++ b/docs/content/getting-started.md
@@ -13,7 +13,7 @@ docker run --rm -it -p 8787:80 joseluisq/static-web-server:2
```

!!! info "Docker Tip"
    You can specify the Docker volume like `-v $HOME/my-public-dir:/public` in order to overwrite the default root directory. See [Docker examples](features/docker.md) for more details.
    You can specify a Docker volume like `-v $HOME/my-public-dir:/public` in order to overwrite the default root directory. See [Docker examples](features/docker.md) for more details.

For more details about the available options type `static-web-server -h` or go to the [Command-line arguments](./configuration/command-line-arguments.md) section.

diff --git a/docs/content/platforms-architectures.md b/docs/content/platforms-architectures.md
index b650fbe..a67c0de 100644
--- a/docs/content/platforms-architectures.md
+++ b/docs/content/platforms-architectures.md
@@ -2,6 +2,9 @@

Currently only the following platforms/architectures are supported.

!!! info "Docker"
    For Docker images supported list see [Docker OS/Arch](/features/docker/#osarch).

## Linux

#### x86
@@ -13,7 +16,9 @@ Currently only the following platforms/architectures are supported.
  - `x86_64-unknown-linux-musl`

#### ARM
  - `arm-unknown-linux-gnueabihf`
  - `arm-unknown-linux-gnueabihf` (armv6)
  - `arm-unknown-linux-musleabihf` (armv6)
  - `armv7-unknown-linux-musleabihf` (armv7)

#### ARM64
  - `aarch64-unknown-linux-musl`