Bot Updating Documentation

pull/56/head
LinuxServer-CI 2022-05-01 05:30:38 +02:00
rodzic eb1bd727fc
commit ca0a6ce921
1 zmienionych plików z 16 dodań i 10 usunięć

Wyświetl plik

@ -20,17 +20,17 @@ title: wireguard
## 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/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: 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
@ -107,7 +107,7 @@ To help you get started creating a container from this image you can either use
version: "2.1" version: "2.1"
services: services:
wireguard: wireguard:
image: lscr.io/linuxserver/wireguard image: lscr.io/linuxserver/wireguard:latest
container_name: wireguard container_name: wireguard
cap_add: cap_add:
- NET_ADMIN - NET_ADMIN
@ -155,7 +155,7 @@ docker run -d \
-v /lib/modules:/lib/modules \ -v /lib/modules:/lib/modules \
--sysctl="net.ipv4.conf.all.src_valid_mark=1" \ --sysctl="net.ipv4.conf.all.src_valid_mark=1" \
--restart unless-stopped \ --restart unless-stopped \
lscr.io/linuxserver/wireguard lscr.io/linuxserver/wireguard:latest
``` ```
## Parameters ## Parameters
@ -196,6 +196,12 @@ Docker images are configured using parameters passed at runtime (such as those a
| :-----: | --- | | :-----: | --- |
| `--sysctl=` | Required for client mode. | | `--sysctl=` | Required for client mode. |
### 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__`.
@ -241,7 +247,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" }}' wireguard` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' wireguard`
* Image version number * 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`
## Versions ## Versions