2021-05-26 05:57:06 +08:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "lang:clipboard.copy" content = "Copy to clipboard" >
< meta name = "lang:clipboard.copied" content = "Copied to clipboard" >
< meta name = "lang:search.language" content = "en" >
< meta name = "lang:search.pipeline.stopwords" content = "True" >
< meta name = "lang:search.pipeline.trimmer" content = "True" >
< meta name = "lang:search.result.none" content = "No matching documents" >
< meta name = "lang:search.result.one" content = "1 matching document" >
< meta name = "lang:search.result.other" content = "# matching documents" >
< meta name = "lang:search.tokenizer" content = "[\s\-]+" >
< link href = "https://fonts.gstatic.com/" rel = "preconnect" crossorigin >
< link href = "https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel = "stylesheet" >
< style >
body,
input {
font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif
}
code,
kbd,
pre {
font-family: "Roboto Mono", "Courier New", Courier, monospace
}
< / style >
< link rel = "stylesheet" href = "_static/stylesheets/application.css" / >
< link rel = "stylesheet" href = "_static/stylesheets/application-palette.css" / >
< link rel = "stylesheet" href = "_static/stylesheets/application-fixes.css" / >
< link rel = "stylesheet" href = "_static/fonts/material-icons.css" / >
< meta name = "theme-color" content = "#3f51b5" >
< script src = "_static/javascripts/modernizr.js" > < / script >
2021-08-11 11:27:13 +08:00
< title > Welcome to the Netmaker Documentation — Netmaker 0.7 documentation< / title >
2021-06-02 00:23:05 +08:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/material.css" type = "text/css" / >
< script id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
2021-05-26 05:57:06 +08:00
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< link rel = "author" title = "About these documents" href = "about.html" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "About" href = "about.html" / >
< / head >
< body dir = ltr
data-md-color-primary=indigo data-md-color-accent=light-blue>
< svg class = "md-svg" >
< defs data-children-count = "0" >
< svg xmlns = "http://www.w3.org/2000/svg" width = "416" height = "448" viewBox = "0 0 416 448" id = "__github" > < path fill = "currentColor" d = "M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z" / > < / svg >
< / defs >
< / svg >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" >
< label class = "md-overlay" data-md-component = "overlay" for = "__drawer" > < / label >
< a href = "#index" tabindex = "1" class = "md-skip" > Skip to content < / a >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header-nav md-grid" >
< div class = "md-flex navheader" >
< div class = "md-flex__cell md-flex__cell--shrink" >
2021-08-11 11:27:13 +08:00
< a href = "#" title = "Netmaker 0.7 documentation"
2021-05-26 05:57:06 +08:00
class="md-header-nav__button md-logo">
< i class = "md-icon" > & #xe869< / i >
< / a >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< label class = "md-icon md-icon--menu md-header-nav__button" for = "__drawer" > < / label >
< / div >
< div class = "md-flex__cell md-flex__cell--stretch" >
< div class = "md-flex__ellipsis md-header-nav__title" data-md-component = "title" >
< span class = "md-header-nav__topic" > Netmaker Docs< / span >
< span class = "md-header-nav__topic" > Welcome to the Netmaker Documentation < / span >
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< label class = "md-icon md-icon--search md-header-nav__button" for = "__search" > < / 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" action = "search.html" method = "GET" name = "search" >
< input type = "text" class = "md-search__input" name = "q" placeholder = "Search"
autocapitalize="off" autocomplete="off" spellcheck="false"
data-md-component="query" data-md-state="active">
< label class = "md-icon md-search__icon" for = "__search" > < / label >
< button type = "reset" class = "md-icon md-search__icon" data-md-component = "reset" tabindex = "-1" >

< / button >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "result" >
< div class = "md-search-result__meta" >
Type to start searching
< / div >
< ol class = "md-search-result__list" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< div class = "md-header-nav__source" >
< a href = "https://github.com/gravitl/netmaker/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< div class = "md-source__icon" >
< svg xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" viewBox = "0 0 24 24" width = "28" height = "28" >
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
< / svg >
< / div >
< div class = "md-source__repository" >
Netmaker
< / div >
< / a >
< / div >
< / div >
< script src = "_static/javascripts/version_dropdown.js" > < / script >
< script >
var json_loc = ""versions.json"",
target_loc = "../",
text = "Versions";
$( document ).ready( add_version_dropdown(json_loc, target_loc, text));
< / script >
< / div >
< / nav >
< / header >
< div class = "md-container" >
< nav class = "md-tabs" data-md-component = "tabs" >
< div class = "md-tabs__inner md-grid" >
< ul class = "md-tabs__list" >
2021-08-11 11:27:13 +08:00
< li class = "md-tabs__item" > < a href = "#" class = "md-tabs__link" > Netmaker 0.7 documentation< / a > < / li >
2021-05-26 05:57:06 +08:00
< / ul >
< / div >
< / nav >
< main class = "md-main" >
< div class = "md-main__inner md-grid" data-md-component = "container" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" data-md-level = "0" >
< label class = "md-nav__title md-nav__title--site" for = "__drawer" >
2021-08-11 11:27:13 +08:00
< a href = "#" title = "Netmaker 0.7 documentation" class = "md-nav__button md-logo" >
2021-05-26 05:57:06 +08:00
< i class = "md-icon" > & #xe869< / i >
< / a >
< a href = "#"
2021-08-11 11:27:13 +08:00
title="Netmaker 0.7 documentation">Netmaker Docs< / a >
2021-05-26 05:57:06 +08:00
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/gravitl/netmaker/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< div class = "md-source__icon" >
< svg xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" viewBox = "0 0 24 24" width = "28" height = "28" >
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
< / svg >
< / div >
< div class = "md-source__repository" >
Netmaker
< / div >
< / a >
< / div >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "about.html" class = "md-nav__link" > About< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "about.html#what-is-netmaker" class = "md-nav__link" > What is Netmaker?< / a >
< / li >
< li class = "md-nav__item" >
< a href = "about.html#how-does-netmaker-work" class = "md-nav__link" > How Does Netmaker Work?< / a >
< / li >
< li class = "md-nav__item" >
< a href = "about.html#use-cases-for-netmaker" class = "md-nav__link" > Use Cases for Netmaker< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "architecture.html" class = "md-nav__link" > Architecture< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "architecture.html#core-concepts" class = "md-nav__link" > Core Concepts< / a >
< / li >
< li class = "md-nav__item" >
< a href = "architecture.html#components" class = "md-nav__link" > Components< / a >
< / li >
< li class = "md-nav__item" >
< a href = "architecture.html#technical-process" class = "md-nav__link" > Technical Process< / a >
< / li >
< li class = "md-nav__item" >
< a href = "architecture.html#compatible-systems-for-netclient" class = "md-nav__link" > Compatible Systems for Netclient< / a >
< / li >
< li class = "md-nav__item" >
< a href = "architecture.html#limitations" class = "md-nav__link" > Limitations< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "quick-start.html" class = "md-nav__link" > Quick Install< / a >
2021-05-26 05:57:06 +08:00
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "quick-start.html#introduction" class = "md-nav__link" > 0. Introduction< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "quick-start.html#prerequisites" class = "md-nav__link" > 1. Prerequisites< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "quick-start.html#install-dependencies" class = "md-nav__link" > 2. Install Dependencies< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "quick-start.html#prepare-vm" class = "md-nav__link" > 3. Prepare VM< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "quick-start.html#install-netmaker" class = "md-nav__link" > 4. Install Netmaker< / a >
2021-05-26 05:57:06 +08:00
2021-08-10 22:02:15 +08:00
< / li > < / ul >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "getting-started.html" class = "md-nav__link" > Getting Started< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "getting-started.html#setup" class = "md-nav__link" > Setup< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "getting-started.html#deploy-nodes" class = "md-nav__link" > Deploy Nodes< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "getting-started.html#manage-nodes" class = "md-nav__link" > Manage Nodes< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "getting-started.html#uninstalling-the-netclient" class = "md-nav__link" > Uninstalling the netclient< / a >
< / li >
2021-05-26 05:57:06 +08:00
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "getting-started.html#uninstalling-netmaker" class = "md-nav__link" > Uninstalling Netmaker< / a >
2021-05-26 05:57:06 +08:00
2021-08-10 22:02:15 +08:00
< / li > < / ul >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-10 22:02:15 +08:00
< a href = "server-installation.html" class = "md-nav__link" > Advanced Server Installation< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2021-05-26 05:57:06 +08:00
< a href = "server-installation.html#system-compatibility" class = "md-nav__link" > System Compatibility< / a >
< / li >
< li class = "md-nav__item" >
2021-08-11 11:27:13 +08:00
< a href = "server-installation.html#server-configuration-reference" class = "md-nav__link" > Server Configuration Reference< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-11 11:27:13 +08:00
< a href = "server-installation.html#dns-mode-setup" class = "md-nav__link" > DNS Mode Setup< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-11 11:27:13 +08:00
< a href = "server-installation.html#docker-compose-install" class = "md-nav__link" > Docker Compose Install< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-11 11:27:13 +08:00
< a href = "server-installation.html#linux-install-without-docker" class = "md-nav__link" > Linux Install without Docker< / a >
2021-05-26 05:57:06 +08:00
< / li >
< li class = "md-nav__item" >
2021-08-11 11:27:13 +08:00
< a href = "server-installation.html#kubernetes-install" class = "md-nav__link" > Kubernetes Install< / a >
2021-05-26 05:57:06 +08:00
2021-08-10 22:02:15 +08:00
< / li >
< li class = "md-nav__item" >
< a href = "server-installation.html#nginx-reverse-proxy-setup-with-https" class = "md-nav__link" > Nginx Reverse Proxy Setup with https< / a >
2021-05-26 05:57:06 +08:00
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "client-installation.html" class = "md-nav__link" > Client Installation< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "client-installation.html#introduction-to-netclient" class = "md-nav__link" > Introduction to Netclient< / a >
< / li >
< li class = "md-nav__item" >
< a href = "client-installation.html#modes-and-system-compatibility" class = "md-nav__link" > Modes and System Compatibility< / a >
< / li >
< li class = "md-nav__item" >
< a href = "client-installation.html#prerequisites" class = "md-nav__link" > Prerequisites< / a >
< / li >
< li class = "md-nav__item" >
< a href = "client-installation.html#configuration" class = "md-nav__link" > Configuration< / a >
< / li >
< li class = "md-nav__item" >
< a href = "client-installation.html#installation" class = "md-nav__link" > Installation< / a >
< / li >
< li class = "md-nav__item" >
< a href = "client-installation.html#managing-netclient" class = "md-nav__link" > Managing Netclient< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "external-clients.html" class = "md-nav__link" > External Clients< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "external-clients.html#introduction" class = "md-nav__link" > Introduction< / a >
2021-06-10 02:45:05 +08:00
< / li >
< li class = "md-nav__item" >
< a href = "external-clients.html#configuring-an-ingress-gateway" class = "md-nav__link" > Configuring an Ingress Gateway< / a >
< / li >
< li class = "md-nav__item" >
< a href = "external-clients.html#adding-clients-to-a-gateway" class = "md-nav__link" > Adding Clients to a Gateway< / a >
2021-05-26 05:57:06 +08:00
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "usage.html" class = "md-nav__link" > Using Netmaker< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "usage.html#external-tutorials" class = "md-nav__link" > External Tutorials< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "api.html" class = "md-nav__link" > API Reference< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "api.html#api-usage" class = "md-nav__link" > API Usage< / a >
< / li >
< li class = "md-nav__item" >
< a href = "api.html#authentication" class = "md-nav__link" > Authentication< / a >
< / li >
< li class = "md-nav__item" >
< a href = "api.html#format-of-calls-for-curl" class = "md-nav__link" > Format of Calls for Curl< / a >
< / li >
< li class = "md-nav__item" >
< a href = "api.html#api-documentation" class = "md-nav__link" > API Documentation< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "troubleshoot.html" class = "md-nav__link" > Troubleshooting< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "troubleshoot.html#common-issues" class = "md-nav__link" > Common Issues< / a >
< / li >
< li class = "md-nav__item" >
< a href = "troubleshoot.html#server" class = "md-nav__link" > Server< / a >
< / li >
< li class = "md-nav__item" >
< a href = "troubleshoot.html#ui" class = "md-nav__link" > UI< / a >
< / li >
< li class = "md-nav__item" >
< a href = "troubleshoot.html#agent" class = "md-nav__link" > Agent< / a >
< / li >
< li class = "md-nav__item" >
< a href = "troubleshoot.html#coredns" class = "md-nav__link" > CoreDNS< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "support.html" class = "md-nav__link" > Support< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "support.html#faq" class = "md-nav__link" > FAQ< / a >
< / li >
< li class = "md-nav__item" >
< a href = "support.html#contact" class = "md-nav__link" > Contact< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html" class = "md-nav__link" > Code of Conduct< / a >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "conduct.html#our-pledge" class = "md-nav__link" > Our Pledge< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html#our-standards" class = "md-nav__link" > Our Standards< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html#our-responsibilities" class = "md-nav__link" > Our Responsibilities< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html#scope" class = "md-nav__link" > Scope< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html#enforcement" class = "md-nav__link" > Enforcement< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html#attribution" class = "md-nav__link" > Attribution< / a >
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "license.html" class = "md-nav__link" > License< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" >
< label class = "md-nav__title" for = "__toc" > Contents< / label >
< ul class = "md-nav__list" data-md-scrollfix = "" >
< li class = "md-nav__item" > < a href = "#index--page-root" class = "md-nav__link" > Welcome to the Netmaker Documentation< / a > < nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" > < a href = "#about" class = "md-nav__link" > About< / a >
< / li >
< li class = "md-nav__item" > < a href = "#architecture" class = "md-nav__link" > Architecture< / a >
< / li >
< li class = "md-nav__item" > < a href = "#quick-start" class = "md-nav__link" > Quick Start< / a >
< / li >
< li class = "md-nav__item" > < a href = "#server-installation" class = "md-nav__link" > Server Installation< / a >
< / li >
< li class = "md-nav__item" > < a href = "#client-installation" class = "md-nav__link" > Client Installation< / a >
< / li >
< li class = "md-nav__item" > < a href = "#external-clients" class = "md-nav__link" > External Clients< / a >
< / li >
< li class = "md-nav__item" > < a href = "#guides" class = "md-nav__link" > Guides< / a >
< / li >
< li class = "md-nav__item" > < a href = "#api-reference" class = "md-nav__link" > API Reference< / a >
< / li >
< li class = "md-nav__item" > < a href = "#troubleshooting" class = "md-nav__link" > Troubleshooting< / a >
< / li >
< li class = "md-nav__item" > < a href = "#support" class = "md-nav__link" > Support< / a >
< / li >
< li class = "md-nav__item" > < a href = "#code-of-conduct" class = "md-nav__link" > Code of Conduct< / a >
< / li >
< li class = "md-nav__item" > < a href = "#licensing" class = "md-nav__link" > Licensing< / a >
< / li > < / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" >
< article class = "md-content__inner md-typeset" role = "main" >
< a class = "reference internal image-reference" href = "_images/netmaker.png" > < img alt = "Netmaker WireGuard" class = "align-center" src = "_images/netmaker.png" style = "width: 100%;" / > < / a >
< p > < span class = "raw-html" > < br / > < / span > < / p >
< h1 id = "index--page-root" > Welcome to the Netmaker Documentation< a class = "headerlink" href = "#index--page-root" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.< / p >
< p > This documentation covers Netmaker’ < a class = "reference internal" href = "server-installation.html" > < span class = "doc" > installation< / span > < / a > , < a class = "reference internal" href = "usage.html" > < span class = "doc" > usage< / span > < / a > , < a class = "reference internal" href = "support.html" > < span class = "doc" > troubleshooting< / span > < / a > , and customization, as well as reference documents for the < a class = "reference internal" href = "api.html" > < span class = "doc" > API< / span > < / a > , UI and Agent configuration. All of the < a class = "reference external" href = "https://github.com/gravitl/netmaker" > source code< / a > for Netmaker is on GitHub.< / p >
< h2 id = "about" > About< a class = "headerlink" href = "#about" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "about.html" > About< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "about.html#what-is-netmaker" > What is Netmaker?< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "about.html#how-does-netmaker-work" > How Does Netmaker Work?< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "about.html#use-cases-for-netmaker" > Use Cases for Netmaker< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "architecture" > Architecture< a class = "headerlink" href = "#architecture" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A technical overview of Netmaker, including design decisions and limitations.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "architecture.html" > Architecture< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "architecture.html#core-concepts" > Core Concepts< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "architecture.html#components" > Components< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "architecture.html#technical-process" > Technical Process< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "architecture.html#compatible-systems-for-netclient" > Compatible Systems for Netclient< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "architecture.html#limitations" > Limitations< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "quick-start" > Quick Start< a class = "headerlink" href = "#quick-start" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A quick start guide to getting up and running with Netmaker and WireGuard as quickly as possible.< / p >
< div class = "toctree-wrapper compound" >
< ul >
2021-08-10 22:02:15 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "quick-start.html" > Quick Install< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "quick-start.html#introduction" > 0. Introduction< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "quick-start.html#prerequisites" > 1. Prerequisites< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "quick-start.html#install-dependencies" > 2. Install Dependencies< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "quick-start.html#prepare-vm" > 3. Prepare VM< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "quick-start.html#install-netmaker" > 4. Install Netmaker< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "getting-started.html" > Getting Started< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-started.html#setup" > Setup< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-started.html#deploy-nodes" > Deploy Nodes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-started.html#manage-nodes" > Manage Nodes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-started.html#uninstalling-the-netclient" > Uninstalling the netclient< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-started.html#uninstalling-netmaker" > Uninstalling Netmaker< / a > < / li >
2021-05-26 05:57:06 +08:00
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "server-installation" > Server Installation< a class = "headerlink" href = "#server-installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.< / p >
< div class = "toctree-wrapper compound" >
< ul >
2021-08-10 22:02:15 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "server-installation.html" > Advanced Server Installation< / a > < ul >
2021-05-26 05:57:06 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#system-compatibility" > System Compatibility< / a > < / li >
2021-08-11 11:27:13 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#server-configuration-reference" > Server Configuration Reference< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#dns-mode-setup" > DNS Mode Setup< / a > < / li >
2021-05-26 05:57:06 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#docker-compose-install" > Docker Compose Install< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#linux-install-without-docker" > Linux Install without Docker< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#kubernetes-install" > Kubernetes Install< / a > < / li >
2021-08-10 22:02:15 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "server-installation.html#nginx-reverse-proxy-setup-with-https" > Nginx Reverse Proxy Setup with https< / a > < / li >
2021-05-26 05:57:06 +08:00
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "client-installation" > Client Installation< a class = "headerlink" href = "#client-installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "client-installation.html" > Client Installation< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "client-installation.html#introduction-to-netclient" > Introduction to Netclient< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "client-installation.html#modes-and-system-compatibility" > Modes and System Compatibility< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "client-installation.html#prerequisites" > Prerequisites< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "client-installation.html#configuration" > Configuration< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "client-installation.html#installation" > Installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "client-installation.html#managing-netclient" > Managing Netclient< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "external-clients" > External Clients< a class = "headerlink" href = "#external-clients" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A detailed guide to give clients outside of the Netmaker network access to network resources.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "external-clients.html" > External Clients< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "external-clients.html#introduction" > Introduction< / a > < / li >
2021-06-10 02:45:05 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "external-clients.html#configuring-an-ingress-gateway" > Configuring an Ingress Gateway< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "external-clients.html#adding-clients-to-a-gateway" > Adding Clients to a Gateway< / a > < / li >
2021-05-26 05:57:06 +08:00
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "guides" > Guides< a class = "headerlink" href = "#guides" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "usage.html" > Using Netmaker< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "usage.html#external-tutorials" > External Tutorials< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "api-reference" > API Reference< a class = "headerlink" href = "#api-reference" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A reference document for the Netmaker Server API, and example API calls for various use cases.< / p >
< p > < strong > Coming Soon:< / strong > Swagger Documentation< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "api.html" > API Reference< / a > < / li >
< / ul >
< / div >
< h2 id = "troubleshooting" > Troubleshooting< a class = "headerlink" href = "#troubleshooting" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Help with common Netmaker/netclient issues.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "troubleshoot.html" > Troubleshooting< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "troubleshoot.html#common-issues" > Common Issues< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "troubleshoot.html#server" > Server< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "troubleshoot.html#ui" > UI< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "troubleshoot.html#agent" > Agent< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "troubleshoot.html#coredns" > CoreDNS< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "support" > Support< a class = "headerlink" href = "#support" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Where to go for help, and a FAQ.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "support.html" > Support< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "support.html#faq" > FAQ< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "support.html#contact" > Contact< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "code-of-conduct" > Code of Conduct< a class = "headerlink" href = "#code-of-conduct" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A statement on our expectations and pledge to the community.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "conduct.html" > Code of Conduct< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "conduct.html#our-pledge" > Our Pledge< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "conduct.html#our-standards" > Our Standards< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "conduct.html#our-responsibilities" > Our Responsibilities< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "conduct.html#scope" > Scope< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "conduct.html#enforcement" > Enforcement< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "conduct.html#attribution" > Attribution< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< h2 id = "licensing" > Licensing< a class = "headerlink" href = "#licensing" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A link to the Netmaker license.< / p >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "license.html" > License< / a > < / li >
< / ul >
< / div >
< / article >
< / div >
< / div >
< / main >
< / div >
< footer class = "md-footer" >
< div class = "md-footer-nav" >
< nav class = "md-footer-nav__inner md-grid" >
< a href = "about.html" title = "About"
class="md-flex md-footer-nav__link md-footer-nav__link--next"
rel="next">
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" > < span
class="md-flex__ellipsis"> < span
class="md-footer-nav__direction"> Next < / span > About < / span >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" > < i
class="md-icon md-icon--arrow-forward md-footer-nav__button">< / i >
< / div >
< / a >
< / nav >
< / div >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-footer-copyright" >
< div class = "md-footer-copyright__highlight" >
© Copyright 2021, Alex Feiszli.
< / div >
Created using
2021-06-02 00:23:05 +08:00
< a href = "http://www.sphinx-doc.org/" > Sphinx< / a > 3.5.4.
2021-05-26 05:57:06 +08:00
and
< a href = "https://github.com/bashtage/sphinx-material/" > Material for
Sphinx< / a >
< / div >
< / div >
< / div >
< / footer >
< script src = "_static/javascripts/application.js" > < / script >
< script > app . initialize ( { version : "1.0.4" , url : { base : ".." } } ) < / script >
< / body >
< / html >
