wg-easy/docs/content/examples/tutorials/basic-installation.md at ac547bbf7c70394e1afee13b36c4b90957efeae8

mirror of https://github.com/wg-easy/wg-easy.git synced 2026-07-06 07:42:25 +00:00

* feat: add Google OAuth login support (#2625)

* 🔧 Add login via google

* 🔧 Update code style and docs

* Add fix for db migrate

* 🔧 Update docker-compose

* 🔧 Fix sqlite"

* 🔧 Update docker-compose

* ⚰️ Remove environments

* 🔧 Fix: remove ensureGoogleIdColumn workaround from sqlite.ts

* 🔧 Remove space

* move oauth section

* add openid client

* wip make oauth more generic

* properly allow multiple providers

* fix type import

* github login flow

* adjust github logo with theme

* move docs to own page

* nullable password, prevent timing attack

this prevents timing attacks by always checking hash even if there is none
prevents using basic auth if 2fa is enabled

* support generic oidc

* add ability to set password for oidc users

this allows oidc users to add password login
cant be removed after

* move password login route

move password login route from /api/session to /api/auth/password
align with oauth

* unique index on oauth

* link/unlink logic

* improve docs

* support allowed domains

* support auto register

* refactoring

* disable pw auth

* move 2fa to its own page

* 2fa for oauth, rework 2fa system

* fix design, fix link

Closes #2650

* add auto launch

* improve docs

* improvements

---------

Co-authored-by: Daniel Molenda <dm@fotc.com>

2026-06-12 13:38:32 +02:00

1.7 KiB

Raw Blame History

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)
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-easy

 cd /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

1.7 KiB Raw Blame History