mirror of
https://github.com/gravitl/netmaker.git
synced 2024-09-22 00:06:04 +08:00
877 lines
34 KiB
HTML
877 lines
34 KiB
HTML
|
||
<!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>
|
||
|
||
|
||
|
||
<title>Getting Started — Netmaker 0.7 documentation</title>
|
||
<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>
|
||
<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="Advanced Server Installation" href="server-installation.html" />
|
||
<link rel="prev" title="Quick Install" href="quick-start.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="#getting-started" 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">
|
||
<a href="index.html" title="Netmaker 0.7 documentation"
|
||
class="md-header-nav__button md-logo">
|
||
|
||
<i class="md-icon"></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"> Getting Started </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">
|
||
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">Netmaker 0.7 documentation</a></li>
|
||
</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">
|
||
<a href="index.html" title="Netmaker 0.7 documentation" class="md-nav__button md-logo">
|
||
|
||
<i class="md-icon"></i>
|
||
|
||
</a>
|
||
<a href="index.html"
|
||
title="Netmaker 0.7 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">
|
||
|
||
<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">
|
||
|
||
|
||
<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">0. Introduction</a>
|
||
|
||
|
||
</li>
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<a href="quick-start.html#prerequisites" class="md-nav__link">1. Prerequisites</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#prepare-vm" class="md-nav__link">3. Prepare VM</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">
|
||
|
||
|
||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
||
<label class="md-nav__link md-nav__link--active" for="__toc"> Getting Started </label>
|
||
|
||
<a href="#" class="md-nav__link md-nav__link--active">Getting Started</a>
|
||
|
||
|
||
<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="#getting-started--page-root" class="md-nav__link">Getting Started</a><nav class="md-nav">
|
||
<ul class="md-nav__list">
|
||
<li class="md-nav__item"><a href="#setup" class="md-nav__link">Setup</a><nav class="md-nav">
|
||
<ul class="md-nav__list">
|
||
<li class="md-nav__item"><a href="#create-key" class="md-nav__link">Create Key</a>
|
||
</li></ul>
|
||
</nav>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#manage-nodes" class="md-nav__link">Manage Nodes</a>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#uninstalling-netmaker" class="md-nav__link">Uninstalling Netmaker</a>
|
||
</li></ul>
|
||
</nav>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<ul class="md-nav__list">
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<a href="#setup" class="md-nav__link">Setup</a>
|
||
|
||
|
||
</li>
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<a href="#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
|
||
|
||
|
||
</li>
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<a href="#manage-nodes" class="md-nav__link">Manage Nodes</a>
|
||
|
||
|
||
</li>
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<a href="#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
|
||
|
||
|
||
</li>
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<a href="#uninstalling-netmaker" class="md-nav__link">Uninstalling Netmaker</a>
|
||
|
||
|
||
</li></ul>
|
||
|
||
</li>
|
||
<li class="md-nav__item">
|
||
|
||
|
||
<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></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>
|
||
|
||
|
||
</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 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#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">
|
||
|
||
|
||
<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="#getting-started--page-root" class="md-nav__link">Getting Started</a><nav class="md-nav">
|
||
<ul class="md-nav__list">
|
||
<li class="md-nav__item"><a href="#setup" class="md-nav__link">Setup</a><nav class="md-nav">
|
||
<ul class="md-nav__list">
|
||
<li class="md-nav__item"><a href="#create-key" class="md-nav__link">Create Key</a>
|
||
</li></ul>
|
||
</nav>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#manage-nodes" class="md-nav__link">Manage Nodes</a>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
|
||
</li>
|
||
<li class="md-nav__item"><a href="#uninstalling-netmaker" class="md-nav__link">Uninstalling Netmaker</a>
|
||
</li></ul>
|
||
</nav>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="md-content">
|
||
<article class="md-content__inner md-typeset" role="main">
|
||
|
||
|
||
<h1 id="getting-started--page-root">Getting Started<a class="headerlink" href="#getting-started--page-root" title="Permalink to this headline">¶</a></h1>
|
||
<p>Once you have Netmaker installed via the <a class="reference internal" href="quick-start.html"><span class="doc">Quick Install</span></a> guide, you can use this Getting Started guide to help create and manage your first network.</p>
|
||
|
||
<h2 id="setup">Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2>
|
||
<ol class="arabic simple">
|
||
<li><p>Create your admin user, with a username and password.</p></li>
|
||
<li><p>Login with your new user</p></li>
|
||
<li><p>Create your first network by clicking on Create Network</p></li>
|
||
</ol>
|
||
<a class="reference internal image-reference" href="_images/create-net.png"><img alt="Create Network Screen" class="align-center" src="_images/create-net.png" style="width: 80%;"/></a>
|
||
<p>This network should have a sensible name (nodes will use it to set their interfaces).</p>
|
||
<p>More importantly, it should have a non-overlapping, private address range.</p>
|
||
<p>If you are running a small (less than 254 machines) network, and are unsure of which CIDR’s to use, you could consider:</p>
|
||
<ul class="simple">
|
||
<li><p>10.11.12.0/24</p></li>
|
||
<li><p>10.20.30.0/24</p></li>
|
||
<li><p>100.99.98.0/24</p></li>
|
||
</ul>
|
||
<p>Once your network is created, you should see that the netmaker server has added itself to the network. From here, you can move on to adding additional nodes to the network.</p>
|
||
<a class="reference internal image-reference" href="_images/netmaker-node.png"><img alt="Node Screen" class="align-center" src="_images/netmaker-node.png" style="width: 80%;"/></a>
|
||
|
||
<h3 id="create-key">Create Key<a class="headerlink" href="#create-key" title="Permalink to this headline">¶</a></h3>
|
||
<p>Adding nodes to the network typically requires a key.</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Click on the ACCESS KEYS tab and select the network you created.</p></li>
|
||
<li><p>Click ADD NEW ACCESS KEY</p></li>
|
||
<li><p>Give it a name (ex: “mykey”) and a number of uses (ex: 25)</p></li>
|
||
<li><p>Click CREATE KEY (<strong>Important:</strong> Do not click out of the following screen until you have saved your key details. It will appear only once.)</p></li>
|
||
<li><p>Copy the bottom command under “Your agent install command with access token” and save it somewhere locally. E.x: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-sfL</span> <span class="pre">https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/netclient-install.sh</span> <span class="pre">|</span> <span class="pre">KEY=vm3ow4thatogiwnsla3thsl3894ths</span> <span class="pre">sh</span> <span class="pre">-</span></code>.</p></li>
|
||
</ol>
|
||
<a class="reference internal image-reference" href="_images/access-key.png"><img alt="Access Key Screen" class="align-center" src="_images/access-key.png" style="width: 80%;"/></a>
|
||
<p>You will use this command to install the netclient on your nodes. There are three different values for three different scenarios:</p>
|
||
<ul class="simple">
|
||
<li><p>The <strong>Access Key</strong> value is the secret string that will allow your node to authenticate with the Netmaker network. This can be used with existing netclient installations where additional configurations (such as setting the server IP manually) may be required. This is not typical. E.g. <code class="docutils literal notranslate"><span class="pre">netclient</span> <span class="pre">join</span> <span class="pre">-k</span> <span class="pre"><access</span> <span class="pre">key></span> <span class="pre">-s</span> <span class="pre">grpc.myserver.com</span> <span class="pre">-p</span> <span class="pre">50051</span></code></p></li>
|
||
<li><p>The <strong>Access Token</strong> value is a base64 encoded string that contains the server IP and grpc port, as well as the access key. This is decoded by the netclient and can be used with existing netclient installations like this: <code class="docutils literal notranslate"><span class="pre">netclient</span> <span class="pre">join</span> <span class="pre">-t</span> <span class="pre"><access</span> <span class="pre">token></span></code>. You should use this method for adding a network to a node that is already on a network. For instance, Node A is in the <strong>mynet</strong> network and now you are adding it to <strong>default</strong>.</p></li>
|
||
<li><p>The <strong>install command</strong> value is a curl command that can be run on Linux systems. It is a simple script that downloads the netclient binary and runs the install command all in one.</p></li>
|
||
</ul>
|
||
<p>Networks can also be enabled to allow nodes to sign up without keys at all. In this scenario, nodes enter a “pending state” and are not permitted to join the network until an admin approves them.</p>
|
||
|
||
|
||
|
||
<h2 id="deploy-nodes">Deploy Nodes<a class="headerlink" href="#deploy-nodes" title="Permalink to this headline">¶</a></h2>
|
||
<ol class="arabic simple" start="0">
|
||
<li><p>Prereqisite: Every machine on which you install should have wireguard and systemd already installed.</p></li>
|
||
<li><p>SSH to each machine</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">su</span> <span class="pre">-</span></code></p></li>
|
||
<li><p><strong>Prerequisite Check:</strong> Every Linux machine on which you run the netclient must have WireGuard and systemd installed</p></li>
|
||
<li><p>For linux machines with SystemD and WireGuard installed, Run the install command, Ex: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-sfL</span> <span class="pre">https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/netclient-install.sh</span> <span class="pre">|</span> <span class="pre">KEY=vm3ow4thatogiwnsla3thsl3894ths</span> <span class="pre">sh</span> <span class="pre">-</span></code></p></li>
|
||
<li><p>For Mac, Windows, and arch-specific linux distributions (e.g. ARM), <a class="reference external" href="https://github.com/gravitl/netmaker/releases/tag/latest/">download the appropriate netclient for your system</a> . Then, run “netclient join -t <your token>”.</p></li>
|
||
</ol>
|
||
<p>You should get output similar to the below. The netclient retrieves local settings, submits them to the server for processing, and retrieves updated settings. Then it sets the local network configuration. For more information about this process, see the <a class="reference internal" href="client-installation.html"><span class="doc">client installation</span></a> documentation. If this process failed and you do not see your node in the console (see below), then reference the <a class="reference internal" href="troubleshoot.html"><span class="doc">troubleshooting</span></a> documentation.</p>
|
||
<a class="reference internal image-reference" href="_images/nc-install-output.png"><img alt="Output from Netclient Install" class="align-center" src="_images/nc-install-output.png" style="width: 80%;"/></a>
|
||
<a class="reference internal image-reference" href="_images/nm-node-success.png"><img alt="Node Success" class="align-center" src="_images/nm-node-success.png" style="width: 80%;"/></a>
|
||
<p>Repeat the above steps for every machine you would like to add to your network. You can re-use the same install command so long as you do not run out of uses on your access key (after which it will be invalidated and deleted).</p>
|
||
<p>Once installed on all nodes, you can test the connection by pinging the private address of any node from any other node.</p>
|
||
<a class="reference internal image-reference" href="_images/ping-node.png"><img alt="Node Success" class="align-center" src="_images/ping-node.png" style="width: 80%;"/></a>
|
||
|
||
|
||
<h2 id="manage-nodes">Manage Nodes<a class="headerlink" href="#manage-nodes" title="Permalink to this headline">¶</a></h2>
|
||
<p>Your machines should now be visible in the control pane.</p>
|
||
<a class="reference internal image-reference" href="_images/nodes.png"><img alt="Node Success" class="align-center" src="_images/nodes.png" style="width: 80%;"/></a>
|
||
<p>You can view/modify/delete any node by selecting it in the NODES tab. For instance, you can change the name to something more sensible like “workstation” or “api server”. You can also modify network settings here, such as keys or the WireGuard port. These settings will be picked up by the node on its next check in. For more information, see Advanced Configuration in the <a class="reference internal" href="usage.html"><span class="doc">Using Netmaker</span></a> docs.</p>
|
||
<a class="reference internal image-reference" href="_images/node-details.png"><img alt="Node Success" class="align-center" src="_images/node-details.png" style="width: 80%;"/></a>
|
||
<p>Nodes can be added/removed/modified on the network at any time. Nodes can also be added to multiple Netmaker networks. Any changes will get picked up by any nodes on a given network, and will take aboue ~30 seconds to take effect.</p>
|
||
|
||
|
||
<h2 id="uninstalling-the-netclient">Uninstalling the netclient<a class="headerlink" href="#uninstalling-the-netclient" title="Permalink to this headline">¶</a></h2>
|
||
<ol class="arabic simple">
|
||
<li><p>To remove your nodes from the default network, run the following on each node: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">netclient</span> <span class="pre">leave</span> <span class="pre">-n</span> <span class="pre">default</span></code></p></li>
|
||
<li><p>To remove the netclient entirely from each node, run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">rm</span> <span class="pre">-rf</span> <span class="pre">/etc/netclient</span></code> (after running the first step)</p></li>
|
||
</ol>
|
||
|
||
|
||
<h2 id="uninstalling-netmaker">Uninstalling Netmaker<a class="headerlink" href="#uninstalling-netmaker" title="Permalink to this headline">¶</a></h2>
|
||
<p>To uninstall Netmaker from the server, simply run <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">down</span></code> or <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">down</span> <span class="pre">--volumes</span></code> to remove the docker volumes for a future installation.</p>
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
</div>
|
||
</main>
|
||
</div>
|
||
<footer class="md-footer">
|
||
<div class="md-footer-nav">
|
||
<nav class="md-footer-nav__inner md-grid">
|
||
|
||
<a href="quick-start.html" title="Quick Install"
|
||
class="md-flex md-footer-nav__link md-footer-nav__link--prev"
|
||
rel="prev">
|
||
<div class="md-flex__cell md-flex__cell--shrink">
|
||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
|
||
</div>
|
||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
||
<span class="md-flex__ellipsis">
|
||
<span
|
||
class="md-footer-nav__direction"> Previous </span> Quick Install </span>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<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> 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>
|
||
</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
|
||
<a href="http://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
|
||
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> |