mirror of
https://github.com/h44z/wg-portal.git
synced 2025-06-28 09:17:00 +00:00
2 lines
33 KiB
HTML
2 lines
33 KiB
HTML
|
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><link href=https://wgportal.org/v2.0.0/documentation/getting-started/helm/ rel=canonical><link href=../docker/ rel=prev><link href=../sources/ rel=next><link rel=icon href=../../../assets/images/favicon-large.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.6.12"><title>Helm - WireGuard Portal</title><link rel=stylesheet href=../../../assets/stylesheets/main.2afb09e1.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.06af60db.min.css><link rel=stylesheet href=../../../stylesheets/extra.css><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 property=og:type content=website><meta property=og:title content="Helm - WireGuard Portal"><meta property=og:description content="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><meta property=og:image content=https://wgportal.org/v2.0.0/assets/images/social/documentation/getting-started/helm.png><meta property=og:image:type content=image/png><meta property=og:image:width content=1200><meta property=og:image:height content=630><meta content=https://wgportal.org/v2.0.0/documentation/getting-started/helm/ property=og:url><meta name=twitter:card content=summary_large_image><meta name=twitter:title content="Helm - WireGuard Portal"><meta name=twitter:description content="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><meta name=twitter:image content=https://wgportal.org/v2.0.0/assets/images/social/documentation/getting-started/helm.png></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=white data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#installing-the-chart class=md-skip> 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 class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title="WireGuard Portal" class="md-header__button md-logo" aria-label="WireGuard Portal" data-md-component=logo> <img src=../../../assets/images/logo.svg alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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 xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><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"/></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 type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__sea
|
||
|
|
</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
|