<!doctype html><htmllang=enclass=no-js><head><metacharset=utf-8><metaname=viewportcontent="width=device-width,initial-scale=1"><metaname=descriptioncontent="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><linkhref=https://wgportal.org/master/documentation/getting-started/helm/rel=canonical><linkhref=../docker/rel=prev><linkhref=../sources/rel=next><linkrel=iconhref=../../../assets/images/favicon-large.png><metaname=generatorcontent="mkdocs-1.6.1, mkdocs-material-9.6.11"><title>Helm - WireGuard Portal</title><linkrel=stylesheethref=../../../assets/stylesheets/main.4af4bdda.min.css><linkrel=stylesheethref=../../../assets/stylesheets/palette.06af60db.min.css><linkrel=stylesheethref=../../../stylesheets/extra.css><script>__md_scope=newURL("../../..",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><metaproperty=og:typecontent=website><metaproperty=og:titlecontent="Helm - WireGuard Portal"><metaproperty=og:descriptioncontent="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><metaproperty=og:imagecontent=https://wgportal.org/master/assets/images/social/documentation/getting-started/helm.png><metaproperty=og:image:typecontent=image/png><metaproperty=og:image:widthcontent=1200><metaproperty=og:image:heightcontent=630><metacontent=https://wgportal.org/master/documentation/getting-started/helm/property=og:url><metaname=twitter:cardcontent=summary_large_image><metaname=twitter:titlecontent="Helm - WireGuard Portal"><metaname=twitter:descriptioncontent="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><metaname=twitter:imagecontent=https://wgportal.org/master/assets/images/social/documentation/getting-started/helm.png></head><bodydir=ltrdata-md-color-scheme=defaultdata-md-color-primary=whitedata-md-color-accent=indigo><inputclass=md-toggledata-md-toggle=drawertype=checkboxid=__drawerautocomplete=off><inputclass=md-toggledata-md-toggle=searchtype=checkboxid=__searchautocomplete=off><labelclass=md-overlayfor=__drawer></label><divdata-md-component=skip><ahref=#installing-the-chartclass=md-skip> Skip to content </a></div><divdata-md-component=announce></div><divdata-md-color-scheme=defaultdata-md-component=outdatedhidden></div><headerclass=md-headerdata-md-component=header><navclass="md-header__inner md-grid"aria-label=Header><ahref=../../..title="WireGuard Portal"class="md-header__button md-logo"aria-label="WireGuard Portal"data-md-component=logo><imgsrc=../../../assets/images/logo.svgalt=logo></a><labelclass="md-header__button md-icon"for=__drawer><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg></label><divclass=md-header__titledata-md-component=header-title><divclass=md-header__ellipsis><divclass=md-header__topic><spanclass=md-ellipsis> WireGuard Portal </span></div><divclass=md-header__topicdata-md-component=header-topic><spanclass=md-ellipsis> Helm </span></div></div></div><labelclass="md-header__button md-icon"for=__search><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="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><divclass=md-searchdata-md-component=searchrole=dialog><labelclass=md-search__overlayfor=__search></label><divclass=md-search__innerrole=search><formclass=md-search__formname=search><inputtype=textclass=md-search__inputname=queryaria-label=Searchplaceholder=Searchautocapitalize=offautocorrect=offautocomplete=offspellcheck=falsedata-md-component=search-queryrequired><labelclass="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 <ahref=#values>Values</a> section lists the parameters that can be configured during installation.</p><h2id=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><ahref=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><ahref=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><ahref=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><ahref=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><ahref=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><ahref=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><ahref=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
