mirror of
https://github.com/wg-easy/wg-easy.git
synced 2026-04-13 08:19:23 +00:00
68fde7d165
Some checks failed
Mark stale issues and pull requests / stale (push) Has been cancelled
CodeQL / Analyze (javascript-typescript) (push) Has been cancelled
Edge / Build Docker (map[os:ubuntu-24.04-arm platform:linux/arm/v7]) (push) Has been cancelled
Edge / Build Docker (map[os:ubuntu-24.04-arm platform:linux/arm64]) (push) Has been cancelled
Edge / Build Docker (map[os:ubuntu-latest platform:linux/amd64]) (push) Has been cancelled
Edge / Build & Deploy Docs (push) Has been cancelled
Lint / Check Docs (push) Has been cancelled
Lint / Lint (format:check) (push) Has been cancelled
Lint / Lint (lint) (push) Has been cancelled
Lint / Lint (typecheck) (push) Has been cancelled
Edge / Merge & Deploy Docker (push) Has been cancelled
* Updated container launch commands * one more occurrence --------- Co-authored-by: Bernd Storath <999999bst@gmail.com>
1.7 KiB
1.7 KiB
title
| title |
|---|
| Basic Installation |
Requirements
- You need to have a host that you can manage
- You need to have a domain name or a public IP address
- You need a supported architecture (x86_64, arm64, armv7)
- You need curl installed on your host
Install Docker
Follow the Docs here: https://docs.docker.com/engine/install/ and install Docker on your host.
Install wg-easy
-
Create a directory for the configuration files (you can choose any directory you like):
sudo mkdir -p /etc/docker/containers/wg-easy -
Download docker compose file
sudo curl -o /etc/docker/containers/wg-easy/docker-compose.yml https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml -
Start
wg-easycd /etc/docker/containers/wg-easy sudo docker compose up -d
Setup Firewall
If you are using a firewall, you need to open the following ports:
- UDP 51820 (WireGuard)
These ports can be changed, so if you change them you have to update your firewall rules accordingly.
Setup Reverse Proxy
- To setup traefik follow the instructions here: Traefik
- To setup caddy follow the instructions here: Caddy
- If you do not want to use a reverse proxy follow the instructions here: No Reverse Proxy
Update wg-easy
To update wg-easy to the latest version, run:
cd /etc/docker/containers/wg-easy
sudo docker compose pull
sudo docker compose up -d
Auto Update
If you want to enable auto-updates, follow the instructions here: Auto Updates