Examples
Below are some sample YAML configurations demonstrating how to override some default values.
Basic Configuration
core:
+ Examples - WireGuard Portal Examples
Below are some sample YAML configurations demonstrating how to override some default values.
Basic
core:
admin_user: test@example.com
admin_password: password
import_existing: false
@@ -26,11 +26,10 @@
debug: true
type: sqlite
dsn: data/sqlite.db
-
LDAP Authentication and Synchronization Configuration
# ... (basic configuration)
+
LDAP Authentication and Synchronization
# ... (basic configuration)
auth:
ldap:
-
# a sample LDAP provider with user sync enabled
- id: ldap
provider_name: Active Directory
@@ -54,12 +53,23 @@
admin_group: CN=WireGuardAdmins,OU=Some-OU,DC=COMPANY,DC=LOCAL
registration_enabled: true
log_user_info: true
-
OpenID Connect (OIDC) Authentication Configuration
# ... (basic configuration)
+
OpenID Connect (OIDC) Authentication
# ... (basic configuration)
auth:
oidc:
+ # a sample Entra ID provider with environment variable substitution
+ - id: azure
+ provider_name: azure
+ display_name: Login with</br>Entra ID
+ registration_enabled: true
+ base_url: "https://login.microsoftonline.com/${AZURE_TENANT_ID}/v2.0"
+ client_id: "${AZURE_CLIENT_ID}"
+ client_secret: "${AZURE_CLIENT_SECRET}"
+ extra_scopes:
+ - profile
+ - email
- # a sample provider where users with the attribute `wg_admin` set to `true` are considered as admins
+ # a sample provider where users with the attribute `wg_admin` set to `true` are considered as admins
- id: oidc-with-admin-attribute
provider_name: google
display_name: Login with</br>Google
@@ -82,7 +92,7 @@
registration_enabled: true
log_user_info: true
- # a sample provider where users in the group `the-admin-group` are considered as admins
+ # a sample provider where users in the group `the-admin-group` are considered as admins
- id: oidc-with-admin-group
provider_name: google2
display_name: Login with</br>Google2
@@ -104,13 +114,12 @@
- admin_group_regex: ^the-admin-group$
registration_enabled: true
log_user_info: true
-
Plain OAuth2 Authentication Configuration
# ... (basic configuration)
+
Plain OAuth2 Authentication
# ... (basic configuration)
auth:
oauth:
-
# a sample provider where users with the attribute `this-attribute-must-be-true` set to `true` or `True`
- # are considered as admins
+ # are considered as admins
- id: google_plain_oauth-with-admin-attribute
provider_name: google3
display_name: Login with</br>Google3
@@ -133,7 +142,7 @@
registration_enabled: true
# a sample provider where either users with the attribute `this-attribute-must-be-true` set to `true` or
- # users in the group `admin-group-name` are considered as admins
+ # users in the group `admin-group-name` are considered as admins
- id: google_plain_oauth_with_groups
provider_name: google4
display_name: Login with</br>Google4
@@ -158,7 +167,7 @@
admin_group_regex: ^admin-group-name$
registration_enabled: true
log_user_info: true
-
WireGuard Portal Configuration
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. Complete configuration examples are available in the Configuration Examples page.
Below you will find sections like core, advanced, statistics, mail, auth, database, and web.
Each section describes the individual configuration keys, their default values, and a brief explanation of their purpose.
Core
These are the primary configuration options that control fundamental WireGuard Portal behavior. More advanced options are found in the subsequent Advanced section.
admin_user
- Default:
admin@wgportal.local - Description: The administrator user. This user will be created as a default admin if it does not yet exist.
admin_password
- Default:
wgportal - Description: The administrator password. The default password of
wgportalshould be changed immediately.
editable_keys
- Default:
true - Description: Allow editing of WireGuard key-pairs directly in the UI.
create_default_peer
- Default:
false - Description: If a user logs in for the first time with no existing peers, automatically create a new WireGuard peer for all server interfaces.
create_default_peer_on_creation
- Default:
false - Description: If an LDAP user is created (e.g., through LDAP sync) and has no peers, automatically create a new WireGuard peer for all server interfaces.
re_enable_peer_after_user_enable
- Default:
true - Description: Re-enable all peers that were previously disabled if the associated user is re-enabled.
delete_peer_after_user_deleted
- Default:
false - Description: If a user is deleted, remove all linked peers. Otherwise, peers remain but are disabled.
self_provisioning_allowed
- Default:
false - Description: Allow registered (non-admin) users to self-provision peers from their profile page.
import_existing
- Default:
true - Description: On startup, import existing WireGuard interfaces and peers into WireGuard Portal.
restore_state
- Default:
true - Description: Restore the WireGuard interface states (up/down) that existed before WireGuard Portal started.
Advanced
Additional or more specialized configuration options for logging and interface creation details.
log_level
- Default:
info - Description: The log level used by the application. Valid options are:
trace,debug,info,warn,error.
log_pretty
- Default:
false - Description: If
true, log messages are colorized and formatted for readability (pretty-print).
log_json
- Default:
false - Description: If
true, log messages are structured in JSON format.
start_listen_port
- Default:
51820 - Description: The first port to use when automatically creating new WireGuard interfaces.
start_cidr_v4
- Default:
10.11.12.0/24 - Description: The initial IPv4 subnet to use when automatically creating new WireGuard interfaces.
start_cidr_v6
- Default:
fdfd:d3ad:c0de:1234::0/64 - Description: The initial IPv6 subnet to use when automatically creating new WireGuard interfaces.
use_ip_v6
- Default:
true - Description: Enable or disable IPv6 support.
config_storage_path
- Default: (empty)
- Description: Path to a directory where
wg-quickstyle configuration files will be stored (if you need local filesystem configs).
expiry_check_interval
- Default:
15m - Description: Interval after which existing peers are checked if they are expired. Format uses
s,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration.
rule_prio_offset
- Default:
20000 - Description: Offset for IP route rule priorities when configuring routing.
route_table_offset
- Default:
20000 - Description: Offset for IP route table IDs when configuring routing.
api_admin_only
- Default:
true - Description: If
true, the public REST API is accessible only to admin users. The API docs live at/api/v1/doc.html.
Database
Configuration for the underlying database used by WireGuard Portal. Supported databases include SQLite, MySQL, Microsoft SQL Server, and Postgres.
debug
- Default:
false - Description: If
true, logs all database statements (verbose).
slow_query_threshold
- Default: 0
- Description: A time threshold (e.g.,
100ms) above which queries are considered slow and logged as warnings. If empty or zero, slow query logging is disabled. Format usess,msfor seconds, milliseconds, see time.ParseDuration.
type
- Default:
sqlite - Description: The database type. Valid options:
sqlite,mssql,mysql,postgres.
dsn
- Default:
data/sqlite.db - Description: The Data Source Name (DSN) for connecting to the database.
For example:user:pass@tcp(1.2.3.4:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local -
Statistics
Controls how WireGuard Portal collects and reports usage statistics, including ping checks and Prometheus metrics.
use_ping_checks
- Default:
true - Description: Enable periodic ping checks to verify that peers remain responsive.
ping_check_workers
- Default:
10 - Description: Number of parallel worker processes for ping checks.
ping_unprivileged
- Default:
false - Description: If
false, ping checks run without root privileges. This is currently considered BETA.
ping_check_interval
- Default:
1m - Description: Interval between consecutive ping checks for all peers. Format uses
s,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration.
data_collection_interval
- Default:
1m - Description: Interval between data collection cycles (bytes sent/received, handshake times, etc.). Format uses
s,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration.
collect_interface_data
- Default:
true - Description: If
true, collects interface-level data (bytes in/out) for monitoring and statistics.
collect_peer_data
- Default:
true - Description: If
true, collects peer-level data (bytes, last handshake, endpoint, etc.).
collect_audit_data
- Default:
true - Description: If
true, logs certain portal events (such as user logins) to the database.
listening_address
- Default:
:8787 - Description: Address and port for the integrated Prometheus metric server (e.g.,
:8787).
Options for configuring email notifications or sending peer configurations via email.
host
- Default:
127.0.0.1 - Description: Hostname or IP of the SMTP server.
port
- Default:
25 - Description: Port number for the SMTP server.
encryption
- Default:
none - Description: SMTP encryption type. Valid values:
none,tls,starttls.
cert_validation
- Default:
false - Description: If
true, validate the SMTP server certificate (relevant ifencryption=tls).
username
- Default: (empty)
- Description: Optional SMTP username for authentication.
password
- Default: (empty)
- Description: Optional SMTP password for authentication.
auth_type
- Default:
plain - Description: SMTP authentication type. Valid values:
plain,login,crammd5.
from
- Default:
Wireguard Portal <noreply@wireguard.local> - Description: The default "From" address when sending emails.
link_only
- Default:
false - Description: If
true, emails only contain a link to WireGuard Portal, rather than attaching the full configuration.
Auth
WireGuard Portal supports multiple authentication strategies, including OpenID Connect (oidc), OAuth (oauth), and LDAP (ldap). Each can have multiple providers configured. Below are the relevant keys.
OIDC Provider Properties
The oidc array contains a list of OpenID Connect providers. Below are the properties for each OIDC provider entry inside auth.oidc:
provider_name
- Default: (empty)
- Description: A unique name for this provider. Must not conflict with other providers.
display_name
- Default: (empty)
- Description: A user-friendly name shown on the login page (e.g., "Login with Google").
base_url
- Default: (empty)
- Description: The OIDC provider’s base URL (e.g.,
https://accounts.google.com).
client_id
- Default: (empty)
- Description: The OAuth client ID from the OIDC provider.
client_secret
- Default: (empty)
- Description: The OAuth client secret from the OIDC provider.
extra_scopes
- Default: (empty)
- Description: A list of additional OIDC scopes (e.g.,
profile,email).
field_map
- Default: (empty)
- Description: Maps OIDC claims to WireGuard Portal user fields.
-
Available fields:
user_identifier,email,firstname,lastname,phone,department,is_admin,user_groups.Field Typical OIDC Claim Explanation user_identifiersuborpreferred_usernameA unique identifier for the user. Often the OIDC subclaim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also supportpreferred_usernameif it’s unique.emailemailThe user’s email address as provided by the IdP. Not always verified, depending on IdP settings. firstnamegiven_nameThe user’s first name, typically provided by the IdP in the given_nameclaim.lastnamefamily_nameThe user’s last (family) name, typically provided by the IdP in the family_nameclaim.phonephone_numberThe user’s phone number. This may require additional scopes/permissions from the IdP to access. departmentCustom claim (e.g., department)If the IdP can provide organizational data, it may store it in a custom claim. Adjust accordingly (e.g., department,org, or another attribute).is_adminCustom claim or derived role If the IdP returns a role or admin flag, you can map that to is_admin. Often this is managed through custom claims or group membership.user_groupsgroupsor another custom claimA list of group memberships for the user. Some IdPs provide groupsout of the box; others require custom claims or directory lookups.
admin_mapping
- Default: (empty)
- Description: WgPortal can grant a user admin rights by matching the value of the
is_adminclaim against a regular expression. Alternatively, a regular expression can be used to check if a user is member of a specific group listed in theuser_groupclaim. The regular expressions are defined inadmin_value_regexandadmin_group_regex.admin_value_regex: A regular expression to match theis_adminclaim. By default, this expression matches the string "true" (^true$).admin_group_regex: A regular expression to match theuser_groupsclaim. Each entry in theuser_groupsclaim is checked against this regex.
registration_enabled
- Default: (empty)
- Description: If
true, a new user will be created in WireGuard Portal if not already present.
log_user_info
- Default: (empty)
- Description: If
true, OIDC user data is logged at the trace level upon login (for debugging).
OAuth Provider Properties
The oauth array contains a list of plain OAuth2 providers. Below are the properties for each OAuth provider entry inside auth.oauth:
provider_name
- Default: (empty)
- Description: A unique name for this provider. Must not conflict with other providers.
display_name
- Default: (empty)
- Description: A user-friendly name shown on the login page.
client_id
- Default: (empty)
- Description: The OAuth client ID for the provider.
client_secret
- Default: (empty)
- Description: The OAuth client secret for the provider.
auth_url
- Default: (empty)
- Description: URL of the authentication endpoint.
token_url
- Default: (empty)
- Description: URL of the token endpoint.
user_info_url
- Default: (empty)
- Description: URL of the user information endpoint.
scopes
- Default: (empty)
- Description: A list of OAuth scopes.
field_map
- Default: (empty)
- Description: Maps OAuth attributes to WireGuard Portal fields.
-
Available fields:
user_identifier,email,firstname,lastname,phone,department,is_admin,user_groups.Field Typical Claim Explanation user_identifiersuborpreferred_usernameA unique identifier for the user. Often the OIDC subclaim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also supportpreferred_usernameif it’s unique.emailemailThe user’s email address as provided by the IdP. Not always verified, depending on IdP settings. firstnamegiven_nameThe user’s first name, typically provided by the IdP in the given_nameclaim.lastnamefamily_nameThe user’s last (family) name, typically provided by the IdP in the family_nameclaim.phonephone_numberThe user’s phone number. This may require additional scopes/permissions from the IdP to access. departmentCustom claim (e.g., department)If the IdP can provide organizational data, it may store it in a custom claim. Adjust accordingly (e.g., department,org, or another attribute).is_adminCustom claim or derived role If the IdP returns a role or admin flag, you can map that to is_admin. Often this is managed through custom claims or group membership.user_groupsgroupsor another custom claimA list of group memberships for the user. Some IdPs provide groupsout of the box; others require custom claims or directory lookups.
admin_mapping
- Default: (empty)
- Description: WgPortal can grant a user admin rights by matching the value of the
is_adminclaim against a regular expression. Alternatively, a regular expression can be used to check if a user is member of a specific group listed in theuser_groupclaim. The regular expressions are defined inadmin_value_regexandadmin_group_regex. admin_value_regex: A regular expression to match theis_adminclaim. By default, this expression matches the string "true" (^true$).admin_group_regex: A regular expression to match theuser_groupsclaim. Each entry in theuser_groupsclaim is checked against this regex.
registration_enabled
- Default: (empty)
- Description: If
true, new users are created automatically on successful login.
log_user_info
- Default: (empty)
- Description: If
true, logs user info at the trace level upon login.
LDAP Provider Properties
The ldap array contains a list of LDAP authentication providers. Below are the properties for each LDAP provider entry inside auth.ldap:
url
- Default: (empty)
- Description: The LDAP server URL (e.g.,
ldap://srv-ad01.company.local:389).
start_tls
- Default: (empty)
- Description: If
true, use STARTTLS to secure the LDAP connection.
cert_validation
- Default: (empty)
- Description: If
true, validate the LDAP server’s TLS certificate.
tls_certificate_path
- Default: (empty)
- Description: Path to a TLS certificate if needed for LDAP connections.
tls_key_path
- Default: (empty)
- Description: Path to the corresponding TLS certificate key.
base_dn
- Default: (empty)
- Description: The base DN for user searches (e.g.,
DC=COMPANY,DC=LOCAL).
bind_user
- Default: (empty)
- Description: The bind user for LDAP (e.g.,
company\\ldap_wireguardorldap_wireguard@company.local).
bind_pass
- Default: (empty)
- Description: The bind password for LDAP authentication.
field_map
- Default: (empty)
-
Description: Maps LDAP attributes to WireGuard Portal fields.
- Available fields:
user_identifier,email,firstname,lastname,phone,department,memberof.
WireGuard Portal Field Typical LDAP Attribute Short Description user_identifier sAMAccountName / uid Uniquely identifies the user within the LDAP directory. email mail / userPrincipalName Stores the user's primary email address. firstname givenName Contains the user's first (given) name. lastname sn Contains the user's last (surname) name. phone telephoneNumber / mobile Holds the user's phone or mobile number. department departmentNumber / ou Specifies the department or organizational unit of the user. memberof memberOf Lists the groups and roles to which the user belongs. - Available fields:
login_filter
- Default: (empty)
- Description: An LDAP filter to restrict which users can log in. Use
{{login_identifier}}to insert the username. For example:(&(objectClass=organizationalPerson)(mail={{login_identifier}})(!userAccountControl:1.2.840.113556.1.4.803:=2)) +Overview - WireGuard Portal Overview
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.yml in the working directory of the executable.
It is possible to override configuration filepath using the environment variableWG_PORTAL_CONFIG. For example:WG_PORTAL_CONFIG=/etc/wg-portal/config.yaml ./wg-portal.
Also, environment variable substitution in config file is supported. Refer to syntax.Configuration examples are available on the Examples page.
Default configuration
core: + admin_user: admin@wgportal.local + admin_password: wgportal + editable_keys: true + create_default_peer: false + create_default_peer_on_creation: false + re_enable_peer_after_user_enable: true + delete_peer_after_user_deleted: false + self_provisioning_allowed: false + import_existing: true + restore_state: true + +advanced: + log_level: info + log_pretty: false + log_json: false + start_listen_port: 51820 + start_cidr_v4: 10.11.12.0/24 + start_cidr_v6: fdfd:d3ad:c0de:1234::0/64 + use_ip_v6: true + config_storage_path: "" + expiry_check_interval: 15m + rule_prio_offset: 20000 + api_admin_only: true + +database: + debug: false + slow_query_threshold: 0 + type: sqlite + dsn: data/sqlite.db + +statistics: + use_ping_checks: true + ping_check_workers: 10 + ping_unprivileged: false + ping_check_interval: 1m + data_collection_interval: 1m + collect_interface_data: true + collect_peer_data: true + collect_audit_data: true + listening_address: :8787 + +mail: + host: 127.0.0.1 + port: 25 + encryption: none + cert_validation: false + username: "" + password: "" + auth_type: plain + from: Wireguard Portal <noreply@wireguard.local> + link_only: false + +auth: + oidc: [] + oauth: [] + ldap: [] + +web: + listening_address: :8888 + external_url: http://localhost:8888 + site_company_name: WireGuard Portal + site_title: WireGuard Portal + session_identifier: wgPortalSession + session_secret: very_secret + csrf_secret: extremely_secret + request_logging: false + cert_file: "" + key_File: "" +Below you will find sections like
core,advanced,database,statistics,mail,authandweb.
Each section describes the individual configuration keys, their default values, and a brief explanation of their purpose.
Core
These are the primary configuration options that control fundamental WireGuard Portal behavior. More advanced options are found in the subsequent
Advancedsection.admin_user- Default:
admin@wgportal.local - Description: The administrator user. This user will be created as a default admin if it does not yet exist.
admin_password- Default:
wgportal - Description: The administrator password. The default password of
wgportalshould be changed immediately.
editable_keys- Default:
true - Description: Allow editing of WireGuard key-pairs directly in the UI.
create_default_peer- Default:
false - Description: If a user logs in for the first time with no existing peers, automatically create a new WireGuard peer for all server interfaces.
create_default_peer_on_creation- Default:
false - Description: If an LDAP user is created (e.g., through LDAP sync) and has no peers, automatically create a new WireGuard peer for all server interfaces.
re_enable_peer_after_user_enable- Default:
true - Description: Re-enable all peers that were previously disabled if the associated user is re-enabled.
delete_peer_after_user_deleted- Default:
false - Description: If a user is deleted, remove all linked peers. Otherwise, peers remain but are disabled.
self_provisioning_allowed- Default:
false - Description: Allow registered (non-admin) users to self-provision peers from their profile page.
import_existing- Default:
true - Description: On startup, import existing WireGuard interfaces and peers into WireGuard Portal.
restore_state- Default:
true - Description: Restore the WireGuard interface states (up/down) that existed before WireGuard Portal started.
Advanced
Additional or more specialized configuration options for logging and interface creation details.
log_level- Default:
info - Description: The log level used by the application. Valid options are:
trace,debug,info,warn,error.
log_pretty- Default:
false - Description: If
true, log messages are colorized and formatted for readability (pretty-print).
log_json- Default:
false - Description: If
true, log messages are structured in JSON format.
start_listen_port- Default:
51820 - Description: The first port to use when automatically creating new WireGuard interfaces.
start_cidr_v4- Default:
10.11.12.0/24 - Description: The initial IPv4 subnet to use when automatically creating new WireGuard interfaces.
start_cidr_v6- Default:
fdfd:d3ad:c0de:1234::0/64 - Description: The initial IPv6 subnet to use when automatically creating new WireGuard interfaces.
use_ip_v6- Default:
true - Description: Enable or disable IPv6 support.
config_storage_path- Default: (empty)
- Description: Path to a directory where
wg-quickstyle configuration files will be stored (if you need local filesystem configs).
expiry_check_interval- Default:
15m - Description: Interval after which existing peers are checked if they are expired. Format uses
s,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration.
rule_prio_offset- Default:
20000 - Description: Offset for IP route rule priorities when configuring routing.
route_table_offset- Default:
20000 - Description: Offset for IP route table IDs when configuring routing.
api_admin_only- Default:
true - Description: If
true, the public REST API is accessible only to admin users. The API docs live at/api/v1/doc.html.
Database
Configuration for the underlying database used by WireGuard Portal. Supported databases include SQLite, MySQL, Microsoft SQL Server, and Postgres.
debug- Default:
false - Description: If
true, logs all database statements (verbose).
slow_query_threshold- Default: 0
- Description: A time threshold (e.g.,
100ms) above which queries are considered slow and logged as warnings. If empty or zero, slow query logging is disabled. Format usess,msfor seconds, milliseconds, see time.ParseDuration.
type- Default:
sqlite - Description: The database type. Valid options:
sqlite,mssql,mysql,postgres.
dsn- Default:
data/sqlite.db - Description: The Data Source Name (DSN) for connecting to the database.
For example:user:pass@tcp(1.2.3.4:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local +
Statistics
Controls how WireGuard Portal collects and reports usage statistics, including ping checks and Prometheus metrics.
use_ping_checks- Default:
true - Description: Enable periodic ping checks to verify that peers remain responsive.
ping_check_workers- Default:
10 - Description: Number of parallel worker processes for ping checks.
ping_unprivileged- Default:
false - Description: If
false, ping checks run without root privileges. This is currently considered BETA.
ping_check_interval- Default:
1m - Description: Interval between consecutive ping checks for all peers. Format uses
s,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration.
data_collection_interval- Default:
1m - Description: Interval between data collection cycles (bytes sent/received, handshake times, etc.). Format uses
s,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration.
collect_interface_data- Default:
true - Description: If
true, collects interface-level data (bytes in/out) for monitoring and statistics.
collect_peer_data- Default:
true - Description: If
true, collects peer-level data (bytes, last handshake, endpoint, etc.).
collect_audit_data- Default:
true - Description: If
true, logs certain portal events (such as user logins) to the database.
listening_address- Default:
:8787 - Description: Address and port for the integrated Prometheus metric server (e.g.,
:8787).
Mail
Options for configuring email notifications or sending peer configurations via email.
host- Default:
127.0.0.1 - Description: Hostname or IP of the SMTP server.
port- Default:
25 - Description: Port number for the SMTP server.
encryption- Default:
none - Description: SMTP encryption type. Valid values:
none,tls,starttls.
cert_validation- Default:
false - Description: If
true, validate the SMTP server certificate (relevant ifencryption=tls).
username- Default: (empty)
- Description: Optional SMTP username for authentication.
password- Default: (empty)
- Description: Optional SMTP password for authentication.
auth_type- Default:
plain - Description: SMTP authentication type. Valid values:
plain,login,crammd5.
from- Default:
Wireguard Portal <noreply@wireguard.local> - Description: The default "From" address when sending emails.
link_only- Default:
false - Description: If
true, emails only contain a link to WireGuard Portal, rather than attaching the full configuration.
Auth
WireGuard Portal supports multiple authentication strategies, including OpenID Connect (
oidc), OAuth (oauth), and LDAP (ldap). Each can have multiple providers configured. Below are the relevant keys.
OIDC
The
oidcarray contains a list of OpenID Connect providers. Below are the properties for each OIDC provider entry insideauth.oidc:provider_name- Default: (empty)
- Description: A unique name for this provider. Must not conflict with other providers.
display_name- Default: (empty)
- Description: A user-friendly name shown on the login page (e.g., "Login with Google").
base_url- Default: (empty)
- Description: The OIDC provider’s base URL (e.g.,
https://accounts.google.com).
client_id- Default: (empty)
- Description: The OAuth client ID from the OIDC provider.
client_secret- Default: (empty)
- Description: The OAuth client secret from the OIDC provider.
extra_scopes- Default: (empty)
- Description: A list of additional OIDC scopes (e.g.,
profile,email).
field_map- Default: (empty)
- Description: Maps OIDC claims to WireGuard Portal user fields.
-
Available fields:
user_identifier,email,firstname,lastname,phone,department,is_admin,user_groups.Field Typical OIDC Claim Explanation user_identifiersuborpreferred_usernameA unique identifier for the user. Often the OIDC subclaim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also supportpreferred_usernameif it’s unique.emailemailThe user’s email address as provided by the IdP. Not always verified, depending on IdP settings. firstnamegiven_nameThe user’s first name, typically provided by the IdP in the given_nameclaim.lastnamefamily_nameThe user’s last (family) name, typically provided by the IdP in the family_nameclaim.phonephone_numberThe user’s phone number. This may require additional scopes/permissions from the IdP to access. departmentCustom claim (e.g., department)If the IdP can provide organizational data, it may store it in a custom claim. Adjust accordingly (e.g., department,org, or another attribute).is_adminCustom claim or derived role If the IdP returns a role or admin flag, you can map that to is_admin. Often this is managed through custom claims or group membership.user_groupsgroupsor another custom claimA list of group memberships for the user. Some IdPs provide groupsout of the box; others require custom claims or directory lookups.
admin_mapping- Default: (empty)
- Description: WgPortal can grant a user admin rights by matching the value of the
is_adminclaim against a regular expression. Alternatively, a regular expression can be used to check if a user is member of a specific group listed in theuser_groupclaim. The regular expressions are defined inadmin_value_regexandadmin_group_regex.admin_value_regex: A regular expression to match theis_adminclaim. By default, this expression matches the string "true" (^true$).admin_group_regex: A regular expression to match theuser_groupsclaim. Each entry in theuser_groupsclaim is checked against this regex.
registration_enabled- Default: (empty)
- Description: If
true, a new user will be created in WireGuard Portal if not already present.
log_user_info- Default: (empty)
- Description: If
true, OIDC user data is logged at the trace level upon login (for debugging).
OAuth
The
oautharray contains a list of plain OAuth2 providers. Below are the properties for each OAuth provider entry insideauth.oauth:provider_name- Default: (empty)
- Description: A unique name for this provider. Must not conflict with other providers.
display_name- Default: (empty)
- Description: A user-friendly name shown on the login page.
client_id- Default: (empty)
- Description: The OAuth client ID for the provider.
client_secret- Default: (empty)
- Description: The OAuth client secret for the provider.
auth_url- Default: (empty)
- Description: URL of the authentication endpoint.
token_url- Default: (empty)
- Description: URL of the token endpoint.
user_info_url- Default: (empty)
- Description: URL of the user information endpoint.
scopes- Default: (empty)
- Description: A list of OAuth scopes.
field_map- Default: (empty)
- Description: Maps OAuth attributes to WireGuard Portal fields.
-
Available fields:
user_identifier,email,firstname,lastname,phone,department,is_admin,user_groups.Field Typical Claim Explanation user_identifiersuborpreferred_usernameA unique identifier for the user. Often the OIDC subclaim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also supportpreferred_usernameif it’s unique.emailemailThe user’s email address as provided by the IdP. Not always verified, depending on IdP settings. firstnamegiven_nameThe user’s first name, typically provided by the IdP in the given_nameclaim.lastnamefamily_nameThe user’s last (family) name, typically provided by the IdP in the family_nameclaim.phonephone_numberThe user’s phone number. This may require additional scopes/permissions from the IdP to access. departmentCustom claim (e.g., department)If the IdP can provide organizational data, it may store it in a custom claim. Adjust accordingly (e.g., department,org, or another attribute).is_adminCustom claim or derived role If the IdP returns a role or admin flag, you can map that to is_admin. Often this is managed through custom claims or group membership.user_groupsgroupsor another custom claimA list of group memberships for the user. Some IdPs provide groupsout of the box; others require custom claims or directory lookups.
admin_mapping- Default: (empty)
- Description: WgPortal can grant a user admin rights by matching the value of the
is_adminclaim against a regular expression. Alternatively, a regular expression can be used to check if a user is member of a specific group listed in theuser_groupclaim. The regular expressions are defined inadmin_value_regexandadmin_group_regex. admin_value_regex: A regular expression to match theis_adminclaim. By default, this expression matches the string "true" (^true$).admin_group_regex: A regular expression to match theuser_groupsclaim. Each entry in theuser_groupsclaim is checked against this regex.
registration_enabled- Default: (empty)
- Description: If
true, new users are created automatically on successful login.
log_user_info- Default: (empty)
- Description: If
true, logs user info at the trace level upon login.
LDAP
The
ldaparray contains a list of LDAP authentication providers. Below are the properties for each LDAP provider entry insideauth.ldap:url- Default: (empty)
- Description: The LDAP server URL (e.g.,
ldap://srv-ad01.company.local:389).
start_tls- Default: (empty)
- Description: If
true, use STARTTLS to secure the LDAP connection.
cert_validation- Default: (empty)
- Description: If
true, validate the LDAP server’s TLS certificate.
tls_certificate_path- Default: (empty)
- Description: Path to a TLS certificate if needed for LDAP connections.
tls_key_path- Default: (empty)
- Description: Path to the corresponding TLS certificate key.
base_dn- Default: (empty)
- Description: The base DN for user searches (e.g.,
DC=COMPANY,DC=LOCAL).
bind_user- Default: (empty)
- Description: The bind user for LDAP (e.g.,
company\\ldap_wireguardorldap_wireguard@company.local).
bind_pass- Default: (empty)
- Description: The bind password for LDAP authentication.
field_map- Default: (empty)
-
Description: Maps LDAP attributes to WireGuard Portal fields.
- Available fields:
user_identifier,email,firstname,lastname,phone,department,memberof.
WireGuard Portal Field Typical LDAP Attribute Short Description user_identifier sAMAccountName / uid Uniquely identifies the user within the LDAP directory. email mail / userPrincipalName Stores the user's primary email address. firstname givenName Contains the user's first (given) name. lastname sn Contains the user's last (surname) name. phone telephoneNumber / mobile Holds the user's phone or mobile number. department departmentNumber / ou Specifies the department or organizational unit of the user. memberof memberOf Lists the groups and roles to which the user belongs. - Available fields:
login_filter- Default: (empty)
- Description: An LDAP filter to restrict which users can log in. Use
{{login_identifier}}to insert the username. For example:(&(objectClass=organizationalPerson)(mail={{login_identifier}})(!userAccountControl:1.2.840.113556.1.4.803:=2))
admin_group- Default: (empty)
- Description: A specific LDAP group whose members are considered administrators in WireGuard Portal. For example:
CN=WireGuardAdmins,OU=Some-OU,DC=YOURDOMAIN,DC=LOCAL
sync_interval- Default: (empty)
- Description: How frequently (in duration, e.g.
30m) to synchronize users from LDAP. Empty or0disables sync. Format usess,m,h,dfor seconds, minutes, hours, days, see time.ParseDuration. Only users that match thesync_filterare synchronized, ifdisable_missingistrue, users not found in LDAP are disabled.
sync_filter- Default: (empty)
- Description: An LDAP filter to select which users get synchronized into WireGuard Portal. For example:
(&(objectClass=organizationalPerson)(!userAccountControl:1.2.840.113556.1.4.803:=2)(mail=*)) -
disable_missing- Default: (empty)
- Description: If
true, any user not found in LDAP (during sync) is disabled in WireGuard Portal.
auto_re_enable- Default: (empty)
- Description: If
true, users that where disabled because they were missing (seedisable_missing) will be re-enabled once they are found again.
registration_enabled- Default: (empty)
- Description: If
true, new user accounts are created in WireGuard Portal upon first login.
log_user_info- Default: (empty)
- Description: If
true, logs LDAP user data at the trace level upon login.
- Default:
Binaries
Starting from v2, each release includes compiled binaries for supported platforms. These binary versions can be manually downloaded and installed.
Download
With curl:
curl -L -o wg-portal https://github.com/h44z/wg-portal/releases/download/${WG_PORTAL_VERSION}/wg-portal_linux_amd64
+With wget:
wget -O wg-portal https://github.com/h44z/wg-portal/releases/download/${WG_PORTAL_VERSION}/wg-portal_linux_amd64
+with gh cli:
gh release download ${WG_PORTAL_VERSION} --repo h44z/wg-portal --output wg-portal --pattern '*amd64'
+Install
sudo mkdir -p /opt/wg-portal
+sudo install wg-portal /opt/wg-portal/
+Unreleased
Unreleased versions could be downloaded from GitHub Workflow artifacs also.
Building
To build a standalone application, use the Makefile provided in the repository. Go version 1.23 or higher has to be installed to build WireGuard Portal. If you want to re-compile the frontend, NodeJS 18 and NPM >= 9 is required.
# build the frontend (optional)
-make frontend
-
-# build the binary
-make build
-Docker Container
Image Usage
The preferred way to start WireGuard Portal as Docker container is to use Docker Compose.
A sample docker-compose.yml:
version: '3.6'
+ Docker - WireGuard Portal Docker
Image Usage
The preferred way to start WireGuard Portal as Docker container is to use Docker Compose.
A sample docker-compose.yml:
---
services:
wg-portal:
image: wgportal/wg-portal:latest
+ container_name: wg-portal
restart: unless-stopped
+ logging:
+ options:
+ max-size: "10m"
+ max-file: "3"
cap_add:
- NET_ADMIN
network_mode: "host"
- ports:
- - "8888:8888"
volumes:
- /etc/wireguard:/etc/wireguard
- ./data:/app/data
- ./config:/app/config
-
By default, the webserver is listening on port 8888.
Volumes for /app/data and /app/config should be used ensure data persistence across container restarts.
Image Versioning
All images are hosted on Docker Hub at https://hub.docker.com/r/wgportal/wg-portal. There are three types of tags in the repository:
Semantic versioned tags
For example, 1.0.19.
These are official releases of WireGuard Portal. They correspond to the GitHub tags that we make, and you can see the release notes for them here: https://github.com/h44z/wg-portal/releases.
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:1.0.19, 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 v1 or 1.0.
Version 1 is currently stable, version 2 is in development.
latest
This is the most recent build to master! It changes a lot and is very unstable.
We recommend that you don't use it except for development purposes.
Branch tags
For each commit in the master and the stable branch, a corresponding Docker image is build. These images use the master or stable tags.
Configuration
You can configure WireGuard Portal using a yaml configuration file. The filepath of the yaml configuration file defaults to /app/config/config.yml. It is possible to override the configuration filepath using the environment variable WG_PORTAL_CONFIG.
By default, WireGuard Portal uses a SQLite database. The database is stored in /app/data/sqlite.db.
You should mount those directories as a volume: - /app/data - /app/config
A detailed description of the configuration options can be found here.
Kubernetes
Installing the Chart
To install the chart with the release name wg-portal:
helm install wg-portal oci://ghcr.io/h44z/charts/wg-portal
+This command deploy wg-portal on the Kubernetes cluster in the default configuration. The Values section lists the parameters that can be configured during installation.
Values
| Key | Type | Default | Description |
|---|---|---|---|
| nameOverride | string | "" | Partially override resource names (adds suffix) |
| fullnameOverride | string | "" | Fully override resource names |
| extraDeploy | list | [] | Array of extra objects to deploy with the release |
| config.advanced | tpl/object | {} | Advanced configuration options. |
| config.auth | tpl/object | {} | Auth configuration options. |
| config.core | tpl/object | {} | Core configuration options. If external admins in auth are not defined and there are no admin_user and admin_password defined here, the default credentials will be generated. |
| config.database | tpl/object | {} | Database configuration options |
| config.mail | tpl/object | {} | Mail configuration options |
| config.statistics | tpl/object | {} | Statistics configuration options |
| config.web | tpl/object | {} | Web configuration options.listening_address will be set automatically from service.web.port. external_url is required to enable ingress and certificate resources. |
| revisionHistoryLimit | string | 10 | The number of old ReplicaSets to retain to allow rollback. |
| workloadType | string | "Deployment" | Workload type - Deployment or StatefulSet |
| strategy | object | {"type":"RollingUpdate"} | Update strategy for the workload Valid values are: RollingUpdate or Recreate for Deployment, RollingUpdate or OnDelete for StatefulSet |
| image.repository | string | "ghcr.io/h44z/wg-portal" | Image repository |
| image.pullPolicy | string | "IfNotPresent" | Image pull policy |
| image.tag | string | "" | Overrides the image tag whose default is the chart appVersion |
| imagePullSecrets | list | [] | Image pull secrets |
| podAnnotations | tpl/object | {} | Extra annotations to add to the pod |
| podLabels | object | {} | Extra labels to add to the pod |
| podSecurityContext | object | {} | Pod Security Context |
| securityContext.capabilities.add | list | ["NET_ADMIN"] | Add capabilities to the container |
| initContainers | tpl/list | [] | Pod init containers |
| sidecarContainers | tpl/list | [] | Pod sidecar containers |
| dnsPolicy | string | "ClusterFirst" | Set DNS policy for the pod. Valid values are ClusterFirstWithHostNet, ClusterFirst, Default or None. |
| restartPolicy | string | "Always" | Restart policy for all containers within the pod. Valid values are Always, OnFailure or Never. |
| hostNetwork | string | false. | Use the host's network namespace. |
| resources | object | {} | Resources requests and limits |
| command | list | [] | Overwrite pod command |
| args | list | [] | Additional pod arguments |
| env | tpl/list | [] | Additional environment variables |
| envFrom | tpl/list | [] | Additional environment variables from a secret or configMap |
| livenessProbe | object | {} | Liveness probe configuration |
| readinessProbe | object | {} | Readiness probe configuration |
| startupProbe | object | {} | Startup probe configuration |
| volumes | tpl/list | [] | Additional volumes |
| volumeMounts | tpl/list | [] | Additional volumeMounts |
| nodeSelector | object | {"kubernetes.io/os":"linux"} | Node Selector configuration |
| tolerations | list | [] | Tolerations configuration |
| affinity | object | {} | Affinity configuration |
| service.mixed.enabled | bool | false | Whether to create a single service for the web and wireguard interfaces |
| service.mixed.type | string | "LoadBalancer" | Service type |
| service.web.annotations | object | {} | Annotations for the web service |
| service.web.type | string | "ClusterIP" | Web service type |
| service.web.port | int | 8888 | Web service port Used for the web interface listener |
| service.wireguard.annotations | object | {} | Annotations for the WireGuard service |
| service.wireguard.type | string | "LoadBalancer" | Wireguard service type |
| service.wireguard.ports | list | [51820] | Wireguard service ports. Exposes the WireGuard ports for created interfaces. Lowerest port is selected as start port for the first interface. Increment next port by 1 for each additional interface. |
| service.metrics.port | int | 8787 | |
| ingress.enabled | bool | false | Specifies whether an ingress resource should be created |
| ingress.className | string | "" | Ingress class name |
| ingress.annotations | object | {} | Ingress annotations |
| ingress.tls | bool | false | Ingress TLS configuration. Enable certificate resource or add ingress annotation to create required secret |
| certificate.enabled | bool | false | Specifies whether a certificate resource should be created |
| certificate.issuer.name | string | "" | Certificate issuer name |
| certificate.issuer.kind | string | "" | Certificate issuer kind (ClusterIssuer or Issuer) |
| certificate.issuer.group | string | "cert-manager.io" | Certificate issuer group |
| certificate.duration | string | "" | Optional. Documentation |
| certificate.renewBefore | string | "" | Optional. Documentation |
| certificate.commonName | string | "" | Optional. Documentation |
| certificate.emailAddresses | list | [] | Optional. Documentation |
| certificate.ipAddresses | list | [] | Optional. Documentation |
| certificate.keystores | object | {} | Optional. Documentation |
| certificate.privateKey | object | {} | Optional. Documentation |
| certificate.secretTemplate | object | {} | Optional. Documentation |
| certificate.subject | object | {} | Optional. Documentation |
| certificate.uris | list | [] | Optional. Documentation |
| certificate.usages | list | [] | Optional. Documentation |
| persistence.enabled | bool | false | Specifies whether an persistent volume should be created |
| persistence.annotations | object | {} | Persistent Volume Claim annotations |
| persistence.storageClass | string | "" | Persistent Volume storage class. If undefined (the default) cluster's default provisioner will be used. |
| persistence.accessMode | string | "ReadWriteOnce" | Persistent Volume Access Mode |
| persistence.size | string | "1Gi" | Persistent Volume size |
| serviceAccount.create | bool | true | Specifies whether a service account should be created |
| serviceAccount.annotations | object | {} | Service account annotations |
| serviceAccount.automount | bool | false | Automatically mount a ServiceAccount's API credentials |
| serviceAccount.name | string | "" | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
| monitoring.enabled | bool | false | Enable Prometheus monitoring. |
| monitoring.apiVersion | string | "monitoring.coreos.com/v1" | API version of the Prometheus resource. Use azmonitoring.coreos.com/v1 for Azure Managed Prometheus. |
| monitoring.kind | string | "PodMonitor" | Kind of the Prometheus resource. Could be PodMonitor or ServiceMonitor. |
| monitoring.labels | object | {} | Resource labels. |
| monitoring.annotations | object | {} | Resource annotations. |
| monitoring.interval | string | 1m | Interval at which metrics should be scraped. If not specified config.statistics.data_collection_interval interval is used. |
| monitoring.metricRelabelings | list | [] | Relabelings to samples before ingestion. |
| monitoring.relabelings | list | [] | Relabelings to samples before scraping. |
| monitoring.scrapeTimeout | string | "" | Timeout after which the scrape is ended If not specified, the Prometheus global scrape interval is used. |
| monitoring.jobLabel | string | "" | The label to use to retrieve the job name from. |
| monitoring.podTargetLabels | object | {} | Transfers labels on the Kubernetes Pod onto the target. |
| monitoring.dashboard.enabled | bool | false | Enable Grafana dashboard. |
| monitoring.dashboard.annotations | object | {} | Annotations for the dashboard ConfigMap. |
| monitoring.dashboard.labels | object | {} | Additional labels for the dashboard ConfigMap. |
| monitoring.dashboard.namespace | string | "" | Dashboard ConfigMap namespace Overrides the namespace for the dashboard ConfigMap. |
Sources
To build the application from source files, use the Makefile provided in the repository.
Requirements
- Git
- Make
- Go:
>=1.23.0 - NodeJS with npm:
node>=18, npm>=9
Build
# Get source code
+git clone https://github.com/h44z/wg-portal -b ${WG_PORTAL_VERSION:-master} --depth 1
+cd wg-portal
+# Build the frontend
+make frontend
+# Build the backend
+make build
+Install
Compiled binary will be available in ./dist directory.
Upgrade from V1
For production deployments of WireGuard Portal, we strongly recommend using version 1. If you want to use version 2, please be aware that it is still in beta and not feature complete.
Upgrade from v1 to v2
Before upgrading from V1, make sure that you have a backup of your currently working configuration files and database!
To start the upgrade process, start the wg-portal binary with the -migrateFrom parameter. The configuration (config.yml) for WireGuard Portal must be updated and valid before starting the upgrade.
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. For example:
./wg-portal-amd64 -migrateFromType=mysql -migrateFrom=user:pass@tcp(1.2.3.4:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local
-The upgrade will transform the old, existing database and store the values in the new database specified in the config.yml configuration file. Ensure that the new database does not contain any data!
If you are using Docker, you can adapt the docker-compose.yml file to start the upgrade process:
services:
- wg-portal:
- image: wgportal/wg-portal:latest
- # ... other settings
- restart: no
- command: ["-migrateFrom=/app/data/wg_portal.db"]
-By default WG-Portal exposes Prometheus metrics on port 8787 if interface/peer statistic data collection is enabled.
Exposed Metrics
| Metric | Type | Description |
|---|---|---|
wireguard_interface_received_bytes_total | gauge | Bytes received through the interface. |
wireguard_interface_sent_bytes_total | gauge | Bytes sent through the interface. |
wireguard_peer_last_handshake_seconds | gauge | Seconds from the last handshake with the peer. |
wireguard_peer_received_bytes_total | gauge | Bytes received from the peer. |
wireguard_peer_sent_bytes_total | gauge | Bytes sent to the peer. |
wireguard_peer_up | gauge | Peer connection state (boolean: 1/0). |
Prometheus Config
Add following scrape job to your Prometheus config file:
# prometheus.yaml
+scrape_configs:
+ - job_name: wg-portal
+ scrape_interval: 60s
+ static_configs:
+ - targets:
+ - localhost:8787 # Change localhost to IP Address or hostname with WG-Portal
+Grafana Dashboard
You may import dashboard.json into your Grafana instance.
Overview
WireGuard Portal is a simple, web based configuration portal for WireGuard. The portal uses the WireGuard wgctrl library to manage existing VPN interfaces. This allows for seamless activation or deactivation of new users, without disturbing existing VPN connections.
The configuration portal supports using a database (SQLite, MySQL, MsSQL or Postgres), OAuth or LDAP (Active Directory or OpenLDAP) as a user source for authentication and profile data.
Features
- Self-hosted - the whole application is a single binary
- Responsive web UI written in Vue.JS
- Automatically select IP from the network pool assigned to client
- QR-Code for convenient mobile client configuration
- Sent email to client with QR-code and client config
- Enable / Disable clients seamlessly
- Generation of wg-quick configuration file (
wgX.conf) if required - User authentication (database, OAuth or LDAP)
- IPv6 ready
- Docker ready
- Can be used with existing WireGuard setups
- Support for multiple WireGuard interfaces
- Peer Expiry Feature
- Handle route and DNS settings like wg-quick does
- REST API for management and client deployment
Quick-Start
The easiest way to get started is to use the provided Docker image.
Overview
WireGuard Portal is a simple, web-based configuration portal for WireGuard server management. The portal uses the WireGuard wgctrl library to manage existing VPN interfaces. This allows for the seamless activation or deactivation of new users without disturbing existing VPN connections.
The configuration portal supports using a database (SQLite, MySQL, MsSQL or Postgres), OAuth or LDAP (Active Directory or OpenLDAP) as a user source for authentication and profile data.
Features
- Self-hosted - the whole application is a single binary
- Responsive multi-language web UI written in Vue.JS
- Automatically selects IP from the network pool assigned to the client
- QR-Code for convenient mobile client configuration
- Sends email to the client with QR-code and client config
- Enable / Disable clients seamlessly
- Generation of wg-quick configuration file (
wgX.conf) if required - User authentication (database, OAuth, or LDAP)
- IPv6 ready
- Docker ready
- Can be used with existing WireGuard setups
- Support for multiple WireGuard interfaces
- Peer Expiry Feature
- Handles route and DNS settings like wg-quick does
- Exposes Prometheus metrics for monitoring and alertingt
- REST API for management and client deployment
REST API
REST API
Upgrade
For production deployments of WireGuard Portal, we strongly recommend using version 1. If you want to use version 2, please be aware that it is still in beta and not feature complete.
Upgrade from v1 to v2
To start the upgrade process, start the wg-portal binary with the -migrateFrom parameter. The configuration (config.yml) for WireGuard Portal must be updated and valid before starting the upgrade.
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. For example:
./wg-portal-amd64 -migrateFromType=mysql -migrateFrom='user:pass@tcp(1.2.3.4:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local'
+The upgrade will transform the old, existing database and store the values in the new database specified in the config.yml configuration file. Ensure that the new database does not contain any data!
If you are using Docker, you can adapt the docker-compose.yml file to start the upgrade process:
services:
+ wg-portal:
+ image: wgportal/wg-portal:latest
+ # ... other settings
+ restart: no
+ command: ["-migrateFrom=/app/data/wg_portal.db"]
+A beautiful and simple UI to manage your WireGuard peers and interfaces
WireGuard Portal is an open source web-based user interface that makes it easy to setup and manage WireGuard VPN connections. It's built on top of WireGuard's official wgctrl library.
Get started
More information about WireGuard
WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography.
WireGuard uses state-of-the-art cryptography and still manages to be as easy to configure and deploy as SSH. A combination of extremely high-speed cryptographic primitives and the fact that WireGuard lives inside the Linux kernel means that secure networking can be very high-speed. It is suitable for both small embedded devices like smartphones and fully loaded backbone routers.
Explore official documentation
Official Website
If you'd like a general conceptual overview of what WireGuard is about, read onward here.
Protocol & Cryptography
WireGuard uses state-of-the-art cryptography, like the Noise protocol framework, Curve25519, ChaCha20, Poly1305, BLAKE2, SipHash24, HKDF, and secure trusted constructions.
Client Installation
You may progress to installation and reading the quickstart instructions on how to use it.