From 5222bd1f2cd0cba627a390edb6d29bd16b3a7e98 Mon Sep 17 00:00:00 2001 From: Emile Nijssen Date: Sun, 23 May 2021 16:24:25 +0200 Subject: [PATCH] update readme --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6dd93ed..06cc9bb 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,21 @@ ## Installation ### 1. Install Docker -Make sure you have [Docker](https://docs.docker.com/get-docker/) installed. -### 2. Configure +If you haven't installed Docker yet, install it by running: + +```bash +$ curl -sSL https://get.docker.com | sh +$ sudo sh get-docker.sh +$ sudo usermod -aG docker $(whoami) +$ bash +``` + +### 2. Configure WireGuard + +Run these commands to prepare and configure WireGuard. ```bash -# Create a directory for the configuration files $ mkdir ~/.wg-easy $ cd ~/.wg-easy $ wget https://raw.githubusercontent.com/WeeJeWel/wg-easy/master/docker-compose.yml @@ -19,10 +28,12 @@ Change `WG_HOST=raspberrypi.local` to your server's public address, e.g. `WG_HOS Optionally, set a Web UI password by uncommenting `PASSWORD=foobar123` and change the password. -### 3. Run +### 3. Run WireGuard + +Finally, run WireGuard. It will automatically start after a reboot. ```bash -$ docker compose up +$ docker-compose up ``` The Web UI will be available on `http://0.0.0.0:51821`. You can create new clients there.