mirrors/amnezia-wg-easy
1
0
Fork 1
mirror of https://github.com/w0rng/amnezia-wg-easy.git synced 2025-04-25 21:00:21 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' into feat-cidr-notation

Browse source
This commit is contained in:
Philip H 2024-03-14 13:49:26 +01:00 • committed by GitHub
commit 68187e07a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 161 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -23,6 +23,8 @@ You have found the easiest way to install & manage WireGuard on any Linux host!
* Tx/Rx charts for each connected client.
* Gravatar support.
* Automatic Light / Dark Mode
* Multilanguage Support
* UI_TRAFFIC_STATS (default off)
## Requirements
@ -36,9 +38,9 @@ You have found the easiest way to install & manage WireGuard on any Linux host!
If you haven't installed Docker yet, install it by running:
```bash
$ curl -sSL https://get.docker.com | sh
$ sudo usermod -aG docker $(whoami)
$ exit
curl -sSL https://get.docker.com | sh
sudo usermod -aG docker $(whoami)
exit
```
And log in again.
@ -72,6 +74,10 @@ The Web UI will now be available on `http://0.0.0.0:51821`.
> 💡 Your configuration files will be saved in `~/.wg-easy`
WireGuard Easy can be launched with Docker Compose as well - just download
[`docker-compose.yml`](docker-compose.yml), make necessary adjustments and
execute `docker compose up --detach`.
### 3. Sponsor
Are you enjoying this project? [Buy Emile a beer!](https://github.com/sponsors/WeeJeWel) 🍻
@ -97,7 +103,7 @@ These options can be configured by setting environment variables using `-e KEY="
| `WG_POST_UP` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L20) for the default value. |
| `WG_PRE_DOWN` | `...` | - | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L27) for the default value. |
| `WG_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L28) for the default value. |
| `LANG` | `en` | `de` | Web UI language (Supports: en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th). |
| `LANG` | `en` | `de` | Web UI language (Supports: en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th, hi). |
| `UI_TRAFFIC_STATS` | `false` | `true` | Enable detailed RX / TX client stats in Web UI |
> If you change `WG_PORT`, make sure to also change the exposed port.
@ -114,6 +120,16 @@ docker pull ghcr.io/wg-easy/wg-easy
And then run the `docker run -d \ ...` command above again.
To update using Docker Compose:
```shell
docker compose pull
docker compose up --detach
```
The WireGuared Easy container will be automatically recreated if a newer image
was pulled.
## Common Use Cases
* [Using WireGuard-Easy with Pi-Hole](https://github.com/wg-easy/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole)