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/master/documentation/getting-started/helm/index.html

67 lines
36 KiB
HTML
Raw Normal View History

Deployed 2cf2341 to master with MkDocs 1.6.1 and mike 2.1.3
2025-01-23 12:43:34 +00:00
<!DOCTYPE html>
Deployed 9680e83 to master with MkDocs 1.6.1 and mike 2.1.3
2025-03-04 07:40:05 +00:00
<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.7" name="generator"/><title>Helm - WireGuard Portal</title><link href="../../../assets/stylesheets/main.8608ea7d.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
</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 cont
Deployed 2cf2341 to master with MkDocs 1.6.1 and mike 2.1.3
2025-01-23 12:43:34 +00:00
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 Copy Permalink