From cd60761ea750dc6ecf383b683a6a24111eba0c29 Mon Sep 17 00:00:00 2001 From: Christoph Haas Date: Sun, 4 May 2025 11:16:46 +0200 Subject: [PATCH] improve docs --- docs/documentation/configuration/overview.md | 8 ++++---- docs/documentation/getting-started/docker.md | 6 +++--- docs/documentation/getting-started/sources.md | 1 + docs/documentation/upgrade/v1.md | 6 ++++-- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/documentation/configuration/overview.md b/docs/documentation/configuration/overview.md index 234660f..03bc68e 100644 --- a/docs/documentation/configuration/overview.md +++ b/docs/documentation/configuration/overview.md @@ -1,10 +1,10 @@ This page provides an overview of **all available configuration options** for WireGuard Portal. -You can supply these configurations in a **YAML** file (e.g. `config.yaml`) when starting the Portal. -The path of the configuration file defaults to **config/config.yaml** (or config/config.yml) in the working directory of the executable. -It is possible to override configuration filepath using the environment variable `WG_PORTAL_CONFIG`. +You can supply these configurations in a **YAML** file when starting the Portal. +The path of the configuration file defaults to `config/config.yaml` (or `config/config.yml`) in the working directory of the executable. +It is possible to override the configuration filepath using the environment variable `WG_PORTAL_CONFIG`. For example: `WG_PORTAL_CONFIG=/etc/wg-portal/config.yaml ./wg-portal`. -Also, environment variable substitution in the config file is supported. Refer to [syntax](https://github.com/a8m/envsubst?tab=readme-ov-file#docs). +Also, environment variable substitution in the config file is supported. Refer to the [syntax](https://github.com/a8m/envsubst?tab=readme-ov-file#docs). Configuration examples are available on the [Examples](./examples.md) page. diff --git a/docs/documentation/getting-started/docker.md b/docs/documentation/getting-started/docker.md index 5b24df5..ecf5227 100644 --- a/docs/documentation/getting-started/docker.md +++ b/docs/documentation/getting-started/docker.md @@ -13,7 +13,7 @@ A sample docker-compose.yml (managing WireGuard interfaces directly on the host) --8<-- "docker-compose.yml::18" ``` -By default, the webserver is listening on port **8888**. +By default, the webserver is listening on port **8888** on all available interfaces. Volumes for `/app/data` and `/app/config` should be used ensure data persistence across container restarts. @@ -118,7 +118,7 @@ These are official releases of WireGuard Portal. They correspond to the GitHub t Once these tags show up in this repository, they will never change. -For production deployments of WireGuard Portal, we strongly recommend using one of these tags, e.g. **wgportal/wg-portal:2.0.0**, instead of the latest or canary tags. +For production deployments of WireGuard Portal, we strongly recommend using one of these tags, e.g. `wgportal/wg-portal:2.0.0`, instead of the latest or canary tags. If you only want to stay at the same major or major+minor version, use either `v[MAJOR]` or `[MAJOR].[MINOR]` tags. For example `v2` or `2.0`. @@ -149,7 +149,7 @@ You should mount those directories as a volume: A detailed description of the configuration options can be found [here](../configuration/overview.md). -If you want to access configuration files in wg-quick format, you can mount the `/etc/wireguard` directory to a location of your choice. +If you want to access configuration files in wg-quick format, you can mount the `/etc/wireguard` directory inside the container to a location of your choice. Also enable the `config_storage_path` option in the configuration file: ```yaml advanced: diff --git a/docs/documentation/getting-started/sources.md b/docs/documentation/getting-started/sources.md index 265e5b9..36e9b71 100644 --- a/docs/documentation/getting-started/sources.md +++ b/docs/documentation/getting-started/sources.md @@ -22,4 +22,5 @@ make build ## Install Compiled binary will be available in `./dist` directory. + For installation instructions, check the [Binaries](./binaries.md) section. diff --git a/docs/documentation/upgrade/v1.md b/docs/documentation/upgrade/v1.md index 096d10f..52bdbe7 100644 --- a/docs/documentation/upgrade/v1.md +++ b/docs/documentation/upgrade/v1.md @@ -13,7 +13,9 @@ To upgrade from a previous SQLite database, start wg-portal like: ./wg-portal-amd64 -migrateFrom=old_wg_portal.db ``` -You can also specify the database type using the parameter **-migrateFromType**, supported types: mysql, mssql, postgres or sqlite. +You can also specify the database type using the parameter **-migrateFromType**. +Supported database types: `mysql`, `mssql`, `postgres` or `sqlite`. + For example: ```shell @@ -31,5 +33,5 @@ services: image: wgportal/wg-portal:v2 # ... other settings restart: no - command: ["-migrateFrom=/app/data/wg_portal.db"] + command: ["-migrateFrom=/app/data/old_wg_portal.db"] ```