mirror of
https://github.com/h44z/wg-portal.git
synced 2025-04-19 08:55:12 +00:00
67 lines
36 KiB
HTML
67 lines
36 KiB
HTML
<!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/master/documentation/getting-started/helm/" rel="canonical"/><link href="../docker/" rel="prev"/><link href="../sources/" rel="next"/><link href="../../../assets/images/favicon-large.png" rel="icon"/><meta content="mkdocs-1.6.1, mkdocs-material-9.6.9" name="generator"/><title>Helm - WireGuard Portal</title><link href="../../../assets/stylesheets/main.4af4bdda.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="Helm - 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/master/assets/images/social/documentation/getting-started/helm.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/master/documentation/getting-started/helm/" property="og:url"/><meta content="summary_large_image" name="twitter:card"/><meta content="Helm - 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/master/assets/images/social/documentation/getting-started/helm.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="#installing-the-chart"> 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"> Helm </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--active md-nav__item--nested"> <input checked="" class="md-nav__toggle md-toggle" 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="true" 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="../binaries/"> <span class="md-ellipsis"> Binaries </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../docker/"> <span class="md-ellipsis"> Docker </span> </a> </li> <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"> Helm </span> <span class="md-nav__icon md-icon"></span> </label> <a class="md-nav__link md-nav__link--active" href="./"> <span class="md-ellipsis"> Helm </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="#installing-the-chart"> <span class="md-ellipsis"> Installing the Chart </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#values"> <span class="md-ellipsis"> Values </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../sources/"> <span class="md-ellipsis"> Sources </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" 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="false" 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"> <a class="md-nav__link" href="../../configuration/overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../configuration/examples/"> <span class="md-ellipsis"> Examples </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../upgrade/v1/"> <span class="md-ellipsis"> Upgrade </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../monitoring/prometheus/"> <span class="md-ellipsis"> Monitoring </span> </a> </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="#installing-the-chart"> <span class="md-ellipsis"> Installing the Chart </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="#values"> <span class="md-ellipsis"> Values </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1>Helm</h1> <h2 id="installing-the-chart">Installing the Chart</h2> <p>To install the chart with the release name <code>wg-portal</code>:</p> <div class="highlight"><pre><span></span><code><span class="go">helm install wg-portal oci://ghcr.io/h44z/charts/wg-portal</span>
|
|
</code></pre></div> <p>This command deploy wg-portal on the Kubernetes cluster in the default configuration. The <a href="#values">Values</a> section lists the parameters that can be configured during installation.</p> <h2 id="values">Values</h2> <table> <thead> <tr> <th>Key</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>nameOverride</td> <td>string</td> <td><code>""</code></td> <td>Partially override resource names (adds suffix)</td> </tr> <tr> <td>fullnameOverride</td> <td>string</td> <td><code>""</code></td> <td>Fully override resource names</td> </tr> <tr> <td>extraDeploy</td> <td>list</td> <td><code>[]</code></td> <td>Array of extra objects to deploy with the release</td> </tr> <tr> <td>config.advanced</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#advanced">Advanced configuration</a> options.</td> </tr> <tr> <td>config.auth</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#auth">Auth configuration</a> options.</td> </tr> <tr> <td>config.core</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#core">Core configuration</a> options.<br/> If external admins in <code>auth</code> are defined and there are no <code>admin_user</code> and <code>admin_password</code> defined here, the default admin account will be disabled.</td> </tr> <tr> <td>config.database</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#database">Database configuration</a> options</td> </tr> <tr> <td>config.mail</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#mail">Mail configuration</a> options</td> </tr> <tr> <td>config.statistics</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#statistics">Statistics configuration</a> options</td> </tr> <tr> <td>config.web</td> <td>tpl/object</td> <td><code>{}</code></td> <td><a href="https://wgportal.org/latest/documentation/configuration/overview/#web">Web configuration</a> options.<br/> <code>listening_address</code> will be set automatically from <code>service.web.port</code>. <code>external_url</code> is required to enable ingress and certificate resources.</td> </tr> <tr> <td>revisionHistoryLimit</td> <td>string</td> <td><code>10</code></td> <td>The number of old ReplicaSets to retain to allow rollback.</td> </tr> <tr> <td>workloadType</td> <td>string</td> <td><code>"Deployment"</code></td> <td>Workload type - <code>Deployment</code> or <code>StatefulSet</code></td> </tr> <tr> <td>strategy</td> <td>object</td> <td><code>{"type":"RollingUpdate"}</code></td> <td>Update strategy for the workload Valid values are: <code>RollingUpdate</code> or <code>Recreate</code> for Deployment, <code>RollingUpdate</code> or <code>OnDelete</code> for StatefulSet</td> </tr> <tr> <td>image.repository</td> <td>string</td> <td><code>"ghcr.io/h44z/wg-portal"</code></td> <td>Image repository</td> </tr> <tr> <td>image.pullPolicy</td> <td>string</td> <td><code>"IfNotPresent"</code></td> <td>Image pull policy</td> </tr> <tr> <td>image.tag</td> <td>string</td> <td><code>""</code></td> <td>Overrides the image tag whose default is the chart appVersion</td> </tr> <tr> <td>imagePullSecrets</td> <td>list</td> <td><code>[]</code></td> <td>Image pull secrets</td> </tr> <tr> <td>podAnnotations</td> <td>tpl/object</td> <td><code>{}</code></td> <td>Extra annotations to add to the pod</td> </tr> <tr> <td>podLabels</td> <td>object</td> <td><code>{}</code></td> <td>Extra labels to add to the pod</td> </tr> <tr> <td>podSecurityContext</td> <td>object</td> <td><code>{}</code></td> <td>Pod Security Context</td> </tr> <tr> <td>securityContext.capabilities.add</td> <td>list</td> <td><code>["NET_ADMIN"]</code></td> <td>Add capabilities to the container</td> </tr> <tr> <td>initContainers</td> <td>tpl/list</td> <td><code>[]</code></td> <td>Pod init containers</td> </tr> <tr> <td>sidecarContainers</td> <td>tpl/list</td> <td><code>[]</code></td> <td>Pod sidecar containers</td> </tr> <tr> <td>dnsPolicy</td> <td>string</td> <td><code>"ClusterFirst"</code></td> <td>Set DNS policy for the pod. Valid values are <code>ClusterFirstWithHostNet</code>, <code>ClusterFirst</code>, <code>Default</code> or <code>None</code>.</td> </tr> <tr> <td>restartPolicy</td> <td>string</td> <td><code>"Always"</code></td> <td>Restart policy for all containers within the pod. Valid values are <code>Always</code>, <code>OnFailure</code> or <code>Never</code>.</td> </tr> <tr> <td>hostNetwork</td> <td>string</td> <td><code>false</code>.</td> <td>Use the host's network namespace.</td> </tr> <tr> <td>resources</td> <td>object</td> <td><code>{}</code></td> <td>Resources requests and limits</td> </tr> <tr> <td>command</td> <td>list</td> <td><code>[]</code></td> <td>Overwrite pod command</td> </tr> <tr> <td>args</td> <td>list</td> <td><code>[]</code></td> <td>Additional pod arguments</td> </tr> <tr> <td>env</td> <td>tpl/list</td> <td><code>[]</code></td> <td>Additional environment variables</td> </tr> <tr> <td>envFrom</td> <td>tpl/list</td> <td><code>[]</code></td> <td>Additional environment variables from a secret or configMap</td> </tr> <tr> <td>livenessProbe</td> <td>object</td> <td><code>{}</code></td> <td>Liveness probe configuration</td> </tr> <tr> <td>readinessProbe</td> <td>object</td> <td><code>{}</code></td> <td>Readiness probe configuration</td> </tr> <tr> <td>startupProbe</td> <td>object</td> <td><code>{}</code></td> <td>Startup probe configuration</td> </tr> <tr> <td>volumes</td> <td>tpl/list</td> <td><code>[]</code></td> <td>Additional volumes</td> </tr> <tr> <td>volumeMounts</td> <td>tpl/list</td> <td><code>[]</code></td> <td>Additional volumeMounts</td> </tr> <tr> <td>nodeSelector</td> <td>object</td> <td><code>{"kubernetes.io/os":"linux"}</code></td> <td>Node Selector configuration</td> </tr> <tr> <td>tolerations</td> <td>list</td> <td><code>[]</code></td> <td>Tolerations configuration</td> </tr> <tr> <td>affinity</td> <td>object</td> <td><code>{}</code></td> <td>Affinity configuration</td> </tr> <tr> <td>service.mixed.enabled</td> <td>bool</td> <td><code>false</code></td> <td>Whether to create a single service for the web and wireguard interfaces</td> </tr> <tr> <td>service.mixed.type</td> <td>string</td> <td><code>"LoadBalancer"</code></td> <td>Service type</td> </tr> <tr> <td>service.web.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Annotations for the web service</td> </tr> <tr> <td>service.web.type</td> <td>string</td> <td><code>"ClusterIP"</code></td> <td>Web service type</td> </tr> <tr> <td>service.web.port</td> <td>int</td> <td><code>8888</code></td> <td>Web service port Used for the web interface listener</td> </tr> <tr> <td>service.web.appProtocol</td> <td>string</td> <td><code>"http"</code></td> <td>Web service appProtocol. Will be auto set to <code>https</code> if certificate is enabled.</td> </tr> <tr> <td>service.wireguard.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Annotations for the WireGuard service</td> </tr> <tr> <td>service.wireguard.type</td> <td>string</td> <td><code>"LoadBalancer"</code></td> <td>Wireguard service type</td> </tr> <tr> <td>service.wireguard.ports</td> <td>list</td> <td><code>[51820]</code></td> <td>Wireguard service ports. Exposes the WireGuard ports for created interfaces. Lowerest port is selected as start port for the first interface. Increment next port by 1 for each additional interface.</td> </tr> <tr> <td>service.metrics.port</td> <td>int</td> <td><code>8787</code></td> <td></td> </tr> <tr> <td>ingress.enabled</td> <td>bool</td> <td><code>false</code></td> <td>Specifies whether an ingress resource should be created</td> </tr> <tr> <td>ingress.className</td> <td>string</td> <td><code>""</code></td> <td>Ingress class name</td> </tr> <tr> <td>ingress.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Ingress annotations</td> </tr> <tr> <td>ingress.tls</td> <td>bool</td> <td><code>false</code></td> <td>Ingress TLS configuration. Enable certificate resource or add ingress annotation to create required secret</td> </tr> <tr> <td>certificate.enabled</td> <td>bool</td> <td><code>false</code></td> <td>Specifies whether a certificate resource should be created. If enabled, certificate will be used for the web.</td> </tr> <tr> <td>certificate.issuer.name</td> <td>string</td> <td><code>""</code></td> <td>Certificate issuer name</td> </tr> <tr> <td>certificate.issuer.kind</td> <td>string</td> <td><code>""</code></td> <td>Certificate issuer kind (ClusterIssuer or Issuer)</td> </tr> <tr> <td>certificate.issuer.group</td> <td>string</td> <td><code>"cert-manager.io"</code></td> <td>Certificate issuer group</td> </tr> <tr> <td>certificate.duration</td> <td>string</td> <td><code>""</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.renewBefore</td> <td>string</td> <td><code>""</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.commonName</td> <td>string</td> <td><code>""</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.emailAddresses</td> <td>list</td> <td><code>[]</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.ipAddresses</td> <td>list</td> <td><code>[]</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.keystores</td> <td>object</td> <td><code>{}</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.privateKey</td> <td>object</td> <td><code>{}</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.secretTemplate</td> <td>object</td> <td><code>{}</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.subject</td> <td>object</td> <td><code>{}</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.uris</td> <td>list</td> <td><code>[]</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>certificate.usages</td> <td>list</td> <td><code>[]</code></td> <td>Optional. <a href="https://cert-manager.io/docs/usage/certificate/#creating-certificate-resources">Documentation</a></td> </tr> <tr> <td>persistence.enabled</td> <td>bool</td> <td><code>false</code></td> <td>Specifies whether an persistent volume should be created</td> </tr> <tr> <td>persistence.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Persistent Volume Claim annotations</td> </tr> <tr> <td>persistence.storageClass</td> <td>string</td> <td><code>""</code></td> <td>Persistent Volume storage class. If undefined (the default) cluster's default provisioner will be used.</td> </tr> <tr> <td>persistence.accessMode</td> <td>string</td> <td><code>"ReadWriteOnce"</code></td> <td>Persistent Volume Access Mode</td> </tr> <tr> <td>persistence.size</td> <td>string</td> <td><code>"1Gi"</code></td> <td>Persistent Volume size</td> </tr> <tr> <td>persistence.volumeName</td> <td>string</td> <td><code>""</code></td> <td>Persistent Volume Name (optional)</td> </tr> <tr> <td>serviceAccount.create</td> <td>bool</td> <td><code>true</code></td> <td>Specifies whether a service account should be created</td> </tr> <tr> <td>serviceAccount.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Service account annotations</td> </tr> <tr> <td>serviceAccount.automount</td> <td>bool</td> <td><code>false</code></td> <td>Automatically mount a ServiceAccount's API credentials</td> </tr> <tr> <td>serviceAccount.name</td> <td>string</td> <td><code>""</code></td> <td>The name of the service account to use. If not set and create is true, a name is generated using the fullname template</td> </tr> <tr> <td>monitoring.enabled</td> <td>bool</td> <td><code>false</code></td> <td>Enable Prometheus monitoring.</td> </tr> <tr> <td>monitoring.apiVersion</td> <td>string</td> <td><code>"monitoring.coreos.com/v1"</code></td> <td>API version of the Prometheus resource. Use <code>azmonitoring.coreos.com/v1</code> for Azure Managed Prometheus.</td> </tr> <tr> <td>monitoring.kind</td> <td>string</td> <td><code>"PodMonitor"</code></td> <td>Kind of the Prometheus resource. Could be <code>PodMonitor</code> or <code>ServiceMonitor</code>.</td> </tr> <tr> <td>monitoring.labels</td> <td>object</td> <td><code>{}</code></td> <td>Resource labels.</td> </tr> <tr> <td>monitoring.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Resource annotations.</td> </tr> <tr> <td>monitoring.interval</td> <td>string</td> <td><code>1m</code></td> <td>Interval at which metrics should be scraped. If not specified <code>config.statistics.data_collection_interval</code> interval is used.</td> </tr> <tr> <td>monitoring.metricRelabelings</td> <td>list</td> <td><code>[]</code></td> <td>Relabelings to samples before ingestion.</td> </tr> <tr> <td>monitoring.relabelings</td> <td>list</td> <td><code>[]</code></td> <td>Relabelings to samples before scraping.</td> </tr> <tr> <td>monitoring.scrapeTimeout</td> <td>string</td> <td><code>""</code></td> <td>Timeout after which the scrape is ended If not specified, the Prometheus global scrape interval is used.</td> </tr> <tr> <td>monitoring.jobLabel</td> <td>string</td> <td><code>""</code></td> <td>The label to use to retrieve the job name from.</td> </tr> <tr> <td>monitoring.podTargetLabels</td> <td>object</td> <td><code>{}</code></td> <td>Transfers labels on the Kubernetes Pod onto the target.</td> </tr> <tr> <td>monitoring.dashboard.enabled</td> <td>bool</td> <td><code>false</code></td> <td>Enable Grafana dashboard.</td> </tr> <tr> <td>monitoring.dashboard.annotations</td> <td>object</td> <td><code>{}</code></td> <td>Annotations for the dashboard ConfigMap.</td> </tr> <tr> <td>monitoring.dashboard.labels</td> <td>object</td> <td><code>{}</code></td> <td>Additional labels for the dashboard ConfigMap.</td> </tr> <tr> <td>monitoring.dashboard.namespace</td> <td>string</td> <td><code>""</code></td> <td>Dashboard ConfigMap namespace Overrides the namespace for the dashboard ConfigMap.</td> </tr> </tbody> </table> </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": ["content.code.copy", "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.c8b220af.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> |