docs faq

docs/_build/html/_sources/client-installation.rst.txt

@@ -1,26 +1,61 @@
-============
+====================
 Client Installation
-============
+====================
 
 This document tells you how to install the netclient on machines that will be a part of your Netmaker network, as well as non-compatible systems.
 
+These steps should be run after the Netmaker server has been created and a network has been designated within Netmaker.
+
 System Compatibility
 ====================
 
 Prerequisites
 =============
 
-Installing Netclient
-===================
+Configuration
+===============
 
-Linux
------
+Variable Reference
+--------------------
 
-Kubernetes/Docker
------------------
+Config File Reference
+------------------------
+
+CLI Reference
+------------------------
+
+Installation
+======================
+
+Token
+-------
+
+Access Key
+------------
 
-Customizing your Installation
------------------------------
+Manual
+---------
+
+Config File
+------------
+
+Managing Netclient
+=====================
+
+Viewing Logs
+---------------
+
+Making Updates
+----------------
+
+Adding/Removing Networks
+---------------------------
+
+Uninstalling
+---------------
+
+Troubleshooting
+-----------------
 
-Unmanaged Clients (Pure WireGuard)
+Unmanaged (External) Clients
 ==================================

docs/_build/html/_sources/server-installation.rst.txt

@@ -33,17 +33,17 @@ This requires privileged (root) access to the host machine and multiple host dir
 
 To run a non-docker installation, you are running the Netmaker binary, CoreDNS binary, MongoDB, and a web server directly on your host. This requires all the requirements for those individual components. Our guided install assumes systemd-based linux, but there are many other ways to install Netmaker's individual components onto machines that do not support Docker. 
 
-DNS Mode Prereqisite Setup (Ubuntu)
+DNS Mode Prereqisite Setup
 ====================================
 
 If you plan on running the server in DNS Mode, you will be deploying a CoreDNS server. We recommend binding CoreDNS to port 53 of the host system (which it will do by default). On some systems, this will conflift with existing processes. Specifically on linux systems running systemd-resolved, there may be a service consuming port 53. The below steps will disable systemd-resolved, and replace it with a generic (e.g. Google) nameserver. The following was tested on Ubuntu 20.04. This may have consequences for existing private DNS so proceed with caution:
 
-1. systemctl stop systemd-resolved 
-2. systemctl disable systemd-resolved 
-3. vim /etc/systemd/resolved.conf
+1. ``systemctl stop systemd-resolved`` 
+2. ``systemctl disable systemd-resolved`` 
+3. ``vim /etc/systemd/resolved.conf``
     * uncomment DNS and add 8.8.8.8 or whatever reachable nameserver is your preference
     * uncomment DNSStubListener and set to "no"
-4. sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf
+4. ``ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf``
 
 Port 53 should now be available for CoreDNS to use.
 

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

@@ -3,10 +3,57 @@ Support
 =========
 
 FAQ
-----
+======
+
+Does/Will Netmaker Support X Operating System?
+--------------------------------------------------
+
+Netmaker is initially available on a limited number of operating systems for good reason: Every operating system is designed differently. With a small team, we can either focus on making Netmaker do a lot on a few number of operating systems, or a little on a bunch of operating systems. We chose the first option. You can view the System Compatibility docs for more info, but in general, you should only be using Netmaker on systemd linux right now.
+
+However, as of v0.4, we will technically be able to bring any operating system into the network. This is a bit of a hack. v0.4 introduces Ingress Gateways. Think of it this way. You set up a private network. You want devices to access it. You set up a single node as an "Ingress Gateway" and generate config files for "external clients." These clients are unmanaged and unmeshed, meaning they can access the network but only via the gateway. It also means they will not automatically account for changes to the network, and the user will have to update the configs manually.
+
+This lets us immediately "support" any device which can run WireGuard, which includes most operating systems at this point including phones and Windows.
+
+As we stabilize the design and feature set of Netmaker, we will expand the operating system support for Netclient which configures dynamic, fully-meshed devices. Expect to see updates about new OS support every few weeks, until eventually the Ingress Gateway becomes unnecessary (though you will still want it for certain use cases).
+
+How do I install the Netclient on X?
+---------------------------------------
+
+As per the above, there are many unsupported operating systems. You are still welcome to try, it is just an executable binary file after all. If the system is unix-based and has kernel WireGuard installed, netclient may very well mesh the device into the network. However, the service likely will encounter problems retrieving updates.
+
+Is Netmaker a VPN like NordNPN?
+--------------------------------
+
+No. Netmaker makes Virtual Networks, which are technically VPNs, but different. It's more like a corporate VPN, or a VPC (if you're familiar with AWS).
+
+If you're looking to achieve self-hosted web browsing, with functionality similar to NordVPN, ExpressVPN, Surfshark, Tunnelbear, or Private Internet Access, this is probably not the project for you. Technically, you can accomplish this with Netmaker, but it would be a little like using a all-terrain vehicle for stock car racing.
+
+There are many good projects out there that support general internet privacy using WireGuard. Here are just a few of them:
+
+https://github.com/trailofbits/algo
+https://github.com/pivpn/pivpn
+https://github.com/subspacecloud/subspace
+https://github.com/mullvad/mullvadvpn-app
+
+Do you offer any paid support?
+---------------------------------
+
+Not at this time, but eventually we will. If you are interested, or if you are interested in sponsoring the project generally, please contact Alex Feiszli ([email protected]).
+
+Why the SSPL License?
+----------------------
+
+We thought long and hard about the license. Ultimately, we think this is the best way to support and ensure the health of the project long term. The community deserves something that is well-maintained, and in order to do that, eventually we need some financial support. We won't do that by limiting the project, but we will offer some additional support, and hosted options for things people would end up paying for anyway (relay servers, load balancing support, backups). 
+
+While SSPL is not an OSI-approved open source license, it let's people generally run the project however they want, both for private use and business use, without running into the issue of someone else monetizing the project and making it financially untenable. We are working on making the guidelines clear, and will make sure that the license does not impact the communities ability to use and modify the project.
+
+If you have concerns about the license leading to project restrictions down the road, just know that there are other paid, closed-source/closed-core options out there, so beyond not wanting to follow that path, we also don't think it's a good idea economically either. We firmly believe that having the project open is not only right, but the best option.
+
+All that said, we will re-evaluate the license on a regular basis and determine if an OSI-approved license makes more sense. It's just easier to move from SSPL to another license than vice-versa.
+
 
 Contact
---------
+===========
 If you need help, try the discord or open a GitHub ticket.
 
 Email: [email protected]

docs/_build/html/about.html

@@ -342,6 +342,20 @@
       <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
     </li></ul>
     
     </li>
@@ -353,6 +367,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -360,14 +381,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>

docs/_build/html/api.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="Support" href="support.html" />
+    <link rel="next" title="Troubleshooting" href="troubleshoot.html" />
     <link rel="prev" title="Using Netmaker" href="usage.html" />
   
    
@@ -263,7 +263,7 @@
     <li class="md-nav__item">
     
     
-      <a href="architecture.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
       
     
     </li>
@@ -280,8 +280,64 @@
     
     
       <a href="quick-start.html" class="md-nav__link">Quick Start</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#prerequisites" class="md-nav__link">Prerequisites</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#install" class="md-nav__link">Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#setup" class="md-nav__link">Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -291,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -298,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -477,19 +561,54 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#agent" class="md-nav__link">Agent</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>
@@ -779,12 +898,12 @@
             </a>
           
           
-            <a href="support.html" title="Support"
+            <a href="troubleshoot.html" title="Troubleshooting"
                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> Support </span>
+                class="md-footer-nav__direction"> Next </span> Troubleshooting </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

@@ -370,6 +370,20 @@
       <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
     </li></ul>
     
     </li>
@@ -381,6 +395,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -388,14 +409,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>

docs/_build/html/client-installation.html

@@ -263,7 +263,7 @@
     <li class="md-nav__item">
     
     
-      <a href="architecture.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
       
     
     </li>
@@ -280,8 +280,64 @@
     
     
       <a href="quick-start.html" class="md-nav__link">Quick Start</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#install" class="md-nav__link">Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#setup" class="md-nav__link">Setup</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -291,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -298,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -329,17 +413,43 @@
         </li>
         <li class="md-nav__item"><a href="#prerequisites" class="md-nav__link">Prerequisites</a>
         </li>
-        <li class="md-nav__item"><a href="#installing-netclient" class="md-nav__link">Installing Netclient</a><nav class="md-nav">
+        <li class="md-nav__item"><a href="#configuration" class="md-nav__link">Configuration</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#variable-reference" class="md-nav__link">Variable Reference</a>
+        </li>
+        <li class="md-nav__item"><a href="#config-file-reference" class="md-nav__link">Config File Reference</a>
+        </li>
+        <li class="md-nav__item"><a href="#cli-reference" class="md-nav__link">CLI Reference</a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#installation" class="md-nav__link">Installation</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#token" class="md-nav__link">Token</a>
+        </li>
+        <li class="md-nav__item"><a href="#access-key" class="md-nav__link">Access Key</a>
+        </li>
+        <li class="md-nav__item"><a href="#manual" class="md-nav__link">Manual</a>
+        </li>
+        <li class="md-nav__item"><a href="#config-file" class="md-nav__link">Config File</a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#managing-netclient" class="md-nav__link">Managing Netclient</a><nav class="md-nav">
               <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#linux" class="md-nav__link">Linux</a>
+        <li class="md-nav__item"><a href="#viewing-logs" class="md-nav__link">Viewing Logs</a>
         </li>
-        <li class="md-nav__item"><a href="#kubernetes-docker" class="md-nav__link">Kubernetes/Docker</a>
+        <li class="md-nav__item"><a href="#making-updates" class="md-nav__link">Making Updates</a>
         </li>
-        <li class="md-nav__item"><a href="#customizing-your-installation" class="md-nav__link">Customizing your Installation</a>
+        <li class="md-nav__item"><a href="#adding-removing-networks" class="md-nav__link">Adding/Removing Networks</a>
+        </li>
+        <li class="md-nav__item"><a href="#uninstalling" class="md-nav__link">Uninstalling</a>
+        </li>
+        <li class="md-nav__item"><a href="#troubleshooting" class="md-nav__link">Troubleshooting</a>
         </li></ul>
             </nav>
         </li>
-        <li class="md-nav__item"><a href="#unmanaged-clients-pure-wireguard" class="md-nav__link">Unmanaged Clients (Pure WireGuard)</a>
+        <li class="md-nav__item"><a href="#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
         </li></ul>
             </nav>
         </li>
@@ -363,14 +473,28 @@
     <li class="md-nav__item">
     
     
-      <a href="#installing-netclient" class="md-nav__link">Installing Netclient</a>
+      <a href="#configuration" class="md-nav__link">Configuration</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="#installation" class="md-nav__link">Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="#managing-netclient" class="md-nav__link">Managing Netclient</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="#unmanaged-clients-pure-wireguard" class="md-nav__link">Unmanaged Clients (Pure WireGuard)</a>
+      <a href="#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
       
     
     </li></ul>
@@ -463,19 +587,54 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#agent" class="md-nav__link">Agent</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>
@@ -592,17 +751,43 @@
         </li>
         <li class="md-nav__item"><a href="#prerequisites" class="md-nav__link">Prerequisites</a>
         </li>
-        <li class="md-nav__item"><a href="#installing-netclient" class="md-nav__link">Installing Netclient</a><nav class="md-nav">
+        <li class="md-nav__item"><a href="#configuration" class="md-nav__link">Configuration</a><nav class="md-nav">
               <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#linux" class="md-nav__link">Linux</a>
+        <li class="md-nav__item"><a href="#variable-reference" class="md-nav__link">Variable Reference</a>
         </li>
-        <li class="md-nav__item"><a href="#kubernetes-docker" class="md-nav__link">Kubernetes/Docker</a>
+        <li class="md-nav__item"><a href="#config-file-reference" class="md-nav__link">Config File Reference</a>
         </li>
-        <li class="md-nav__item"><a href="#customizing-your-installation" class="md-nav__link">Customizing your Installation</a>
+        <li class="md-nav__item"><a href="#cli-reference" class="md-nav__link">CLI Reference</a>
         </li></ul>
             </nav>
         </li>
-        <li class="md-nav__item"><a href="#unmanaged-clients-pure-wireguard" class="md-nav__link">Unmanaged Clients (Pure WireGuard)</a>
+        <li class="md-nav__item"><a href="#installation" class="md-nav__link">Installation</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#token" class="md-nav__link">Token</a>
+        </li>
+        <li class="md-nav__item"><a href="#access-key" class="md-nav__link">Access Key</a>
+        </li>
+        <li class="md-nav__item"><a href="#manual" class="md-nav__link">Manual</a>
+        </li>
+        <li class="md-nav__item"><a href="#config-file" class="md-nav__link">Config File</a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#managing-netclient" class="md-nav__link">Managing Netclient</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#viewing-logs" class="md-nav__link">Viewing Logs</a>
+        </li>
+        <li class="md-nav__item"><a href="#making-updates" class="md-nav__link">Making Updates</a>
+        </li>
+        <li class="md-nav__item"><a href="#adding-removing-networks" class="md-nav__link">Adding/Removing Networks</a>
+        </li>
+        <li class="md-nav__item"><a href="#uninstalling" class="md-nav__link">Uninstalling</a>
+        </li>
+        <li class="md-nav__item"><a href="#troubleshooting" class="md-nav__link">Troubleshooting</a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
         </li></ul>
             </nav>
         </li>
@@ -618,6 +803,7 @@
   
 <h1 id="client-installation--page-root">Client Installation<a class="headerlink" href="#client-installation--page-root" title="Permalink to this headline">¶</a></h1>
 <p>This document tells you how to install the netclient on machines that will be a part of your Netmaker network, as well as non-compatible systems.</p>
+<p>These steps should be run after the Netmaker server has been created and a network has been designated within Netmaker.</p>
 
 <h2 id="system-compatibility">System Compatibility<a class="headerlink" href="#system-compatibility" title="Permalink to this headline">¶</a></h2>
 
@@ -625,19 +811,52 @@
 <h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
 
 
-<h2 id="installing-netclient">Installing Netclient<a class="headerlink" href="#installing-netclient" title="Permalink to this headline">¶</a></h2>
+<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+
+<h3 id="variable-reference">Variable Reference<a class="headerlink" href="#variable-reference" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="config-file-reference">Config File Reference<a class="headerlink" href="#config-file-reference" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="cli-reference">CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline">¶</a></h3>
+
+
+
+<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+
+<h3 id="token">Token<a class="headerlink" href="#token" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="access-key">Access Key<a class="headerlink" href="#access-key" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="manual">Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="config-file">Config File<a class="headerlink" href="#config-file" title="Permalink to this headline">¶</a></h3>
+
+
+
+<h2 id="managing-netclient">Managing Netclient<a class="headerlink" href="#managing-netclient" title="Permalink to this headline">¶</a></h2>
+
+<h3 id="viewing-logs">Viewing Logs<a class="headerlink" href="#viewing-logs" title="Permalink to this headline">¶</a></h3>
+
+
+<h3 id="making-updates">Making Updates<a class="headerlink" href="#making-updates" title="Permalink to this headline">¶</a></h3>
+
 
-<h3 id="linux">Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
+<h3 id="adding-removing-networks">Adding/Removing Networks<a class="headerlink" href="#adding-removing-networks" title="Permalink to this headline">¶</a></h3>
 
 
-<h3 id="kubernetes-docker">Kubernetes/Docker<a class="headerlink" href="#kubernetes-docker" title="Permalink to this headline">¶</a></h3>
+<h3 id="uninstalling">Uninstalling<a class="headerlink" href="#uninstalling" title="Permalink to this headline">¶</a></h3>
 
 
-<h3 id="customizing-your-installation">Customizing your Installation<a class="headerlink" href="#customizing-your-installation" title="Permalink to this headline">¶</a></h3>
+<h3 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h3>
 
 
 
-<h2 id="unmanaged-clients-pure-wireguard">Unmanaged Clients (Pure WireGuard)<a class="headerlink" href="#unmanaged-clients-pure-wireguard" title="Permalink to this headline">¶</a></h2>
+<h2 id="unmanaged-external-clients">Unmanaged (External) Clients<a class="headerlink" href="#unmanaged-external-clients" title="Permalink to this headline">¶</a></h2>
 
 
 

docs/_build/html/conduct.html

@@ -263,7 +263,7 @@
     <li class="md-nav__item">
     
     
-      <a href="architecture.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
       
     
     </li>
@@ -280,8 +280,64 @@
     
     
       <a href="quick-start.html" class="md-nav__link">Quick Start</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#prerequisites" class="md-nav__link">Prerequisites</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#install" class="md-nav__link">Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#setup" class="md-nav__link">Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -291,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -298,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -433,19 +517,54 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#agent" class="md-nav__link">Agent</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>

docs/_build/html/contribute.html

@@ -263,7 +263,7 @@
     <li class="md-nav__item">
     
     
-      <a href="architecture.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
       
     
     </li>
@@ -280,8 +280,64 @@
     
     
       <a href="quick-start.html" class="md-nav__link">Quick Start</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#prerequisites" class="md-nav__link">Prerequisites</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#install" class="md-nav__link">Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#setup" class="md-nav__link">Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -291,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -298,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -433,19 +517,54 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#agent" class="md-nav__link">Agent</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>

docs/_build/html/genindex.html

@@ -359,7 +359,7 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
       
     
     </li>
@@ -415,14 +415,28 @@
     <li class="md-nav__item">
     
     
-      <a href="client-installation.html#installing-netclient" class="md-nav__link">Installing Netclient</a>
+      <a href="client-installation.html#configuration" class="md-nav__link">Configuration</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>
+      <a href="client-installation.html#installation" class="md-nav__link">Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#managing-netclient" class="md-nav__link">Managing Netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
       
     
     </li></ul>

docs/_build/html/index.html

@@ -360,7 +360,7 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
       
     
     </li>
@@ -416,14 +416,28 @@
     <li class="md-nav__item">
     
     
-      <a href="client-installation.html#installing-netclient" class="md-nav__link">Installing Netclient</a>
+      <a href="client-installation.html#configuration" class="md-nav__link">Configuration</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>
+      <a href="client-installation.html#installation" class="md-nav__link">Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#managing-netclient" class="md-nav__link">Managing Netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
       
     
     </li></ul>
@@ -774,7 +788,7 @@
 <li class="toctree-l1"><a class="reference internal" href="server-installation.html">Server Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="server-installation.html#notes-on-optional-features">Notes on Optional Features</a></li>
 <li class="toctree-l2"><a class="reference internal" href="server-installation.html#system-compatibility">System Compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="server-installation.html#dns-mode-prereqisite-setup-ubuntu">DNS Mode Prereqisite Setup (Ubuntu)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="server-installation.html#dns-mode-prereqisite-setup">DNS Mode Prereqisite Setup</a></li>
 <li class="toctree-l2"><a class="reference internal" href="server-installation.html#docker-compose-install">Docker Compose Install</a></li>
 <li class="toctree-l2"><a class="reference internal" href="server-installation.html#linux-install-without-docker">Linux Install without Docker</a></li>
 <li class="toctree-l2"><a class="reference internal" href="server-installation.html#kubernetes-install">Kubernetes Install</a></li>
@@ -792,8 +806,10 @@
 <li class="toctree-l1"><a class="reference internal" href="client-installation.html">Client Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="client-installation.html#system-compatibility">System Compatibility</a></li>
 <li class="toctree-l2"><a class="reference internal" href="client-installation.html#prerequisites">Prerequisites</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client-installation.html#installing-netclient">Installing Netclient</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client-installation.html#unmanaged-clients-pure-wireguard">Unmanaged Clients (Pure WireGuard)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="client-installation.html#configuration">Configuration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="client-installation.html#installation">Installation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="client-installation.html#managing-netclient">Managing Netclient</a></li>
+<li class="toctree-l2"><a class="reference internal" href="client-installation.html#unmanaged-external-clients">Unmanaged (External) Clients</a></li>
 </ul>
 </li>
 </ul>

docs/_build/html/license.html

@@ -262,7 +262,7 @@
     <li class="md-nav__item">
     
     
-      <a href="architecture.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
       
     
     </li>
@@ -279,8 +279,64 @@
     
     
       <a href="quick-start.html" class="md-nav__link">Quick Start</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#prerequisites" class="md-nav__link">Prerequisites</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#install" class="md-nav__link">Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#setup" class="md-nav__link">Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -290,6 +346,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -297,14 +360,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -432,19 +516,54 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#agent" class="md-nav__link">Agent</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>

docs/_build/html/quick-start.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="Server Installation Notes" href="server-installation.html" />
+    <link rel="next" title="Server Installation" href="server-installation.html" />
     <link rel="prev" title="Architecture" href="architecture.html" />
   
    
@@ -376,72 +376,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html" class="md-nav__link">Server Installation Notes</a>
-      
-    
-    </li>
-    <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#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
+      <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#slim-install-no-dns-and-no-client-mode" class="md-nav__link">Slim Install - No DNS and No Client Mode</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html#full-install-dns-and-client-mode-enabled" class="md-nav__link">Full Install - DNS and Client Mode Enabled</a>
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#server-only-install-ui-dns-client-disabled" class="md-nav__link">Server Only Install - UI, DNS, Client Disabled</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html#no-dns-coredns-disabled-client-enabled" class="md-nav__link">No DNS - CoreDNS Disabled, Client Enabled</a>
+      <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#no-client-client-enabled-coredns-disabled" class="md-nav__link">No Client - Client Enabled, CoreDNS Disabled</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#reference-compose-file-annotated" class="md-nav__link">Reference Compose File - Annotated</a>
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
       
     
-    </li></ul>
-    
     </li>
     <li class="md-nav__item">
     
@@ -460,26 +423,7 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#configuration" class="md-nav__link">Configuration</a>
-      <ul class="md-nav__list"> 
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html#defaults" class="md-nav__link">Defaults</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html#config-file" class="md-nav__link">Config File</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html#environment-variables" class="md-nav__link">Environment Variables</a>
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -923,12 +867,12 @@
             </a>
           
           
-            <a href="server-installation.html" title="Server Installation Notes"
+            <a href="server-installation.html" title="Server Installation"
                class="md-flex md-footer-nav__link md-footer-nav__link--next"
                rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
                 class="md-flex__ellipsis"> <span
-                class="md-footer-nav__direction"> Next </span> Server Installation Notes </span>
+                class="md-footer-nav__direction"> Next </span> Server Installation </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink"><i
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>

docs/_build/html/search.html

@@ -365,7 +365,7 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
       
     
     </li>
@@ -421,14 +421,28 @@
     <li class="md-nav__item">
     
     
-      <a href="client-installation.html#installing-netclient" class="md-nav__link">Installing Netclient</a>
+      <a href="client-installation.html#configuration" class="md-nav__link">Configuration</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>
+      <a href="client-installation.html#installation" class="md-nav__link">Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#managing-netclient" class="md-nav__link">Managing Netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
       
     
     </li></ul>

docs/_build/html/server-installation.html

@@ -357,7 +357,7 @@
         </li>
         <li class="md-nav__item"><a href="#system-compatibility" class="md-nav__link">System Compatibility</a>
         </li>
-        <li class="md-nav__item"><a href="#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+        <li class="md-nav__item"><a href="#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
         </li>
         <li class="md-nav__item"><a href="#docker-compose-install" class="md-nav__link">Docker Compose Install</a><nav class="md-nav">
               <ul class="md-nav__list">
@@ -419,7 +419,7 @@
     <li class="md-nav__item">
     
     
-      <a href="#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      <a href="#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
       
     
     </li>
@@ -739,7 +739,7 @@
         </li>
         <li class="md-nav__item"><a href="#system-compatibility" class="md-nav__link">System Compatibility</a>
         </li>
-        <li class="md-nav__item"><a href="#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+        <li class="md-nav__item"><a href="#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
         </li>
         <li class="md-nav__item"><a href="#docker-compose-install" class="md-nav__link">Docker Compose Install</a><nav class="md-nav">
               <ul class="md-nav__list">
@@ -811,20 +811,20 @@
 <p>To run a non-docker installation, you are running the Netmaker binary, CoreDNS binary, MongoDB, and a web server directly on your host. This requires all the requirements for those individual components. Our guided install assumes systemd-based linux, but there are many other ways to install Netmaker’s individual components onto machines that do not support Docker.</p>
 
 
-<h2 id="dns-mode-prereqisite-setup-ubuntu">DNS Mode Prereqisite Setup (Ubuntu)<a class="headerlink" href="#dns-mode-prereqisite-setup-ubuntu" title="Permalink to this headline">¶</a></h2>
+<h2 id="dns-mode-prereqisite-setup">DNS Mode Prereqisite Setup<a class="headerlink" href="#dns-mode-prereqisite-setup" title="Permalink to this headline">¶</a></h2>
 <p>If you plan on running the server in DNS Mode, you will be deploying a CoreDNS server. We recommend binding CoreDNS to port 53 of the host system (which it will do by default). On some systems, this will conflift with existing processes. Specifically on linux systems running systemd-resolved, there may be a service consuming port 53. The below steps will disable systemd-resolved, and replace it with a generic (e.g. Google) nameserver. The following was tested on Ubuntu 20.04. This may have consequences for existing private DNS so proceed with caution:</p>
 <ol class="arabic simple">
-<li><p>systemctl stop systemd-resolved</p></li>
-<li><p>systemctl disable systemd-resolved</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">stop</span> <span class="pre">systemd-resolved</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">disable</span> <span class="pre">systemd-resolved</span></code></p></li>
 <li><dl class="simple">
-<dt>vim /etc/systemd/resolved.conf</dt><dd><ul class="simple">
+<dt><code class="docutils literal notranslate"><span class="pre">vim</span> <span class="pre">/etc/systemd/resolved.conf</span></code></dt><dd><ul class="simple">
 <li><p>uncomment DNS and add 8.8.8.8 or whatever reachable nameserver is your preference</p></li>
 <li><p>uncomment DNSStubListener and set to “no”</p></li>
 </ul>
 </dd>
 </dl>
 </li>
-<li><p>sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">ln</span> <span class="pre">-sf</span> <span class="pre">/run/systemd/resolve/resolv.conf</span> <span class="pre">/etc/resolv.conf</span></code></p></li>
 </ol>
 <p>Port 53 should now be available for CoreDNS to use.</p>
 

docs/_build/html/support.html

@@ -347,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -354,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup" class="md-nav__link">DNS Mode Prereqisite Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -389,14 +417,28 @@
     <li class="md-nav__item">
     
     
-      <a href="client-installation.html#installing-netclient" class="md-nav__link">Installing Netclient</a>
+      <a href="client-installation.html#configuration" class="md-nav__link">Configuration</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#installation" class="md-nav__link">Installation</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="client-installation.html#unmanaged-clients-pure-wireguard" class="md-nav__link">Unmanaged Clients (Pure WireGuard)</a>
+      <a href="client-installation.html#managing-netclient" class="md-nav__link">Managing Netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html#unmanaged-external-clients" class="md-nav__link">Unmanaged (External) Clients</a>
       
     
     </li></ul>
@@ -542,7 +584,19 @@
   <ul class="md-nav__list" data-md-scrollfix="">
         <li class="md-nav__item"><a href="#support--page-root" class="md-nav__link">Support</a><nav class="md-nav">
               <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#faq" class="md-nav__link">FAQ</a>
+        <li class="md-nav__item"><a href="#faq" class="md-nav__link">FAQ</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#does-will-netmaker-support-x-operating-system" class="md-nav__link">Does/Will Netmaker Support X Operating System?</a>
+        </li>
+        <li class="md-nav__item"><a href="#how-do-i-install-the-netclient-on-x" class="md-nav__link">How do I install the Netclient on X?</a>
+        </li>
+        <li class="md-nav__item"><a href="#is-netmaker-a-vpn-like-nordnpn" class="md-nav__link">Is Netmaker a VPN like NordNPN?</a>
+        </li>
+        <li class="md-nav__item"><a href="#do-you-offer-any-paid-support" class="md-nav__link">Do you offer any paid support?</a>
+        </li>
+        <li class="md-nav__item"><a href="#why-the-sspl-license" class="md-nav__link">Why the SSPL License?</a>
+        </li></ul>
+            </nav>
         </li>
         <li class="md-nav__item"><a href="#contact" class="md-nav__link">Contact</a>
         </li></ul>
@@ -667,7 +721,19 @@
   <ul class="md-nav__list" data-md-scrollfix="">
         <li class="md-nav__item"><a href="#support--page-root" class="md-nav__link">Support</a><nav class="md-nav">
               <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#faq" class="md-nav__link">FAQ</a>
+        <li class="md-nav__item"><a href="#faq" class="md-nav__link">FAQ</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#does-will-netmaker-support-x-operating-system" class="md-nav__link">Does/Will Netmaker Support X Operating System?</a>
+        </li>
+        <li class="md-nav__item"><a href="#how-do-i-install-the-netclient-on-x" class="md-nav__link">How do I install the Netclient on X?</a>
+        </li>
+        <li class="md-nav__item"><a href="#is-netmaker-a-vpn-like-nordnpn" class="md-nav__link">Is Netmaker a VPN like NordNPN?</a>
+        </li>
+        <li class="md-nav__item"><a href="#do-you-offer-any-paid-support" class="md-nav__link">Do you offer any paid support?</a>
+        </li>
+        <li class="md-nav__item"><a href="#why-the-sspl-license" class="md-nav__link">Why the SSPL License?</a>
+        </li></ul>
+            </nav>
         </li>
         <li class="md-nav__item"><a href="#contact" class="md-nav__link">Contact</a>
         </li></ul>
@@ -687,6 +753,38 @@
 
 <h2 id="faq">FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
 
+<h3 id="does-will-netmaker-support-x-operating-system">Does/Will Netmaker Support X Operating System?<a class="headerlink" href="#does-will-netmaker-support-x-operating-system" title="Permalink to this headline">¶</a></h3>
+<p>Netmaker is initially available on a limited number of operating systems for good reason: Every operating system is designed differently. With a small team, we can either focus on making Netmaker do a lot on a few number of operating systems, or a little on a bunch of operating systems. We chose the first option. You can view the System Compatibility docs for more info, but in general, you should only be using Netmaker on systemd linux right now.</p>
+<p>However, as of v0.4, we will technically be able to bring any operating system into the network. This is a bit of a hack. v0.4 introduces Ingress Gateways. Think of it this way. You set up a private network. You want devices to access it. You set up a single node as an “Ingress Gateway” and generate config files for “external clients.” These clients are unmanaged and unmeshed, meaning they can access the network but only via the gateway. It also means they will not automatically account for changes to the network, and the user will have to update the configs manually.</p>
+<p>This lets us immediately “support” any device which can run WireGuard, which includes most operating systems at this point including phones and Windows.</p>
+<p>As we stabilize the design and feature set of Netmaker, we will expand the operating system support for Netclient which configures dynamic, fully-meshed devices. Expect to see updates about new OS support every few weeks, until eventually the Ingress Gateway becomes unnecessary (though you will still want it for certain use cases).</p>
+
+
+<h3 id="how-do-i-install-the-netclient-on-x">How do I install the Netclient on X?<a class="headerlink" href="#how-do-i-install-the-netclient-on-x" title="Permalink to this headline">¶</a></h3>
+<p>As per the above, there are many unsupported operating systems. You are still welcome to try, it is just an executable binary file after all. If the system is unix-based and has kernel WireGuard installed, netclient may very well mesh the device into the network. However, the service likely will encounter problems retrieving updates.</p>
+
+
+<h3 id="is-netmaker-a-vpn-like-nordnpn">Is Netmaker a VPN like NordNPN?<a class="headerlink" href="#is-netmaker-a-vpn-like-nordnpn" title="Permalink to this headline">¶</a></h3>
+<p>No. Netmaker makes Virtual Networks, which are technically VPNs, but different. It’s more like a corporate VPN, or a VPC (if you’re familiar with AWS).</p>
+<p>If you’re looking to achieve self-hosted web browsing, with functionality similar to NordVPN, ExpressVPN, Surfshark, Tunnelbear, or Private Internet Access, this is probably not the project for you. Technically, you can accomplish this with Netmaker, but it would be a little like using a all-terrain vehicle for stock car racing.</p>
+<p>There are many good projects out there that support general internet privacy using WireGuard. Here are just a few of them:</p>
+<p><a class="reference external" href="https://github.com/trailofbits/algo">https://github.com/trailofbits/algo</a>
+<a class="reference external" href="https://github.com/pivpn/pivpn">https://github.com/pivpn/pivpn</a>
+<a class="reference external" href="https://github.com/subspacecloud/subspace">https://github.com/subspacecloud/subspace</a>
+<a class="reference external" href="https://github.com/mullvad/mullvadvpn-app">https://github.com/mullvad/mullvadvpn-app</a></p>
+
+
+<h3 id="do-you-offer-any-paid-support">Do you offer any paid support?<a class="headerlink" href="#do-you-offer-any-paid-support" title="Permalink to this headline">¶</a></h3>
+<p>Not at this time, but eventually we will. If you are interested, or if you are interested in sponsoring the project generally, please contact Alex Feiszli (<a class="reference external" href="mailto:alex%40gravitl.com">alex<span>@</span>gravitl<span>.</span>com</a>).</p>
+
+
+<h3 id="why-the-sspl-license">Why the SSPL License?<a class="headerlink" href="#why-the-sspl-license" title="Permalink to this headline">¶</a></h3>
+<p>We thought long and hard about the license. Ultimately, we think this is the best way to support and ensure the health of the project long term. The community deserves something that is well-maintained, and in order to do that, eventually we need some financial support. We won’t do that by limiting the project, but we will offer some additional support, and hosted options for things people would end up paying for anyway (relay servers, load balancing support, backups).</p>
+<p>While SSPL is not an OSI-approved open source license, it let’s people generally run the project however they want, both for private use and business use, without running into the issue of someone else monetizing the project and making it financially untenable. We are working on making the guidelines clear, and will make sure that the license does not impact the communities ability to use and modify the project.</p>
+<p>If you have concerns about the license leading to project restrictions down the road, just know that there are other paid, closed-source/closed-core options out there, so beyond not wanting to follow that path, we also don’t think it’s a good idea economically either. We firmly believe that having the project open is not only right, but the best option.</p>
+<p>All that said, we will re-evaluate the license on a regular basis and determine if an OSI-approved license makes more sense. It’s just easier to move from SSPL to another license than vice-versa.</p>
+
+
 
 <h2 id="contact">Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h2>
 <p>If you need help, try the discord or open a GitHub ticket.</p>

docs/_build/html/troubleshoot.html

@@ -315,6 +315,27 @@
       <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
     </li></ul>
     
     </li>
@@ -326,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -333,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>

docs/_build/html/usage.html

@@ -263,7 +263,7 @@
     <li class="md-nav__item">
     
     
-      <a href="architecture.html#compatible-systems" class="md-nav__link">Compatible Systems</a>
+      <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
       
     
     </li>
@@ -280,8 +280,64 @@
     
     
       <a href="quick-start.html" class="md-nav__link">Quick Start</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#prerequisites" class="md-nav__link">Prerequisites</a>
       
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#install" class="md-nav__link">Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#setup" class="md-nav__link">Setup</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="quick-start.html#uninstralling-netmaker" class="md-nav__link">Uninstralling Netmaker</a>
+      
+    
+    </li></ul>
+    
     </li>
     <li class="md-nav__item">
     
@@ -291,6 +347,13 @@
     <li class="md-nav__item">
     
     
+      <a href="server-installation.html#notes-on-optional-features" class="md-nav__link">Notes on Optional Features</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
       <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
       
     
@@ -298,14 +361,35 @@
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
+      <a href="server-installation.html#dns-mode-prereqisite-setup-ubuntu" class="md-nav__link">DNS Mode Prereqisite Setup (Ubuntu)</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="server-installation.html#installing-netmaker" class="md-nav__link">Installing Netmaker</a>
+      <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html#configuration-reference" class="md-nav__link">Configuration Reference</a>
       
     
     </li></ul>
@@ -465,19 +549,54 @@
     <li class="md-nav__item">
     
     
-      <a href="support.html" class="md-nav__link">Support</a>
+      <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
       <ul class="md-nav__list"> 
     <li class="md-nav__item">
     
     
-      <a href="support.html#faq" class="md-nav__link">FAQ</a>
+      <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
       
     
     </li>
     <li class="md-nav__item">
     
     
-      <a href="support.html#troubleshooting" class="md-nav__link">Troubleshooting</a>
+      <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#agent" class="md-nav__link">Agent</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
+      
+    
+    </li></ul>
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html" class="md-nav__link">Support</a>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+    
+    
+      <a href="support.html#faq" class="md-nav__link">FAQ</a>
       
     
     </li>

docs/client-installation.rst

@@ -1,26 +1,61 @@
-============
+====================
 Client Installation
-============
+====================
 
 This document tells you how to install the netclient on machines that will be a part of your Netmaker network, as well as non-compatible systems.
 
+These steps should be run after the Netmaker server has been created and a network has been designated within Netmaker.
+
 System Compatibility
 ====================
 
 Prerequisites
 =============
 
-Installing Netclient
-===================
+Configuration
+===============
 
-Linux
------
+Variable Reference
+--------------------
 
-Kubernetes/Docker
------------------
+Config File Reference
+------------------------
+
+CLI Reference
+------------------------
+
+Installation
+======================
+
+Token
+-------
+
+Access Key
+------------
 
-Customizing your Installation
------------------------------
+Manual
+---------
+
+Config File
+------------
+
+Managing Netclient
+=====================
+
+Viewing Logs
+---------------
+
+Making Updates
+----------------
+
+Adding/Removing Networks
+---------------------------
+
+Uninstalling
+---------------
+
+Troubleshooting
+-----------------
 
-Unmanaged Clients (Pure WireGuard)
+Unmanaged (External) Clients
 ==================================

docs/server-installation.rst

@@ -33,17 +33,17 @@ This requires privileged (root) access to the host machine and multiple host dir
 
 To run a non-docker installation, you are running the Netmaker binary, CoreDNS binary, MongoDB, and a web server directly on your host. This requires all the requirements for those individual components. Our guided install assumes systemd-based linux, but there are many other ways to install Netmaker's individual components onto machines that do not support Docker. 
 
-DNS Mode Prereqisite Setup (Ubuntu)
+DNS Mode Prereqisite Setup
 ====================================
 
 If you plan on running the server in DNS Mode, you will be deploying a CoreDNS server. We recommend binding CoreDNS to port 53 of the host system (which it will do by default). On some systems, this will conflift with existing processes. Specifically on linux systems running systemd-resolved, there may be a service consuming port 53. The below steps will disable systemd-resolved, and replace it with a generic (e.g. Google) nameserver. The following was tested on Ubuntu 20.04. This may have consequences for existing private DNS so proceed with caution:
 
-1. systemctl stop systemd-resolved 
-2. systemctl disable systemd-resolved 
-3. vim /etc/systemd/resolved.conf
+1. ``systemctl stop systemd-resolved`` 
+2. ``systemctl disable systemd-resolved`` 
+3. ``vim /etc/systemd/resolved.conf``
     * uncomment DNS and add 8.8.8.8 or whatever reachable nameserver is your preference
     * uncomment DNSStubListener and set to "no"
-4. sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf
+4. ``ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf``
 
 Port 53 should now be available for CoreDNS to use.
 

docs/support.rst

@@ -3,10 +3,65 @@ Support
 =========
 
 FAQ
-----
+======
+
+Does/Will Netmaker Support X Operating System?
+--------------------------------------------------
+
+Netmaker is initially available on a limited number of operating systems for good reason: Every operating system is designed differently. With a small team, we can either focus on making Netmaker do a lot on a few number of operating systems, or a little on a bunch of operating systems. We chose the first option. You can view the System Compatibility docs for more info, but in general, you should only be using Netmaker on systemd linux right now.
+
+However, as of v0.4, we will technically be able to bring any operating system into the network. This is a bit of a hack. v0.4 introduces Ingress Gateways. Think of it this way. You set up a private network. You want devices to access it. You set up a single node as an "Ingress Gateway" and generate config files for "external clients." These clients are unmanaged and unmeshed, meaning they can access the network but only via the gateway. It also means they will not automatically account for changes to the network, and the user will have to update the configs manually.
+
+This lets us immediately "support" any device which can run WireGuard, which includes most operating systems at this point including phones and Windows.
+
+As we stabilize the design and feature set of Netmaker, we will expand the operating system support for Netclient which configures dynamic, fully-meshed devices. Expect to see updates about new OS support every few weeks, until eventually the Ingress Gateway becomes unnecessary (though you will still want it for certain use cases).
+
+How do I install the Netclient on X?
+---------------------------------------
+
+As per the above, there are many unsupported operating systems. You are still welcome to try, it is just an executable binary file after all. If the system is unix-based and has kernel WireGuard installed, netclient may very well mesh the device into the network. However, the service likely will encounter problems retrieving updates.
+
+Is Netmaker a VPN like NordNPN?
+--------------------------------
+
+No. Netmaker makes Virtual Networks, which are technically VPNs, but different. It's more like a corporate VPN, or a VPC (if you're familiar with AWS).
+
+If you're looking to achieve self-hosted web browsing, with functionality similar to NordVPN, ExpressVPN, Surfshark, Tunnelbear, or Private Internet Access, this is probably not the project for you. Technically, you can accomplish this with Netmaker, but it would be a little like using a all-terrain vehicle for stock car racing.
+
+There are many good projects out there that support general internet privacy using WireGuard. Here are just a few of them:
+
+https://github.com/trailofbits/algo
+https://github.com/pivpn/pivpn
+https://github.com/subspacecloud/subspace
+https://github.com/mullvad/mullvadvpn-app
+
+Do you offer any paid support?
+---------------------------------
+
+Not at this time, but eventually we will. If you are interested, or if you are interested in sponsoring the project generally, please contact Alex Feiszli ([email protected]).
+
+Why the SSPL License?
+----------------------
+
+We thought long and hard about the license. Ultimately, we think this is the best way to support and ensure the health of the project long term. The community deserves something that is well-maintained, and in order to do that, eventually we need some financial support. We won't do that by limiting the project, but we will offer some additional support, and hosted options for things people would end up paying for anyway (relay servers, load balancing support, backups). 
+
+While SSPL is not an OSI-approved open source license, it let's people generally run the project however they want, both for private use and business use, without running into the issue of someone else monetizing the project and making it financially untenable. We are working on making the guidelines clear, and will make sure that the license does not impact the communities ability to use and modify the project.
+
+If you have concerns about the license leading to project restrictions down the road, just know that there are other paid, closed-source/closed-core options out there, so beyond not wanting to follow that path, we also don't think it's a good idea economically either. We firmly believe that having the project open is not only right, but the best option.
+
+All that said, we will re-evaluate the license on a regular basis and determine if an OSI-approved license makes more sense. It's just easier to move from SSPL to another license than vice-versa.
+
+Issues, Bugs, and Feature Requests
+=====================================
+
+Issues / Bugs
+----------------
+
+Feature Requests
+-------------------
 
 Contact
---------
+===========
 If you need help, try the discord or open a GitHub ticket.
 
 Email: [email protected]