From 2347c76812df3d2b78bfbcc1787bff18aa6f694d Mon Sep 17 00:00:00 2001 From: DaanSelen Date: Fri, 9 Jan 2026 15:48:52 +0100 Subject: [PATCH] chore: change docs --- docker/README.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/docker/README.md b/docker/README.md index 638fbce3..7ea15e3c 100644 --- a/docker/README.md +++ b/docker/README.md @@ -55,7 +55,7 @@ docker run -d \ --- -### 📦 Docker Compose Alternative +### 📦 Docker Compose Alternative (see the [compose file](./compose.yaml)) You can also use Docker Compose for easier configuration: @@ -65,7 +65,6 @@ services: image: ghcr.io/wgdashboard/wgdashboard:latest restart: unless-stopped container_name: wgdashboard - ports: - 10086:10086/tcp - 51820:51820/udp @@ -96,23 +95,23 @@ Updating the WGDashboard container should be through 'The Docker Way' - by pulli ## ⚙️ Environment Variables -| Variable | Accepted Values | Default | Example | Description | -| ------------------ | ---------------------------------------- | ----------------------- | --------------------- | ----------------------------------------------------------------------- | -| `tz` | Timezone | `Europe/Amsterdam` | `America/New_York` | Sets the container's timezone. Useful for accurate logs and scheduling. | -| `global_dns` | IPv4 and IPv6 addresses | `9.9.9.9` | `8.8.8.8`, `1.1.1.1` | Default DNS for WireGuard clients. | -| `public_ip` | Public IP address | Retrieved automatically | `253.162.134.73` | Used to generate accurate client configs. Needed if container is NAT’d. | -| `wgd_port` | Any port that is allowed for the process | `10086` | `443` | This port is used to set the WGDashboard web port. | -| `username` | Any non‐empty string | `-` | `admin` | Username for the WGDashboard web interface account. | -| `password` | Any non‐empty string | `-` | `s3cr3tP@ss` | Password for the WGDashboard web interface account (stored hashed). | -| `enable_totp` | `true`, `false` | `true` | `false` | Enable TOTP‐based two‐factor authentication for the account. | -| `wg_autostart` | Wireguard interface name | `false` | `true` | Auto‐start the WireGuard client when the container launches. | -| `email_server` | SMTP server address | `-` | `smtp.gmail.com` | SMTP server for sending email notifications. | -| `email_port` | SMTP port number | `-` | `587` | Port for connecting to the SMTP server. | -| `email_encryption` | `TLS`, `SSL`, etc. | `-` | `TLS` | Encryption method for email communication. | -| `email_username` | Any non-empty string | `-` | `user@example.com` | Username for SMTP authentication. | -| `email_password` | Any non-empty string | `-` | `app_password` | Password for SMTP authentication. | -| `email_from` | Valid email address | `-` | `noreply@example.com` | Email address used as the sender for notifications. | -| `email_template` | Path to template file | `-` | `your-template` | Custom template for email notifications. | +| Variable | Accepted Values | Default | Example | Description | +| ------------------ | ---------------------------------------- | ----------------------- | ------------------------ | ----------------------------------------------------------------------- | +| `tz` | Timezone | `Europe/Amsterdam` | `America/New_York` | Sets the container's timezone. Useful for accurate logs and scheduling. | +| `global_dns` | IPv4 and IPv6 addresses | `9.9.9.9` | `8.8.8.8`, `1.1.1.1` | Default DNS for WireGuard clients. | +| `public_ip` | Public IP address | Retrieved automatically | `253.162.134.73` | Used to generate accurate client configs. Needed if container is NAT’d. | +| `wgd_port` | Any port that is allowed for the process | `10086` | `443` | This port is used to set the WGDashboard web port. | +| `username` | Any non‐empty string | `-` | `admin` | Username for the WGDashboard web interface account. | +| `password` | Any non‐empty string | `-` | `s3cr3tP@ss` | Password for the WGDashboard web interface account (stored hashed). | +| `enable_totp` | `true`, `false` | `true` | `false` | Enable TOTP‐based two‐factor authentication for the account. | +| `wg_autostart` | Wireguard interface name | `-` | `wg0` or `wg0||wg1||wg2` | Auto‐start the WireGuard interface when the container launches. | +| `email_server` | SMTP server address | `-` | `smtp.gmail.com` | SMTP server for sending email notifications. | +| `email_port` | SMTP port number | `-` | `587` | Port for connecting to the SMTP server. | +| `email_encryption` | `TLS`, `SSL`, etc. | `-` | `TLS` | Encryption method for email communication. | +| `email_username` | Any non-empty string | `-` | `user@example.com` | Username for SMTP authentication. | +| `email_password` | Any non-empty string | `-` | `app_password` | Password for SMTP authentication. | +| `email_from` | Valid email address | `-` | `noreply@example.com` | Email address used as the sender for notifications. | +| `email_template` | Path to template file | `-` | `your-template` | Custom template for email notifications. | ---