config/docker-wireguard
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make minor improvements for ReadMe.md (#1428)

Browse Source 
The following minor improvements were made to `README.md`:

- The notice about stable version was styled as block quote to emphasize
  it more and it was moved right after the title of the section
  "Versions", and a link to the production branch was added;
- versions table was updated to add links to branches for easier
  navigation;
- some typos were fixed;
- wording was changed in couple of places to make it simpler;
- the `docker run` command was updated to:
  - use long options to make it more self-explanatory;
  - wrap password hash value placeholder in single quotes to avoid
    variable expanding as password hashes tend to contain `$`;
  - some other very minor changes to make `docker run` options uniform.

Co-authored-by: Philip H. <47042125+pheiduck@users.noreply.github.com>
This commit is contained in:
Edgars
2024-09-23 13:02:33 +03:00
committed by GitHub
parent 6dc89257ff
commit 99e1e15b03
1 changed files with 28 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -36,15 +36,18 @@ You have found the easiest way to install & manage WireGuard on any Linux host!
## Versions ## Versions
We provide more then 1 docker image to get, this will help you decide which one is best for you. <br> > 💡 For the **stable** version please read instructions on the
For **stable** versions instead of nightly or development please read **README** from the **production** branch! > [**production** branch](/wg-easy/wg-easy/tree/production)!
We provide more than 1 docker image tag, the following will help you decide
which one suites the best for you.
| tag | Branch | Example | Description | | tag | Branch | Example | Description |
| - | - | - | - | | - | - | - | - |
| `latest` | production | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | stable as possbile get bug fixes quickly when needed, deployed against `production`. | | `latest` | [`production`](/wg-easy/wg-easy/tree/production) | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | stable as possbile get bug fixes quickly when needed, deployed against [`production`](/wg-easy/wg-easy/tree/production). |
| `14` | production | `ghcr.io/wg-easy/wg-easy:14` | same as latest, stick to a version tag. | | `14` | [`production`](/wg-easy/wg-easy/tree/production) | `ghcr.io/wg-easy/wg-easy:14` | same as latest, stick to a version tag. |
| `nightly` | master | `ghcr.io/wg-easy/wg-easy:nightly` | mostly unstable gets frequent package and code updates, deployed against `master`. | | `nightly` | [`master`](/wg-easy/wg-easy/tree/master) | `ghcr.io/wg-easy/wg-easy:nightly` | mostly unstable gets frequent package and code updates, deployed against [`master`](/wg-easy/wg-easy/tree/master). |
| `development` | pull requests | `ghcr.io/wg-easy/wg-easy:development` | used for development, testing code from PRs before landing into `master`. | | `development` | pull requests | `ghcr.io/wg-easy/wg-easy:development` | used for development, testing code from PRs before landing into [`master`](/wg-easy/wg-easy/tree/master). |
## Installation ## Installation
@@ -52,7 +55,7 @@ For **stable** versions instead of nightly or development please read **README**
If you haven't installed Docker yet, install it by running: If you haven't installed Docker yet, install it by running:
```bash ```shell
curl -sSL https://get.docker.com | sh curl -sSL https://get.docker.com | sh
sudo usermod -aG docker $(whoami) sudo usermod -aG docker $(whoami)
exit exit
@@ -64,28 +67,28 @@ And log in again.
To automatically install & run wg-easy, simply run: To automatically install & run wg-easy, simply run:
``` ```shell
docker run -d \ docker run --detach \
--name=wg-easy \ --name wg-easy \
-e LANG=de \ --env LANG=de \
-e WG_HOST=<🚨YOUR_SERVER_IP> \ --env WG_HOST=<🚨YOUR_SERVER_IP> \
-e PASSWORD_HASH=<🚨YOUR_ADMIN_PASSWORD_HASH> \ --env PASSWORD_HASH='<🚨YOUR_ADMIN_PASSWORD_HASH>' \
-e PORT=51821 \ --env PORT=51821 \
-e WG_PORT=51820 \ --env WG_PORT=51820 \
-v ~/.wg-easy:/etc/wireguard \ --volume ~/.wg-easy:/etc/wireguard \
-p 51820:51820/udp \ --publish 51820:51820/udp \
-p 51821:51821/tcp \ --publish 51821:51821/tcp \
--cap-add=NET_ADMIN \ --cap-add NET_ADMIN \
--cap-add=SYS_MODULE \ --cap-add SYS_MODULE \
--sysctl="net.ipv4.conf.all.src_valid_mark=1" \ --sysctl 'net.ipv4.conf.all.src_valid_mark=1' \
--sysctl="net.ipv4.ip_forward=1" \ --sysctl 'net.ipv4.ip_forward=1' \
--restart unless-stopped \ --restart unless-stopped \
ghcr.io/wg-easy/wg-easy ghcr.io/wg-easy/wg-easy
``` ```
> 💡 Replace `YOUR_SERVER_IP` with your WAN IP, or a Dynamic DNS hostname. > 💡 Replace `<🚨YOUR_SERVER_IP>` with your WAN IP, or a Dynamic DNS hostname.
> >
> 💡 Replace `YOUR_ADMIN_PASSWORD_HASH` with a bcrypt password hash to log in on the Web UI. See [How_to_generate_an_bcrypt_hash.md](./How_to_generate_an_bcrypt_hash.md) for know how generate the hash. > 💡 Replace `<🚨YOUR_ADMIN_PASSWORD_HASH>` with a bcrypt password hash to log in on the Web UI. See [How_to_generate_an_bcrypt_hash.md](./How_to_generate_an_bcrypt_hash.md) for instructions on how to generate a hashed password.
The Web UI will now be available on `http://0.0.0.0:51821`. The Web UI will now be available on `http://0.0.0.0:51821`.
@@ -139,7 +142,7 @@ These options can be configured by setting environment variables using `-e KEY="
To update to the latest version, simply run: To update to the latest version, simply run:
```bash ```shell
docker stop wg-easy docker stop wg-easy
docker rm wg-easy docker rm wg-easy
docker pull ghcr.io/wg-easy/wg-easy docker pull ghcr.io/wg-easy/wg-easy