UniqueSoft/wg-portal
2
0
Fork 0
mirror of https://github.com/h44z/wg-portal synced 2025-06-26 18:16:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README for REST API

Browse Source
This commit is contained in:
Christoph Haas 2025-01-11 18:38:22 +01:00
parent fb19b6c4a8
commit f0c6a865c0
1 changed files with 93 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -38,7 +38,7 @@ The configuration portal supports using a database (SQLite, MySQL, MsSQL or Post
* Peer Expiry Feature * Peer Expiry Feature
* Handle route and DNS settings like wg-quick does * Handle route and DNS settings like wg-quick does
* Exposes Prometheus [metrics](#metrics) * Exposes Prometheus [metrics](#metrics)
* ~~REST API for management and client deployment~~ (coming soon) * REST API for management and client deployment
![Screenshot](screenshot.png) ![Screenshot](screenshot.png)
@ -56,7 +56,7 @@ By default, WireGuard Portal uses a SQLite database. The database is stored in *
The following configuration options are available: The following configuration options are available:
| configuration key | parent key | default_value | description | | configuration key | parent key | default_value | description |
|----------------------------------|------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------|------------|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| admin_user | core | admin@wgportal.local | The administrator user. This user will be created as default admin if it does not yet exist. | | admin_user | core | admin@wgportal.local | The administrator user. This user will be created as default admin if it does not yet exist. |
| admin_password | core | wgportal | The administrator password. If unchanged, a random password will be set on first startup. | | admin_password | core | wgportal | The administrator password. If unchanged, a random password will be set on first startup. |
| editable_keys | core | true | Allow to edit key-pairs in the UI. | | editable_keys | core | true | Allow to edit key-pairs in the UI. |
@ -78,6 +78,7 @@ The following configuration options are available:
| expiry_check_interval | advanced | 15m | The interval after which existing peers will be checked if they expired. | | expiry_check_interval | advanced | 15m | The interval after which existing peers will be checked if they expired. |
| rule_prio_offset | advanced | 20000 | The default offset for ip route rule priorities. | | rule_prio_offset | advanced | 20000 | The default offset for ip route rule priorities. |
| route_table_offset | advanced | 20000 | The default offset for ip route table id's. | | route_table_offset | advanced | 20000 | The default offset for ip route table id's. |
| api_admin_only | advanced | true | This flag specifies if the public REST API is available to administrators only. The API Swagger documentation is available under /api/v1/doc.html |
| use_ping_checks | statistics | true | If enabled, peers will be pinged periodically to check if they are still connected. | | use_ping_checks | statistics | true | If enabled, peers will be pinged periodically to check if they are still connected. |
| ping_check_workers | statistics | 10 | Number of parallel ping checks that will be executed. | | ping_check_workers | statistics | 10 | Number of parallel ping checks that will be executed. |
| ping_unprivileged | statistics | false | If set to false, the ping checks will run without root permissions (BETA). | | ping_unprivileged | statistics | false | If set to false, the ping checks will run without root permissions (BETA). |