Browse Source

Add setup and update instructions for Compose (#901)

pull/902/head
Philip H 1 year ago
committed by GitHub
parent
commit
17fdb3396f
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 20
      README.md

20
README.md

@ -36,9 +36,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: If you haven't installed Docker yet, install it by running:
```bash ```bash
$ 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
``` ```
And log in again. And log in again.
@ -72,6 +72,10 @@ The Web UI will now be available on `http://0.0.0.0:51821`.
> 💡 Your configuration files will be saved in `~/.wg-easy` > 💡 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 ### 3. Sponsor
Are you enjoying this project? [Buy Emile a beer!](https://github.com/sponsors/WeeJeWel) 🍻 Are you enjoying this project? [Buy Emile a beer!](https://github.com/sponsors/WeeJeWel) 🍻
@ -114,6 +118,16 @@ docker pull ghcr.io/wg-easy/wg-easy
And then run the `docker run -d \ ...` command above again. 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 ## Common Use Cases
* [Using WireGuard-Easy with Pi-Hole](https://github.com/wg-easy/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole) * [Using WireGuard-Easy with Pi-Hole](https://github.com/wg-easy/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole)

Loading…
Cancel
Save