diff --git a/master/documentation/configuration/overview/index.html b/master/documentation/configuration/overview/index.html index a07ced9..80d11e9 100644 --- a/master/documentation/configuration/overview/index.html +++ b/master/documentation/configuration/overview/index.html @@ -1,9 +1,9 @@ - Overview - WireGuard Portal
Skip to content

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 wgportal should 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-quick style 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, d for 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 uses s, ms for 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
+ Overview - WireGuard Portal      
     
      
      
     
      
     
     
     
     
      
     
     
     
     
     
      
     
     
     
     
     
    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 wgportal should 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-quick style 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, d for 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 uses s, ms for 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, d for 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, d for 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 if encryption = 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.
      •  
      
       
    • 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_identifier sub or preferred_username A unique identifier for the user. Often the OIDC sub claim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also support preferred_username if it’s unique. 
       
       email email The user’s email address as provided by the IdP. Not always verified, depending on IdP settings. 
       
       firstname given_name The user’s first name, typically provided by the IdP in the given_name claim. 
       
       lastname family_name The user’s last (family) name, typically provided by the IdP in the family_name claim. 
       
       phone phone_number The user’s phone number. This may require additional scopes/permissions from the IdP to access. 
       
       department Custom 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_admin Custom 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_groups groups or another custom claim A list of group memberships for the user. Some IdPs provide groups out 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_admin claim against a regular expression. Alternatively, a regular expression can be used to check if a user is member of a specific group listed in the user_group claim. The regular expressions are defined in admin_value_regex and admin_group_regex.
         
      • admin_value_regex: A regular expression to match the is_admin claim. By default, this expression matches the string "true" (^true$).
        •  
      • admin_group_regex: A regular expression to match the user_groups claim. Each entry in the user_groups claim 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_identifier sub or preferred_username A unique identifier for the user. Often the OIDC sub claim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also support preferred_username if it’s unique. 
       
       email email The user’s email address as provided by the IdP. Not always verified, depending on IdP settings. 
       
       firstname given_name The user’s first name, typically provided by the IdP in the given_name claim. 
       
       lastname family_name The user’s last (family) name, typically provided by the IdP in the family_name claim. 
       
       phone phone_number The user’s phone number. This may require additional scopes/permissions from the IdP to access. 
       
       department Custom 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_admin Custom 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_groups groups or another custom claim A list of group memberships for the user. Some IdPs provide groups out 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_admin claim against a regular expression. Alternatively, a regular expression can be used to check if a user is member of a specific group listed in the user_group claim. The regular expressions are defined in admin_value_regex and admin_group_regex.
      •  
    • admin_value_regex: A regular expression to match the is_admin claim. By default, this expression matches the string "true" (^true$).
      •  
    • admin_group_regex: A regular expression to match the user_groups claim. Each entry in the user_groups claim 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_wireguard or ldap_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. 
              
       
      •  
     
    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 or 0 disables sync. Format uses s, m, h, d for seconds, minutes, hours, days, see time.ParseDuration. Only users that match the sync_filter are synchronized, if disable_missing is true, 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.
      •  
     
    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.
      •