Bot Updating Documentation

pull/56/head
LinuxServer-CI 2022-05-04 00:55:47 +02:00
rodzic 43897ff278
commit b0dc4628e4
1 zmienionych plików z 16 dodań i 10 usunięć

Wyświetl plik

@ -21,17 +21,17 @@ SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relatio
## Supported Architectures ## Supported Architectures
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `lscr.io/linuxserver/swag` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. Simply pulling `lscr.io/linuxserver/swag:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Available | Tag |
| :----: | --- | | :----: | :----: | ---- |
| x86-64 | amd64-latest | | x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | arm64v8-latest | | arm64 | ✅ | arm64v8-\<version tag\> |
| armhf | arm32v7-latest | | armhf| ✅ | arm32v7-\<version tag\> |
## Application Setup ## Application Setup
@ -119,7 +119,7 @@ To help you get started creating a container from this image you can either use
version: "2.1" version: "2.1"
services: services:
swag: swag:
image: lscr.io/linuxserver/swag image: lscr.io/linuxserver/swag:latest
container_name: swag container_name: swag
cap_add: cap_add:
- NET_ADMIN - NET_ADMIN
@ -170,7 +170,7 @@ docker run -d \
-p 80:80 `#optional` \ -p 80:80 `#optional` \
-v /path/to/appdata/config:/config \ -v /path/to/appdata/config:/config \
--restart unless-stopped \ --restart unless-stopped \
lscr.io/linuxserver/swag lscr.io/linuxserver/swag:latest
``` ```
## Parameters ## Parameters
@ -214,6 +214,12 @@ Docker images are configured using parameters passed at runtime (such as those a
| Parameter | Function | | Parameter | Function |
| :-----: | --- | | :-----: | --- |
### Portainer notice
{% hint style="warning" %}
This image utilises `cap_add` or `sysctl` to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
{% endhint %}
## Environment variables from files (Docker secrets) ## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`. You can set any environment variable from a file by using a special prepend `FILE__`.
@ -259,7 +265,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
* Container version number * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' swag` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' swag`
* Image version number * Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/swag` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/swag:latest`
## Versions ## Versions