mirror of
https://github.com/gravitl/netmaker.git
synced 2025-10-31 12:16:29 +08:00
updated docs
This commit is contained in:
afeiszli
440
docs/_build/html/getting-started.html
vendored
440
docs/_build/html/getting-started.html
vendored
@@ -46,7 +46,7 @@
|
||||
|
||||
|
||||
|
||||
<title>Getting Started — Netmaker 0.9.0 documentation</title>
|
||||
<title>Getting Started — Netmaker 0.9.4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/material.css" />
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
@@ -56,7 +56,7 @@
|
||||
<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="Install with Nginx (depreciated)" href="quick-start-nginx.html" />
|
||||
<link rel="next" title="Advanced Server Installation" href="server-installation.html" />
|
||||
<link rel="prev" title="Quick Install" href="quick-start.html" />
|
||||
|
||||
|
||||
@@ -81,7 +81,7 @@
|
||||
<nav class="md-header-nav md-grid">
|
||||
<div class="md-flex navheader">
|
||||
<div class="md-flex__cell md-flex__cell--shrink">
|
||||
<a href="index.html" title="Netmaker 0.9.0 documentation"
|
||||
<a href="index.html" title="Netmaker 0.9.4 documentation"
|
||||
class="md-header-nav__button md-logo">
|
||||
|
||||
<i class="md-icon"></i>
|
||||
@@ -167,7 +167,7 @@
|
||||
<nav class="md-tabs" data-md-component="tabs">
|
||||
<div class="md-tabs__inner md-grid">
|
||||
<ul class="md-tabs__list">
|
||||
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">Netmaker 0.9.0 documentation</a></li>
|
||||
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">Netmaker 0.9.4 documentation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
@@ -179,13 +179,13 @@
|
||||
<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">
|
||||
<a href="index.html" title="Netmaker 0.9.0 documentation" class="md-nav__button md-logo">
|
||||
<a href="index.html" title="Netmaker 0.9.4 documentation" class="md-nav__button md-logo">
|
||||
|
||||
<i class="md-icon"></i>
|
||||
|
||||
</a>
|
||||
<a href="index.html"
|
||||
title="Netmaker 0.9.0 documentation">Netmaker Docs</a>
|
||||
title="Netmaker 0.9.4 documentation">Netmaker Docs</a>
|
||||
</label>
|
||||
<div class="md-nav__source">
|
||||
<a href="https://github.com/gravitl/netmaker/" title="Go to repository" class="md-source" data-md-source="github">
|
||||
@@ -209,72 +209,16 @@
|
||||
<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>
|
||||
<a href="about.html" class="md-nav__link">1. About</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">
|
||||
|
||||
@@ -287,50 +231,8 @@
|
||||
|
||||
|
||||
<a href="quick-start.html" class="md-nav__link">Quick Install</a>
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start.html#prerequisites" class="md-nav__link">0. Prerequisites</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start.html#prepare-dns" class="md-nav__link">1. Prepare DNS</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start.html#install-dependencies" class="md-nav__link">2. Install Dependencies</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start.html#open-firewall" class="md-nav__link">3. Open Firewall</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start.html#install-netmaker" class="md-nav__link">4. Install Netmaker</a>
|
||||
|
||||
|
||||
</li></ul>
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
@@ -417,48 +319,6 @@
|
||||
<a href="#uninstalling-netmaker" class="md-nav__link">Uninstalling Netmaker</a>
|
||||
|
||||
|
||||
</li></ul>
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html" class="md-nav__link">Install with Nginx (depreciated)</a>
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html#introduction" class="md-nav__link">0. Introduction</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html#prerequisites" class="md-nav__link">1. Prerequisites</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html#install-dependencies" class="md-nav__link">2. Install Dependencies</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html#prepare-vm" class="md-nav__link">3. Prepare VM</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html#install-netmaker" class="md-nav__link">4. Install Netmaker</a>
|
||||
|
||||
|
||||
</li></ul>
|
||||
|
||||
</li>
|
||||
@@ -466,358 +326,92 @@
|
||||
|
||||
|
||||
<a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#server-configuration-reference" class="md-nav__link">Server Configuration Reference</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#dns-mode-setup" class="md-nav__link">DNS Mode Setup</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
|
||||
|
||||
|
||||
</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>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#highly-available-installation-kubernetes" class="md-nav__link">Highly Available Installation (Kubernetes)</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="server-installation.html#highly-available-installation-vms-bare-metal" class="md-nav__link">Highly Available Installation (VMs/Bare Metal)</a>
|
||||
|
||||
|
||||
</li></ul>
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="oauth.html#configuring-your-provider" class="md-nav__link">Configuring your provider</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="oauth.html#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
|
||||
|
||||
|
||||
</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#notes-on-windows" class="md-nav__link">Notes on Windows</a>
|
||||
<a href="external-clients.html" class="md-nav__link">Ingress GW + External Clients</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>
|
||||
<a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="client-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
|
||||
<a href="relay-server.html" class="md-nav__link">Relay Servers</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>
|
||||
|
||||
|
||||
</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>
|
||||
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="external-clients.html#configuring-dns-for-ext-clients-optional" class="md-nav__link">Configuring DNS for Ext Clients (OPTIONAL)</a>
|
||||
|
||||
|
||||
</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>
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="usage.html#external-tutorials" class="md-nav__link">External Tutorials</a>
|
||||
<a href="ui-reference.html" class="md-nav__link">UI Reference</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>
|
||||
<a href="upgrades.html" class="md-nav__link">Upgrades</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#netclient" class="md-nav__link">Netclient</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">
|
||||
|
||||
@@ -984,12 +578,12 @@
|
||||
</a>
|
||||
|
||||
|
||||
<a href="quick-start-nginx.html" title="Install with Nginx (depreciated)"
|
||||
<a href="server-installation.html" title="Advanced Server Installation"
|
||||
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> Install with Nginx (depreciated) </span>
|
||||
class="md-footer-nav__direction"> Next </span> Advanced Server Installation </span>
|
||||
</div>
|
||||
<div class="md-flex__cell md-flex__cell--shrink"><i
|
||||
class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
|
||||
|
||||
Reference in New Issue
Block a user