272 lines
7.5 KiB
Markdown
272 lines
7.5 KiB
Markdown
---
|
||
title: Wireguard 14
|
||
description: Archived guide to installing WireGuard VPN using linuxserver.io's older wireguard image, kept for reference only.
|
||
---
|
||
|
||
|
||
:ellipsis{left=0px width=40rem top=10rem blur=140px zIndex=60}
|
||
|
||
::note{to="/serveex/core/wireguard"}
|
||
|
||
wg-easy 15 got a lot more complicated, "not so easy" anymore, arguably. That's exactly why this old v14 tutorial is worth keeping around: it's still the simplest way to get a WireGuard server running if you don't need what the new version adds.
|
||
::
|
||
|
||
## Introduction
|
||
Using a VPN allows remote access to a server’s local resources without exposing them to the internet. It’s a clean and secure way to access services like SSH without exposing the port publicly. With a VPN, you can securely connect to your network from anywhere and make devices on different networks communicate.
|
||
|
||
Here we will use [Wireguard](https://www.wireguard.com/), a secure and high-performance VPN server, using containers:
|
||
|
||
- [wg-easy](https://github.com/wg-easy/wg-easy) as the server, providing a very simple web UI to manage connections and download config files (including QR codes for phones)
|
||
- [Wireguard](https://docs.linuxserver.io/images/docker-wireguard/?h=wireguard) as the client for Linux systems
|
||
|
||
Clients are also available for Windows, macOS, iOS, and Android.
|
||
|
||
The concept:
|
||
|
||
- On the internet, anyone can reach any internet box and thus any exposed server.
|
||
- Your server is on your local network. It is accessible only locally unless services are explicitly exposed (as we did with Dockge). To access non-exposed resources, you must be on the same local network.
|
||
- We want to securely access these unexposed services (like SSH) from anywhere.
|
||
- We also want to connect services between servers, like linking two Dockge instances securely.
|
||
|
||
To achieve this, we’ll create a **Virtual Private Network** (VPN), i.e., a secure tunnel that only connected machines can use. They’ll appear to be on the same private network.
|
||
|
||
Additionally, you can add your phone, laptop, or other devices to the VPN and securely access your server resources wherever you are.
|
||
|
||
|
||
|
||
In this diagram, machine 1 is part of two networks:
|
||
|
||
- Its local network (devices behind the same router, e.g. `192.168.x.x` – machines 1 and 2)
|
||
- The VPN network (VPN devices with a second IP, e.g. `10.8.x.x` – machines 1 and 4)
|
||
|
||
You *can* allow VPN clients to share access to their local networks, but we won’t do that here for security and subnet conflict reasons (e.g., if two remote machines use the same local IP like `192.168.1.1`).
|
||
|
||
So only VPN-connected devices can communicate with each other on the VPN, not with other local devices outside the VPN.
|
||
|
||
## Server Side
|
||
::note
|
||
📋 __Checklist:__
|
||
|
||
- Ensure port `51820 UDP` is available and properly forwarded through your router to the server (`Source 51820 UDP -> Destination 51820 UDP -> Server`).
|
||
- Ensure port `51821 TCP` is available for the web UI.
|
||
::
|
||
|
||
::warning{to="https://wg-easy.github.io/wg-easy/latest/"}
|
||
|
||
__Warning:__ This guide uses version `14` of **wg-easy**. Version `15` introduces breaking changes incompatible with this configuration.
|
||
::
|
||
|
||
::file-tree
|
||
---
|
||
tree:
|
||
/:
|
||
- srv:
|
||
- docker:
|
||
- wg-easy:
|
||
- config:
|
||
- etc_wireguard/
|
||
- compose.yaml
|
||
- .env
|
||
---
|
||
::
|
||
|
||
The container runs in `HOST` mode, meaning it uses the host’s network stack directly.
|
||
|
||
::steps{level="3"}
|
||
### Deploy the stack
|
||
|
||
Open Dockge, click `compose`, and name the stack `wg_easy`.
|
||
|
||
Paste the following configuration:
|
||
|
||
```yaml [compose.yaml]
|
||
---
|
||
services:
|
||
wg-easy:
|
||
network_mode: host
|
||
env_file:
|
||
- .env
|
||
environment:
|
||
- LANG=en
|
||
- WG_HOST=${HOST}
|
||
- PASSWORD_HASH=${PW}
|
||
- WG_DEFAULT_ADDRESS=${ADDRESS}
|
||
- WG_HIDE_KEYS=never
|
||
- WG_ALLOWED_IPS=${IPS}
|
||
- WG_DEFAULT_DNS=
|
||
- UI_TRAFFIC_STATS=true
|
||
- UI_CHART_TYPE=1
|
||
image: ghcr.io/wg-easy/wg-easy:14
|
||
container_name: wg-easy
|
||
volumes:
|
||
- /srv/docker/wg_easy/config/etc_wireguard:/etc/wireguard
|
||
restart: unless-stopped
|
||
cap_add:
|
||
- NET_ADMIN
|
||
- SYS_MODULE
|
||
```
|
||
|
||
::tip{icon=""}
|
||
✨ __Tip:__
|
||
|
||
- You can also specify your own wireguard port with `WG_PORT`
|
||
- Add the Watchtower label to enable automatic updates
|
||
|
||
```yaml [compose.yaml]
|
||
---
|
||
services:
|
||
wg-easy:
|
||
#...
|
||
labels:
|
||
- com.centurylinklabs.watchtower.enable=true
|
||
```
|
||
::
|
||
|
||
In `.env`:
|
||
|
||
```properties [.env]
|
||
HOST=
|
||
PW=
|
||
ADDRESS=
|
||
IPS=
|
||
```
|
||
|
||
| Variable | Description | Example |
|
||
|--------------|-------------|---------|
|
||
| `HOST` | IP of public access of your host (router ISP's IP if it's at home) | `80.75.137.27` |
|
||
| `PW` | Bcrypt password hash, [generate here](https://bcrypt-generator.com/). **NOTE:** Double the `$` characters | `$$2a$$12$$FF6T4QqSP9Ho` |
|
||
| `ADDRESS` | VPN DHCP address range, the `x` must remain, others can vary | `10.8.0.x` |
|
||
| `IPS` | IPs routed by clients through the VPN. Use `10.8.0.0/24` to only route VPN traffic. To include local LAN, add `192.168.0.0/16` separated by commas. | `10.8.0.0/24` |
|
||
|
||
Deploy the stack.
|
||
|
||
### Done !
|
||
::
|
||
|
||
### Enable Forwarding on Host
|
||
|
||
To allow communication between VPN clients, enable:
|
||
|
||
```bash [Terminal]
|
||
sudo sysctl net.ipv4.ip_forward=1
|
||
sudo sysctl net.ipv4.conf.all.src_valid_mark=1
|
||
```
|
||
|
||
### Retrieve Configuration Files
|
||
|
||
To configure clients, download the config files from the server:
|
||
|
||
- Visit `http://your-server-ip:51821`
|
||
- Create a client
|
||
- Download the config file
|
||
- Rename it to `wg0.conf`
|
||
|
||
::caution
|
||
|
||
If it fails, check firewall rules.
|
||
::
|
||
|
||
## On the Client Server
|
||
::note
|
||
|
||
Assumes the client is a Linux server with Docker installed
|
||
::
|
||
|
||
::file-tree
|
||
---
|
||
tree:
|
||
/:
|
||
- srv:
|
||
- docker:
|
||
- wireguard:
|
||
- config:
|
||
- wg_confs/
|
||
- compose.yaml
|
||
---
|
||
::
|
||
|
||
::steps{level="3"}
|
||
### Create the config folder
|
||
|
||
Create the folder `/srv/docker/wireguard/config/wg_confs`:
|
||
|
||
::tip{icon="" to="/serveex/files/file-browser-quantum"}
|
||
✨ __Tip:__ Use **File Browser** to browse and edit files without terminal
|
||
::
|
||
|
||
```bash [Terminal]
|
||
sudo mkdir -p /srv/docker/wireguard/config/wg_confs
|
||
```
|
||
|
||
### Copy the configuration file
|
||
|
||
Copy the `wg0.conf` file downloaded earlier:
|
||
|
||
::tip{icon=""}
|
||
✨ __Tip:__ Easiest way is to transfer the file via SFTP to `/home/youruser`, then move it:
|
||
|
||
```bash [Terminal]
|
||
sudo cp ~/wg0.conf /srv/docker/wireguard/config/wg_confs
|
||
```
|
||
::
|
||
|
||
### Deploy the container
|
||
|
||
Create `compose.yaml` in `/srv/docker/wireguard`:
|
||
|
||
```bash [Terminal]
|
||
sudo nano /srv/docker/wireguard/compose.yaml
|
||
```
|
||
|
||
Paste:
|
||
|
||
```yaml [compose.yaml]
|
||
---
|
||
services:
|
||
wireguard:
|
||
image: lscr.io/linuxserver/wireguard:latest
|
||
container_name: wireguard
|
||
network_mode: host
|
||
cap_add:
|
||
- NET_ADMIN
|
||
- SYS_MODULE #optional
|
||
environment:
|
||
- TZ=Europe/Paris
|
||
volumes:
|
||
- /srv/docker/wireguard/config:/config
|
||
- /lib/modules:/lib/modules #optional
|
||
restart: unless-stopped
|
||
```
|
||
|
||
Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit.
|
||
|
||
Start the container:
|
||
|
||
```bash [Terminal]
|
||
cd /srv/docker/wireguard
|
||
sudo docker compose up -d
|
||
```
|
||
|
||
::note
|
||
|
||
Repeat for each client
|
||
::
|
||
|
||
### Done !
|
||
::
|
||
|
||
## Other Devices
|
||
|
||
- **Phone:** Install Wireguard and scan the QR code from the web UI (`http://your-server-ip:51821`)
|
||
- **PC:** Install the Wireguard client and import the config file
|
||
|
||
::warning
|
||
|
||
__Warning:__ If a client device is on the same LAN as the server, edit `wg0.conf` and change the endpoint to the local server IP:
|
||
`Endpoint = your-server-ip:51820`
|
||
::
|
||
|
||
And this is the result:
|
||
|
||
|