index formatting good

docs/_build/html/_sources/api.rst.txt

@@ -1,6 +1,6 @@
-===========================================
-Netmaker Server API Reference Documentation
-==========================================
+=============================================
+API Reference
+=============================================
 
 API Usage
 ==========================
@@ -105,7 +105,7 @@ Nodes API
 Nodes API Call Examples
 ----------------------- 
   
-**Get All Nodes:**`curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes | jq`
+**Get All Nodes:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes | jq`
   
 **Get Network Nodes:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes/skynet | jq`
     
@@ -149,13 +149,13 @@ Users API
 Users API Calls Examples
 ------------------------
   
-**Get User:**`curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/{username} | jq`
+**Get User:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/{username} | jq`
 
 **Update User:** `curl -X PUT -d '{"password":"noonewillguessthis"}' -H 'Content-Type: application/json' -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/users/{username}`
   
 **Delete User:** `curl -X DELETE -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/users/{username}`
   
-**Check for Admin User:**`curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/adm/hasadmin`
+**Check for Admin User:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/adm/hasadmin`
   
 **Create Admin User:** `curl -d '{ "username": "smartguy", "password": "YOUR_PASS"}' -H 'Content-Type: application/json' -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/users/adm/createadmin`
    

docs/_build/html/_sources/contribute.rst.txt

@@ -0,0 +1,26 @@
+===========
+Contribute
+===========
+
+Submitting an Issue
+====================
+
+Submitting an Enhancement
+==========================
+
+Contributing Code
+==================
+
+Forking
+----------
+
+Building
+-----------
+
+Testing
+----------
+
+Submitting a PR
+-----------------
+
+

docs/_build/html/_sources/index.rst.txt

@@ -9,22 +9,28 @@
    :alt: Netmaker WireGuard
    :align: center
 
+.. role:: raw-html(raw)
+    :format: html
 
+:raw-html:`<br />`
+
+=======================================
 Welcome to the Netmaker Documentation
 =======================================
 
 
-Netmaker is a platform for creating and managing fast, secure, and easy-to-use virtual overlay networks using WireGuard.
+Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.
+
+This documentation covers Netmaker's installation, usage, troubleshooting, and customization, as well as reference documents for the API, UI and Agent configuration. All of the `source code <https://github.com/gravitl/netmaker>`_ for Netmaker is on GitHub.
 
-This site covers Netmaker's installation, usage, troubleshooting, and customization, as well as thorough documentation of configurations for the API, UI and Agent. You can view and retrieve all of our `source code <https://github.com/gravitl/netmaker>`_ on GitHub.
+:raw-html:`<br />`
 
 .. raw:: html
    :file: youtube-1.html
 
 About
 ------
-
-A quick overview of Netmaker, explaining what it is about, and why you should be using it.
+A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.
 
 .. toctree::
    :maxdepth: 2
@@ -34,7 +40,7 @@ A quick overview of Netmaker, explaining what it is about, and why you should be
 Architecture
 ---------------
 
-Information about Netmaker's technical design and how it is implemented.
+A technical overview of Netmaker, including design decisions and limitations.
 
 .. toctree::
    :maxdepth: 2
@@ -44,7 +50,7 @@ Information about Netmaker's technical design and how it is implemented.
 Quick Start
 ---------------
 
-Get up and running as quickly as possible with a full mesh overlay VPN based on WireGuard.
+A quick start guide to getting up and running with Netmaker and WireGuard as quickly as possible.
 
 .. toctree::
    :maxdepth: 2
@@ -54,7 +60,7 @@ Get up and running as quickly as possible with a full mesh overlay VPN based on
 Server Installation
 --------------------
 
-Covers installation of the Server, UI, DB, and supporting services such as Client and CoreDNS.
+A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.
 
 .. toctree::
    :maxdepth: 2
@@ -64,7 +70,7 @@ Covers installation of the Server, UI, DB, and supporting services such as Clien
 Client Installation
 --------------------
 
-Covers installation of the agent (netclient) and configuration options.
+A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.
 
 .. toctree::
    :maxdepth: 2
@@ -72,10 +78,10 @@ Covers installation of the agent (netclient) and configuration options.
    client-installation
 
 
-Using Netmaker
+Guides
 ----------------
 
-Different use cases such as site-to-site/gateway, Kubernetes, and DNS. Use these guides to get started with a more advanced use case.
+A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.
 
 .. toctree::
    :maxdepth: 2
@@ -85,10 +91,9 @@ Different use cases such as site-to-site/gateway, Kubernetes, and DNS. Use these
 API Reference
 ---------------
 
+A reference document for the Netmaker Server API, and example API calls for various use cases.
 
-These are the reference documents for the Netmaker Server API. It also provides examples for various API calls that cover different use cases. The API docs are currently static. In a future release these docs will be replaced by Swagger docs.
-
-**TODO:** Swagger Documentation via https://github.com/swaggo/swag
+**Coming Soon:** Swagger Documentation
 
 .. toctree::
    :maxdepth: 1
@@ -98,7 +103,7 @@ These are the reference documents for the Netmaker Server API. It also provides
 Support
 ----------------
 
-Common issue troubleshooting, FAQ, and Contact information.
+A few helpful documents for if you run into issues with Netmaker.
 
 .. toctree::
    :maxdepth: 2
@@ -106,11 +111,19 @@ Common issue troubleshooting, FAQ, and Contact information.
    support
 
 
+Contributing
+-----------------
+
+A guide on how to contribute to the Netmaker project.
+
+.. toctree:: 
+
+        contribute.rst
 
 Code of Conduct
 -----------------
 
-Learn how to approproately interact with the community: 
+A statement on our expectations and pledge to the community.
 
 .. toctree:: 
 
@@ -119,7 +132,7 @@ Learn how to approproately interact with the community:
 Licensing
 ---------------
 
-Information about the Netmaker license.
+A link to the Netmaker license.
 
 .. toctree:: 
 

docs/_build/html/about.html

@@ -57,7 +57,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Architecture" href="architecture.html" />
-    <link rel="prev" title="Welcome to the Netmaker Documentation" href="index.html" />
+    <link rel="prev" title="" href="index.html" />
   
    
 
@@ -502,9 +502,58 @@
     <li class="md-nav__item">
     
     
-      <a href="contact.html" class="md-nav__link">Contact</a>
+      <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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -636,7 +685,7 @@
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
           
-            <a href="index.html" title="Welcome to the Netmaker Documentation"
+            <a href="index.html" title=""
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -645,7 +694,7 @@
               <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> Welcome to the Netmaker Documentation </span>
+                      class="md-footer-nav__direction"> Previous </span> <span class="raw-html"><br /></span> </span>
               </div>
             </a>
           

docs/_build/html/api.html

@@ -46,16 +46,17 @@
   
   
   
-    <title>API Usage &#8212; Netmaker 0.3.5 documentation</title>
+    <title>API Reference &#8212; Netmaker 0.3.5 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="Code of Conduct" href="conduct.html" />
+    <link rel="next" title="Support" href="support.html" />
     <link rel="prev" title="Using Netmaker" href="usage.html" />
   
    
@@ -93,7 +94,7 @@
       <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"> API Usage </span>
+          <span class="md-header-nav__topic"> API Reference </span>
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
@@ -208,26 +209,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -356,15 +385,17 @@
     
     
     <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"> API Usage </label>
+    <label class="md-nav__link md-nav__link--active" for="__toc"> API Reference </label>
     
-      <a href="#" class="md-nav__link md-nav__link--active">API Usage</a>
+      <a href="#" class="md-nav__link md-nav__link--active">API Reference</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="#api--page-root" class="md-nav__link">API Usage</a>
+        <li class="md-nav__item"><a href="#api--page-root" class="md-nav__link">API Reference</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#api-usage" class="md-nav__link">API Usage</a>
         </li>
         <li class="md-nav__item"><a href="#authentication" class="md-nav__link">Authentication</a>
         </li>
@@ -391,11 +422,18 @@
         <li class="md-nav__item"><a href="#server-management-api" class="md-nav__link">Server Management API</a>
         </li>
         <li class="md-nav__item"><a href="#file-server-api" class="md-nav__link">File Server API</a>
+        </li></ul>
+            </nav>
         </li></ul>
             </nav>
         </li>
   </ul>
 </nav>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="#api-usage" class="md-nav__link">API Usage</a>
       
     
     </li>
@@ -417,74 +455,62 @@
     
     
       <a href="#api-documentation" class="md-nav__link">API Documentation</a>
-      <ul class="md-nav__list"> 
-    <li class="md-nav__item">
-    
-    
-      <a href="#networks-api" class="md-nav__link">Networks API</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="#networks-api-call-examples" class="md-nav__link">Networks API Call Examples</a>
-      
+    </li></ul>
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#access-keys-api" class="md-nav__link">Access Keys API</a>
-      
-    
-    </li>
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="#access-keys-api-call-examples" class="md-nav__link">Access Keys API Call Examples</a>
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#nodes-api" class="md-nav__link">Nodes API</a>
+      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#nodes-api-call-examples" class="md-nav__link">Nodes API Call Examples</a>
+      <a href="support.html#contact" class="md-nav__link">Contact</a>
       
     
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#users-api" class="md-nav__link">Users API</a>
-      
-    
-    </li>
+      <a href="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="#users-api-calls-examples" class="md-nav__link">Users API Calls Examples</a>
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#server-management-api" class="md-nav__link">Server Management API</a>
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#file-server-api" class="md-nav__link">File Server API</a>
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
       
     
     </li></ul>
@@ -545,13 +571,6 @@
       <a href="license.html" class="md-nav__link">License</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   
@@ -567,7 +586,9 @@
 <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="#api--page-root" class="md-nav__link">API Usage</a>
+        <li class="md-nav__item"><a href="#api--page-root" class="md-nav__link">API Reference</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#api-usage" class="md-nav__link">API Usage</a>
         </li>
         <li class="md-nav__item"><a href="#authentication" class="md-nav__link">Authentication</a>
         </li>
@@ -594,6 +615,8 @@
         <li class="md-nav__item"><a href="#server-management-api" class="md-nav__link">Server Management API</a>
         </li>
         <li class="md-nav__item"><a href="#file-server-api" class="md-nav__link">File Server API</a>
+        </li></ul>
+            </nav>
         </li></ul>
             </nav>
         </li>
@@ -607,23 +630,25 @@
           <article class="md-content__inner md-typeset" role="main">
             
   
-<h1 id="api--page-root">API Usage<a class="headerlink" href="#api--page-root" title="Permalink to this headline">¶</a></h1>
+<h1 id="api--page-root">API Reference<a class="headerlink" href="#api--page-root" title="Permalink to this headline">¶</a></h1>
+
+<h2 id="api-usage">API Usage<a class="headerlink" href="#api-usage" title="Permalink to this headline">¶</a></h2>
 <p>Most actions that can be performed via API can be performed via UI. We recommend managing your networks using the official netmaker-ui project. However, Netmaker can also be run without the UI, and all functions can be achieved via API calls. If your use case requires using Netmaker without the UI or you need to do some troubleshooting/advanced configuration, using the API directly may help.</p>
 
 
-<h1 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline">¶</a></h1>
+<h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline">¶</a></h2>
 <p>API calls must be authenticated via a header of  the format  <cite>-H “Authorization: Bearer &lt;YOUR_SECRET_KEY&gt;”</cite> There are two methods to obtain YOUR_SECRET_KEY:
 1. Using the masterkey. By default, this value is “secret key,” but you should change this on your instance and keep it secure. This value can be set via env var at startup or in a config file (config/environments/&lt; env &gt;.yaml). See the [general usage](./USAGE.md) documentation for more details.
 2. Using a JWT recieved for a node. This  can be retrieved by calling the <cite>/api/nodes/&lt;network&gt;/authenticate</cite> endpoint, as documented below.</p>
 
 
-<h1 id="format-of-calls-for-curl">Format of Calls for Curl<a class="headerlink" href="#format-of-calls-for-curl" title="Permalink to this headline">¶</a></h1>
+<h2 id="format-of-calls-for-curl">Format of Calls for Curl<a class="headerlink" href="#format-of-calls-for-curl" title="Permalink to this headline">¶</a></h2>
 <p>Requests take the format of <cite>curl -H “Authorization: Bearer &lt;YOUR_SECRET_KEY&gt;” -H ‘Content-Type: application/json’ localhost:8081/api/path/to/endpoint</cite></p>
 
 
-<h1 id="api-documentation">API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h1>
+<h2 id="api-documentation">API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h2>
 
-<h2 id="networks-api">Networks API<a class="headerlink" href="#networks-api" title="Permalink to this headline">¶</a></h2>
+<h3 id="networks-api">Networks API<a class="headerlink" href="#networks-api" title="Permalink to this headline">¶</a></h3>
 <p><strong>Get All Networks:</strong> <cite>/api/networks</cite>, <cite>GET</cite></p>
 <p><strong>Create Network:</strong> <cite>/api/network</cite>, <cite>POST</cite></p>
 <p><strong>Get Network:</strong> <cite>/api/networks/{network id}</cite>, <cite>GET</cite></p>
@@ -632,7 +657,7 @@
 <p><strong>Cycle PublicKeys on all Nodes:</strong> <cite>/api/networks/{network id}/keyupdate</cite>, <cite>POST</cite></p>
 
 
-<h2 id="networks-api-call-examples">Networks API Call Examples<a class="headerlink" href="#networks-api-call-examples" title="Permalink to this headline">¶</a></h2>
+<h3 id="networks-api-call-examples">Networks API Call Examples<a class="headerlink" href="#networks-api-call-examples" title="Permalink to this headline">¶</a></h3>
 <p><strong>Get All Networks:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/networks | jq</cite></p>
 <p><strong>Create Network:</strong> <cite>curl -d ‘{“addressrange”:”10.70.0.0/16”,”netid”:”skynet”}’ -H “Authorization: Bearer YOUR_SECRET_KEY” -H ‘Content-Type: application/json’ localhost:8081/api/networks</cite></p>
 <p><strong>Get Network:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/networks/skynet | jq</cite></p>
@@ -641,19 +666,19 @@
 <p><strong>Cycle PublicKeys on all Nodes:</strong> <cite>curl -X POST -H “Authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/networks/skynet/keyupdate</cite></p>
 
 
-<h2 id="access-keys-api">Access Keys API<a class="headerlink" href="#access-keys-api" title="Permalink to this headline">¶</a></h2>
+<h3 id="access-keys-api">Access Keys API<a class="headerlink" href="#access-keys-api" title="Permalink to this headline">¶</a></h3>
 <p><strong>Get All Keys:</strong> <cite>/api/networks/{network id}/keys</cite>, <cite>GET</cite></p>
 <p><strong>Create Key:</strong> <cite>/api/networks/{network id}/keys</cite>, <cite>GET</cite></p>
 <p><strong>Delete Key:</strong> <cite>/api/networks/{network id}/keys/{keyname}</cite>, <cite>DELETE</cite></p>
 
 
-<h2 id="access-keys-api-call-examples">Access Keys API Call Examples<a class="headerlink" href="#access-keys-api-call-examples" title="Permalink to this headline">¶</a></h2>
+<h3 id="access-keys-api-call-examples">Access Keys API Call Examples<a class="headerlink" href="#access-keys-api-call-examples" title="Permalink to this headline">¶</a></h3>
 <p><strong>Get All Keys:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/networks/skynet/keys | jq</cite></p>
 <p><strong>Create Key:</strong> <cite>curl -d ‘{“uses”:10,”name”:”mykey”}’ -H “Authorization: Bearer YOUR_SECRET_KEY” -H ‘Content-Type: application/json’ localhost:8081/api/networks/skynet/keys</cite></p>
 <p><strong>Delete Key:</strong> <cite>curl -X DELETE -H “Authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/networks/skynet/keys/mykey</cite></p>
 
 
-<h2 id="nodes-api">Nodes API<a class="headerlink" href="#nodes-api" title="Permalink to this headline">¶</a></h2>
+<h3 id="nodes-api">Nodes API<a class="headerlink" href="#nodes-api" title="Permalink to this headline">¶</a></h3>
 <p><strong>Get All Nodes:</strong> <cite>/api/nodes</cite>, <cite>GET</cite></p>
 <p><strong>Get Network Nodes:</strong> <cite>/api/nodes/{network id}</cite>, <cite>GET</cite></p>
 <p><strong>Create Node:</strong> <cite>/api/nodes/{network id}</cite>, <cite>POST</cite></p>
@@ -668,8 +693,8 @@
 <p><strong>Authenticate:</strong> <cite>/api/nodes/adm/{network id}/authenticate</cite>, <cite>POST</cite></p>
 
 
-<h2 id="nodes-api-call-examples">Nodes API Call Examples<a class="headerlink" href="#nodes-api-call-examples" title="Permalink to this headline">¶</a></h2>
-<p><a href="#id1"><span class="problematic" id="id2">**</span></a>Get All Nodes:<a href="#id3"><span class="problematic" id="id4">**</span></a><cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/nodes | jq</cite></p>
+<h3 id="nodes-api-call-examples">Nodes API Call Examples<a class="headerlink" href="#nodes-api-call-examples" title="Permalink to this headline">¶</a></h3>
+<p><strong>Get All Nodes:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/nodes | jq</cite></p>
 <p><strong>Get Network Nodes:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/nodes/skynet | jq</cite></p>
 <p><strong>Create Node:</strong> <cite>curl  -d  ‘{ “endpoint”: 100.200.100.200, “publickey”: aorijqalrik3ajflaqrdajhkr,”macaddress”: “8c:90:b5:06:f1:d9”,”password”: “reallysecret”,”localaddress”: “172.16.16.1”,”accesskey”: “aA3bVG0rnItIRXDx”,”listenport”: 6400}’ -H ‘Content-Type: application/json’ -H “authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/nodes/skynet</cite></p>
 <p><strong>Get Node:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/nodes/skynet/{macaddress} | jq</cite></p>
@@ -682,7 +707,7 @@
 <p><strong>Authenticate:</strong> <cite>curl -d  ‘{“macaddress”: “8c:90:b5:06:f1:d9”, “password”: “YOUR_PASSWORD”}’ -H ‘Content-Type: application/json’ localhost:8081/api/nodes/adm/skynet/authenticate</cite></p>
 
 
-<h2 id="users-api">Users API<a class="headerlink" href="#users-api" title="Permalink to this headline">¶</a></h2>
+<h3 id="users-api">Users API<a class="headerlink" href="#users-api" title="Permalink to this headline">¶</a></h3>
 <p><strong>Note:</strong> Only able to create Admin user at this time. The “user” is only used by the [user interface](<a class="reference external" href="https://github.com/gravitl/netmaker-ui">https://github.com/gravitl/netmaker-ui</a>) to authenticate the  single  admin user.</p>
 <p><strong>Get User:</strong> <cite>/api/users/{username}</cite>, <cite>GET</cite></p>
 <p><strong>Update User:</strong> <cite>/api/users/{username}</cite>, <cite>PUT</cite></p>
@@ -692,16 +717,16 @@
 <p><strong>Authenticate:</strong> <cite>/api/users/adm/authenticate</cite>, <cite>POST</cite></p>
 
 
-<h2 id="users-api-calls-examples">Users API Calls Examples<a class="headerlink" href="#users-api-calls-examples" title="Permalink to this headline">¶</a></h2>
-<p><a href="#id5"><span class="problematic" id="id6">**</span></a>Get User:<a href="#id7"><span class="problematic" id="id8">**</span></a><cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/users/{username} | jq</cite></p>
+<h3 id="users-api-calls-examples">Users API Calls Examples<a class="headerlink" href="#users-api-calls-examples" title="Permalink to this headline">¶</a></h3>
+<p><strong>Get User:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/users/{username} | jq</cite></p>
 <p><strong>Update User:</strong> <cite>curl -X PUT -d ‘{“password”:”noonewillguessthis”}’ -H ‘Content-Type: application/json’ -H “authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/users/{username}</cite></p>
 <p><strong>Delete User:</strong> <cite>curl -X DELETE -H “authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/users/{username}</cite></p>
-<p><a href="#id9"><span class="problematic" id="id10">**</span></a>Check for Admin User:<a href="#id11"><span class="problematic" id="id12">**</span></a><cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/users/adm/hasadmin</cite></p>
+<p><strong>Check for Admin User:</strong> <cite>curl -H “Authorization: Bearer YOUR_SECRET_KEY” http://localhost:8081/api/users/adm/hasadmin</cite></p>
 <p><strong>Create Admin User:</strong> <cite>curl -d ‘{ “username”: “smartguy”, “password”: “YOUR_PASS”}’ -H ‘Content-Type: application/json’ -H “authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/users/adm/createadmin</cite></p>
 <p><strong>Authenticate:</strong> <cite>curl -d  ‘{“username”: “smartguy”, “password”: “YOUR_PASS”}’ -H ‘Content-Type: application/json’ localhost:8081/api/nodes/adm/skynet/authenticate</cite></p>
 
 
-<h2 id="server-management-api">Server Management API<a class="headerlink" href="#server-management-api" title="Permalink to this headline">¶</a></h2>
+<h3 id="server-management-api">Server Management API<a class="headerlink" href="#server-management-api" title="Permalink to this headline">¶</a></h3>
 <p>The Server Mgmt. API allows you to add and remove the server from networks.</p>
 <p><strong>Add to Network:</strong> <cite>/api/server/addnetwork/{network id}</cite>, <cite>POST</cite></p>
 <p><strong>Remove from Network:</strong> <cite>/api/server/removenetwork/{network id}</cite>, <cite>DELETE</cite></p>
@@ -709,13 +734,14 @@
 <p><strong>Remove from Network:</strong> <cite>curl -X DELETE -H “authorization: Bearer YOUR_SECRET_KEY” localhost:8081/api/server/removenetwork/{network id}</cite></p>
 
 
-<h2 id="file-server-api">File Server API<a class="headerlink" href="#file-server-api" title="Permalink to this headline">¶</a></h2>
+<h3 id="file-server-api">File Server API<a class="headerlink" href="#file-server-api" title="Permalink to this headline">¶</a></h3>
 <p><strong>Get File:</strong> <cite>/meshclient/files/{filename}</cite>, <cite>GET</cite></p>
 <p><strong>Example:</strong> <cite>curl localhost:8081/meshclient/files/meshclient</cite></p>
 
 
 
 
+
           </article>
         </div>
       </div>
@@ -739,12 +765,12 @@
             </a>
           
           
-            <a href="conduct.html" title="Code of Conduct"
+            <a href="support.html" title="Support"
                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> Code of Conduct </span>
+                class="md-footer-nav__direction"> Next </span> Support </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink"><i
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>

docs/_build/html/architecture.html

@@ -516,9 +516,58 @@
     <li class="md-nav__item">
     
     
-      <a href="contact.html" class="md-nav__link">Contact</a>
+      <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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     

docs/_build/html/client-installation.html

@@ -53,6 +53,7 @@
     <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="Using Netmaker" href="usage.html" />
@@ -208,26 +209,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -477,6 +506,62 @@
       <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -535,13 +620,6 @@
       <a href="license.html" class="md-nav__link">License</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   

docs/_build/html/conduct.html

@@ -53,10 +53,11 @@
     <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="License" href="license.html" />
-    <link rel="prev" title="API Usage" href="api.html" />
+    <link rel="prev" title="Contribute" href="contribute.html" />
   
    
 
@@ -208,26 +209,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -447,6 +476,62 @@
       <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -531,13 +616,6 @@
       <a href="license.html" class="md-nav__link">License</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   
@@ -665,7 +743,7 @@ available <a class="reference external" href="https://contributor-covenant.org/v
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
           
-            <a href="api.html" title="API Usage"
+            <a href="contribute.html" title="Contribute"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -674,7 +752,7 @@ available <a class="reference external" href="https://contributor-covenant.org/v
               <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> API Usage </span>
+                      class="md-footer-nav__direction"> Previous </span> Contribute </span>
               </div>
             </a>
           

docs/_build/html/contribute.html

@@ -0,0 +1,750 @@
+
+<!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>Contribute &#8212; Netmaker 0.3.5 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="Code of Conduct" href="conduct.html" />
+    <link rel="prev" title="Support" href="support.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="#contribute" 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.3.5 documentation"
+           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"> Contribute </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">
+        &#xE5CD;
+      </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.3.5 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.3.5 documentation" class="md-nav__button md-logo">
+      
+        <i class="md-icon">&#xe869</i>
+      
+    </a>
+    <a href="index.html"
+       title="Netmaker 0.3.5 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#introduction" class="md-nav__link">Introduction</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" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</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 Start</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html" class="md-nav__link">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#prerequisites" class="md-nav__link">Prerequisites</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</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#system-compatibility" class="md-nav__link">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#installing-netclient" class="md-nav__link">Installing Netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#unmanaged-clients-pure-wireguard" class="md-nav__link">Unmanaged Clients (Pure WireGuard)</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>
+    <li class="md-nav__item">
+    
+    
+      <a href="usage.html#basic" class="md-nav__link">Basic</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="usage.html#local-network" class="md-nav__link">Local Network</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="usage.html#site-to-site" class="md-nav__link">Site-to-Site</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="usage.html#dual-stack-with-ipv6" class="md-nav__link">Dual Stack with IPv6</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="usage.html#kubernetes-node-network" class="md-nav__link">Kubernetes Node Network</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html" 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>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#networks-api" class="md-nav__link">Networks API</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#networks-api-call-examples" class="md-nav__link">Networks API Call Examples</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#access-keys-api" class="md-nav__link">Access Keys API</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#access-keys-api-call-examples" class="md-nav__link">Access Keys API Call Examples</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#nodes-api" class="md-nav__link">Nodes API</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#nodes-api-call-examples" class="md-nav__link">Nodes API Call Examples</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#users-api" class="md-nav__link">Users API</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#users-api-calls-examples" class="md-nav__link">Users API Calls Examples</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#server-management-api" class="md-nav__link">Server Management API</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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">
+    
+    
+    <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"> Contribute </label>
+    
+      <a href="#" class="md-nav__link md-nav__link--active">Contribute</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="#contribute--page-root" class="md-nav__link">Contribute</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+        </li>
+        <li class="md-nav__item"><a href="#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+        </li>
+        <li class="md-nav__item"><a href="#contributing-code" class="md-nav__link">Contributing Code</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#forking" class="md-nav__link">Forking</a>
+        </li>
+        <li class="md-nav__item"><a href="#building" class="md-nav__link">Building</a>
+        </li>
+        <li class="md-nav__item"><a href="#testing" class="md-nav__link">Testing</a>
+        </li>
+        <li class="md-nav__item"><a href="#submitting-a-pr" class="md-nav__link">Submitting a PR</a>
+        </li></ul>
+            </nav>
+        </li></ul>
+            </nav>
+        </li>
+  </ul>
+</nav>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="#contributing-code" class="md-nav__link">Contributing Code</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="#contribute--page-root" class="md-nav__link">Contribute</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+        </li>
+        <li class="md-nav__item"><a href="#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+        </li>
+        <li class="md-nav__item"><a href="#contributing-code" class="md-nav__link">Contributing Code</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#forking" class="md-nav__link">Forking</a>
+        </li>
+        <li class="md-nav__item"><a href="#building" class="md-nav__link">Building</a>
+        </li>
+        <li class="md-nav__item"><a href="#testing" class="md-nav__link">Testing</a>
+        </li>
+        <li class="md-nav__item"><a href="#submitting-a-pr" class="md-nav__link">Submitting a PR</a>
+        </li></ul>
+            </nav>
+        </li></ul>
+            </nav>
+        </li>
+  </ul>
+</nav>
+              </div>
+            </div>
+          </div>
+        
+        <div class="md-content">
+          <article class="md-content__inner md-typeset" role="main">
+            
+  
+<h1 id="contribute--page-root">Contribute<a class="headerlink" href="#contribute--page-root" title="Permalink to this headline">¶</a></h1>
+
+<h2 id="submitting-an-issue">Submitting an Issue<a class="headerlink" href="#submitting-an-issue" title="Permalink to this headline">¶</a></h2>
+
+
+<h2 id="submitting-an-enhancement">Submitting an Enhancement<a class="headerlink" href="#submitting-an-enhancement" title="Permalink to this headline">¶</a></h2>
+
+
+<h2 id="contributing-code">Contributing Code<a class="headerlink" href="#contributing-code" title="Permalink to this headline">¶</a></h2>
+
+<h3 id="forking">Forking<a class="headerlink" href="#forking" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="building">Building<a class="headerlink" href="#building" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="testing">Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="submitting-a-pr">Submitting a PR<a class="headerlink" href="#submitting-a-pr" title="Permalink to this headline">¶</a></h3>
+
+
+
+
+
+          </article>
+        </div>
+      </div>
+    </main>
+  </div>
+  <footer class="md-footer">
+    <div class="md-footer-nav">
+      <nav class="md-footer-nav__inner md-grid">
+          
+            <a href="support.html" title="Support"
+               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> Support </span>
+              </div>
+            </a>
+          
+          
+            <a href="conduct.html" title="Code of Conduct"
+               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> Code of Conduct </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">
+              &#169; 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>

docs/_build/html/genindex.html

@@ -382,96 +382,61 @@
     <li class="md-nav__item">
     
     
-      <a href="api.html" 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>
+      <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#networks-api" class="md-nav__link">Networks API</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="api.html#networks-api-call-examples" class="md-nav__link">Networks API Call Examples</a>
+      <a href="api.html#api-usage" class="md-nav__link">API Usage</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#access-keys-api" class="md-nav__link">Access Keys API</a>
+      <a href="api.html#authentication" class="md-nav__link">Authentication</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#access-keys-api-call-examples" class="md-nav__link">Access Keys API Call Examples</a>
+      <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#nodes-api" class="md-nav__link">Nodes API</a>
+      <a href="api.html#api-documentation" class="md-nav__link">API Documentation</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="api.html#nodes-api-call-examples" class="md-nav__link">Nodes API Call Examples</a>
-      
+    </li></ul>
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#users-api" class="md-nav__link">Users API</a>
-      
-    
-    </li>
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="api.html#users-api-calls-examples" class="md-nav__link">Users API Calls Examples</a>
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#server-management-api" class="md-nav__link">Server Management API</a>
+      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#file-server-api" class="md-nav__link">File Server API</a>
+      <a href="support.html#contact" class="md-nav__link">Contact</a>
       
     
     </li></ul>
@@ -480,26 +445,26 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="contribute.html" class="md-nav__link">Contribute</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#contact" class="md-nav__link">Contact</a>
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
       
     
     </li></ul>

docs/_build/html/index.html

@@ -383,96 +383,61 @@
     <li class="md-nav__item">
     
     
-      <a href="api.html" 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>
+      <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#networks-api" class="md-nav__link">Networks API</a>
+      <a href="api.html#api-usage" class="md-nav__link">API Usage</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#networks-api-call-examples" class="md-nav__link">Networks API Call Examples</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="api.html#access-keys-api" class="md-nav__link">Access Keys API</a>
+      <a href="api.html#authentication" class="md-nav__link">Authentication</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#access-keys-api-call-examples" class="md-nav__link">Access Keys API Call Examples</a>
+      <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#nodes-api" class="md-nav__link">Nodes API</a>
+      <a href="api.html#api-documentation" class="md-nav__link">API Documentation</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="api.html#nodes-api-call-examples" class="md-nav__link">Nodes API Call Examples</a>
-      
+    </li></ul>
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#users-api" class="md-nav__link">Users API</a>
-      
-    
-    </li>
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="api.html#users-api-calls-examples" class="md-nav__link">Users API Calls Examples</a>
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#server-management-api" class="md-nav__link">Server Management API</a>
+      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#file-server-api" class="md-nav__link">File Server API</a>
+      <a href="support.html#contact" class="md-nav__link">Contact</a>
       
     
     </li></ul>
@@ -481,26 +446,26 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="contribute.html" class="md-nav__link">Contribute</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#contact" class="md-nav__link">Contact</a>
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
       
     
     </li></ul>
@@ -588,12 +553,14 @@
         </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="#using-netmaker" class="md-nav__link">Using Netmaker</a>
+        <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="#support" class="md-nav__link">Support</a>
         </li>
+        <li class="md-nav__item"><a href="#contributing" class="md-nav__link">Contributing</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>
@@ -610,17 +577,19 @@
           <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 easy-to-use virtual overlay networks using WireGuard.</p>
-<p>This site covers Netmaker’s installation, usage, troubleshooting, and customization, as well as thorough documentation of configurations for the API, UI and Agent. You can view and retrieve all of our <a class="reference external" href="https://github.com/gravitl/netmaker">source code</a> on GitHub.</p>
+<p>Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.</p>
+<p>This documentation covers Netmaker’s installation, usage, troubleshooting, and customization, as well as reference documents for the API, 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>
+<p><span class="raw-html"><br/></span></p>
 <div style="position:relative; width:100%; height:0px; padding-bottom:56.25%;">
 <iframe src="https://www.youtube.com/embed/PWLPT320Ybo" style="position:absolute; left:0; top:0; width:100%; height:100%">
 </iframe>
 </div>
 
 <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 about, and why you should be using it.</p>
+<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>
@@ -634,7 +603,7 @@
 
 
 <h2 id="architecture">Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h2>
-<p>Information about Netmaker’s technical design and how it is implemented.</p>
+<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>
@@ -648,7 +617,7 @@
 
 
 <h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2>
-<p>Get up and running as quickly as possible with a full mesh overlay VPN based on WireGuard.</p>
+<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>
 <li class="toctree-l1"><a class="reference internal" href="quick-start.html">Quick Start</a></li>
@@ -657,7 +626,7 @@
 
 
 <h2 id="server-installation">Server Installation<a class="headerlink" href="#server-installation" title="Permalink to this headline">¶</a></h2>
-<p>Covers installation of the Server, UI, DB, and supporting services such as Client and CoreDNS.</p>
+<p>A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="server-installation.html">Server Installation</a><ul>
@@ -671,7 +640,7 @@
 
 
 <h2 id="client-installation">Client Installation<a class="headerlink" href="#client-installation" title="Permalink to this headline">¶</a></h2>
-<p>Covers installation of the agent (netclient) and configuration options.</p>
+<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>
@@ -685,8 +654,8 @@
 </div>
 
 
-<h2 id="using-netmaker">Using Netmaker<a class="headerlink" href="#using-netmaker" title="Permalink to this headline">¶</a></h2>
-<p>Different use cases such as site-to-site/gateway, Kubernetes, and DNS. Use these guides to get started with a more advanced use case.</p>
+<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>
@@ -703,20 +672,17 @@
 
 
 <h2 id="api-reference">API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2>
-<p>These are the reference documents for the Netmaker Server API. It also provides examples for various API calls that cover different use cases. The API docs are currently static. In a future release these docs will be replaced by Swagger docs.</p>
-<p><strong>TODO:</strong> Swagger Documentation via <a class="reference external" href="https://github.com/swaggo/swag">https://github.com/swaggo/swag</a></p>
+<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 Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="api.html#authentication">Authentication</a></li>
-<li class="toctree-l1"><a class="reference internal" href="api.html#format-of-calls-for-curl">Format of Calls for Curl</a></li>
-<li class="toctree-l1"><a class="reference internal" href="api.html#api-documentation">API Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 </ul>
 </div>
 
 
 <h2 id="support">Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
-<p>Common issue troubleshooting, FAQ, and Contact information.</p>
+<p>A few helpful documents for if you run into issues with Netmaker.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a><ul>
@@ -729,8 +695,28 @@
 </div>
 
 
+<h2 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
+<p>A guide on how to contribute to the Netmaker project.</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribute</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#submitting-an-issue">Submitting an Issue</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#submitting-an-enhancement">Submitting an Enhancement</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contribute.html#contributing-code">Contributing Code</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="contribute.html#forking">Forking</a></li>
+<li class="toctree-l3"><a class="reference internal" href="contribute.html#building">Building</a></li>
+<li class="toctree-l3"><a class="reference internal" href="contribute.html#testing">Testing</a></li>
+<li class="toctree-l3"><a class="reference internal" href="contribute.html#submitting-a-pr">Submitting a PR</a></li>
+</ul>
+</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>Learn how to approproately interact with the community:</p>
+<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>
@@ -747,7 +733,7 @@
 
 
 <h2 id="licensing">Licensing<a class="headerlink" href="#licensing" title="Permalink to this headline">¶</a></h2>
-<p>Information about the Netmaker license.</p>
+<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>

docs/_build/html/license.html

@@ -53,9 +53,9 @@
     <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="Contact" href="contact.html" />
     <link rel="prev" title="Code of Conduct" href="conduct.html" />
   
    
@@ -208,26 +208,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -447,6 +475,62 @@
       <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -514,13 +598,6 @@
 </nav>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   
@@ -573,17 +650,6 @@
             </a>
           
           
-            <a href="contact.html" title="Contact"
-               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> Contact </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>

docs/_build/html/objects.inv

@@ -2,6 +2,6 @@
 # Project: Netmaker
 # Version: 
 # The remainder of this file is compressed using zlib.
-xÚ…’ÁNÄ †ï<ż@M¼z3zi¢fÍfã™…±%K¡Â`Ü··t¨BRã©ôûÿ:�Až}"ˆ¤ï´WÐÝ‚Ìàf¤ÉÂ}>
-9›FŸMQ=œ¢PÈ FC¨(l¬/™Še
:ꌋ$­•d¼«Ó;2yXè+A(ïtRÍ�T2^#ø÷å¹B1 3Nã×°òŒ6G6Ê™>ů­Ô­oh•ŸÈ�/H“¼`€G¯Ò´ôȽY£ÐÅf2q•'~“×;=Í×nØþìu²Xº«Ôb‡+�Ë€›ôG2êÒ-cÍä*ÌÙ×à˜�ˆ˜×Ú~Œ{�¬òň>1ü¹áy«‘…vÃ1ͳoû,¨døE¤|%k×
-ØsŠÆ
?kßFU?
+xÚ…’ÍNÅ …÷</P·îŒnš¨¹zc\S˜Û’K™
+ƒñ¾½P¨‚©q|çœaøâžÔ�BÉ»k.¸šh6ü6M™Xt£/º¨‡ž¿À	X	L89iIÁAc¯xÉU„I£ÁR§­'aŒ �¶NïȹÈÝ*ð¾˜D«‚lSPÉ Ž§8®0ùÉé!üŠº¥¶5Áj«àsµ1€I��f{Ÿ¦ìÇVªVŽ70gà„œ&àO@³8ƒã÷(Õc´ë›Î
+ÊUò‚ͨvzZ.Ý&dû#ª` tW©ÿÄšâ‹4é÷ å¹‹÷îš«®pÎ>'À�	0é´›e–½Ç¬ÄÑë>Àýù%vä­FÚ/áò`ÛgA%“,ø¸síZAö¼zmÇïgb_¤<%ü

docs/_build/html/quick-start.html

@@ -53,10 +53,11 @@
     <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="Server Installation" href="server-installation.html" />
-    <link rel="prev" title="Introduction" href="introduction.html" />
+    <link rel="prev" title="Architecture" href="architecture.html" />
   
    
 
@@ -208,26 +209,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -456,6 +485,62 @@
       <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -514,13 +599,6 @@
       <a href="license.html" class="md-nav__link">License</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   
@@ -663,7 +741,7 @@ To uninstall the netmaker server, simply run <cite>docker-compose down</cite></p
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
           
-            <a href="introduction.html" title="Introduction"
+            <a href="architecture.html" title="Architecture"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -672,7 +750,7 @@ To uninstall the netmaker server, simply run <cite>docker-compose down</cite></p
               <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> Introduction </span>
+                      class="md-footer-nav__direction"> Previous </span> Architecture </span>
               </div>
             </a>
           

docs/_build/html/search.html

@@ -388,96 +388,61 @@
     <li class="md-nav__item">
     
     
-      <a href="api.html" 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>
+      <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#networks-api" class="md-nav__link">Networks API</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="api.html#networks-api-call-examples" class="md-nav__link">Networks API Call Examples</a>
+      <a href="api.html#api-usage" class="md-nav__link">API Usage</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#access-keys-api" class="md-nav__link">Access Keys API</a>
+      <a href="api.html#authentication" class="md-nav__link">Authentication</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#access-keys-api-call-examples" class="md-nav__link">Access Keys API Call Examples</a>
+      <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#nodes-api" class="md-nav__link">Nodes API</a>
+      <a href="api.html#api-documentation" class="md-nav__link">API Documentation</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="api.html#nodes-api-call-examples" class="md-nav__link">Nodes API Call Examples</a>
-      
+    </li></ul>
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#users-api" class="md-nav__link">Users API</a>
-      
-    
-    </li>
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="api.html#users-api-calls-examples" class="md-nav__link">Users API Calls Examples</a>
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#server-management-api" class="md-nav__link">Server Management API</a>
+      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="api.html#file-server-api" class="md-nav__link">File Server API</a>
+      <a href="support.html#contact" class="md-nav__link">Contact</a>
       
     
     </li></ul>
@@ -486,26 +451,26 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="contribute.html" class="md-nav__link">Contribute</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#contact" class="md-nav__link">Contact</a>
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
       
     
     </li></ul>

docs/_build/html/server-installation.html

@@ -53,6 +53,7 @@
     <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="Client Installation" href="client-installation.html" />
@@ -208,26 +209,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -477,6 +506,62 @@
       <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -535,13 +620,6 @@
       <a href="license.html" class="md-nav__link">License</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   

docs/_build/html/support.html

@@ -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="Code of Conduct" href="conduct.html" />
+    <link rel="next" title="Contribute" href="contribute.html" />
     <link rel="prev" title="API Usage" href="api.html" />
   
    
@@ -536,6 +536,34 @@
       <a href="#contact" class="md-nav__link">Contact</a>
       
     
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -695,12 +723,12 @@ Discord: <a class="reference external" href="https://discord.gg/zRb9Vfhk8A">http
             </a>
           
           
-            <a href="conduct.html" title="Code of Conduct"
+            <a href="contribute.html" title="Contribute"
                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> Code of Conduct </span>
+                class="md-footer-nav__direction"> Next </span> Contribute </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink"><i
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>

docs/_build/html/usage.html

@@ -53,6 +53,7 @@
     <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="API Usage" href="api.html" />
@@ -208,26 +209,54 @@
     <li class="md-nav__item">
     
     
-      <a href="introduction.html" class="md-nav__link">Introduction</a>
+      <a href="about.html" class="md-nav__link">About</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#use-cases" class="md-nav__link">Use Cases</a>
+      <a href="about.html#introduction" class="md-nav__link">Introduction</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="introduction.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <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="introduction.html#limitations" class="md-nav__link">Limitations</a>
+      <a href="about.html#use-cases" class="md-nav__link">Use Cases</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#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
       
     
     </li></ul>
@@ -479,6 +508,62 @@
       <a href="api.html#file-server-api" class="md-nav__link">File Server API</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#troubleshooting" class="md-nav__link">Troubleshooting</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="contribute.html" class="md-nav__link">Contribute</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-issue" class="md-nav__link">Submitting an Issue</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#submitting-an-enhancement" class="md-nav__link">Submitting an Enhancement</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="contribute.html#contributing-code" class="md-nav__link">Contributing Code</a>
+      
+    
     </li></ul>
     
     </li>
@@ -537,13 +622,6 @@
       <a href="license.html" class="md-nav__link">License</a>
       
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="contact.html" class="md-nav__link">Contact</a>
-      
-    
     </li>
   </ul>
   

docs/api.rst

@@ -1,6 +1,6 @@
-===========================================
-Netmaker Server API Reference Documentation
-==========================================
+=============================================
+API Reference
+=============================================
 
 API Usage
 ==========================
@@ -105,7 +105,7 @@ Nodes API
 Nodes API Call Examples
 ----------------------- 
   
-**Get All Nodes:**`curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes | jq`
+**Get All Nodes:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes | jq`
   
 **Get Network Nodes:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes/skynet | jq`
     
@@ -149,13 +149,13 @@ Users API
 Users API Calls Examples
 ------------------------
   
-**Get User:**`curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/{username} | jq`
+**Get User:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/{username} | jq`
 
 **Update User:** `curl -X PUT -d '{"password":"noonewillguessthis"}' -H 'Content-Type: application/json' -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/users/{username}`
   
 **Delete User:** `curl -X DELETE -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/users/{username}`
   
-**Check for Admin User:**`curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/adm/hasadmin`
+**Check for Admin User:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/users/adm/hasadmin`
   
 **Create Admin User:** `curl -d '{ "username": "smartguy", "password": "YOUR_PASS"}' -H 'Content-Type: application/json' -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/users/adm/createadmin`
    

docs/contribute.rst

@@ -0,0 +1,26 @@
+===========
+Contribute
+===========
+
+Submitting an Issue
+====================
+
+Submitting an Enhancement
+==========================
+
+Contributing Code
+==================
+
+Forking
+----------
+
+Building
+-----------
+
+Testing
+----------
+
+Submitting a PR
+-----------------
+
+

docs/index.rst

@@ -9,22 +9,28 @@
    :alt: Netmaker WireGuard
    :align: center
 
+.. role:: raw-html(raw)
+    :format: html
 
+:raw-html:`<br />`
+
+=======================================
 Welcome to the Netmaker Documentation
 =======================================
 
 
-Netmaker is a platform for creating and managing fast, secure, and easy-to-use virtual overlay networks using WireGuard.
+Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.
+
+This documentation covers Netmaker's installation, usage, troubleshooting, and customization, as well as reference documents for the API, UI and Agent configuration. All of the `source code <https://github.com/gravitl/netmaker>`_ for Netmaker is on GitHub.
 
-This site covers Netmaker's installation, usage, troubleshooting, and customization, as well as thorough documentation of configurations for the API, UI and Agent. You can view and retrieve all of our `source code <https://github.com/gravitl/netmaker>`_ on GitHub.
+:raw-html:`<br />`
 
 .. raw:: html
    :file: youtube-1.html
 
 About
 ------
-
-A quick overview of Netmaker, explaining what it is about, and why you should be using it.
+A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.
 
 .. toctree::
    :maxdepth: 2
@@ -34,7 +40,7 @@ A quick overview of Netmaker, explaining what it is about, and why you should be
 Architecture
 ---------------
 
-Information about Netmaker's technical design and how it is implemented.
+A technical overview of Netmaker, including design decisions and limitations.
 
 .. toctree::
    :maxdepth: 2
@@ -44,7 +50,7 @@ Information about Netmaker's technical design and how it is implemented.
 Quick Start
 ---------------
 
-Get up and running as quickly as possible with a full mesh overlay VPN based on WireGuard.
+A quick start guide to getting up and running with Netmaker and WireGuard as quickly as possible.
 
 .. toctree::
    :maxdepth: 2
@@ -54,7 +60,7 @@ Get up and running as quickly as possible with a full mesh overlay VPN based on
 Server Installation
 --------------------
 
-Covers installation of the Server, UI, DB, and supporting services such as Client and CoreDNS.
+A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.
 
 .. toctree::
    :maxdepth: 2
@@ -64,7 +70,7 @@ Covers installation of the Server, UI, DB, and supporting services such as Clien
 Client Installation
 --------------------
 
-Covers installation of the agent (netclient) and configuration options.
+A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.
 
 .. toctree::
    :maxdepth: 2
@@ -72,10 +78,10 @@ Covers installation of the agent (netclient) and configuration options.
    client-installation
 
 
-Using Netmaker
+Guides
 ----------------
 
-Different use cases such as site-to-site/gateway, Kubernetes, and DNS. Use these guides to get started with a more advanced use case.
+A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.
 
 .. toctree::
    :maxdepth: 2
@@ -85,10 +91,9 @@ Different use cases such as site-to-site/gateway, Kubernetes, and DNS. Use these
 API Reference
 ---------------
 
+A reference document for the Netmaker Server API, and example API calls for various use cases.
 
-These are the reference documents for the Netmaker Server API. It also provides examples for various API calls that cover different use cases. The API docs are currently static. In a future release these docs will be replaced by Swagger docs.
-
-**TODO:** Swagger Documentation via https://github.com/swaggo/swag
+**Coming Soon:** Swagger Documentation
 
 .. toctree::
    :maxdepth: 1
@@ -98,7 +103,7 @@ These are the reference documents for the Netmaker Server API. It also provides
 Support
 ----------------
 
-Common issue troubleshooting, FAQ, and Contact information.
+A few helpful documents for if you run into issues with Netmaker.
 
 .. toctree::
    :maxdepth: 2
@@ -106,11 +111,19 @@ Common issue troubleshooting, FAQ, and Contact information.
    support
 
 
+Contributing
+-----------------
+
+A guide on how to contribute to the Netmaker project.
+
+.. toctree:: 
+
+        contribute.rst
 
 Code of Conduct
 -----------------
 
-Learn how to approproately interact with the community: 
+A statement on our expectations and pledge to the community.
 
 .. toctree:: 
 
@@ -119,7 +132,7 @@ Learn how to approproately interact with the community:
 Licensing
 ---------------
 
-Information about the Netmaker license.
+A link to the Netmaker license.
 
 .. toctree::