From ceabef087f5ade2d107275656691315c776fd43c Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 4 May 2022 00:55:45 +0200 Subject: [PATCH] Bot Updating Templated Files --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 927c036..9b676ad 100755 --- a/README.md +++ b/README.md @@ -46,17 +46,17 @@ SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relatio ## 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: -| Architecture | Tag | -| :----: | --- | -| x86-64 | amd64-latest | -| arm64 | arm64v8-latest | -| armhf | arm32v7-latest | +| Architecture | Available | Tag | +| :----: | :----: | ---- | +| x86-64 | ✅ | amd64-\ | +| arm64 | ✅ | arm64v8-\ | +| armhf| ✅ | arm32v7-\ | ## Application Setup @@ -144,7 +144,7 @@ Here are some example snippets to help you get started creating a container. version: "2.1" services: swag: - image: lscr.io/linuxserver/swag + image: lscr.io/linuxserver/swag:latest container_name: swag cap_add: - NET_ADMIN @@ -195,7 +195,7 @@ docker run -d \ -p 80:80 `#optional` \ -v /path/to/appdata/config:/config \ --restart unless-stopped \ - lscr.io/linuxserver/swag + lscr.io/linuxserver/swag:latest ``` ## Parameters @@ -222,6 +222,10 @@ Container images are configured using parameters passed at runtime (such as thos | `-e STAGING=false` | Set to `true` to retrieve certs in staging mode. Rate limits will be much higher, but the resulting cert will not pass the browser's security test. Only to be used for testing purposes. | | `-v /config` | All the config files including the webroot reside here. | +### Portainer notice + +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. + ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. @@ -265,7 +269,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' swag` * 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` ## Updating Info @@ -283,7 +287,7 @@ Below are the instructions for updating containers: ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/swag` +* Update the image: `docker pull lscr.io/linuxserver/swag:latest` * Stop the running container: `docker stop swag` * Delete the container: `docker rm swag` * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)