Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-04-19 08:55:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
wg-portal/v2.0.0-beta.4/documentation/configuration/overview/index.html

70 lines
76 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="no-js" lang="en"> <head><meta charset="utf-8"/><meta content="width=device-width,initial-scale=1" name="viewport"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." name="description"/><link href="https://wgportal.org/v2.0.0-beta.4/documentation/configuration/overview/" rel="canonical"/><link href="../../getting-started/upgrade/" rel="prev"/><link href="../examples/" rel="next"/><link href="../../../assets/images/favicon-large.png" rel="icon"/><meta content="mkdocs-1.6.1, mkdocs-material-9.5.50" name="generator"/><title>Overview - WireGuard Portal</title><link href="../../../assets/stylesheets/main.a40c8224.min.css" rel="stylesheet"/><link href="../../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/><link href="../../../stylesheets/extra.css" rel="stylesheet"/><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta content="website" property="og:type"/><meta content="Overview - WireGuard Portal" property="og:title"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." property="og:description"/><meta content="https://wgportal.org/v2.0.0-beta.4/assets/images/social/documentation/configuration/overview.png" property="og:image"/><meta content="image/png" property="og:image:type"/><meta content="1200" property="og:image:width"/><meta content="630" property="og:image:height"/><meta content="https://wgportal.org/v2.0.0-beta.4/documentation/configuration/overview/" property="og:url"/><meta content="summary_large_image" name="twitter:card"/><meta content="Overview - WireGuard Portal" name="twitter:title"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." name="twitter:description"/><meta content="https://wgportal.org/v2.0.0-beta.4/assets/images/social/documentation/configuration/overview.png" name="twitter:image"/></head> <body data-md-color-accent="indigo" data-md-color-primary="white" data-md-color-scheme="default" dir="ltr"> <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/> <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a class="md-skip" href="#wireguard-portal-configuration"> Skip to content </a> </div> <div data-md-component="announce"> </div> <div data-md-color-scheme="default" data-md-component="outdated" hidden=""> </div> <header class="md-header" data-md-component="header"> <nav aria-label="Header" class="md-header__inner md-grid"> <a aria-label="WireGuard Portal" class="md-header__button md-logo" data-md-component="logo" href="../../.." title="WireGuard Portal"> <img alt="logo" src="../../../assets/images/logo.svg"/> </a> <label class="md-header__button md-icon" for="__drawer"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> WireGuard Portal </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> Overview </span> </div> </div> </div> <label class="md-header__button md-icon" for="__search"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/> <label class="md-search__icon md-icon" for="__search"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg> </label> <nav aria-label="Search" class="md-search__options"> <button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" data-md-scrollfix="" tabindex="0"> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a class="md-source" data-md-component="source" href="https://github.com/h44z/wg-portal" title="Go to repository"> <div class="md-source__icon md-icon"> <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg> </div> <div class="md-source__repository"> h44z/wg-portal </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <nav aria-label="Tabs" class="md-tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a class="md-tabs__link" href="../../.."> Home </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a class="md-tabs__link" href="../../overview/"> Documentation </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav aria-label="Navigation" class="md-nav md-nav--primary md-nav--lifted" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a aria-label="WireGuard Portal" class="md-nav__button md-logo" data-md-component="logo" href="../../.." title="WireGuard Portal"> <img alt="logo" src="../../../assets/images/logo.svg"/> </a> WireGuard Portal </label> <div class="md-nav__source"> <a class="md-source" data-md-component="source" href="https://github.com/h44z/wg-portal" title="Go to repository"> <div class="md-source__icon md-icon"> <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg> </div> <div class="md-source__repository"> h44z/wg-portal </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../.."> <span class="md-ellipsis"> Home </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input checked="" class="md-nav__toggle md-toggle" id="__nav_2" type="checkbox"/> <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex=""> <span class="md-ellipsis"> Documentation </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="true" aria-labelledby="__nav_2_label" class="md-nav" data-md-level="1"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Documentation </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" id="__nav_2_2" type="checkbox"/> <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0"> <span class="md-ellipsis"> Getting Started </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="false" aria-labelledby="__nav_2_2_label" class="md-nav" data-md-level="2"> <label class="md-nav__title" for="__nav_2_2"> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/building/"> <span class="md-ellipsis"> Building </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/docker/"> <span class="md-ellipsis"> Docker Container </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/upgrade/"> <span class="md-ellipsis"> Upgrade from V1 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input checked="" class="md-nav__toggle md-toggle" id="__nav_2_3" type="checkbox"/> <label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="0"> <span class="md-ellipsis"> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="true" aria-labelledby="__nav_2_3_label" class="md-nav" data-md-level="2"> <label class="md-nav__title" for="__nav_2_3"> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/> <label class="md-nav__link md-nav__link--active" for="__toc"> <span class="md-ellipsis"> Overview </span> <span class="md-nav__icon md-icon"></span> </label> <a class="md-nav__link md-nav__link--active" href="./"> <span class="md-ellipsis"> Overview </span> </a> <nav aria-label="Table of contents" class="md-nav md-nav--secondary"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="#core"> <span class="md-ellipsis"> Core </span> </a> <nav aria-label="Core" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_user"> <span class="md-ellipsis"> admin_user </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_password"> <span class="md-ellipsis"> admin_password </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#editable_keys"> <span class="md-ellipsis"> editable_keys </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#create_default_peer"> <span class="md-ellipsis"> create_default_peer </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#create_default_peer_on_creation"> <span class="md-ellipsis"> create_default_peer_on_creation </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#re_enable_peer_after_user_enable"> <span class="md-ellipsis"> re_enable_peer_after_user_enable </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#delete_peer_after_user_deleted"> <span class="md-ellipsis"> delete_peer_after_user_deleted </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#self_provisioning_allowed"> <span class="md-ellipsis"> self_provisioning_allowed </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#import_existing"> <span class="md-ellipsis"> import_existing </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#restore_state"> <span class="md-ellipsis"> restore_state </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#advanced"> <span class="md-ellipsis"> Advanced </span> </a> <nav aria-label="Advanced" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#log_level"> <span class="md-ellipsis"> log_level </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_pretty"> <span class="md-ellipsis"> log_pretty </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_json"> <span class="md-ellipsis"> log_json </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_listen_port"> <span class="md-ellipsis"> start_listen_port </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_cidr_v4"> <span class="md-ellipsis"> start_cidr_v4 </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_cidr_v6"> <span class="md-ellipsis"> start_cidr_v6 </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#use_ip_v6"> <span class="md-ellipsis"> use_ip_v6 </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#config_storage_path"> <span class="md-ellipsis"> config_storage_path </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#expiry_check_interval"> <span class="md-ellipsis"> expiry_check_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#rule_prio_offset"> <span class="md-ellipsis"> rule_prio_offset </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#route_table_offset"> <span class="md-ellipsis"> route_table_offset </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#api_admin_only"> <span class="md-ellipsis"> api_admin_only </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#database"> <span class="md-ellipsis"> Database </span> </a> <nav aria-label="Database" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#debug"> <span class="md-ellipsis"> debug </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#slow_query_threshold"> <span class="md-ellipsis"> slow_query_threshold </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#type"> <span class="md-ellipsis"> type </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#dsn"> <span class="md-ellipsis"> dsn </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#statistics"> <span class="md-ellipsis"> Statistics </span> </a> <nav aria-label="Statistics" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#use_ping_checks"> <span class="md-ellipsis"> use_ping_checks </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ping_check_workers"> <span class="md-ellipsis"> ping_check_workers </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ping_unprivileged"> <span class="md-ellipsis"> ping_unprivileged </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ping_check_interval"> <span class="md-ellipsis"> ping_check_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#data_collection_interval"> <span class="md-ellipsis"> data_collection_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#collect_interface_data"> <span class="md-ellipsis"> collect_interface_data </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#collect_peer_data"> <span class="md-ellipsis"> collect_peer_data </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#collect_audit_data"> <span class="md-ellipsis"> collect_audit_data </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#listening_address"> <span class="md-ellipsis"> listening_address </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#mail"> <span class="md-ellipsis"> Mail </span> </a> <nav aria-label="Mail" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#host"> <span class="md-ellipsis"> host </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#port"> <span class="md-ellipsis"> port </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#encryption"> <span class="md-ellipsis"> encryption </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#cert_validation"> <span class="md-ellipsis"> cert_validation </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#username"> <span class="md-ellipsis"> username </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#password"> <span class="md-ellipsis"> password </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#auth_type"> <span class="md-ellipsis"> auth_type </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#from"> <span class="md-ellipsis"> from </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#link_only"> <span class="md-ellipsis"> link_only </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#auth"> <span class="md-ellipsis"> Auth </span> </a> <nav aria-label="Auth" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#oidc-provider-properties"> <span class="md-ellipsis"> OIDC Provider Properties </span> </a> <nav aria-label="OIDC Provider Properties" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#provider_name"> <span class="md-ellipsis"> provider_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#display_name"> <span class="md-ellipsis"> display_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#base_url"> <span class="md-ellipsis"> base_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_id"> <span class="md-ellipsis"> client_id </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_secret"> <span class="md-ellipsis"> client_secret </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#extra_scopes"> <span class="md-ellipsis"> extra_scopes </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#field_map"> <span class="md-ellipsis"> field_map </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_mapping"> <span class="md-ellipsis"> admin_mapping </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#registration_enabled"> <span class="md-ellipsis"> registration_enabled </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_user_info"> <span class="md-ellipsis"> log_user_info </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#oauth-provider-properties"> <span class="md-ellipsis"> OAuth Provider Properties </span> </a> <nav aria-label="OAuth Provider Properties" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#provider_name_1"> <span class="md-ellipsis"> provider_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#display_name_1"> <span class="md-ellipsis"> display_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_id_1"> <span class="md-ellipsis"> client_id </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_secret_1"> <span class="md-ellipsis"> client_secret </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#auth_url"> <span class="md-ellipsis"> auth_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#token_url"> <span class="md-ellipsis"> token_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#user_info_url"> <span class="md-ellipsis"> user_info_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#scopes"> <span class="md-ellipsis"> scopes </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#field_map_1"> <span class="md-ellipsis"> field_map </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_mapping_1"> <span class="md-ellipsis"> admin_mapping </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#registration_enabled_1"> <span class="md-ellipsis"> registration_enabled </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_user_info_1"> <span class="md-ellipsis"> log_user_info </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ldap-provider-properties"> <span class="md-ellipsis"> LDAP Provider Properties </span> </a> <nav aria-label="LDAP Provider Properties" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#url"> <span class="md-ellipsis"> url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_tls"> <span class="md-ellipsis"> start_tls </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#cert_validation_1"> <span class="md-ellipsis"> cert_validation </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#tls_certificate_path"> <span class="md-ellipsis"> tls_certificate_path </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#tls_key_path"> <span class="md-ellipsis"> tls_key_path </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#base_dn"> <span class="md-ellipsis"> base_dn </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#bind_user"> <span class="md-ellipsis"> bind_user </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#bind_pass"> <span class="md-ellipsis"> bind_pass </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#field_map_2"> <span class="md-ellipsis"> field_map </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#login_filter"> <span class="md-ellipsis"> login_filter </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_group"> <span class="md-ellipsis"> admin_group </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#sync_interval"> <span class="md-ellipsis"> sync_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#sync_filter"> <span class="md-ellipsis"> sync_filter </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#disable_missing"> <span class="md-ellipsis"> disable_missing </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#registration_enabled_2"> <span class="md-ellipsis"> registration_enabled </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_user_info_2"> <span class="md-ellipsis"> log_user_info </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../examples/"> <span class="md-ellipsis"> Examples </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../rest-api/api-doc/"> <span class="md-ellipsis"> REST API </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav aria-label="Table of contents" class="md-nav md-nav--secondary"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="#core"> <span class="md-ellipsis"> Core </span> </a> <nav aria-label="Core" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_user"> <span class="md-ellipsis"> admin_user </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_password"> <span class="md-ellipsis"> admin_password </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#editable_keys"> <span class="md-ellipsis"> editable_keys </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#create_default_peer"> <span class="md-ellipsis"> create_default_peer </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#create_default_peer_on_creation"> <span class="md-ellipsis"> create_default_peer_on_creation </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#re_enable_peer_after_user_enable"> <span class="md-ellipsis"> re_enable_peer_after_user_enable </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#delete_peer_after_user_deleted"> <span class="md-ellipsis"> delete_peer_after_user_deleted </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#self_provisioning_allowed"> <span class="md-ellipsis"> self_provisioning_allowed </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#import_existing"> <span class="md-ellipsis"> import_existing </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#restore_state"> <span class="md-ellipsis"> restore_state </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#advanced"> <span class="md-ellipsis"> Advanced </span> </a> <nav aria-label="Advanced" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#log_level"> <span class="md-ellipsis"> log_level </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_pretty"> <span class="md-ellipsis"> log_pretty </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_json"> <span class="md-ellipsis"> log_json </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_listen_port"> <span class="md-ellipsis"> start_listen_port </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_cidr_v4"> <span class="md-ellipsis"> start_cidr_v4 </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_cidr_v6"> <span class="md-ellipsis"> start_cidr_v6 </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#use_ip_v6"> <span class="md-ellipsis"> use_ip_v6 </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#config_storage_path"> <span class="md-ellipsis"> config_storage_path </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#expiry_check_interval"> <span class="md-ellipsis"> expiry_check_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#rule_prio_offset"> <span class="md-ellipsis"> rule_prio_offset </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#route_table_offset"> <span class="md-ellipsis"> route_table_offset </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#api_admin_only"> <span class="md-ellipsis"> api_admin_only </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#database"> <span class="md-ellipsis"> Database </span> </a> <nav aria-label="Database" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#debug"> <span class="md-ellipsis"> debug </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#slow_query_threshold"> <span class="md-ellipsis"> slow_query_threshold </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#type"> <span class="md-ellipsis"> type </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#dsn"> <span class="md-ellipsis"> dsn </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#statistics"> <span class="md-ellipsis"> Statistics </span> </a> <nav aria-label="Statistics" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#use_ping_checks"> <span class="md-ellipsis"> use_ping_checks </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ping_check_workers"> <span class="md-ellipsis"> ping_check_workers </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ping_unprivileged"> <span class="md-ellipsis"> ping_unprivileged </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ping_check_interval"> <span class="md-ellipsis"> ping_check_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#data_collection_interval"> <span class="md-ellipsis"> data_collection_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#collect_interface_data"> <span class="md-ellipsis"> collect_interface_data </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#collect_peer_data"> <span class="md-ellipsis"> collect_peer_data </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#collect_audit_data"> <span class="md-ellipsis"> collect_audit_data </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#listening_address"> <span class="md-ellipsis"> listening_address </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#mail"> <span class="md-ellipsis"> Mail </span> </a> <nav aria-label="Mail" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#host"> <span class="md-ellipsis"> host </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#port"> <span class="md-ellipsis"> port </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#encryption"> <span class="md-ellipsis"> encryption </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#cert_validation"> <span class="md-ellipsis"> cert_validation </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#username"> <span class="md-ellipsis"> username </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#password"> <span class="md-ellipsis"> password </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#auth_type"> <span class="md-ellipsis"> auth_type </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#from"> <span class="md-ellipsis"> from </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#link_only"> <span class="md-ellipsis"> link_only </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#auth"> <span class="md-ellipsis"> Auth </span> </a> <nav aria-label="Auth" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#oidc-provider-properties"> <span class="md-ellipsis"> OIDC Provider Properties </span> </a> <nav aria-label="OIDC Provider Properties" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#provider_name"> <span class="md-ellipsis"> provider_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#display_name"> <span class="md-ellipsis"> display_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#base_url"> <span class="md-ellipsis"> base_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_id"> <span class="md-ellipsis"> client_id </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_secret"> <span class="md-ellipsis"> client_secret </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#extra_scopes"> <span class="md-ellipsis"> extra_scopes </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#field_map"> <span class="md-ellipsis"> field_map </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_mapping"> <span class="md-ellipsis"> admin_mapping </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#registration_enabled"> <span class="md-ellipsis"> registration_enabled </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_user_info"> <span class="md-ellipsis"> log_user_info </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#oauth-provider-properties"> <span class="md-ellipsis"> OAuth Provider Properties </span> </a> <nav aria-label="OAuth Provider Properties" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#provider_name_1"> <span class="md-ellipsis"> provider_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#display_name_1"> <span class="md-ellipsis"> display_name </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_id_1"> <span class="md-ellipsis"> client_id </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#client_secret_1"> <span class="md-ellipsis"> client_secret </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#auth_url"> <span class="md-ellipsis"> auth_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#token_url"> <span class="md-ellipsis"> token_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#user_info_url"> <span class="md-ellipsis"> user_info_url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#scopes"> <span class="md-ellipsis"> scopes </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#field_map_1"> <span class="md-ellipsis"> field_map </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_mapping_1"> <span class="md-ellipsis"> admin_mapping </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#registration_enabled_1"> <span class="md-ellipsis"> registration_enabled </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_user_info_1"> <span class="md-ellipsis"> log_user_info </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#ldap-provider-properties"> <span class="md-ellipsis"> LDAP Provider Properties </span> </a> <nav aria-label="LDAP Provider Properties" class="md-nav"> <ul class="md-nav__list"> <li class="md-nav__item"> <a class="md-nav__link" href="#url"> <span class="md-ellipsis"> url </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#start_tls"> <span class="md-ellipsis"> start_tls </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#cert_validation_1"> <span class="md-ellipsis"> cert_validation </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#tls_certificate_path"> <span class="md-ellipsis"> tls_certificate_path </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#tls_key_path"> <span class="md-ellipsis"> tls_key_path </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#base_dn"> <span class="md-ellipsis"> base_dn </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#bind_user"> <span class="md-ellipsis"> bind_user </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#bind_pass"> <span class="md-ellipsis"> bind_pass </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#field_map_2"> <span class="md-ellipsis"> field_map </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#login_filter"> <span class="md-ellipsis"> login_filter </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#admin_group"> <span class="md-ellipsis"> admin_group </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#sync_interval"> <span class="md-ellipsis"> sync_interval </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#sync_filter"> <span class="md-ellipsis"> sync_filter </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#disable_missing"> <span class="md-ellipsis"> disable_missing </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#registration_enabled_2"> <span class="md-ellipsis"> registration_enabled </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#log_user_info_2"> <span class="md-ellipsis"> log_user_info </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="wireguard-portal-configuration">WireGuard Portal Configuration</h1> <p>This page provides an overview of <strong>all available configuration options</strong> for WireGuard Portal. You can supply these configurations in a <strong>YAML</strong> file (e.g. <code>config.yaml</code>) when starting the Portal. Complete configuration examples are available in the <a href="../examples/">Configuration Examples</a> page.</p> <p>Below you will find sections like <code>core</code>, <code>advanced</code>, <code>statistics</code>, <code>mail</code>, <code>auth</code>, <code>database</code>, and <code>web</code>.<br/> Each section describes the individual configuration keys, their default values, and a brief explanation of their purpose.</p> <hr/> <h2 id="core">Core</h2> <p>These are the primary configuration options that control fundamental WireGuard Portal behavior. More advanced options are found in the subsequent <code>Advanced</code> section.</p> <h3 id="admin_user"><code>admin_user</code></h3> <ul> <li><strong>Default:</strong> <code>admin@wgportal.local</code></li> <li><strong>Description:</strong> The administrator user. This user will be created as a default admin if it does not yet exist.</li> </ul> <h3 id="admin_password"><code>admin_password</code></h3> <ul> <li><strong>Default:</strong> <code>wgportal</code></li> <li><strong>Description:</strong> The administrator password. The default password of <code>wgportal</code> should be changed immediately.</li> </ul> <h3 id="editable_keys"><code>editable_keys</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> Allow editing of WireGuard key-pairs directly in the UI.</li> </ul> <h3 id="create_default_peer"><code>create_default_peer</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If a user logs in for the first time with no existing peers, automatically create a new WireGuard peer for <strong>all</strong> server interfaces.</li> </ul> <h3 id="create_default_peer_on_creation"><code>create_default_peer_on_creation</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If an LDAP user is created (e.g., through LDAP sync) and has no peers, automatically create a new WireGuard peer for <strong>all</strong> server interfaces.</li> </ul> <h3 id="re_enable_peer_after_user_enable"><code>re_enable_peer_after_user_enable</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> Re-enable all peers that were previously disabled if the associated user is re-enabled.</li> </ul> <h3 id="delete_peer_after_user_deleted"><code>delete_peer_after_user_deleted</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If a user is deleted, remove all linked peers. Otherwise, peers remain but are disabled.</li> </ul> <h3 id="self_provisioning_allowed"><code>self_provisioning_allowed</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> Allow registered (non-admin) users to self-provision peers from their profile page.</li> </ul> <h3 id="import_existing"><code>import_existing</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> On startup, import existing WireGuard interfaces and peers into WireGuard Portal.</li> </ul> <h3 id="restore_state"><code>restore_state</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> Restore the WireGuard interface states (up/down) that existed before WireGuard Portal started.</li> </ul> <hr/> <h2 id="advanced">Advanced</h2> <p>Additional or more specialized configuration options for logging and interface creation details.</p> <h3 id="log_level"><code>log_level</code></h3> <ul> <li><strong>Default:</strong> <code>info</code></li> <li><strong>Description:</strong> The log level used by the application. Valid options are: <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code>, <code>error</code>.</li> </ul> <h3 id="log_pretty"><code>log_pretty</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If <code>true</code>, log messages are colorized and formatted for readability (pretty-print).</li> </ul> <h3 id="log_json"><code>log_json</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If <code>true</code>, log messages are structured in JSON format.</li> </ul> <h3 id="start_listen_port"><code>start_listen_port</code></h3> <ul> <li><strong>Default:</strong> <code>51820</code></li> <li><strong>Description:</strong> The first port to use when automatically creating new WireGuard interfaces.</li> </ul> <h3 id="start_cidr_v4"><code>start_cidr_v4</code></h3> <ul> <li><strong>Default:</strong> <code>10.11.12.0/24</code></li> <li><strong>Description:</strong> The initial IPv4 subnet to use when automatically creating new WireGuard interfaces.</li> </ul> <h3 id="start_cidr_v6"><code>start_cidr_v6</code></h3> <ul> <li><strong>Default:</strong> <code>fdfd:d3ad:c0de:1234::0/64</code></li> <li><strong>Description:</strong> The initial IPv6 subnet to use when automatically creating new WireGuard interfaces.</li> </ul> <h3 id="use_ip_v6"><code>use_ip_v6</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> Enable or disable IPv6 support.</li> </ul> <h3 id="config_storage_path"><code>config_storage_path</code></h3> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Path to a directory where <code>wg-quick</code> style configuration files will be stored (if you need local filesystem configs).</li> </ul> <h3 id="expiry_check_interval"><code>expiry_check_interval</code></h3> <ul> <li><strong>Default:</strong> <code>15m</code></li> <li><strong>Description:</strong> Interval after which existing peers are checked if they are expired. Format uses <code>s</code>, <code>m</code>, <code>h</code>, <code>d</code> for seconds, minutes, hours, days, see <a href="https://golang.org/pkg/time/#ParseDuration">time.ParseDuration</a>.</li> </ul> <h3 id="rule_prio_offset"><code>rule_prio_offset</code></h3> <ul> <li><strong>Default:</strong> <code>20000</code></li> <li><strong>Description:</strong> Offset for IP route rule priorities when configuring routing.</li> </ul> <h3 id="route_table_offset"><code>route_table_offset</code></h3> <ul> <li><strong>Default:</strong> <code>20000</code></li> <li><strong>Description:</strong> Offset for IP route table IDs when configuring routing.</li> </ul> <h3 id="api_admin_only"><code>api_admin_only</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> If <code>true</code>, the public REST API is accessible only to admin users. The API docs live at <a href="../../rest-api/api-doc/"><code>/api/v1/doc.html</code></a>.</li> </ul> <hr/> <h2 id="database">Database</h2> <p>Configuration for the underlying database used by WireGuard Portal. Supported databases include SQLite, MySQL, Microsoft SQL Server, and Postgres.</p> <h3 id="debug"><code>debug</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If <code>true</code>, logs all database statements (verbose).</li> </ul> <h3 id="slow_query_threshold"><code>slow_query_threshold</code></h3> <ul> <li><strong>Default:</strong> 0</li> <li><strong>Description:</strong> A time threshold (e.g., <code>100ms</code>) above which queries are considered slow and logged as warnings. If empty or zero, slow query logging is disabled. Format uses <code>s</code>, <code>ms</code> for seconds, milliseconds, see <a href="https://golang.org/pkg/time/#ParseDuration">time.ParseDuration</a>.</li> </ul> <h3 id="type"><code>type</code></h3> <ul> <li><strong>Default:</strong> <code>sqlite</code></li> <li><strong>Description:</strong> The database type. Valid options: <code>sqlite</code>, <code>mssql</code>, <code>mysql</code>, <code>postgres</code>.</li> </ul> <h3 id="dsn"><code>dsn</code></h3> <ul> <li><strong>Default:</strong> <code>data/sqlite.db</code></li> <li><strong>Description:</strong> The Data Source Name (DSN) for connecting to the database.<br/> For example: <div class="highlight"><pre><span></span><code>user:pass@tcp(1.2.3.4:3306)/dbname?charset=utf8mb4&amp;parseTime=True&amp;loc=Local
</code></pre></div></li> </ul> <hr/> <h2 id="statistics">Statistics</h2> <p>Controls how WireGuard Portal collects and reports usage statistics, including ping checks and Prometheus metrics.</p> <h3 id="use_ping_checks"><code>use_ping_checks</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> Enable periodic ping checks to verify that peers remain responsive.</li> </ul> <h3 id="ping_check_workers"><code>ping_check_workers</code></h3> <ul> <li><strong>Default:</strong> <code>10</code></li> <li><strong>Description:</strong> Number of parallel worker processes for ping checks.</li> </ul> <h3 id="ping_unprivileged"><code>ping_unprivileged</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If <code>false</code>, ping checks run without root privileges. This is currently considered BETA.</li> </ul> <h3 id="ping_check_interval"><code>ping_check_interval</code></h3> <ul> <li><strong>Default:</strong> <code>1m</code></li> <li><strong>Description:</strong> Interval between consecutive ping checks for all peers. Format uses <code>s</code>, <code>m</code>, <code>h</code>, <code>d</code> for seconds, minutes, hours, days, see <a href="https://golang.org/pkg/time/#ParseDuration">time.ParseDuration</a>.</li> </ul> <h3 id="data_collection_interval"><code>data_collection_interval</code></h3> <ul> <li><strong>Default:</strong> <code>1m</code></li> <li><strong>Description:</strong> Interval between data collection cycles (bytes sent/received, handshake times, etc.). Format uses <code>s</code>, <code>m</code>, <code>h</code>, <code>d</code> for seconds, minutes, hours, days, see <a href="https://golang.org/pkg/time/#ParseDuration">time.ParseDuration</a>.</li> </ul> <h3 id="collect_interface_data"><code>collect_interface_data</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> If <code>true</code>, collects interface-level data (bytes in/out) for monitoring and statistics.</li> </ul> <h3 id="collect_peer_data"><code>collect_peer_data</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> If <code>true</code>, collects peer-level data (bytes, last handshake, endpoint, etc.).</li> </ul> <h3 id="collect_audit_data"><code>collect_audit_data</code></h3> <ul> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Description:</strong> If <code>true</code>, logs certain portal events (such as user logins) to the database.</li> </ul> <h3 id="listening_address"><code>listening_address</code></h3> <ul> <li><strong>Default:</strong> <code>:8787</code></li> <li><strong>Description:</strong> Address and port for the integrated Prometheus metric server (e.g., <code>:8787</code>).</li> </ul> <hr/> <h2 id="mail">Mail</h2> <p>Options for configuring email notifications or sending peer configurations via email.</p> <h3 id="host"><code>host</code></h3> <ul> <li><strong>Default:</strong> <code>127.0.0.1</code></li> <li><strong>Description:</strong> Hostname or IP of the SMTP server.</li> </ul> <h3 id="port"><code>port</code></h3> <ul> <li><strong>Default:</strong> <code>25</code></li> <li><strong>Description:</strong> Port number for the SMTP server.</li> </ul> <h3 id="encryption"><code>encryption</code></h3> <ul> <li><strong>Default:</strong> <code>none</code></li> <li><strong>Description:</strong> SMTP encryption type. Valid values: <code>none</code>, <code>tls</code>, <code>starttls</code>.</li> </ul> <h3 id="cert_validation"><code>cert_validation</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If <code>true</code>, validate the SMTP server certificate (relevant if <code>encryption</code> = <code>tls</code>).</li> </ul> <h3 id="username"><code>username</code></h3> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Optional SMTP username for authentication.</li> </ul> <h3 id="password"><code>password</code></h3> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Optional SMTP password for authentication.</li> </ul> <h3 id="auth_type"><code>auth_type</code></h3> <ul> <li><strong>Default:</strong> <code>plain</code></li> <li><strong>Description:</strong> SMTP authentication type. Valid values: <code>plain</code>, <code>login</code>, <code>crammd5</code>.</li> </ul> <h3 id="from"><code>from</code></h3> <ul> <li><strong>Default:</strong> <code>Wireguard Portal &lt;noreply@wireguard.local&gt;</code></li> <li><strong>Description:</strong> The default "From" address when sending emails.</li> </ul> <h3 id="link_only"><code>link_only</code></h3> <ul> <li><strong>Default:</strong> <code>false</code></li> <li><strong>Description:</strong> If <code>true</code>, emails only contain a link to WireGuard Portal, rather than attaching the full configuration.</li> </ul> <hr/> <h2 id="auth">Auth</h2> <p>WireGuard Portal supports multiple authentication strategies, including <strong>OpenID Connect</strong> (<code>oidc</code>), <strong>OAuth</strong> (<code>oauth</code>), and <strong>LDAP</strong> (<code>ldap</code>). Each can have multiple providers configured. Below are the relevant keys.</p> <hr/> <h3 id="oidc-provider-properties">OIDC Provider Properties</h3> <p>The <code>oidc</code> array contains a list of OpenID Connect providers. Below are the properties for each OIDC provider entry inside <code>auth.oidc</code>:</p> <h4 id="provider_name"><code>provider_name</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A <strong>unique</strong> name for this provider. Must not conflict with other providers.</li> </ul> <h4 id="display_name"><code>display_name</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A user-friendly name shown on the login page (e.g., "Login with Google").</li> </ul> <h4 id="base_url"><code>base_url</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The OIDC provider’s base URL (e.g., <code>https://accounts.google.com</code>).</li> </ul> <h4 id="client_id"><code>client_id</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The OAuth client ID from the OIDC provider.</li> </ul> <h4 id="client_secret"><code>client_secret</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The OAuth client secret from the OIDC provider.</li> </ul> <h4 id="extra_scopes"><code>extra_scopes</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A list of additional OIDC scopes (e.g., <code>profile</code>, <code>email</code>).</li> </ul> <h4 id="field_map"><code>field_map</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Maps OIDC claims to WireGuard Portal user fields. </li> <li> <p>Available fields: <code>user_identifier</code>, <code>email</code>, <code>firstname</code>, <code>lastname</code>, <code>phone</code>, <code>department</code>, <code>is_admin</code>, <code>user_groups</code>.</p> <table> <thead> <tr> <th><strong>Field</strong></th> <th><strong>Typical OIDC Claim</strong></th> <th><strong>Explanation</strong></th> </tr> </thead> <tbody> <tr> <td><code>user_identifier</code></td> <td><code>sub</code> or <code>preferred_username</code></td> <td>A unique identifier for the user. Often the OIDC <code>sub</code> claim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also support <code>preferred_username</code> if it’s unique.</td> </tr> <tr> <td><code>email</code></td> <td><code>email</code></td> <td>The user’s email address as provided by the IdP. Not always verified, depending on IdP settings.</td> </tr> <tr> <td><code>firstname</code></td> <td><code>given_name</code></td> <td>The user’s first name, typically provided by the IdP in the <code>given_name</code> claim.</td> </tr> <tr> <td><code>lastname</code></td> <td><code>family_name</code></td> <td>The user’s last (family) name, typically provided by the IdP in the <code>family_name</code> claim.</td> </tr> <tr> <td><code>phone</code></td> <td><code>phone_number</code></td> <td>The user’s phone number. This may require additional scopes/permissions from the IdP to access.</td> </tr> <tr> <td><code>department</code></td> <td>Custom claim (e.g., <code>department</code>)</td> <td>If the IdP can provide organizational data, it may store it in a custom claim. Adjust accordingly (e.g., <code>department</code>, <code>org</code>, or another attribute).</td> </tr> <tr> <td><code>is_admin</code></td> <td>Custom claim or derived role</td> <td>If the IdP returns a role or admin flag, you can map that to <code>is_admin</code>. Often this is managed through custom claims or group membership.</td> </tr> <tr> <td><code>user_groups</code></td> <td><code>groups</code> or another custom claim</td> <td>A list of group memberships for the user. Some IdPs provide <code>groups</code> out of the box; others require custom claims or directory lookups.</td> </tr> </tbody> </table> </li> </ul> <h4 id="admin_mapping"><code>admin_mapping</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> WgPortal can grant a user admin rights by matching the value of the <code>is_admin</code> 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 <code>user_group</code> claim. The regular expressions are defined in <code>admin_value_regex</code> and <code>admin_group_regex</code>.<ul> <li><code>admin_value_regex</code>: A regular expression to match the <code>is_admin</code> claim. By default, this expression matches the string "true" (<code>^true$</code>).</li> <li><code>admin_group_regex</code>: A regular expression to match the <code>user_groups</code> claim. Each entry in the <code>user_groups</code> claim is checked against this regex.</li> </ul> </li> </ul> <h4 id="registration_enabled"><code>registration_enabled</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, a new user will be created in WireGuard Portal if not already present.</li> </ul> <h4 id="log_user_info"><code>log_user_info</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, OIDC user data is logged at the trace level upon login (for debugging).</li> </ul> <hr/> <h3 id="oauth-provider-properties">OAuth Provider Properties</h3> <p>The <code>oauth</code> array contains a list of plain OAuth2 providers. Below are the properties for each OAuth provider entry inside <code>auth.oauth</code>:</p> <h4 id="provider_name_1"><code>provider_name</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A <strong>unique</strong> name for this provider. Must not conflict with other providers.</li> </ul> <h4 id="display_name_1"><code>display_name</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A user-friendly name shown on the login page.</li> </ul> <h4 id="client_id_1"><code>client_id</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The OAuth client ID for the provider.</li> </ul> <h4 id="client_secret_1"><code>client_secret</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The OAuth client secret for the provider.</li> </ul> <h4 id="auth_url"><code>auth_url</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> URL of the authentication endpoint.</li> </ul> <h4 id="token_url"><code>token_url</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> URL of the token endpoint.</li> </ul> <h4 id="user_info_url"><code>user_info_url</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> URL of the user information endpoint.</li> </ul> <h4 id="scopes"><code>scopes</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A list of OAuth scopes.</li> </ul> <h4 id="field_map_1"><code>field_map</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Maps OAuth attributes to WireGuard Portal fields.</li> <li> <p>Available fields: <code>user_identifier</code>, <code>email</code>, <code>firstname</code>, <code>lastname</code>, <code>phone</code>, <code>department</code>, <code>is_admin</code>, <code>user_groups</code>.</p> <table> <thead> <tr> <th><strong>Field</strong></th> <th><strong>Typical Claim</strong></th> <th><strong>Explanation</strong></th> </tr> </thead> <tbody> <tr> <td><code>user_identifier</code></td> <td><code>sub</code> or <code>preferred_username</code></td> <td>A unique identifier for the user. Often the OIDC <code>sub</code> claim is used because it’s guaranteed to be unique for the user within the IdP. Some providers also support <code>preferred_username</code> if it’s unique.</td> </tr> <tr> <td><code>email</code></td> <td><code>email</code></td> <td>The user’s email address as provided by the IdP. Not always verified, depending on IdP settings.</td> </tr> <tr> <td><code>firstname</code></td> <td><code>given_name</code></td> <td>The user’s first name, typically provided by the IdP in the <code>given_name</code> claim.</td> </tr> <tr> <td><code>lastname</code></td> <td><code>family_name</code></td> <td>The user’s last (family) name, typically provided by the IdP in the <code>family_name</code> claim.</td> </tr> <tr> <td><code>phone</code></td> <td><code>phone_number</code></td> <td>The user’s phone number. This may require additional scopes/permissions from the IdP to access.</td> </tr> <tr> <td><code>department</code></td> <td>Custom claim (e.g., <code>department</code>)</td> <td>If the IdP can provide organizational data, it may store it in a custom claim. Adjust accordingly (e.g., <code>department</code>, <code>org</code>, or another attribute).</td> </tr> <tr> <td><code>is_admin</code></td> <td>Custom claim or derived role</td> <td>If the IdP returns a role or admin flag, you can map that to <code>is_admin</code>. Often this is managed through custom claims or group membership.</td> </tr> <tr> <td><code>user_groups</code></td> <td><code>groups</code> or another custom claim</td> <td>A list of group memberships for the user. Some IdPs provide <code>groups</code> out of the box; others require custom claims or directory lookups.</td> </tr> </tbody> </table> </li> </ul> <h4 id="admin_mapping_1"><code>admin_mapping</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> WgPortal can grant a user admin rights by matching the value of the <code>is_admin</code> 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 <code>user_group</code> claim. The regular expressions are defined in <code>admin_value_regex</code> and <code>admin_group_regex</code>.</li> <li><code>admin_value_regex</code>: A regular expression to match the <code>is_admin</code> claim. By default, this expression matches the string "true" (<code>^true$</code>).</li> <li><code>admin_group_regex</code>: A regular expression to match the <code>user_groups</code> claim. Each entry in the <code>user_groups</code> claim is checked against this regex.</li> </ul> <h4 id="registration_enabled_1"><code>registration_enabled</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, new users are created automatically on successful login.</li> </ul> <h4 id="log_user_info_1"><code>log_user_info</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, logs user info at the trace level upon login.</li> </ul> <hr/> <h3 id="ldap-provider-properties">LDAP Provider Properties</h3> <p>The <code>ldap</code> array contains a list of LDAP authentication providers. Below are the properties for each LDAP provider entry inside <code>auth.ldap</code>:</p> <h4 id="url"><code>url</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The LDAP server URL (e.g., <code>ldap://srv-ad01.company.local:389</code>).</li> </ul> <h4 id="start_tls"><code>start_tls</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, use STARTTLS to secure the LDAP connection.</li> </ul> <h4 id="cert_validation_1"><code>cert_validation</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, validate the LDAP server’s TLS certificate.</li> </ul> <h4 id="tls_certificate_path"><code>tls_certificate_path</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Path to a TLS certificate if needed for LDAP connections.</li> </ul> <h4 id="tls_key_path"><code>tls_key_path</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> Path to the corresponding TLS certificate key.</li> </ul> <h4 id="base_dn"><code>base_dn</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The base DN for user searches (e.g., <code>DC=COMPANY,DC=LOCAL</code>).</li> </ul> <h4 id="bind_user"><code>bind_user</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The bind user for LDAP (e.g., <code>company\\ldap_wireguard</code> or <code>ldap_wireguard@company.local</code>).</li> </ul> <h4 id="bind_pass"><code>bind_pass</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> The bind password for LDAP authentication.</li> </ul> <h4 id="field_map_2"><code>field_map</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li> <p><strong>Description:</strong> Maps LDAP attributes to WireGuard Portal fields.</p> <ul> <li>Available fields: <code>user_identifier</code>, <code>email</code>, <code>firstname</code>, <code>lastname</code>, <code>phone</code>, <code>department</code>, <code>memberof</code>.</li> </ul> <table> <thead> <tr> <th><strong>WireGuard Portal Field</strong></th> <th><strong>Typical LDAP Attribute</strong></th> <th><strong>Short Description</strong></th> </tr> </thead> <tbody> <tr> <td>user_identifier</td> <td>sAMAccountName / uid</td> <td>Uniquely identifies the user within the LDAP directory.</td> </tr> <tr> <td>email</td> <td>mail / userPrincipalName</td> <td>Stores the user's primary email address.</td> </tr> <tr> <td>firstname</td> <td>givenName</td> <td>Contains the user's first (given) name.</td> </tr> <tr> <td>lastname</td> <td>sn</td> <td>Contains the user's last (surname) name.</td> </tr> <tr> <td>phone</td> <td>telephoneNumber / mobile</td> <td>Holds the user's phone or mobile number.</td> </tr> <tr> <td>department</td> <td>departmentNumber / ou</td> <td>Specifies the department or organizational unit of the user.</td> </tr> <tr> <td>memberof</td> <td>memberOf</td> <td>Lists the groups and roles to which the user belongs.</td> </tr> </tbody> </table> </li> </ul> <h4 id="login_filter"><code>login_filter</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> An LDAP filter to restrict which users can log in. Use <code>{{login_identifier}}</code> to insert the username. For example: <div class="highlight"><pre><span></span><code>(&amp;(objectClass=organizationalPerson)(mail={{login_identifier}})(!userAccountControl:1.2.840.113556.1.4.803:=2))
</code></pre></div></li> </ul> <h4 id="admin_group"><code>admin_group</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> A specific LDAP group whose members are considered administrators in WireGuard Portal. For example: <div class="highlight"><pre><span></span><code>CN=WireGuardAdmins,OU=Some-OU,DC=YOURDOMAIN,DC=LOCAL
</code></pre></div></li> </ul> <h4 id="sync_interval"><code>sync_interval</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> How frequently (in duration, e.g. <code>30m</code>) to synchronize users from LDAP. Empty or <code>0</code> disables sync. Format uses <code>s</code>, <code>m</code>, <code>h</code>, <code>d</code> for seconds, minutes, hours, days, see <a href="https://golang.org/pkg/time/#ParseDuration">time.ParseDuration</a>. Only users that match the <code>sync_filter</code> are synchronized, if <code>disable_missing</code> is <code>true</code>, users not found in LDAP are disabled.</li> </ul> <h4 id="sync_filter"><code>sync_filter</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> An LDAP filter to select which users get synchronized into WireGuard Portal. For example: <div class="highlight"><pre><span></span><code>(&amp;(objectClass=organizationalPerson)(!userAccountControl:1.2.840.113556.1.4.803:=2)(mail=*))
</code></pre></div></li> </ul> <h4 id="disable_missing"><code>disable_missing</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, any user <strong>not</strong> found in LDAP (during sync) is disabled in WireGuard Portal.</li> </ul> <h4 id="registration_enabled_2"><code>registration_enabled</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, new user accounts are created in WireGuard Portal upon first login.</li> </ul> <h4 id="log_user_info_2"><code>log_user_info</code></h4> <ul> <li><strong>Default:</strong> <em>(empty)</em></li> <li><strong>Description:</strong> If <code>true</code>, logs LDAP user data at the trace level upon login.</li> </ul> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <!-- Application footer --> <footer class="md-footer"> <!-- Further information --> <div class="md-footer-meta md-typeset" style="background-color: #fff;"> <div class="md-footer-meta__inner md-grid" style="background-color: #fff;"> <!-- Copyright and theme information --> <div class="md-footer-copyright"> <div class="md-footer-copyright__highlight" style="color: rgb(38, 38, 38);"> Copyright © 2023-2025 WireGuard Portal Project </div> <div style="color: rgb(38, 38, 38);"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" style="color: black;" target="_blank"> Material for MkDocs </a> </div> </div> <!-- Social links --> <div class="md-social"> <a class="md-social__link" href="https://github.com/h44z/wg-portal" rel="noopener" target="_blank" title="github.com"> <svg viewbox="0 0 480 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1M480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2m-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3m-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1"></path></svg> </a> <a class="md-social__link" href="https://hub.docker.com/r/wgportal/wg-portal" rel="noopener" target="_blank" title="hub.docker.com"> <svg viewbox="0 0 640 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"></path></svg> </a> <a class="md-social__link" href="https://twitter.com/chris_h44z" rel="noopener" target="_blank" title="twitter.com"> <svg viewbox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"></path></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.tabs", "navigation.expand"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src="../../../assets/javascripts/bundle.60a45f97.min.js"></script> <script>document$.subscribe(() => {
window.update_swagger_ui_iframe_height = function (id) {
var iFrameID = document.getElementById(id);
if (iFrameID) {
full_height = (iFrameID.contentWindow.document.body.scrollHeight + 80) + "px";
iFrameID.height = full_height;
iFrameID.style.height = full_height;
}
}
let iframe_id_list = []
var iframes = document.getElementsByClassName("swagger-ui-iframe");
for (var i = 0; i < iframes.length; i++) {
iframe_id_list.push(iframes[i].getAttribute("id"))
}
let ticking = true;
document.addEventListener('scroll', function(e) {
if (!ticking) {
window.requestAnimationFrame(()=> {
let half_vh = window.innerHeight/2;
for(var i = 0; i < iframe_id_list.length; i++) {
let element = document.getElementById(iframe_id_list[i])
if(element==null){
return
}
let diff = element.getBoundingClientRect().top
if(element.contentWindow.update_top_val){
element.contentWindow.update_top_val(half_vh - diff)
}
}
ticking = false;
});
ticking = true;
}
});
const dark_scheme_name = "slate"
window.scheme = document.body.getAttribute("data-md-color-scheme")
const options = {
attributeFilter: ['data-md-color-scheme'],
};
function color_scheme_callback(mutations) {
for (let mutation of mutations) {
if (mutation.attributeName === "data-md-color-scheme") {
scheme = document.body.getAttribute("data-md-color-scheme")
var iframe_list = document.getElementsByClassName("swagger-ui-iframe")
for(var i = 0; i < iframe_list.length; i++) {
var ele = iframe_list.item(i);
if (ele) {
if (scheme === dark_scheme_name) {
ele.contentWindow.enable_dark_mode();
} else {
ele.contentWindow.disable_dark_mode();
}
}
}
}
}
}
observer = new MutationObserver(color_scheme_callback);
observer.observe(document.body, options);
})</script></body> </html>
Reference in New Issue View Git Blame Copy Permalink