Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-09-15 07:11:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve docs

Browse Source
This commit is contained in:
Christoph Haas
2025-05-04 11:16:46 +02:00
parent 2c8304417b
commit cd60761ea7
4 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/documentation/getting-started/docker.md
View File

@@ -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:

1
docs/documentation/getting-started/sources.md
View File

@@ -22,4 +22,5 @@ make build
## Install
Compiled binary will be available in `./dist` directory.
For installation instructions, check the [Binaries](./binaries.md) section.