mirror of
https://github.com/h44z/wg-portal
synced 2025-02-26 05:49:14 +00:00
360 lines
32 KiB
HTML
360 lines
32 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/" rel="canonical"/><link href="documentation/overview/" rel="next"/><link href="assets/images/favicon-large.png" rel="icon"/><meta content="mkdocs-1.6.1, mkdocs-material-9.6.4" name="generator"/><title>WireGuard Portal - 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="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/index.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/" property="og:url"/><meta content="summary_large_image" name="twitter:card"/><meta content="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/index.png" name="twitter:image"/><meta content="WireGuard Portal" property="og:title"/></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"> </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"> WireGuard Portal </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 md-tabs__item--active"> <a class="md-tabs__link" href="."> Home </a> </li> <li class="md-tabs__item"> <a class="md-tabs__link" href="documentation/overview/"> Documentation </a> </li> </ul> </div> </nav> <!-- Additional styles for landing page --> <style>
|
|
|
|
/* Apply box shadow on smaller screens that don't display tabs */
|
|
@media only screen and (max-width: 1220px) {
|
|
.md-header {
|
|
box-shadow: 0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2);
|
|
transition: color 250ms,background-color 250ms,box-shadow 250ms;
|
|
}
|
|
}
|
|
|
|
/* Hide main content for now */
|
|
.md-content {
|
|
display: none;
|
|
}
|
|
|
|
/* Hide table of contents */
|
|
@media screen and (min-width: 60em) {
|
|
.md-sidebar--secondary {
|
|
display: none;
|
|
}
|
|
}
|
|
|
|
/* Hide navigation */
|
|
@media screen and (min-width: 76.25em) {
|
|
.md-sidebar--primary {
|
|
display: none;
|
|
}
|
|
}
|
|
|
|
/* Get started button */
|
|
.md-typeset .md-button--primary {
|
|
color: var(--md-primary-fg-color);
|
|
background-color: var(--md-primary-bg-color);
|
|
border-color: var(--md-primary-bg-color);
|
|
}
|
|
.md-typeset .md-button--primary:hover {
|
|
color: var(--md-primary-bg-color);
|
|
background-color: var(--md-primary-fg-color);
|
|
border-color: var(--md-primary-bg-color);
|
|
}
|
|
|
|
.tx-hero {
|
|
max-width: 700px;
|
|
display: flex;
|
|
padding: .4rem;
|
|
margin: 0 auto;
|
|
text-align: center;
|
|
}
|
|
.tx-hero h1 {
|
|
font-weight: 700;
|
|
font-size: 38px;
|
|
line-height: 46px;
|
|
color: rgb(38, 38, 38);
|
|
}
|
|
.tx-hero p {
|
|
color: rgb(92, 92, 92);
|
|
font-weight: 400;
|
|
font-size: 20px;
|
|
line-height: 32px;
|
|
}
|
|
.tx-hero__image {
|
|
max-width: 1000px;
|
|
min-width: 600px;
|
|
width: 100%;
|
|
height: auto;
|
|
margin: 0 auto;
|
|
display: flex;
|
|
align-items: stretch;
|
|
}
|
|
|
|
.tx-hero__image img {
|
|
width: 100%;
|
|
height: 100%;
|
|
min-width: 0;
|
|
}
|
|
|
|
/* Secondary content styles */
|
|
.secondary-section {
|
|
background: rgb(245, 245, 245) none repeat scroll 0% 0%;
|
|
border-top: 1px solid rgb(222, 222, 222);
|
|
border-bottom: 1px solid rgb(222, 222, 222)
|
|
}
|
|
@media screen and (max-width: 1012px) {
|
|
.secondary-section {
|
|
display: block;
|
|
}
|
|
}
|
|
|
|
.secondary-section .g {
|
|
position: relative;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
padding: 0px 40px;
|
|
max-width: 1280px;
|
|
}
|
|
|
|
.secondary-section .g .section {
|
|
font-size: 18px;
|
|
font-weight: 400;
|
|
line-height: 30px;
|
|
letter-spacing: normal;
|
|
padding: 88px 0px 116px;
|
|
}
|
|
|
|
.secondary-section .g .section.follow {
|
|
padding-top: 0px;
|
|
}
|
|
|
|
|
|
.secondary-section .g .section .component-wrapper {
|
|
display: flex;
|
|
-moz-box-align: center;
|
|
align-items: center;
|
|
}
|
|
|
|
@media screen and (max-width: 1012px) {
|
|
.secondary-section .g .section .component-wrapper {
|
|
display: block;
|
|
}
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper h3 {
|
|
color: rgb(38, 38, 38);
|
|
font-size: 36px;
|
|
font-weight: 700;
|
|
line-height: 46px;
|
|
letter-spacing: normal;
|
|
margin-bottom: 12px;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper h4 {
|
|
color: rgb(38, 38, 38);
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper p {
|
|
color: rgb(92, 92, 92);
|
|
font-size: 18px;
|
|
font-weight: 400;
|
|
line-height: 30px;
|
|
letter-spacing: normal;
|
|
margin-bottom: 16px;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .image-wrapper {
|
|
margin-bottom: 12px;
|
|
overflow: hidden;
|
|
border-radius: 8px;
|
|
margin-top: 48px;
|
|
border: 1px solid rgb(222, 222, 222);
|
|
box-shadow: rgba(202, 202, 202, 0.15) 0px 0px 0px 6px;
|
|
max-width: 600px;
|
|
width: 100%;
|
|
height: auto;
|
|
margin: 0 auto;
|
|
display: flex;
|
|
align-items: stretch;
|
|
}
|
|
|
|
.image-wrapper img {
|
|
width: 100%;
|
|
height: 100%;
|
|
min-width: 0;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .first-column {
|
|
padding-right: 100px;
|
|
flex: 0 1 auto;
|
|
height: auto;
|
|
width: 50%;
|
|
}
|
|
|
|
@media screen and (max-width: 1012px) {
|
|
.secondary-section .g .section .component-wrapper .first-column {
|
|
padding-right: 0px;
|
|
width: 100%;
|
|
margin-bottom: 32px;
|
|
}
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .second-column {
|
|
flex: 0 1 auto;
|
|
height: auto;
|
|
width: 50%;
|
|
}
|
|
@media screen and (max-width: 1012px) {
|
|
.secondary-section .g .section .component-wrapper .second-column {
|
|
width: 100%;
|
|
margin-bottom: 32px;
|
|
}
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid {
|
|
display: grid;
|
|
width: 100%;
|
|
grid-template-columns: repeat(1, 1fr);
|
|
gap: 2rem;
|
|
}
|
|
@media screen and (min-width: 64rem) {
|
|
.secondary-section .g .section .component-wrapper .responsive-grid {
|
|
grid-template-columns: repeat(3, 1fr);
|
|
}
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid a.card-wrapper {
|
|
text-decoration: none;
|
|
transition: none;
|
|
background: none;
|
|
padding: 0;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card {
|
|
position: relative;
|
|
background-color: #fff none repeat scroll 0% 0%;
|
|
padding: 1.5rem;
|
|
display: flex;
|
|
flex-direction: row;
|
|
-moz-box-align: center;
|
|
align-items: center;
|
|
height: 100%;
|
|
-moz-box-pack: start;
|
|
justify-content: flex-start;
|
|
box-shadow: rgba(0, 0, 0, 0.09) 0.3125rem 0.3125rem 0px -0.0625rem, rgba(0, 0, 0, 0.15) 0px 0.25rem 0.5rem 0px;
|
|
transition: all 0.6s cubic-bezier(0.165, 0.84, 0.44, 1) 0s;
|
|
}
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card:hover {
|
|
box-shadow: rgba(0, 0, 0, 0.2) 0.3125rem 0.3125rem 0px -0.0625rem, rgba(0, 0, 0, 0.26) 0px 0.25rem 0.5rem 0px;
|
|
}
|
|
|
|
@media screen and (min-width: 75rem) {
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card {
|
|
padding: 2rem 2.5rem;
|
|
}
|
|
}
|
|
@media screen and (min-width: 36rem) {
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card {
|
|
padding: 1rem 1.5rem;
|
|
}
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card .logo {
|
|
margin-right: 0.75rem;
|
|
width: 1.2rem;
|
|
min-width: 1.2rem;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card .card-content {
|
|
display: flex;
|
|
flex: 1 1 0%;
|
|
flex-direction: column;
|
|
width: 100%;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card .card-content h5 {
|
|
color: rgb(61, 61, 61);
|
|
margin: 0;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card .card-content p {
|
|
margin-top: 0.25em;
|
|
margin-bottom: 0;
|
|
color: rgb(92, 92, 92);
|
|
font-size: 0.65rem;
|
|
font-weight: 300;
|
|
line-height: normal;
|
|
}
|
|
|
|
.secondary-section .g .section .component-wrapper .responsive-grid .card .card-content code {
|
|
background: rgba(0, 0, 0, 0.05) none repeat scroll 0% 0%;
|
|
padding: 2px 6px;
|
|
border-radius: 4px;
|
|
}
|
|
|
|
|
|
.component-wrapper span.em {
|
|
color: rgb(61, 61, 61);
|
|
}
|
|
|
|
.component-wrapper a {
|
|
transition: color 125ms;
|
|
color: rgb(61, 61, 61);
|
|
background: rgba(0, 0, 0, 0.05) none repeat scroll 0% 0%;
|
|
padding: 2px 6px;
|
|
margin: 0px 1px;
|
|
border-radius: 4px;
|
|
display: inline;
|
|
cursor: pointer;
|
|
font-weight: 600;
|
|
}
|
|
|
|
.component-wrapper a:hover {
|
|
color: var(--md-typeset-a-color);
|
|
background: var(--md-accent-fg-color--transparent);
|
|
}
|
|
|
|
</style> <!-- Hero for landing page --> <div class="md-container tx-hero"> <div class="md-grid md-typeset"> <div class="md-main__inner"> <div> <h1>A beautiful and simple UI to manage your WireGuard peers and interfaces</h1> <p>WireGuard Portal is an open source web-based user interface that makes it easy to setup and manage WireGuard VPN connections. It's built on top of WireGuard's official <span class="em">wgctrl</span> library.</p> <a class="md-button md-button--primary" href="documentation/overview/" title="Get Started"> Get started <svg fill="none" height="10" style="margin-left:2px" viewbox="0 0 11 10" width="11"><path d="M1 5.16772H9.5M9.5 5.16772L6.5 1.66772M9.5 5.16772L6.5 8.66772" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"></path></svg> </a> </div> </div> </div> </div> <div class="md-container"> <div class="tx-hero__image"> <img alt="" draggable="false" src="https://wgportal.org/master/assets/images/screenshot.png"/> </div> </div> <div class="md-container secondary-section"> <div class="g"> <!-- Architecture as building blocks --> <div class="section"> <div class="component-wrapper"> <div class="first-column"> <h3>More information about WireGuard</h3> <p> WireGuard® is an extremely <span class="em">simple</span> yet <span class="em">fast</span> and modern VPN that utilizes <span class="em">state-of-the-art cryptography</span>. </p> <p> WireGuard uses state-of-the-art <a href="https://www.wireguard.com/protocol/">cryptography</a> and still manages to be as easy to configure and deploy as SSH. A combination of extremely high-speed cryptographic primitives and the fact that WireGuard lives inside the Linux kernel means that secure networking can be very high-speed. It is suitable for both small embedded devices like smartphones and fully loaded backbone routers. </p> </div> <div class="second-column"> <div class="image-wrapper"> <img alt="" draggable="false" src="https://wgportal.org/master/assets/images/wg-tool.png"/> </div> </div> </div> <div class="component-wrapper" style="display: block;"> <h4>Explore official documentation</h4> <!-- Arch as code --> <div class="responsive-grid"> <a class="card-wrapper" href="https://www.wireguard.com/"> <div class="card"> <div class="logo"> <span class="twemoji"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 3a2 2 0 0 1 2-2h9.982a2 2 0 0 1 1.414.586l4.018 4.018A2 2 0 0 1 21 7.018V21a2 2 0 0 1-2 2H4.75a.75.75 0 0 1 0-1.5H19a.5.5 0 0 0 .5-.5V8.5h-4a2 2 0 0 1-2-2v-4H5a.5.5 0 0 0-.5.5v6.25a.75.75 0 0 1-1.5 0Zm12-.5v4a.5.5 0 0 0 .5.5h4a.5.5 0 0 0-.146-.336l-4.018-4.018A.5.5 0 0 0 15 2.5"></path><path d="M4.53 12.24a.75.75 0 0 1-.039 1.06l-2.639 2.45 2.64 2.45a.75.75 0 1 1-1.022 1.1l-3.23-3a.75.75 0 0 1 0-1.1l3.23-3a.75.75 0 0 1 1.06.04m3.979 1.06a.75.75 0 1 1 1.02-1.1l3.231 3a.75.75 0 0 1 0 1.1l-3.23 3a.75.75 0 1 1-1.021-1.1l2.639-2.45-2.64-2.45Z"></path></svg> </span> </div> <div class="card-content"> <h5>Official Website</h5> <p> If you'd like a general conceptual overview of what WireGuard is about, read onward here. </p> </div> </div> </a> <!-- Networking --> <a class="card-wrapper" href="https://www.wireguard.com/protocol/"> <div class="card"> <div class="logo"> <span class="twemoji"> <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="M256 64h128v64H256zM240 0c-26.5 0-48 21.5-48 48v96c0 26.5 21.5 48 48 48h48v32H32c-17.7 0-32 14.3-32 32s14.3 32 32 32h96v32H80c-26.5 0-48 21.5-48 48v96c0 26.5 21.5 48 48 48h160c26.5 0 48-21.5 48-48v-96c0-26.5-21.5-48-48-48h-48v-32h256v32h-48c-26.5 0-48 21.5-48 48v96c0 26.5 21.5 48 48 48h160c26.5 0 48-21.5 48-48v-96c0-26.5-21.5-48-48-48h-48v-32h96c17.7 0 32-14.3 32-32s-14.3-32-32-32H352v-32h48c26.5 0 48-21.5 48-48V48c0-26.5-21.5-48-48-48zM96 448v-64h128v64zm320-64h128v64H416z"></path></svg> </span> </div> <div class="card-content"> <h5>Protocol & Cryptography</h5> <p> WireGuard uses state-of-the-art cryptography, like the Noise protocol framework, Curve25519, ChaCha20, Poly1305, BLAKE2, SipHash24, HKDF, and secure trusted constructions. </p> </div> </div> </a> <!-- Customize --> <a class="card-wrapper" href="https://www.wireguard.com/install/"> <div class="card"> <div class="logo"> <span class="twemoji"> <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="M192 104.8c0-9.2-5.8-17.3-13.2-22.8-11.6-8.7-18.8-20.7-18.8-34 0-26.5 28.7-48 64-48s64 21.5 64 48c0 13.3-7.2 25.3-18.8 34-7.4 5.5-13.2 13.6-13.2 22.8 0 12.8 10.4 23.2 23.2 23.2H336c26.5 0 48 21.5 48 48v56.8c0 12.8 10.4 23.2 23.2 23.2 9.2 0 17.3-5.8 22.8-13.2 8.7-11.6 20.7-18.8 34-18.8 26.5 0 48 28.7 48 64s-21.5 64-48 64c-13.3 0-25.3-7.2-34-18.8-5.5-7.4-13.6-13.2-22.8-13.2-12.8 0-23.2 10.4-23.2 23.2V464c0 26.5-21.5 48-48 48h-56.8c-12.8 0-23.2-10.4-23.2-23.2 0-9.2 5.8-17.3 13.2-22.8 11.6-8.7 18.8-20.7 18.8-34 0-26.5-28.7-48-64-48s-64 21.5-64 48c0 13.3 7.2 25.3 18.8 34 7.4 5.5 13.2 13.6 13.2 22.8 0 12.8-10.4 23.2-23.2 23.2H48c-26.5 0-48-21.5-48-48V343.2C0 330.4 10.4 320 23.2 320c9.2 0 17.3 5.8 22.8 13.2 8.7 11.6 20.7 18.8 34 18.8 26.5 0 48-28.7 48-64s-21.5-64-48-64c-13.3 0-25.3 7.2-34 18.8-5.5 7.4-13.6 13.2-22.8 13.2C10.4 256 0 245.6 0 232.8V176c0-26.5 21.5-48 48-48h120.8c12.8 0 23.2-10.4 23.2-23.2"></path></svg> </span> </div> <div class="card-content"> <h5>Client Installation</h5> <p> You may progress to installation and reading the quickstart instructions on how to use it. </p> </div> </div> </a> </div> </div> </div> </div> </div> <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 md-nav__item--active"> <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/> <a class="md-nav__link md-nav__link--active" href="."> <span class="md-ellipsis"> Home </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" type="checkbox"/> <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0"> <span class="md-ellipsis"> Documentation </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="false" 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="documentation/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="documentation/getting-started/binaries/"> <span class="md-ellipsis"> Binaries </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/getting-started/docker/"> <span class="md-ellipsis"> Docker </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/getting-started/helm/"> <span class="md-ellipsis"> Helm </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/getting-started/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="documentation/configuration/overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/configuration/examples/"> <span class="md-ellipsis"> Examples </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/upgrade/v1/"> <span class="md-ellipsis"> Upgrade </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/monitoring/prometheus/"> <span class="md-ellipsis"> Monitoring </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="documentation/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"> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> </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.f1b6f286.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> |