From cf75e964010d14dc7c8af12ce2dd4658c1fc2154 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 1 May 2022 05:30:35 +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 c73df20..02d1089 100644 --- a/README.md +++ b/README.md @@ -45,17 +45,17 @@ Find us at: ## 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/wireguard` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `lscr.io/linuxserver/wireguard: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 @@ -132,7 +132,7 @@ Here are some example snippets to help you get started creating a container. version: "2.1" services: wireguard: - image: lscr.io/linuxserver/wireguard + image: lscr.io/linuxserver/wireguard:latest container_name: wireguard cap_add: - NET_ADMIN @@ -180,7 +180,7 @@ docker run -d \ -v /lib/modules:/lib/modules \ --sysctl="net.ipv4.conf.all.src_valid_mark=1" \ --restart unless-stopped \ - lscr.io/linuxserver/wireguard + lscr.io/linuxserver/wireguard:latest ``` ## Parameters @@ -204,6 +204,10 @@ Container images are configured using parameters passed at runtime (such as thos | `-v /lib/modules` | Maps host's modules folder. | | `--sysctl=` | Required for client mode. | +### 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__`. @@ -247,7 +251,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' wireguard` * image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireguard` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireguard:latest` ## Updating Info @@ -265,7 +269,7 @@ Below are the instructions for updating containers: ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/wireguard` +* Update the image: `docker pull lscr.io/linuxserver/wireguard:latest` * Stop the running container: `docker stop wireguard` * Delete the container: `docker rm wireguard` * 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)