# WireGuard® Automation from Homelab to Enterprise
@@ -18,6 +37,7 @@
# Get Started in 5 Minutes
+**For production-grade installations, visit the [Install Docs](https://netmaker.readthedocs.io/en/develop/install.html).**
1. Get a cloud VM with Ubuntu 20.04 and a public IP.
2. Open ports 443, 53, and 51821-51830/udp on the VM firewall and in cloud security settings.
3. Run the script:
@@ -26,8 +46,6 @@
-(For a more customized install, including using your own domain, head over to [the quick start guide](https://docs.netmaker.org/quick-start.html).)
-
After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting-started-with-netmaker-a-wireguard-virtual-networking-platform-3d563fbd87f0) and [Getting Started](https://netmaker.readthedocs.io/en/master/getting-started.html) guide to begin setting up networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes.
# Why Netmaker + WireGuard?
@@ -46,10 +64,9 @@ After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting
- [Business (Subscription)](https://gravitl.com/plans/business)
-- [Email](mailto:info@gravitl.com)
-
## Disclaimer
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
## License
+
Netmaker's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found here: [LICENSE.txt](./LICENSE.txt).
diff --git a/compose/docker-compose.caddy.yml b/compose/docker-compose.caddy.yml
index 1ddb4ee2..12443984 100644
--- a/compose/docker-compose.caddy.yml
+++ b/compose/docker-compose.caddy.yml
@@ -3,7 +3,7 @@ version: "3.4"
services:
netmaker:
container_name: netmaker
- image: gravitl/netmaker:v0.8.2
+ image: gravitl/netmaker:v0.8.3
volumes:
- /etc/netclient/config:/etc/netclient/config
- dnsconfig:/root/config/dnsconfig
diff --git a/compose/docker-compose.nodns.yml b/compose/docker-compose.nodns.yml
deleted file mode 100644
index f8953d73..00000000
--- a/compose/docker-compose.nodns.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-version: "3.4"
-
-services:
- rqlite:
- container_name: rqlite
- image: rqlite/rqlite
- network_mode: host
- restart: always
- volumes:
- - sqldata:/rqlite/file/data
- netmaker:
- depends_on:
- - rqlite
- privileged: true
- container_name: netmaker
- image: gravitl/netmaker:v0.7
- volumes:
- - ./:/local
- - /etc/netclient:/etc/netclient
- - /usr/bin/wg:/usr/bin/wg
- - /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket
- - /run/systemd/system:/run/systemd/system
- - /etc/systemd/system:/etc/systemd/system
- - /sys/fs/cgroup:/sys/fs/cgroup
- cap_add:
- - NET_ADMIN
- - SYS_MODULE
- restart: always
- network_mode: host
- environment:
- SERVER_HOST: "SERVER_PUBLIC_IP"
- DNS_MODE: "off"
- SERVER_API_CONN_STRING: "api.NETMAKER_BASE_DOMAIN:443"
- SERVER_GRPC_CONN_STRING: "grpc.NETMAKER_BASE_DOMAIN:443"
- GRPC_SSL: "on"
- SERVER_HTTP_HOST: "api.NETMAKER_BASE_DOMAIN"
- SERVER_GRPC_HOST: "grpc.NETMAKER_BASE_DOMAIN"
- API_PORT: "8081"
- GRPC_PORT: "50051"
- CLIENT_MODE: "on"
- MASTER_KEY: "REPLACE_MASTER_KEY"
- SERVER_GRPC_WIREGUARD: "off"
- CORS_ALLOWED_ORIGIN: "*"
- netmaker-ui:
- container_name: netmaker-ui
- depends_on:
- - netmaker
- image: gravitl/netmaker-ui:v0.7
- links:
- - "netmaker:api"
- ports:
- - "8082:80"
- environment:
- BACKEND_URL: "https://api.NETMAKER_BASE_DOMAIN"
-volumes:
- sqldata: {}
\ No newline at end of file
diff --git a/compose/docker-compose.yml b/compose/docker-compose.yml
index f7106c0f..9f24d8e3 100644
--- a/compose/docker-compose.yml
+++ b/compose/docker-compose.yml
@@ -3,7 +3,7 @@ version: "3.4"
services:
netmaker:
container_name: netmaker
- image: gravitl/netmaker:v0.8.2
+ image: gravitl/netmaker:v0.8.3
volumes:
- /etc/netclient/config:/etc/netclient/config
- dnsconfig:/root/config/dnsconfig
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
index e6a08d24..d8ba343d 100644
Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
index 7ebdcae0..858da06a 100644
Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ
diff --git a/docs/_build/doctrees/install.doctree b/docs/_build/doctrees/install.doctree
new file mode 100644
index 00000000..8f3723d2
Binary files /dev/null and b/docs/_build/doctrees/install.doctree differ
diff --git a/docs/_build/doctrees/quick-start-nginx.doctree b/docs/_build/doctrees/quick-start-nginx.doctree
index 5d38e4bf..3019efc3 100644
Binary files a/docs/_build/doctrees/quick-start-nginx.doctree and b/docs/_build/doctrees/quick-start-nginx.doctree differ
diff --git a/docs/_build/doctrees/quick-start.doctree b/docs/_build/doctrees/quick-start.doctree
index 5eb70759..22f568d9 100644
Binary files a/docs/_build/doctrees/quick-start.doctree and b/docs/_build/doctrees/quick-start.doctree differ
diff --git a/docs/_build/doctrees/server-installation.doctree b/docs/_build/doctrees/server-installation.doctree
index e1c70e98..bfd68624 100644
Binary files a/docs/_build/doctrees/server-installation.doctree and b/docs/_build/doctrees/server-installation.doctree differ
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
index abd913e0..edd73cef 100644
--- a/docs/_build/html/_sources/index.rst.txt
+++ b/docs/_build/html/_sources/index.rst.txt
@@ -48,6 +48,16 @@ A technical overview of Netmaker, including design decisions and limitations.
architecture
+Install
+------------------------------------
+
+Choose the right install method for you.
+
+.. toctree::
+ :maxdepth: 1
+
+ install
+
Quick Start
---------------
diff --git a/docs/_build/html/_sources/install.rst.txt b/docs/_build/html/_sources/install.rst.txt
new file mode 100644
index 00000000..ea7d3d4f
--- /dev/null
+++ b/docs/_build/html/_sources/install.rst.txt
@@ -0,0 +1,20 @@
+=========
+Install
+=========
+
+Choose the install method that makes sense for you.
+
+**For most users, we recommend the** :doc:`Quick Install<./quick-start>` **guide.**
+
+`Trial, PoC, Testing, and Experimenting `_
+
+:doc:`Quick Install: for general small-to-medium use cases <./quick-start>`
+
+:ref:`Kubernetes Installation `
+
+:ref:`Non-Docker (from binary) Install `
+
+:ref:`Highly Available Installation `
+
+:doc:`Advanced Install Resources <./server-installation>`
+
diff --git a/docs/_build/html/_sources/quick-start-nginx.rst.txt b/docs/_build/html/_sources/quick-start-nginx.rst.txt
index 5c1a3bb9..4fbe89a1 100644
--- a/docs/_build/html/_sources/quick-start-nginx.rst.txt
+++ b/docs/_build/html/_sources/quick-start-nginx.rst.txt
@@ -161,7 +161,7 @@ Start Netmaker
``sudo docker-compose -f docker-compose.yml up -d``
-navigate to dashboard. to see your nginx instance.
+navigate to dashboard. to log into the UI.
To troubleshoot issues, start with:
diff --git a/docs/_build/html/_sources/quick-start.rst.txt b/docs/_build/html/_sources/quick-start.rst.txt
index 3386c001..e229706d 100644
--- a/docs/_build/html/_sources/quick-start.rst.txt
+++ b/docs/_build/html/_sources/quick-start.rst.txt
@@ -62,7 +62,7 @@ Caddy will create 3 subdomains with this wildcard, EX:
ssh root@your-host
sudo apt-get update
- sudo apt-get -y docker docker-compose wireguard
+ sudo apt-get install -y docker.io docker-compose wireguard
At this point you should have all the system dependencies you need.
@@ -132,7 +132,7 @@ Start Netmaker
``sudo docker-compose up -d``
-navigate to dashboard. to see your nginx instance.
+navigate to dashboard. to begin using Netmaker.
To troubleshoot issues, start with:
diff --git a/docs/_build/html/_sources/server-installation.rst.txt b/docs/_build/html/_sources/server-installation.rst.txt
index d4a15f8b..539a0657 100644
--- a/docs/_build/html/_sources/server-installation.rst.txt
+++ b/docs/_build/html/_sources/server-installation.rst.txt
@@ -187,6 +187,8 @@ To run without DNS, follow the :doc:`Quick Install <./quick-start>` guide, omitt
This template is equivalent but omits CoreDNS.
+.. _NoDocker:
+
Linux Install without Docker
=============================
@@ -234,6 +236,8 @@ The following uses Nginx as an http server. You may alternatively use Apache or
CoreDNS Setup
----------------
+.. _KubeInstall:
+
Kubernetes Install
=======================
@@ -276,7 +280,7 @@ The following instructions assume you have Netmaker running and a network you wo
For a more detailed guide on integrating Netmaker with MicroK8s, `check out this guide `_.
Nginx Reverse Proxy Setup with https
-====================================
+======================================
The `Swag Proxy `_ makes it easy to generate a valid ssl certificate for the config bellow. Here is the `documentation `_ for the installation.
@@ -337,3 +341,72 @@ The following file configures Netmaker as a subdomain. This config is an adaptio
proxy_pass_request_headers on;
}
}
+
+.. _HAInstall:
+
+Highly Available Installation
+===============================
+
+For an enterprise Netmaker installation, you will need a server that is highly available, to ensure redundant WireGuard routing when any server goes down. To do this, you will need:
+
+1. A load balancer
+2. 3+ Netmaker server instances
+3. rqlite as the backing database
+
+These documents outline general HA installation guidelines. Netmaker is highly customizable to meet a wide range of enterprise environments. If you would like support with an enterprise-grade Netmaker installation, you can `schedule a consultation here `_ .
+
+The main consideration here is how to configure rqlite. Most other settings and procedures match the standardized way of making applications HA: Load balancing to multiple instances, and sharing a DB. In our case, the DB (rqlite) is distributed, making HA data more easily achievable.
+
+1. Load Balancer Setup
+------------------------
+
+Your load balancer of choice will send requests to the Netmaker servers. Setup is similar to the various guides we have created for Nginx, Caddy, and Traefik. SSL certificates must also be configured and handled by the LB.
+
+2. RQLite Setup
+------------------
+
+RQLite is the included distributed datastore for an HA Netmaker installation. If you have a different corporate database you wish to integrate, Netmaker is easily extended to other DB's. If this is a requirement, please contact us.
+
+Assuming you use Rqlite, you must run it on each Netmaker server VM, or alongside that VM as a container. Setup a config.json for database credentials (password supports BCRYPT HASHING) and mount in working directory of rqlite and specify with `-auth config.json` :
+
+.. code-block::
+
+ [{
+ "username": "netmaker",
+ "password": "",
+ "perms": ["all"]
+ }]
+
+
+Once your servers are set up with rqlite, the first instance must be started normally, and then additional nodes must be added with the "join" command. For instance, here is the first server node:
+
+.. code-block::
+
+ sudo docker run -d -p 4001:4001 -p 4002:4002 rqlite/rqlite -node-id 1 -http-addr 0.0.0.0:4001 -raft-addr 0.0.0.0:4002 -http-adv-addr 1.2.3.4:4001 -raft-adv-addr 1.2.3.4:4002 -auth config.json
+
+And here is a joining node:
+
+.. code-block::
+
+ sudo docker run -d -p 4001:4001 -p 4002:4002 rqlite/rqlite -node-id 2 -http-addr 0.0.0.0:4001 -raft-addr 0.0.0.0:4002 -http-adv-addr 2.3.4.5:4001 -raft-adv-addr 2.3.4.5:4002 -join https://netmaker:@1.2.3.4:4001
+
+- reference for rqlite setup: https://github.com/rqlite/rqlite/blob/master/DOC/CLUSTER_MGMT.md#creating-a-cluster
+- reference for rqlite security: https://github.com/rqlite/rqlite/blob/master/DOC/SECURITY.md
+
+Once rqlite instances have been configured, the Netmaker servers can be deployed.
+
+3. Netmaker Setup
+------------------
+
+Netmaker will be started on each node with default settings, except with DATABASE=rqlite and SQL_CONN set appropriately to reach the local rqlite instance. Rqlite will maintain consistency with each Netmaker backend.
+
+4. Other Considerations
+------------------------
+
+This is enough to get a functioning HA installation of Netmaker. However, you may also want to make the Netmaker UI or the CoreDNS server HA as well. The Netmaker UI can simply be added to the same servers and load balanced appropriately. For some load balancers, you may be able to do this with CoreDNS as well.
+
+
+
+
+
+
diff --git a/docs/_build/html/external-clients.html b/docs/_build/html/external-clients.html
index f32de90d..1a906df5 100644
--- a/docs/_build/html/external-clients.html
+++ b/docs/_build/html/external-clients.html
@@ -275,6 +275,13 @@
+
+
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
index a7ac935b..751810c9 100644
--- a/docs/_build/html/searchindex.js
+++ b/docs/_build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["about","api","architecture","client-installation","conduct","external-clients","getting-started","index","license","quick-start","quick-start-nginx","server-installation","support","troubleshoot","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["about.rst","api.rst","architecture.rst","client-installation.rst","conduct.rst","external-clients.rst","getting-started.rst","index.rst","license.rst","quick-start.rst","quick-start-nginx.rst","server-installation.rst","support.rst","troubleshoot.rst","usage.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,2,3,5,6,7,11,13],"04":[9,10,11],"06":1,"0afehuytvin":3,"0g":3,"1":[1,3,4,5,7,8,11,13],"10":[1,2,3,5,6],"100":[1,6],"101":3,"11":[3,5,6,11],"12":6,"127":11,"147":3,"15":3,"16":[1,2],"168":3,"170":3,"172":1,"182":3,"192":3,"1gb":[9,10],"2":[1,3,7,13],"20":[3,5,6,9,10,11],"200":1,"203":3,"22":3,"236":5,"24":[2,3,5,6],"247":5,"25":6,"251":3,"254":6,"29":10,"2a":3,"2cpu":[9,10],"2gb":[9,10],"3":[3,5,7,11],"30":[6,9,10,11],"31":1,"32":[3,5],"34":3,"4":[3,4,7],"41":3,"443":[9,10,11],"4b":3,"4gb":[9,10],"5":[5,10],"50051":[2,3,6,11],"51821":[3,9,10],"51822":5,"51825":10,"51830":9,"518xx":9,"53":[3,9,10,11],"5c":3,"5qktbtgsvb45y3qyrmwft":3,"60":5,"6400":1,"68":3,"6c":3,"7":[3,5,11,13],"70":1,"77":3,"78":3,"7b":3,"8":[2,3,5,11,13],"80":11,"8081":[1,2,3,11],"8082":11,"8c":1,"9":[9,10],"90":1,"91":3,"98":6,"99":6,"abstract":2,"break":3,"case":[1,2,3,5,7,9,10,11,13,14],"class":11,"default":[1,2,3,5,6,9,10,11,13],"do":[0,1,2,3,4,5,6,9,10,11,13],"final":13,"function":[1,3,11,12,13],"import":[2,5,6],"long":[0,6,12],"new":[2,3,6,10],"null":10,"public":[2,3,4,5,8,9,10],"return":[2,10],"short":3,"static":[2,9,10,11,13],"switch":[11,12],"true":[2,3,11],"try":[12,13],"var":[1,11],"while":[2,12],A:[2,3,5,6,7,9,10,11,13],As:[0,2,3,9,12,13],At:[0,2,3,9,10],Be:[9,10,11],Being:4,By:[0,1,5,9,10,11],For:[2,3,5,6,9,10,11,13],If:[0,1,2,3,5,6,9,10,11,12,13,14],In:[0,1,2,3,4,6,9,10,11,12,13],Is:13,It:[0,2,3,5,6,10,11,12,13,14],No:12,Not:2,On:[2,3,10,11],Or:[9,10],That:2,The:[0,1,2,3,4,5,6,9,10,11,12],Then:[5,6,13],There:[0,1,3,6,12,13],These:[2,3,6],To:[2,3,5,6,9,10,11],Will:3,With:[2,12],a6:3,aa3bvg0rnitirxdx:1,abil:[12,13],abl:[1,2,5],abou:6,about:[2,3,6,9,10,11,12,13],abov:[2,3,6,10,11,12],absent:3,abus:4,accept:[3,4,5],access:[0,2,3,5,6,7,9,10,11,12,13,14],access_token_valu:11,accesskei:[1,3],accomplish:12,account:[4,13],achiev:[1,2,12,13],acm:10,across:[0,3],act:[2,4,5],action:[1,3,4],activ:13,actual:2,ad:[2,6,7,11,12],adapt:[4,11],add:[0,1,2,3,5,6,10,11],addit:[2,3,6,10,11,12,13],addition:9,addnetwork:1,addr:3,address:[2,3,4,5,6,11,13],addressipv6:3,addressrang:1,adequ:11,adm:1,admin:[0,1,2,3,6,11,13],administr:3,adopt:2,advanc:[1,4,6,7,9,10],advfirewal:3,after:[2,3,5,6,12],ag:4,again:[9,10],against:3,agent:[0,2,3,6,7,11,13],agent_backend:11,agentbackend:11,aggreg:2,agre:10,alex:3,algo:12,align:4,all:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],allow:[1,2,3,5,6,9,10,11,13,14],allowedip:[3,5],allowedorigin:11,along:13,alreadi:[2,3,6,11],also:[0,1,2,6,9,10,11,12,13],altern:[2,11],although:13,alwai:11,am:13,amd64:10,an:[0,2,3,4,6,7,9,10,11,12,13,14],android:[2,13],ani:[0,2,3,4,5,6,9,10,11,13],anoth:[2,12,13],answer:13,anymor:13,anyth:2,anywai:12,anywher:[9,10],aorijqalrik3ajflaqrdajhkr:1,apach:[2,11],api:[2,3,6,9,10,11],api_port:11,apiaddress:3,apihost:11,apiport:11,apiserv:3,app:[5,11,12,13],appear:[4,6],appli:[4,11],applic:1,appoint:4,appropri:[2,4,5,6,10],approv:[1,3,6,12],aprov:13,apt:[9,10],ar:[0,1,2,3,4,5,6,8,9,10,11,12,13,14],arbitrari:0,arch:[2,6,10],architectur:11,archiv:10,argument:3,arm:[3,6],around:[9,10],arrai:2,artifact:8,ask:[3,13],asset:11,assum:[2,5,9,10,11,13],attach:5,attack:4,attempt:2,attent:4,attribut:7,authent:[2,3,6],author:1,autom:0,automat:[3,5,11],avail:[3,4,8,11,12],aw:[0,9,10,12],awai:2,await:2,b5:1,back:[2,5],backend:11,backend_url:11,background:2,backup:12,balanc:12,ban:4,bare:2,base64:6,base:[2,3,9,10,11,12],bash:2,basi:[2,12],basic:14,bearer:1,becaus:[0,2,13],becom:[2,13],been:[2,3,9,10],befor:[2,9,10,13],begin:[2,10],behavior:4,behind:[2,5,9,10,13],being:[2,11],believ:12,bellow:11,below:[1,2,5,6,10,11,14],besid:2,best:[4,12],better:2,between:[0,2],bewar:3,beyond:[11,12],bin:[10,11],bin_t:13,binari:[2,3,6,11,12,13],bind:[9,10,11],bit:14,biz:[9,10],blank:[3,5],blob:11,block:[11,13],bodi:4,both:[2,4,9,11,12],bottom:6,bound:[9,10],brows:12,build:2,built:2,bunch:12,busi:[9,10,12,13],button:13,c:[9,10,11],ca:10,caddi:10,caddyfil:9,call:[0,2,3,7,11],callabl:3,can:[0,1,2,3,5,6,8,10,11,12,13,14],cang:11,cannot:[3,5,9,10],cap_add:11,car:12,cat:13,caus:[2,9,10],cd:2,ce:10,center:0,cento:2,certain:2,certbot:10,certif:[10,11],certonli:10,cgroup:11,challeng:10,chang:[0,1,2,3,5,6,11,13],charact:13,chcon:13,check:[1,2,3,6,9,10,11,13],checkin:[1,2,3],chmod:10,choic:5,choos:[3,10],chose:12,chosen:[2,3,10],cidr:6,circumst:[3,4],clarifi:4,clear:12,cli:[2,10],click:[2,6,10,13],client:[0,6,9,10,11,12,13],client_max_body_s:11,client_mod:11,clientmod:11,clone:2,close:12,cloud:[0,9,10,14],cluster:[11,14],code:[2,3,5,8,13],com:[3,4,6,9,10,11,12,13],combin:11,come:[2,7,11],comfort:[9,10],comm:3,command:[2,3,6,9,10,11],comment:[4,11],commit:4,common:[2,7,9,10],commonli:13,commun:[2,3,4,7,10,11,12,13,14],compat:[5,7,12],compil:[2,3],complaint:4,complet:[2,13],complex:2,complic:2,compon:[7,11],compos:[6,7,10,13],comput:[0,2,3],concept:7,concern:12,concurr:[9,10],conf:[5,10,11],confidenti:4,config:[1,2,5],configur:[0,1,2,6,7,9,10,13],conflict:11,connect:[0,2,3,5,6,11,13,14],consensu:[2,13],consequ:11,consid:[4,6],consider:2,consist:2,consol:6,construct:4,consult:13,consum:[3,10,11],contact:[4,7,9,10],contain:[2,6,10,11],container_nam:11,containerd:10,content:1,context:11,continu:[11,13],contrast:2,contribut:4,contributor:4,control:[2,6,11],copi:[6,11],core:[0,7,12],coredn:[3,7,9,10],coredns_addr:11,coredns_ip:[9,10],corednsaddr:3,corefil:11,coreo:2,corpor:[12,13],correct:[4,9],correctli:[2,11],cors_allowed_origin:11,could:[0,4,6,13],cours:10,coven:4,cover:7,cp:[10,11],cpu:[9,10,13],creat:[0,1,2,3,4,5,7,9,10,11,13,14],createadmin:1,creategatewai:1,creation:0,credenti:11,credit:13,critic:4,cron:2,cross:14,cryptocurr:0,cs:10,curl:[6,10,11],current:[2,3,11,13],custom:[2,7,9,10,11],cycl:[1,2],d9:1,d:[1,2,9,10,11],daemon:2,dashboard:[9,10],data:[0,2,11,13],databas:[2,11,13],databaseand:2,date:1,db:[2,7,11],dbu:11,dc:[9,10],ddflzqn:5,dearmor:10,deb:10,debian:2,debug:11,decis:7,decod:[2,3,6],deem:4,defin:4,delet:[1,5,6,13],deletegatewai:1,deni:13,depend:[2,3,7],depends_on:11,deploi:[2,7,9,10,11],deploy:[2,11],depreci:11,derogatori:4,deserv:12,design:[2,3,5,7,12,13],desktop:[2,3,5],detail:[1,2,3,4,6,7,11],determin:[4,12],dev:[9,10,11],develop:[6,9,10,11],devic:[0,2,3,7,12,13],diagram:2,differ:[0,2,4,6,11,12,14],digitalocean:[9,10],dir:3,directli:[0,1,2,5,9,10,11,13],directori:10,disabl:[2,4],disable_remote_ip_check:11,disableremoteipcheck:11,disconnect:13,discord:[12,13],displai:2,displaynam:1,distibut:2,distribut:[2,6],distributionshav:2,dn:[2,7,10,13,14],dns_mode:[11,13],dnsconfig:11,dnsmode:11,dnson:3,dnsstublisten:11,doc:[6,9,10,11,12],docker:[2,6,7,13],document:[0,2,3,6,11],doe:[2,5,7,11,13],doesn:13,domain:[9,11,13],don:[2,3,12,14],done:13,dont:13,down:[0,6,12,13],download:[3,5,6,10,11,13],dual:[3,13,14],due:13,duplic:3,dure:3,dynam:[0,2,7],e:[2,3,4,6,9,10,11,13],each:[0,2,3,6,11,13],easi:[2,11],easier:[2,12],easiest:2,easili:0,echo:[9,10],econom:12,edit:[4,5,13],effect:6,effici:2,egress:[3,5],either:[2,5,12],ejf6yy51m:5,electron:4,elev:11,elimin:2,els:12,email:[9,10,12],empathi:4,empti:11,enabl:[2,6,9,10,11],encod:6,encompass:0,encount:[2,12],encrypt:[0,2,3,13],end:[2,9,10,11,12,13],endpoint:[1,2,3,5],enforc:7,engin:10,ensur:12,enter:[6,10],enterpris:[9,10],entir:6,entireti:2,entri:[11,13],env:[1,11],environ:[0,1,2,4,11,13],equal:11,equival:11,establish:5,etc:[3,6,9,10,11,13],eth0:1,ethnic:4,evalu:12,even:[0,2],event:4,eventu:12,everi:[2,3,6,12],everyon:4,everyth:[2,11],evolv:2,ex:[3,6,9,11],exampl:[2,3,4,5,7,9,10,11],except:11,execut:12,exist:[0,2,6,11],expand:12,expect:[4,7,11],experi:4,explain:[2,7],explicit:4,explicitli:11,expos:2,express:4,expressvpn:12,ext:[7,13],extens:2,extern:[3,11,12],f1:1,f8:3,f:[3,10,11,13],face:4,fact:0,fail:[2,6,10],fair:4,fairli:[2,13],faith:4,fals:[3,11],familiar:[0,2,12,13],faq:7,fast:[2,7,11],faster:[0,2,3],fcontext:13,featur:[9,10,11,12],fedora:2,few:[3,12],field:5,figur:14,file:[2,5,10,12],filenam:1,financi:12,find:[2,11,14],fine:0,firewal:[3,7,11,13],firmli:12,first:[2,3,6,11,12,13,14],fit:[9,10,14],flag:3,flat:0,flexibl:0,flow:2,focu:12,focus:4,folder:2,follow:[2,3,4,6,9,10,11,12,13],forc:11,form:3,format:11,forum:13,forward:[3,5,10],foster:4,found:[0,2,8,11],free:4,freeli:8,frequent:13,friend:13,from:[0,1,2,3,4,5,6,9,10,11,12,13,14],front:[2,11],fs:11,fssl:10,full:[0,2,11],fulli:[0,2],further:4,futur:[6,9,10,12],g:[3,6,9,10,11],gatewai:[1,2,3,7,13,14],gb:13,gcp:[9,10],gender:4,gener:[1,2,3,5,9,10,11,12],generate_config_j:11,get:[1,3,7,9,10,11,13,14],gg:12,github:[2,3,7,9,10,11,12,13],githubusercont:[6,9,10,11],give:[2,6,7,11,13],given:[0,2,6,13],global:3,gnupg:10,go:[2,3,7,11,13],goe:[0,11],golang:2,good:[4,5,12,13,14],googl:11,gpg:10,grab:3,gracefulli:4,gravitl:[3,4,6,9,10,11,12,13],group:[9,10],grpc:[2,3,6,9,10],grpc_port:11,grpc_ssl:11,grpcaddress:3,grpchost:11,grpcport:11,grpcserver:3,guid:[0,2,6,9,10,11,13],guidelin:12,h:[1,3],ha:[0,2,3,6,9,10,11,12,14],hand:7,handl:[0,2,9,10],handshak:13,harass:4,hard:[12,13],harder:13,harm:4,hasadmin:1,have:[0,2,3,4,5,6,9,10,11,12,13,14],haven:13,head:[9,10],header:[1,2,11],health:12,heart:3,heavi:2,help:[1,2,3,6,7,11,12,14],here:[2,4,6,8,9,10,11,12,14],high:[2,13],highli:3,hit:13,hold:[0,2,3],holder:13,hole:[3,13],holepunch:3,home:[0,2,3],hook:[2,5],host:[2,3,9,10,11,12],host_ip:11,hous:1,how:[2,3,7,11,13],howev:[1,2,3,9,10,11,12,13],html:11,http:[1,3,6,7,9,10,12,13],http_port:11,hub:[0,2],hundr:[9,10],i:[3,9,10,11,13],id:[1,3,11],idea:12,ident:4,identifi:3,ignor:3,imag:11,imageri:4,impact:[2,12],implement:2,importantli:6,inappropri:4,inbound:[3,9,10],incid:4,includ:[2,4,5,7,11],inclus:4,incorrect:[3,11,13],increas:2,independ:5,individu:[4,11],industri:2,info:[2,4,9,10,11,12],inform:[2,3,4,6,9,10],ingress:[2,3,7,11,13],initi:[3,12],ins:2,insert:[9,10,11,13],insid:11,instal:[0,2,5,6],instanc:[1,2,3,4,6,9,10,11],instead:[0,3,5,9,10,11,13],instruct:[10,11],insult:4,intact:3,integr:11,intend:3,interact:[0,2,3],interest:[4,12,13],interfac:[1,3,5,6,9,10,11],interfer:[9,10,13],intern:11,internet:[0,2,12],intro:14,introduc:13,introduct:7,invalid:[5,6],investig:4,invis:2,io:[9,10,13],iot:[0,2],ip:[2,3,5,6,9,10,11],ipforward:3,iphon:2,ipsec:2,iptabl:3,ipv4:[3,13],ipv6:[3,13,14],isdualstack:3,isingressgatewai:3,isloc:3,isstat:3,issu:[2,4,7,9,10,11,12],iter:12,its:[0,2,3,4,5,6,11],itself:[2,3,6,11],job:2,join:[2,3,6,13],journalctl:[3,11,13],jq:1,js:11,json:1,just:[0,2,3,5,9,11,12,13],jwt:[1,3],k3:14,k:[3,6],keep:1,keepal:3,kei:[2,3,9,10,11,13],kernel:[0,2,12],keynam:1,keyr:10,keyupd:1,kill:13,know:[11,12,13,14],known:[2,9,10],kube:11,kubectl:11,kubernet:[0,7,14],l:10,lan:3,languag:4,laptop1:1,laptop:5,larg:2,last:1,lastmodifi:1,latenc:2,later:2,latest:[2,3,5,11],launch:2,launchd:[2,3],launchdaemon:2,layer:0,layout:2,lead:12,leadership:4,least:[0,10,13],leav:[3,5,6,13],left:[11,13],less:[2,6],let:[0,12,14],letsencrypt:10,level:[2,4,11],librari:2,light:11,lightweight:2,like:[0,2,3,6,10,11],limit:[7,11,12],line:2,link:[7,9,10,11],linod:[9,10],linux:[2,3,6,7,10,12],linuxserv:11,list:[0,2,3,10,11],listen:11,listenport:1,littl:[2,12],ln:11,load:[2,11,12],local:[2,3,6,10,11],localaddress:[1,3],localhost:1,localrang:3,locat:[0,2,3,11],log:[9,10,11,13],logic:5,login:6,look:12,lookup:2,lot:[2,12],lower:13,lsb:10,lsb_releas:10,lxc:11,m:[3,5,10,13],mac:[2,3,6],macaddress:[1,3],machin:[0,2,3,5,6,9,10,13],made:[0,2,13],mai:[1,2,3,4,6,9,10,11,12,13],mail:4,maintain:[4,12],make:[0,2,4,5,9,10,11,12,13],man:5,manag:[0,2,5,7,11,14],mani:[0,2,9,11,12,14],manual:[2,3,6,10,11,13],map:11,master:[9,10,11],master_kei:11,masterkei:[1,11],match:[3,11],md:1,mean:[2,3,5,11],meant:11,media:4,member:[4,14],memori:13,mesh:[0,5,12,13,14],meshclient:1,metal:2,method:[1,2,3,5,6],mgmt:1,microk8:[11,14],middl:5,might:[0,2,11],min:[9,10],minimum:13,mint:2,minu:11,minut:[9,10,11,13],miss:2,mix:3,mode:[2,7],model:[0,2],modif:11,modifi:[1,2,3,6,9,10,11,12],monet:12,mongo:11,mongodb:11,more:[0,1,2,5,6,7,9,10,11,12],most:[1,2,3,9,10,11,13],mostli:[2,3],mount:11,move:[6,9,10,12],mtu:13,much:[0,2],mullvad:12,mullvadvpn:12,multipl:[0,6,13],must:[1,2,3,5,6,10,11,12,13],my:[1,3,13],mykei:[1,6],mynet:6,myserv:6,mysit:[9,10],n:[2,3,6,9,11,13],name:[1,2,3,5,6,11,13],nameserv:[2,3,11],namespac:11,nat:[5,13],nation:4,nativ:2,navig:[9,10,13],nebula:0,necessari:[2,3,4,11],need:[0,1,2,3,9,10,11,12,13],neighborhood:0,neither:2,net:[3,10],net_admin:11,netclient:[0,5,7],netclient_accesskei:3,netclient_accesstoken:3,netclient_address:3,netclient_addressipv6:3,netclient_api_serv:3,netclient_daemon:3,netclient_dn:3,netclient_endpoint:3,netclient_grpc_serv:3,netclient_interfac:3,netclient_ipforward:3,netclient_is_dualstack:3,netclient_is_loc:3,netclient_keepal:3,netclient_localaddress:3,netclient_localrang:3,netclient_macaddress:3,netclient_nam:3,netclient_network:3,netclient_o:3,netclient_password:3,netclient_port:3,netclient_postdown:3,netclient_postup:3,netclient_privatekei:3,netclient_publickei:3,netclient_roam:3,netclient_udp_holepunch:3,netconfig:[3,13],netid:1,netmak:[1,3,5,8,11,13],netmaker_base_domain:[9,10,11],netmaker_env:11,netsh:3,network:[0,5,6,7,9,10,11,12,13,14],network_mod:11,next:[3,6],nextcloud:14,nginx:[2,9,13],nip:9,nm:[3,11],node:[3,5,7,11,13],nodn:11,non:[2,3,6,11],none:0,noonewillguessthi:1,nordvpn:12,note:[1,5,7,9,10,11,13],notifi:2,now:[0,5,6,9,10,11,12,13],ns:11,nslookup:10,number:[2,6,9,12],o:[9,10,11],oblig:4,obtain:[1,3],od:3,off:[2,3,11,13],offens:4,offic:[0,14],offici:[1,4,10,13],offlin:4,often:2,ok:10,old:10,older:7,omit:11,onc:[5,6,11],one:[2,3,5,6,9,10,11,13],onli:[1,2,3,5,6,12,13],onlin:4,open:[2,4,7,10,12],openvpn:2,oper:[2,3,11],operatingsystem:3,opinion:9,oppos:2,option:[2,3,7,11,12],oracl:[9,10],order:[11,12,13],org:[10,11],orient:4,origin:11,os:3,osi:12,other:[0,2,3,4,5,6,11,12],otherwis:[0,3,4,13],our:[7,13],out:[0,2,6,9,10,11,12,13,14],outlin:[2,11],output:[3,6],outsid:[7,11],over:[0,2,11],overlai:[0,7],overlap:6,overrid:[3,11],overridden:[2,11],overview:[2,7,14],overwhelm:14,own:[2,9,10,11],p:[3,6,9],page:2,pai:12,paid:12,pair:[2,11],pane:6,part:[2,3,11],parti:13,partial:2,particip:4,particular:[2,3],pass:[2,3,11],password:[1,3,6],path:[1,11,12],peer:[2,3,5,13,14],pend:[1,6],peopl:12,per:[9,10,12],perform:[1,2,3,10,11],period:2,perman:4,permiss:[4,9,10,13],permit:6,persistentkeepal:[3,5],person:4,perspect:[0,2],phone:[3,5],physic:4,pick:[2,6],pictur:2,ping:[6,13],pivpn:12,place:[3,9,10,11],plaintext:3,plan:[9,10,11,13],platform:[2,7],pleas:[3,9,10,11,12,13],pledg:7,plu:[3,9],poc:9,point:[2,9,10],polici:4,polit:4,popul:11,port:[2,3,6,9,10,11,13],posit:4,possibl:[2,7,9],post:[1,2,3,4],postchang:3,postdown:3,postup:3,powershel:3,practic:2,pre:11,preced:2,precend:11,prefer:[9,10,11,13],prepar:7,prereqisit:6,prerequisit:[2,6,7,11],prevent:3,previou:2,primari:11,prior:11,privaci:12,privat:[2,4,6,7,11,12,14],privatekei:[3,5],privileg:11,privkei:3,probabl:[0,12],problem:12,process:[3,6,7,11],product:[9,11],profession:4,project:[1,4,11,12],prompt:10,proof:0,properli:[3,13],properti:3,proto:[9,10],protocol:[3,11],provid:[0,2,3,9,10,11],proxi:[7,9,10],proxy_pass:11,proxy_pass_request_head:11,proxy_set_head:11,pubkei:3,publickei:[1,3,5],publicli:[9,10],publish:[4,8],pull:[2,3,5,11],punch:[3,13],purchas:13,push:[3,5],put:1,python3:10,q9cog7c9qjnoxygvri:3,qr:[5,13],quarantin:3,question:13,quick:[6,10,11,13],quickli:[7,9,13],quickstart:13,r:13,race:[4,12],raft:[2,13],ram:[9,10],rang:[3,5,6,9,10],rangestr:1,raspian:2,raw:[3,6,9,10,11],re:[0,3,6,12,13],reach:[0,2,3,5,13],reachabl:[2,3,5,11],reactj:2,read:11,readm:9,reallysecret:1,reason:[2,4,11,12],reboot:13,recent:[2,3,13],reciev:[1,2],recommend:[1,3,5,9,10,11,13],reconfigur:[2,3,13],record:[9,10,13],refer:[2,6,10,13],regard:[2,4],regardless:4,regist:[2,3],registr:3,regular:12,reject:4,rel:2,relai:[2,3,5,12,13],releas:[2,3,10,11],reli:[0,3],religion:4,reload:10,remot:[0,3,11],remoteip:3,remov:[1,2,4,6,10,11,13],removenetwork:1,repeat:6,repercuss:4,replac:[3,10,11],replace_master_kei:[9,10],repo:2,report:[2,4],repositori:[2,8],repres:4,represent:4,request:[1,2,11],requir:[1,2,3,6,10,11,13],resolv:[2,3,11],resolvectl:[3,11],resourc:[5,7],respect:[2,4],respons:[2,7],rest:[9,11],rest_backend:11,restart:[10,11,13],restbackend:11,restorecon:13,restrict:[11,12],result:4,retriev:[0,1,2,3,6,12],revers:[7,9,10],revert:3,review:4,rf:6,rhel:2,right:[0,4,12],risk:13,rkxlgk2mg:5,rm:6,rncjjbsaa3hzuhrk5hpyxm:3,road:12,roam:3,rogu:13,root:[9,10,11,13],rout:[0,2,9],route53:[9,10],router:[2,13],rpumvsbpgq:5,rqlite:13,rule:[3,9,10],run:[0,1,2,3,5,6,7,9,10,11,12,13],runc:10,runtim:11,rv:13,rwx:11,s:[0,2,3,4,5,6,7,8,9,10,11,12,13],said:[2,12],same:[0,3,5,6,10,13],sampl:0,save:[6,9,10],scan:5,scenario:6,scope:7,screen:6,script:[2,3,6,9,11,13],second:6,secret:[1,3,6],secretkei:11,section:[3,11],secur:[0,1,2,3,7,9,10,13,14],sed:[9,10,11],see:[1,2,3,6,9,10,11,13],select:[5,6,13,14],self:12,selinux:13,semanag:13,send:[2,3,11],sens:[2,12],sensibl:[0,2,6],separ:[2,4,14],seper:13,seri:10,serv:[2,10,11],server:[0,3,5,6,8,9,10,12],server_api_conn_str:11,server_api_host:11,server_grpc_conn_str:11,server_grpc_host:11,server_host:11,server_http_host:11,server_nam:11,server_public_ip:[9,10],servic:[2,3,5,9,10,11,12,14],set:[1,2,3,4,6,9,10,11,13,14],setup:[0,2,7,9,10],sever:[2,11],sexual:4,sf:11,sfl:[6,11],sh:[6,11],share:[10,11,13],should:[0,1,2,3,5,6,7,9,10,11,12,13],show:[3,4,11,13],shown:5,side:8,sign:[2,3,6,10,13],signific:2,signigif:2,signup:[2,3,13],similar:[0,6,11,12],simpl:[2,3,6,11,13],simplest:[2,3],simpli:[2,3,5,6,10,13],simplifi:11,simultan:0,singl:[1,2,10,13],site:[0,2,7,11,13,14],situat:[2,13],size:4,skynet:1,slow:0,small:[2,6,12],smartgui:1,snap:10,so:[0,2,3,5,6,9,10,11,12,13],social:4,solut:2,solv:2,some:[1,2,3,11,12,13,14],someon:12,someth:[5,6,10,11,12],somewher:6,soon:[7,13],sort:0,sourc:[2,3,7,8,10,12],space:4,spec:13,special:[2,3,11],specif:[2,3,4,6,11],specifi:[3,11],speed:[0,2],split:3,spoke:[0,2],spread:0,sql:[2,11],sql_conn:11,sqlconn:11,sqldata:11,sqlit:2,sqlite:[11,13],src:9,ssh:[6,9,10],ssl:[10,11],sspl:8,stabl:10,stack:[3,13,14],stai:3,stake:0,standard:[2,7],start:[11,13,14],startup:1,state:6,statement:7,statu:[3,11,13],step:[2,3,6,11],still:[0,11,12],stock:12,stop:11,storag:[9,10,11],storageclassnam:11,store:[2,11],string:[6,11],stuck:13,stun:13,su:6,subdomain:[9,10,11],submit:6,subnet:2,subscript:[9,10,13],subsequ:2,subspac:12,subspacecloud:12,substanti:0,success:2,sudo:[3,6,9,10,11,13],support:[2,9,10,11,13],sure:[9,10,12,13],surfshark:12,suse:2,swag:11,swagger:7,sy:11,sys_modul:11,system:[6,7,9],system_bus_socket:11,system_u:13,systemctl:[3,10,11,13],systemd:[3,6,11,12,13],t:[2,3,6,10,12,13,14],tab:[6,13],tail:3,tailscal:0,take:[0,1,2,4,6,11,13],talk:[0,2],tcp:[9,10],team:[4,12],technic:[0,7,12],technolog:2,tee:10,tell:[0,2,3,11,13],templat:11,temporari:4,temporarili:4,term:12,terrain:12,test:6,than:[2,6,11,12],thei:[0,2,4,11,12,13],them:[2,6,11,12,13],themselv:[2,13],therefor:13,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],thing:[0,2,12],think:[12,14],third:13,thmpvlcykonxi:3,those:[0,2,3,5,10],thought:12,thousand:0,threaten:4,three:[6,10],through:[2,11],ticket:12,time:[1,2,3,5,6,11,13,14],timer:2,timestamp:2,token:[3,6,11,13],too:13,tool:[0,3,10],top:[2,10,13],topic:14,topolog:2,tos:10,toward:4,tr:[9,10],traefik:11,traffic:[0,2,5,10,11,13],trailofbit:12,transact:2,transport:10,treat:[2,3],trial:9,tricki:2,troll:4,troubleshooot:[9,10],troubleshoot:[1,3,6,9,10],tunnel:[0,2],tunnelbear:12,turn:[2,3,11,13],tutori:7,two:[0,1,2,13],txt:10,type:[1,11],typic:[0,2,5,6,11,13],u:[3,11,13],ua2zjt8wn7ga:5,ubuntu:[2,9,10,11],udp:[3,9,10,11,13],udpholepunch:3,ufw:[9,10],ui:[1,3,5,7],ultim:12,unaccept:4,unam:10,uncom:11,uncordon:1,under:[3,6,8,11,13],underlai:[0,14],underscores_in_head:11,uninstal:[7,13],uniqu:[3,9,10],unix:[2,3,12],unless:[3,11],unmanag:2,unnecessari:3,unregist:3,unregistr:3,unset:[3,11],unsupport:12,unsur:[5,6],unten:12,until:[3,6,13],unwelcom:4,unzip:11,up:[0,2,3,6,7,9,10,11,12,13,14],updat:[1,2,6,9,10,12,13],upgrad:[2,13],upon:[2,3],upstream_app:11,upstream_port:11,upstream_proto:11,urandom:[9,10],url:11,us:[1,2,3,4,5,6,7,9,10,11,12,13],usag:[3,7,11,14],user:[2,3,6,13],usernam:[1,6],usr:[10,11],usual:3,util:3,v02:10,v0:[2,11,13],v:13,valid:[2,11],valu:[1,2,3,6,9,11,13],variabl:[2,3,13],variou:[3,7,11],ve:13,vehicl:12,verbos:11,veri:[0,2,3,12],verifi:2,versa:12,version:[2,4,8,9,10,11,13],via:[1,2,3,4,5,6,9,10,11,12,13,14],vice:12,view:[6,12,13],viewpoint:4,vim:[3,11],virtual:[0,3,5,7,9,10,12,14],visibl:[6,11],vm3ow4thatogiwnsla3thsl3894th:6,vm:[0,2,9],vne197vmradjodkb1zsuja:3,volum:[6,11,13],vp:10,vpc:[0,12],vpn:[2,13,14],wa:[2,11],wai:[11,12,13],wait:10,want:[0,2,3,5,9,10,12,13],warn:11,we:[0,1,2,4,9,10,11,12,13],web:[11,12],webserv:2,websit:2,weight:11,welcom:[4,12],well:[2,3,6,7,12,13],were:13,wg:[3,11,13],wgaddress6:3,wgaddress:3,wget:[9,10,11],what:[2,4,5,7,13],whatev:[3,11],when:[2,3,4,11,13],where:[2,5,6,7,11,14],wherev:0,whether:[0,3],which:[0,2,3,4,5,6,8,9,10,11,12,13],who:4,why:[2,3,7,13],wide:2,wider:2,wiki:4,wildcard:[9,10,11],window:[2,6,7],wipe:13,wireguard:[0,3,5,6,7,9,10,11,12,13],wish:[3,5,11],within:[2,3,4],without:[1,2,3,4,6,7,12,13],won:12,work:[2,7,10,12],workstat:[3,6],world:[0,2],wors:2,would:[0,3,5,6,10,11,12],write:[2,11],ws2:3,www:11,x86:3,x:[1,2,6,9,10],y:[9,10],yaml:[1,11],ydazgedrpuxmmrqul35wfjmhvrzr1rq0u:5,ye:[3,13],yet:13,yml:[9,10,11,13],you:[0,1,2,3,5,6,7,9,10,11,13,14],your:[0,1,2,3,5,6,9,10,11,12,13,14],your_email:9,your_pass:1,your_password:1,your_secret_kei:1,yourwildcard:11,z0:[9,10],za:[9,10],zeroti:0,zip:11,zrb9vfhk8a:12},titles:["About","API Reference","Architecture","Client Installation","Code of Conduct","External Clients","Getting Started","Welcome to the Netmaker Documentation","License","Quick Install","Install with Nginx (depreciated)","Advanced Server Installation","Support","Troubleshooting","Using Netmaker"],titleterms:{"0":[9,10],"1":[9,10],"2":[9,10],"3":[9,10],"4":[9,10],"case":0,"do":12,Is:12,No:11,Will:12,about:[0,7],access:1,ad:[3,5],advanc:11,an:5,ani:12,annot:11,api:[1,7],architectur:[2,7],attribut:4,authent:1,caddi:9,call:1,cli:3,client:[2,3,5,7],code:[4,7],common:13,compat:[2,3,11],compon:2,compos:[9,11],concept:2,conduct:[4,7],config:[3,11],configur:[3,5,11],contact:12,core:2,coredn:[2,11,13],creat:6,curl:1,daemon:3,daemonset:11,depend:[9,10],deploi:6,depreci:[7,10],descript:11,disabl:11,dn:[3,5,9,11],docker:[9,10,11],document:[1,7],doe:[0,12],domain:10,enforc:4,enterpris:12,exampl:1,ext:5,extern:[2,5,7,14],faq:12,file:[1,3,11],firewal:[9,10],format:1,gatewai:5,get:6,grpc:11,guid:7,how:[0,12],http:11,i:12,ingress:5,instal:[3,7,9,10,11,12],introduct:[3,5,9,10],issu:13,kei:[1,6],kubernet:11,licens:[7,8,12],like:12,limit:2,linux:11,log:3,make:3,manag:[1,3,6],mesh:2,mode:[3,11],netclient:[2,3,6,11,12,13],netmak:[0,2,6,7,9,10,12,14],network:[1,2,3],nginx:[7,10,11],node:[1,2,6],nordnpn:12,note:3,offer:12,open:9,oper:12,option:5,our:4,pledg:4,prepar:[9,10],prerequisit:[3,9,10],privat:3,process:2,proxi:11,quick:[7,9],refer:[1,3,7,11],remov:3,respons:4,revers:11,rqlite:[2,11],scope:4,secur:11,server:[1,2,7,11,13],setup:[6,11],sqlite:2,sspl:12,standard:4,start:[6,7,9,10],support:[7,12],system:[2,3,11,12],systemd:2,technic:2,templat:10,test:11,troubleshoot:[7,13],tutori:14,ui:[2,11,13],uninstal:[3,6],updat:3,us:[0,14],usag:1,user:1,variabl:11,video:14,view:3,vm:10,vpn:12,welcom:7,what:0,why:12,window:3,wireguard:2,without:11,work:0,written:14,x:12,you:12}})
\ No newline at end of file
+Search.setIndex({docnames:["about","api","architecture","client-installation","conduct","external-clients","getting-started","index","install","license","quick-start","quick-start-nginx","server-installation","support","troubleshoot","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["about.rst","api.rst","architecture.rst","client-installation.rst","conduct.rst","external-clients.rst","getting-started.rst","index.rst","install.rst","license.rst","quick-start.rst","quick-start-nginx.rst","server-installation.rst","support.rst","troubleshoot.rst","usage.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,2,3,5,6,7,12,14],"04":[10,11,12],"06":1,"0afehuytvin":3,"0g":3,"1":[1,3,4,5,7,9,14],"10":[1,2,3,5,6],"100":[1,6],"101":3,"11":[3,5,6,12],"12":6,"127":12,"147":3,"15":3,"16":[1,2],"168":3,"170":3,"172":1,"182":3,"192":3,"1gb":[10,11],"2":[1,3,7,14],"20":[3,5,6,10,11,12],"200":1,"203":3,"22":3,"236":5,"24":[2,3,5,6],"247":5,"25":6,"251":3,"254":6,"29":11,"2a":3,"2cpu":[10,11],"2gb":[10,11],"3":[3,5,7],"30":[6,10,11,12],"31":1,"32":[3,5],"34":3,"4":[3,4,7],"4001":12,"4002":12,"41":3,"443":[10,11,12],"4b":3,"4gb":[10,11],"5":[5,11,12],"50051":[2,3,6,12],"51821":[3,10,11],"51822":5,"51825":11,"51830":10,"518xx":10,"53":[3,10,11,12],"5c":3,"5qktbtgsvb45y3qyrmwft":3,"60":5,"6400":1,"68":3,"6c":3,"7":[3,5,12,14],"70":1,"77":3,"78":3,"7b":3,"8":[2,3,5,12,14],"80":12,"8081":[1,2,3,12],"8082":12,"8c":1,"9":[10,11],"90":1,"91":3,"98":6,"99":6,"abstract":2,"break":3,"case":[1,2,3,5,7,8,10,11,12,14,15],"class":12,"default":[1,2,3,5,6,10,11,12,14],"do":[0,1,2,3,4,5,6,10,11,12,14],"final":14,"function":[1,3,12,13,14],"import":[2,5,6],"long":[0,6,13],"new":[2,3,6,11],"null":11,"public":[2,3,4,5,9,10,11],"return":[2,11],"short":3,"static":[2,10,11,12,14],"switch":[12,13],"true":[2,3,12],"try":[13,14],"var":[1,12],"while":[2,13],A:[2,3,5,6,7,10,11,12,14],And:12,As:[0,2,3,10,13,14],At:[0,2,3,10,11],Be:[10,11,12],Being:4,By:[0,1,5,10,11,12],For:[2,3,5,6,8,10,11,12,14],If:[0,1,2,3,5,6,10,11,12,13,14,15],In:[0,1,2,3,4,6,10,11,12,13,14],Is:14,It:[0,2,3,5,6,11,12,13,14,15],No:13,Not:2,On:[2,3,11,12],Or:[10,11],That:2,The:[0,1,2,3,4,5,6,10,11,12,13],Then:[5,6,14],There:[0,1,3,6,13,14],These:[2,3,6,12],To:[2,3,5,6,10,11,12],Will:3,With:[2,13],_:[],a6:3,aa3bvg0rnitirxdx:1,abil:[13,14],abl:[1,2,5,12],abou:6,about:[2,3,6,10,11,12,13,14],abov:[2,3,6,11,12,13],absent:3,abus:4,accept:[3,4,5],access:[0,2,3,5,6,7,10,11,12,13,14,15],access_token_valu:12,accesskei:[1,3],accomplish:13,account:[4,14],achiev:[1,2,12,13,14],acm:11,across:[0,3],act:[2,4,5],action:[1,3,4],activ:14,actual:2,ad:[2,6,7,12,13],adapt:[4,12],add:[0,1,2,3,5,6,11,12],addit:[2,3,6,11,12,13,14],addition:10,addnetwork:1,addr:[3,12],address:[2,3,4,5,6,12,14],addressipv6:3,addressrang:1,adequ:12,adm:1,admin:[0,1,2,3,6,12,14],administr:3,adopt:2,adv:12,advanc:[1,4,6,7,8,10,11],advfirewal:3,after:[2,3,5,6,13],ag:4,again:[10,11],against:3,agent:[0,2,3,6,7,12,14],agent_backend:12,agentbackend:12,aggreg:2,agre:11,alex:3,algo:13,align:4,all:[0,1,2,3,4,5,6,7,9,10,11,12,13,14],allow:[1,2,3,5,6,10,11,12,14,15],allowedip:[3,5],allowedorigin:12,along:14,alongsid:12,alreadi:[2,3,6,12],also:[0,1,2,6,10,11,12,13,14],altern:[2,12],although:14,alwai:12,am:14,amd64:11,an:[0,2,3,4,6,7,10,11,12,13,14,15],android:[2,14],ani:[0,2,3,4,5,6,10,11,12,14],anoth:[2,13,14],answer:14,anymor:14,anyth:2,anywai:13,anywher:[10,11],aorijqalrik3ajflaqrdajhkr:1,apach:[2,12],api:[2,3,6,10,11,12],api_port:12,apiaddress:3,apihost:12,apiport:12,apiserv:3,app:[5,12,13,14],appear:[4,6],appli:[4,12],applic:[1,12],appoint:4,appropri:[2,4,5,6,11,12],approv:[1,3,6,13],aprov:14,apt:[10,11],ar:[0,1,2,3,4,5,6,9,10,11,12,13,14,15],arbitrari:0,arch:[2,6,11],architectur:12,archiv:11,argument:3,arm:[3,6],around:[10,11],arrai:2,artifact:9,ask:[3,14],asset:12,assum:[2,5,10,11,12,14],attach:5,attack:4,attempt:2,attent:4,attribut:7,auth:12,authent:[2,3,6],author:1,autom:0,automat:[3,5,12],avail:[3,4,7,8,9,13],aw:[0,10,11,13],awai:2,await:2,b5:1,back:[2,5,12],backend:12,backend_url:12,background:2,backup:13,balanc:13,ban:4,bare:2,base64:6,base:[2,3,10,11,12,13],bash:2,basi:[2,13],basic:15,bcrypt:12,bearer:1,becaus:[0,2,14],becom:[2,14],been:[2,3,10,11,12],befor:[2,10,11,14],begin:[2,10,11],behavior:4,behind:[2,5,10,11,14],being:[2,12],believ:13,bellow:12,below:[1,2,5,6,11,12,15],besid:2,best:[4,13],better:2,between:[0,2],bewar:3,beyond:[12,13],bin:[11,12],bin_t:14,binari:[2,3,6,8,12,13,14],bind:[10,11,12],bit:15,biz:[10,11],blank:[3,5],blob:12,block:[12,14],bodi:4,both:[2,4,10,12,13],bottom:6,bound:[10,11],brows:13,build:2,built:2,bunch:13,busi:[10,11,13,14],button:14,c:[10,11,12],ca:11,caddi:[11,12],caddyfil:10,call:[0,2,3,7,12],callabl:3,can:[0,1,2,3,5,6,9,11,12,13,14,15],cang:12,cannot:[3,5,10,11],cap_add:12,car:13,cat:14,caus:[2,10,11],cd:2,ce:11,center:0,cento:2,certain:2,certbot:11,certif:[11,12],certonli:11,cgroup:12,challeng:11,chang:[0,1,2,3,5,6,12,14],charact:14,chcon:14,check:[1,2,3,6,10,11,12,14],checkin:[1,2,3],chmod:11,choic:[5,12],choos:[3,7,8,11],chose:13,chosen:[2,3,11],cidr:6,circumst:[3,4],clarifi:4,clear:13,cli:[2,11],click:[2,6,11,14],client:[0,6,10,11,12,13,14],client_max_body_s:12,client_mod:12,clientmod:12,clone:2,close:13,cloud:[0,10,11,15],cluster:[12,15],cluster_mgmt:12,code:[2,3,5,9,14],com:[3,4,6,10,11,12,13,14],combin:12,come:[2,7,12],comfort:[10,11],comm:3,command:[2,3,6,10,11,12],comment:[4,12],commit:4,common:[2,7,10,11],commonli:14,commun:[2,3,4,7,11,12,13,14,15],compat:[5,7,13],compil:[2,3],complaint:4,complet:[2,14],complex:2,complic:2,compon:[7,12],compos:[6,7,11,14],comput:[0,2,3],concept:7,concern:13,concurr:[10,11],conf:[5,11,12],confidenti:4,config:[1,2,5],configur:[0,1,2,6,7,10,11,14],conflict:12,connect:[0,2,3,5,6,12,14,15],consensu:[2,14],consequ:12,consid:[4,6],consider:2,consist:[2,12],consol:6,construct:4,consult:[12,14],consum:[3,11,12],contact:[4,7,10,11,12],contain:[2,6,11,12],container_nam:12,containerd:11,content:1,context:12,continu:[12,14],contrast:2,contribut:4,contributor:4,control:[2,6,12],copi:[6,12],core:[0,7,13],coredn:[3,7,10,11],coredns_addr:12,coredns_ip:[10,11],corednsaddr:3,corefil:12,coreo:2,corpor:[12,13,14],correct:[4,10],correctli:[2,12],cors_allowed_origin:12,could:[0,4,6,14],cours:11,coven:4,cover:7,cp:[11,12],cpu:[10,11,14],creat:[0,1,2,3,4,5,7,10,11,12,14,15],createadmin:1,creategatewai:1,creation:0,credenti:12,credit:14,critic:4,cron:2,cross:15,cryptocurr:0,cs:11,curl:[6,11,12],current:[2,3,12,14],custom:[2,7,10,11,12],customiz:12,cycl:[1,2],d9:1,d:[1,2,10,11,12],daemon:2,dashboard:[10,11],data:[0,2,12,14],databas:[2,12,14],databaseand:2,datastor:12,date:1,db:[2,7,12],dbu:12,dc:[10,11],ddflzqn:5,dearmor:11,deb:11,debian:2,debug:12,decis:7,decod:[2,3,6],deem:4,defin:4,delet:[1,5,6,14],deletegatewai:1,deni:14,depend:[2,3,7],depends_on:12,deploi:[2,7,10,11,12],deploy:[2,12],depreci:12,derogatori:4,deserv:13,design:[2,3,5,7,13,14],desktop:[2,3,5],detail:[1,2,3,4,6,7,12],determin:[4,13],dev:[10,11,12],develop:[6,10,11,12],devic:[0,2,3,7,13,14],diagram:2,differ:[0,2,4,6,12,13,15],digitalocean:[10,11],dir:3,directli:[0,1,2,5,10,11,12,14],directori:[11,12],disabl:[2,4],disable_remote_ip_check:12,disableremoteipcheck:12,disconnect:14,discord:[13,14],displai:2,displaynam:1,distibut:2,distribut:[2,6,12],distributionshav:2,dn:[2,7,11,14,15],dns_mode:[12,14],dnsconfig:12,dnsmode:12,dnson:3,dnsstublisten:12,doc:[6,10,11,12,13],docker:[2,6,7,8,14],document:[0,2,3,6,12],doe:[2,5,7,12,14],doesn:14,domain:[10,12,14],don:[2,3,13,15],done:14,dont:14,down:[0,6,12,13,14],download:[3,5,6,11,12,14],dual:[3,14,15],due:14,duplic:3,dure:3,dynam:[0,2,7],e:[2,3,4,6,10,11,12,14],each:[0,2,3,6,12,14],easi:[2,12],easier:[2,13],easiest:2,easili:[0,12],echo:[10,11],econom:13,edit:[4,5,14],effect:6,effici:2,egress:[3,5],either:[2,5,13],ejf6yy51m:5,electron:4,elev:12,elimin:2,els:13,email:[10,11,13],empathi:4,empti:12,enabl:[2,6,10,11,12],encod:6,encompass:0,encount:[2,13],encrypt:[0,2,3,14],end:[2,10,11,12,13,14],endpoint:[1,2,3,5],enforc:7,engin:11,enough:12,ensur:[12,13],enter:[6,11],enterpris:[10,11,12],entir:6,entireti:2,entri:[12,14],env:[1,12],environ:[0,1,2,4,12,14],equal:12,equival:12,establish:5,etc:[3,6,10,11,12,14],eth0:1,ethnic:4,evalu:13,even:[0,2],event:4,eventu:13,everi:[2,3,6,13],everyon:4,everyth:[2,12],evolv:2,ex:[3,6,10,12],exampl:[2,3,4,5,7,10,11,12],except:12,execut:13,exist:[0,2,6,12],expand:13,expect:[4,7,12],experi:[4,8],explain:[2,7],explicit:4,explicitli:12,expos:2,express:4,expressvpn:13,ext:[7,14],extend:12,extens:2,extern:[3,12,13],f1:1,f8:3,f:[3,11,12,14],face:4,fact:0,fail:[2,6,11],fair:4,fairli:[2,14],faith:4,fals:[3,12],familiar:[0,2,13,14],faq:7,fast:[2,7,12],faster:[0,2,3],fcontext:14,featur:[10,11,12,13],fedora:2,few:[3,13],field:5,figur:15,file:[2,5,11,13],filenam:1,financi:13,find:[2,12,15],fine:0,firewal:[3,7,12,14],firmli:13,first:[2,3,6,12,13,14,15],fit:[10,11,15],flag:3,flat:0,flexibl:0,flow:2,focu:13,focus:4,folder:2,follow:[2,3,4,6,10,11,12,13,14],forc:12,form:3,format:12,forum:14,forward:[3,5,11],foster:4,found:[0,2,9,12],free:4,freeli:9,frequent:14,friend:14,from:[0,1,2,3,4,5,6,8,10,11,12,13,14,15],front:[2,12],fs:12,fssl:11,full:[0,2,12],fulli:[0,2],further:4,futur:[6,10,11,13],g:[3,6,10,11,12],gatewai:[1,2,3,7,14,15],gb:14,gcp:[10,11],gender:4,gener:[1,2,3,5,8,10,11,12,13],generate_config_j:12,get:[1,3,7,10,11,12,14,15],gg:13,github:[2,3,7,10,11,12,13,14],githubusercont:[6,10,11,12],give:[2,6,7,12,14],given:[0,2,6,14],global:3,gnupg:11,go:[2,3,7,12,14],goe:[0,12],golang:2,good:[4,5,13,14,15],googl:12,gpg:11,grab:3,gracefulli:4,grade:12,gravitl:[3,4,6,10,11,12,13,14],group:[10,11],grpc:[2,3,6,10,11],grpc_port:12,grpc_ssl:12,grpcaddress:3,grpchost:12,grpcport:12,grpcserver:3,guid:[0,2,6,8,10,11,12,14],guidelin:[12,13],h:[1,3],ha:[0,2,3,6,10,11,12,13,15],hand:7,handl:[0,2,10,11,12],handshak:14,harass:4,hard:[13,14],harder:14,harm:4,hasadmin:1,hash:12,have:[0,2,3,4,5,6,10,11,12,13,14,15],haven:14,head:[10,11],header:[1,2,12],health:13,heart:3,heavi:2,help:[1,2,3,6,7,12,13,15],here:[2,4,6,9,10,11,12,13,15],high:[2,14],highli:[3,7,8],hit:14,hold:[0,2,3],holder:14,hole:[3,14],holepunch:3,home:[0,2,3],hook:[2,5],host:[2,3,10,11,12,13],host_ip:12,hous:1,how:[2,3,7,12,14],howev:[1,2,3,10,11,12,13,14],html:12,http:[1,3,6,7,10,11,13,14],http_port:12,hub:[0,2],hundr:[10,11],i:[3,10,11,12,14],id:[1,3,12],idea:13,ident:4,identifi:3,ignor:3,imag:12,imageri:4,impact:[2,13],implement:2,importantli:6,inappropri:4,inbound:[3,10,11],incid:4,includ:[2,4,5,7,12],inclus:4,incorrect:[3,12,14],increas:2,independ:5,individu:[4,12],industri:2,info:[2,4,10,11,12,13],inform:[2,3,4,6,10,11],ingress:[2,3,7,12,14],initi:[3,13],ins:2,insert:[10,11,12,14],insid:12,instal:[0,2,5,6],instanc:[1,2,3,4,6,10,11,12],instead:[0,3,5,10,11,12,14],instruct:[11,12],insult:4,intact:3,integr:12,intend:3,interact:[0,2,3],interest:[4,13,14],interfac:[1,3,5,6,10,11,12],interfer:[10,11,14],intern:12,internet:[0,2,13],intro:15,introduc:14,introduct:7,invalid:[5,6],investig:4,invis:2,io:[10,11,14],iot:[0,2],ip:[2,3,5,6,10,11,12],ipforward:3,iphon:2,ipsec:2,iptabl:3,ipv4:[3,14],ipv6:[3,14,15],isdualstack:3,isingressgatewai:3,isloc:3,isstat:3,issu:[2,4,7,10,11,12,13],iter:13,its:[0,2,3,4,5,6,12],itself:[2,3,6,12],job:2,join:[2,3,6,12,14],journalctl:[3,12,14],jq:1,js:12,json:[1,12],just:[0,2,3,5,10,12,13,14],jwt:[1,3],k3:15,k:[3,6],keep:1,keepal:3,kei:[2,3,10,11,12,14],kernel:[0,2,13],keynam:1,keyr:11,keyupd:1,kill:14,know:[12,13,14,15],known:[2,10,11],kube:12,kubectl:12,kubernet:[0,7,8,15],l:11,lan:3,languag:4,laptop1:1,laptop:5,larg:2,last:1,lastmodifi:1,latenc:2,later:2,latest:[2,3,5,12],launch:2,launchd:[2,3],launchdaemon:2,layer:0,layout:2,lb:12,lead:13,leadership:4,least:[0,11,14],leav:[3,5,6,14],left:[12,14],less:[2,6],let:[0,13,15],letsencrypt:11,level:[2,4,12],librari:2,light:12,lightweight:2,like:[0,2,3,6,11,12],limit:[7,12,13],line:2,link:[7,10,11,12],linod:[10,11],linux:[2,3,6,7,11,13],linuxserv:12,list:[0,2,3,11,12],listen:12,listenport:1,littl:[2,13],ln:12,load:[2,13],local:[2,3,6,11,12],localaddress:[1,3],localhost:1,localrang:3,locat:[0,2,3,12],log:[10,11,12,14],logic:5,login:6,look:13,lookup:2,lot:[2,13],lower:14,lsb:11,lsb_releas:11,lxc:12,m:[3,5,11,14],mac:[2,3,6],macaddress:[1,3],machin:[0,2,3,5,6,10,11,14],made:[0,2,14],mai:[1,2,3,4,6,10,11,12,13,14],mail:4,main:12,maintain:[4,12,13],make:[0,2,4,5,8,10,11,12,13,14],man:5,manag:[0,2,5,7,12,15],mani:[0,2,10,12,13,15],manual:[2,3,6,11,12,14],map:12,master:[10,11,12],master_kei:12,masterkei:[1,12],match:[3,12],md:[1,12],mean:[2,3,5,12],meant:12,media:4,medium:8,meet:12,member:[4,15],memori:14,mesh:[0,5,13,14,15],meshclient:1,metal:2,method:[1,2,3,5,6,7,8],mgmt:1,microk8:[12,15],middl:5,might:[0,2,12],min:[10,11],minimum:14,mint:2,minu:12,minut:[10,11,12,14],miss:2,mix:3,mode:[2,7],model:[0,2],modif:12,modifi:[1,2,3,6,10,11,12,13],monet:13,mongo:12,mongodb:12,more:[0,1,2,5,6,7,10,11,12,13],most:[1,2,3,8,10,11,12,14],mostli:[2,3],mount:12,move:[6,10,11,13],mtu:14,much:[0,2],mullvad:13,mullvadvpn:13,multipl:[0,6,12,14],must:[1,2,3,5,6,11,12,13,14],my:[1,3,14],mykei:[1,6],mynet:6,myserv:6,mysit:[10,11],n:[2,3,6,10,12,14],name:[1,2,3,5,6,12,14],nameserv:[2,3,12],namespac:12,nat:[5,14],nation:4,nativ:2,navig:[10,11,14],nebula:0,necessari:[2,3,4,12],need:[0,1,2,3,10,11,12,13,14],neighborhood:0,neither:2,net:[3,11],net_admin:12,netclient:[0,5,7],netclient_accesskei:3,netclient_accesstoken:3,netclient_address:3,netclient_addressipv6:3,netclient_api_serv:3,netclient_daemon:3,netclient_dn:3,netclient_endpoint:3,netclient_grpc_serv:3,netclient_interfac:3,netclient_ipforward:3,netclient_is_dualstack:3,netclient_is_loc:3,netclient_keepal:3,netclient_localaddress:3,netclient_localrang:3,netclient_macaddress:3,netclient_nam:3,netclient_network:3,netclient_o:3,netclient_password:3,netclient_port:3,netclient_postdown:3,netclient_postup:3,netclient_privatekei:3,netclient_publickei:3,netclient_roam:3,netclient_udp_holepunch:3,netconfig:[3,14],netid:1,netmak:[1,3,5,9,14],netmaker_base_domain:[10,11,12],netmaker_env:12,netsh:3,network:[0,5,6,7,10,11,12,13,14,15],network_mod:12,next:[3,6],nextcloud:15,nginx:[2,14],nip:10,nm:[3,12],node:[3,5,7,12,14],nodn:12,non:[2,3,6,8,12],none:0,noonewillguessthi:1,nordvpn:13,normal:12,note:[1,5,7,10,11,12,14],notifi:2,now:[0,5,6,10,11,12,13,14],ns:12,nslookup:11,number:[2,6,10,13],o:[10,11,12],oblig:4,obtain:[1,3],od:3,off:[2,3,12,14],offens:4,offer:[],offic:[0,15],offici:[1,4,11,14],offlin:4,often:2,ok:11,old:11,older:7,omit:12,onc:[5,6,12],one:[2,3,5,6,10,11,12,14],onli:[1,2,3,5,6,13,14],onlin:4,open:[2,4,7,11,13],openvpn:2,oper:[2,3,12],operatingsystem:3,opinion:10,oppos:2,option:[2,3,7,12,13],oracl:[10,11],order:[12,13,14],org:[11,12],orient:4,origin:12,os:3,osi:13,other:[0,2,3,4,5,6,13],otherwis:[0,3,4,14],our:[7,12,14],out:[0,2,6,10,11,12,13,14,15],outlin:[2,12],output:[3,6],outsid:[7,12],over:[0,2,12],overlai:[0,7],overlap:6,overrid:[3,12],overridden:[2,12],overview:[2,7,15],overwhelm:15,own:[2,10,11,12],p:[3,6,10,12],page:2,pai:13,paid:13,pair:[2,12],pane:6,part:[2,3,12],parti:14,partial:2,particip:4,particular:[2,3],pass:[2,3,12],password:[1,3,6,12],path:[1,12,13],peer:[2,3,5,14,15],pend:[1,6],peopl:13,per:[10,11,13],perform:[1,2,3,11,12],period:2,perm:12,perman:4,permiss:[4,10,11,14],permit:6,persistentkeepal:[3,5],person:4,perspect:[0,2],phone:[3,5],physic:4,pick:[2,6],pictur:2,ping:[6,14],pivpn:13,place:[3,10,11,12],plaintext:3,plan:[10,11,12,14],platform:[2,7],pleas:[3,10,11,12,13,14],pledg:7,plu:[3,10],poc:[8,10],point:[2,10,11],polici:4,polit:4,popul:12,port:[2,3,6,10,11,12,14],posit:4,possibl:[2,7,10],post:[1,2,3,4],postchang:3,postdown:3,postup:3,powershel:3,practic:2,pre:12,preced:2,precend:12,prefer:[10,11,12,14],prepar:7,prereqisit:6,prerequisit:[2,6,7,12],prescrib:[],prevent:3,previou:2,primari:12,prior:12,privaci:13,privat:[2,4,6,7,12,13,15],privatekei:[3,5],privileg:12,privkei:3,probabl:[0,13],problem:13,procedur:12,process:[3,6,7,12],product:[10,12],profession:4,project:[1,4,12,13],prompt:11,proof:0,properli:[3,14],properti:3,proto:[10,11],protocol:[3,12],provid:[0,2,3,10,11,12],proxi:[7,10,11],proxy_pass:12,proxy_pass_request_head:12,proxy_set_head:12,pubkei:3,publickei:[1,3,5],publicli:[10,11],publish:[4,9],pull:[2,3,5,12],punch:[3,14],purchas:14,push:[3,5],put:1,python3:11,q9cog7c9qjnoxygvri:3,qr:[5,14],quarantin:3,question:14,quick:[6,8,11,12,14],quickli:[7,10,14],quickstart:14,r:14,race:[4,13],raft:[2,12,14],ram:[10,11],rang:[3,5,6,10,11,12],rangestr:1,raspian:2,raw:[3,6,10,11,12],re:[0,3,6,13,14],reach:[0,2,3,5,12,14],reachabl:[2,3,5,12],reactj:2,read:12,readm:10,reallysecret:1,reason:[2,4,12,13],reboot:14,recent:[2,3,14],reciev:[1,2],recommend:[1,3,5,8,10,11,12,14],reconfigur:[2,3,14],record:[10,11,14],redund:12,refer:[2,6,11,14],regard:[2,4],regardless:4,regist:[2,3],registr:3,regular:13,reject:4,rel:2,relai:[2,3,5,13,14],releas:[2,3,11,12],reli:[0,3],religion:4,reload:11,remot:[0,3,12],remoteip:3,remov:[1,2,4,6,11,12,14],removenetwork:1,repeat:6,repercuss:4,replac:[3,11,12],replace_master_kei:[10,11],repo:2,report:[2,4],repositori:[2,9],repres:4,represent:4,request:[1,2,12],requir:[1,2,3,6,11,12,14],resolv:[2,3,12],resolvectl:[3,12],resourc:[5,7,8],respect:[2,4],respons:[2,7],rest:[10,12],rest_backend:12,restart:[11,12,14],restbackend:12,restorecon:14,restrict:[12,13],result:4,retriev:[0,1,2,3,6,13],revers:[7,10,11],revert:3,review:4,rf:6,rhel:2,right:[0,4,7,13],risk:14,rkxlgk2mg:5,rm:6,rncjjbsaa3hzuhrk5hpyxm:3,road:13,roam:3,rogu:14,root:[10,11,12,14],rout:[0,2,10,12],route53:[10,11],router:[2,14],rpumvsbpgq:5,rqlite:14,rule:[3,10,11],run:[0,1,2,3,5,6,7,10,11,12,13,14],runc:11,runtim:12,rv:14,rwx:12,s:[0,2,3,4,5,6,7,9,10,11,12,13,14],said:[2,13],same:[0,3,5,6,11,12,14],sampl:0,save:[6,10,11],scan:5,scenario:6,schedul:12,scope:7,screen:6,script:[2,3,6,10,12,14],second:6,secret:[1,3,6],secretkei:12,section:[3,12],secur:[0,1,2,3,7,10,11,14,15],sed:[10,11,12],see:[1,2,3,6,10,11,12,14],select:[5,6,14,15],self:13,selinux:14,semanag:14,send:[2,3,12],sens:[2,8,13],sensibl:[0,2,6],separ:[2,4,15],seper:14,seri:11,serv:[2,11,12],server:[0,3,5,6,9,10,11,13],server_api_conn_str:12,server_api_host:12,server_grpc_conn_str:12,server_grpc_host:12,server_host:12,server_http_host:12,server_nam:12,server_public_ip:[10,11],servic:[2,3,5,10,11,12,13,15],set:[1,2,3,4,6,10,11,12,14,15],setup:[0,2,7,10,11],sever:[2,12],sexual:4,sf:12,sfl:[6,12],sh:[6,12],share:[11,12,14],should:[0,1,2,3,5,6,7,10,11,12,13,14],show:[3,4,12,14],shown:5,side:9,sign:[2,3,6,11,14],signific:2,signigif:2,signup:[2,3,14],similar:[0,6,12,13],simpl:[2,3,6,12,14],simplest:[2,3],simpli:[2,3,5,6,11,12,14],simplifi:12,simultan:0,singl:[1,2,11,14],site:[0,2,7,12,14,15],situat:[2,14],size:4,skynet:1,slow:0,small:[2,6,8,13],smartgui:1,snap:11,so:[0,2,3,5,6,10,11,12,13,14],social:4,solut:2,solv:2,some:[1,2,3,12,13,14,15],someon:13,someth:[5,6,11,12,13],somewher:6,soon:[7,14],sort:0,sourc:[2,3,7,9,11,13],space:4,spec:14,special:[2,3,12],specif:[2,3,4,6,12],specifi:[3,12],speed:[0,2],split:3,spoke:[0,2],spread:0,sql:[2,12],sql_conn:12,sqlconn:12,sqldata:12,sqlit:2,sqlite:[12,14],src:10,ssh:[6,10,11],ssl:[11,12],sspl:9,stabl:11,stack:[3,14,15],stai:3,stake:0,standard:[2,7,12],start:[12,14,15],startup:1,state:6,statement:7,statu:[3,12,14],step:[2,3,6,12],still:[0,12,13],stock:13,stop:12,storag:[10,11,12],storageclassnam:12,store:[2,12],string:[6,12],stuck:14,stun:14,su:6,subdomain:[10,11,12],submit:6,subnet:2,subscript:[10,11,14],subsequ:2,subspac:13,subspacecloud:13,substanti:0,success:2,sudo:[3,6,10,11,12,14],support:[2,10,11,12,14],sure:[10,11,13,14],surfshark:13,suse:2,swag:12,swagger:7,sy:12,sys_modul:12,system:[6,7,10],system_bus_socket:12,system_u:14,systemctl:[3,11,12,14],systemd:[3,6,12,13,14],t:[2,3,6,11,13,14,15],tab:[6,14],tail:3,tailscal:0,take:[0,1,2,4,6,12,14],talk:[0,2],tcp:[10,11],team:[4,13],technic:[0,7,13],technolog:2,tee:11,tell:[0,2,3,12,14],templat:12,temporari:4,temporarili:4,term:13,terrain:13,test:[6,8],than:[2,6,12,13],thei:[0,2,4,12,13,14],them:[2,6,12,13,14],themselv:[2,14],therefor:14,thi:[0,1,2,3,4,5,6,7,9,10,11,12,13,14],thing:[0,2,13],think:[13,15],third:14,thmpvlcykonxi:3,those:[0,2,3,5,11],thought:13,thousand:0,threaten:4,three:[6,11],through:[2,12],ticket:13,time:[1,2,3,5,6,12,14,15],timer:2,timestamp:2,token:[3,6,12,14],too:14,tool:[0,3,11],top:[2,11,14],topic:15,topolog:2,tos:11,toward:4,tr:[10,11],traefik:12,traffic:[0,2,5,11,12,14],trailofbit:13,transact:2,transport:11,treat:[2,3],trial:[8,10],tricki:2,troll:4,troubleshooot:[10,11],troubleshoot:[1,3,6,10,11],tunnel:[0,2],tunnelbear:13,turn:[2,3,12,14],tutori:7,two:[0,1,2,14],txt:11,type:[1,12],typic:[0,2,5,6,12,14],u:[3,12,14],ua2zjt8wn7ga:5,ubuntu:[2,10,11,12],udp:[3,10,11,12,14],udpholepunch:3,ufw:[10,11],ui:[1,3,5,7,11],ultim:13,unaccept:4,unam:11,uncom:12,uncordon:1,under:[3,6,9,12,14],underlai:[0,15],underscores_in_head:12,uninstal:[7,14],uniqu:[3,10,11],unix:[2,3,13],unless:[3,12],unmanag:2,unnecessari:3,unregist:3,unregistr:3,unset:[3,12],unsupport:13,unsur:[5,6],unten:13,until:[3,6,14],unwelcom:4,unzip:12,up:[0,2,3,6,7,10,11,12,13,14,15],updat:[1,2,6,10,11,13,14],upgrad:[2,14],upon:[2,3],upstream_app:12,upstream_port:12,upstream_proto:12,urandom:[10,11],url:12,us:[1,2,3,4,5,6,7,8,10,11,12,13,14],usag:[3,7,12,15],user:[2,3,6,8,14],usernam:[1,6,12],usr:[11,12],usual:3,util:3,v02:11,v0:[2,12,14],v:14,valid:[2,12],valu:[1,2,3,6,10,12,14],variabl:[2,3,14],variou:[3,7,12],ve:14,vehicl:13,verbos:12,veri:[0,2,3,13],verifi:2,versa:13,version:[2,4,9,10,11,12,14],via:[1,2,3,4,5,6,10,11,12,13,14,15],vice:13,view:[6,13,14],viewpoint:4,vim:[3,12],virtual:[0,3,5,7,10,11,13,15],visibl:[6,12],vm3ow4thatogiwnsla3thsl3894th:6,vm:[0,2,10,12],vne197vmradjodkb1zsuja:3,volum:[6,12,14],vp:11,vpc:[0,13],vpn:[2,14,15],wa:[2,12],wai:[12,13,14],wait:11,want:[0,2,3,5,10,11,12,13,14],warn:12,we:[0,1,2,4,8,10,11,12,13,14],web:[12,13],webserv:2,websit:2,weight:12,welcom:[4,13],well:[2,3,6,7,12,13,14],were:14,wg:[3,12,14],wgaddress6:3,wgaddress:3,wget:[10,11,12],what:[2,4,5,7,14],whatev:[3,12],when:[2,3,4,12,14],where:[2,5,6,7,12,15],wherev:0,whether:[0,3],which:[0,2,3,4,5,6,9,10,11,12,13,14],who:4,why:[2,3,7,14],wide:[2,12],wider:2,wiki:4,wildcard:[10,11,12],window:[2,6,7],wipe:14,wireguard:[0,3,5,6,7,10,11,12,13,14],wish:[3,5,12],within:[2,3,4],without:[1,2,3,4,6,7,13,14],won:13,work:[2,7,11,12,13],workstat:[3,6],world:[0,2],wors:2,would:[0,3,5,6,11,12,13],write:[2,12],ws2:3,www:12,x86:3,x:[1,2,6,10,11],y:[10,11],yaml:[1,12],ydazgedrpuxmmrqul35wfjmhvrzr1rq0u:5,ye:[3,14],yet:14,yml:[10,11,12,14],you:[0,1,2,3,5,6,7,8,10,11,12,14,15],your:[0,1,2,3,5,6,10,11,12,13,14,15],your_db_password:12,your_email:10,your_pass:1,your_password:1,your_secret_kei:1,yourwildcard:12,z0:[10,11],za:[10,11],zeroti:0,zip:12,zrb9vfhk8a:13},titles:["About","API Reference","Architecture","Client Installation","Code of Conduct","External Clients","Getting Started","Welcome to the Netmaker Documentation","Install","License","Quick Install","Install with Nginx (depreciated)","Advanced Server Installation","Support","Troubleshooting","Using Netmaker"],titleterms:{"0":[10,11],"1":[10,11,12],"2":[10,11,12],"3":[10,11,12],"4":[10,11,12],"case":0,"do":13,Is:13,No:12,Will:13,about:[0,7],access:1,ad:[3,5],advanc:12,an:5,ani:13,annot:12,api:[1,7],architectur:[2,7],attribut:4,authent:1,avail:12,balanc:12,caddi:10,call:1,cli:3,client:[2,3,5,7],code:[4,7],common:14,compat:[2,3,12],compon:2,compos:[10,12],concept:2,conduct:[4,7],config:[3,12],configur:[3,5,12],consider:12,contact:13,core:2,coredn:[2,12,14],creat:6,curl:1,daemon:3,daemonset:12,depend:[10,11],deploi:6,depreci:[7,11],descript:12,disabl:12,dn:[3,5,10,12],docker:[10,11,12],document:[1,7],doe:[0,13],domain:11,enforc:4,enterpris:13,exampl:1,ext:5,extern:[2,5,7,15],faq:13,file:[1,3,12],firewal:[10,11],format:1,gatewai:5,get:6,grpc:12,guid:7,highli:12,how:[0,13],http:12,i:13,ingress:5,instal:[3,7,8,10,11,12,13],introduct:[3,5,10,11],issu:14,kei:[1,6],kubernet:12,licens:[7,9,13],like:13,limit:2,linux:12,load:12,log:3,make:3,manag:[1,3,6],mesh:2,mode:[3,12],netclient:[2,3,6,12,13,14],netmak:[0,2,6,7,10,11,12,13,15],network:[1,2,3],nginx:[7,11,12],node:[1,2,6],nordnpn:13,note:3,offer:13,open:10,oper:13,option:5,other:12,our:4,pledg:4,prepar:[10,11],prerequisit:[3,10,11],privat:3,process:2,proxi:12,quick:[7,10],refer:[1,3,7,12],remov:3,respons:4,revers:12,rqlite:[2,12],scope:4,secur:12,server:[1,2,7,12,14],setup:[6,12],sqlite:2,sspl:13,standard:4,start:[6,7,10,11],support:[7,13],system:[2,3,12,13],systemd:2,technic:2,templat:11,test:12,troubleshoot:[7,14],tutori:15,ui:[2,12,14],uninstal:[3,6],updat:3,us:[0,15],usag:1,user:1,variabl:12,video:15,view:3,vm:11,vpn:13,welcom:7,what:0,why:13,window:3,wireguard:2,without:12,work:0,written:15,x:13,you:13}})
\ No newline at end of file
diff --git a/docs/_build/html/server-installation.html b/docs/_build/html/server-installation.html
index 057af77d..f0862755 100644
--- a/docs/_build/html/server-installation.html
+++ b/docs/_build/html/server-installation.html
@@ -466,6 +466,18 @@
Most systems support Docker, but some do not. In such environments, there are many options for installing Netmaker. Netmaker is available as a binary file, and there is a zip file of the Netmaker UI static HTML on GitHub. Beyond the UI and Server, you need to install MongoDB and CoreDNS (optional).
To start, we recommend following the Nginx instructions in the Quick Install guide to enable SSL for your environment.
Once this is enabled and configured for a domain, you can continue with the below. The recommended server runs Ubuntu 20.04.
This template assumes your cluster uses Nginx for ingress with valid wildcard certificates. If using an ingress controller other than Nginx (ex: Traefik), you will need to manually modify the Ingress entries in this template to match your environment.
For an enterprise Netmaker installation, you will need a server that is highly available, to ensure redundant WireGuard routing when any server goes down. To do this, you will need:
+
+
A load balancer
+
3+ Netmaker server instances
+
rqlite as the backing database
+
+
These documents outline general HA installation guidelines. Netmaker is highly customizable to meet a wide range of enterprise environments. If you would like support with an enterprise-grade Netmaker installation, you can schedule a consultation here .
+
The main consideration here is how to configure rqlite. Most other settings and procedures match the standardized way of making applications HA: Load balancing to multiple instances, and sharing a DB. In our case, the DB (rqlite) is distributed, making HA data more easily achievable.
Your load balancer of choice will send requests to the Netmaker servers. Setup is similar to the various guides we have created for Nginx, Caddy, and Traefik. SSL certificates must also be configured and handled by the LB.
RQLite is the included distributed datastore for an HA Netmaker installation. If you have a different corporate database you wish to integrate, Netmaker is easily extended to other DB’s. If this is a requirement, please contact us.
+
Assuming you use Rqlite, you must run it on each Netmaker server VM, or alongside that VM as a container. Setup a config.json for database credentials (password supports BCRYPT HASHING) and mount in working directory of rqlite and specify with -auth config.json :
Once your servers are set up with rqlite, the first instance must be started normally, and then additional nodes must be added with the “join” command. For instance, here is the first server node:
Netmaker will be started on each node with default settings, except with DATABASE=rqlite and SQL_CONN set appropriately to reach the local rqlite instance. Rqlite will maintain consistency with each Netmaker backend.
This is enough to get a functioning HA installation of Netmaker. However, you may also want to make the Netmaker UI or the CoreDNS server HA as well. The Netmaker UI can simply be added to the same servers and load balanced appropriately. For some load balancers, you may be able to do this with CoreDNS as well.
+
+
+
diff --git a/docs/conf.py b/docs/conf.py
index 4e2fcefc..030c502d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -22,7 +22,7 @@ copyright = '2021, Alex Feiszli'
author = 'Alex Feiszli'
# The full version, including alpha/beta/rc tags
-release = '0.8.2'
+release = '0.8.3'
# -- General configuration ---------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index abd913e0..edd73cef 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -48,6 +48,16 @@ A technical overview of Netmaker, including design decisions and limitations.
architecture
+Install
+------------------------------------
+
+Choose the right install method for you.
+
+.. toctree::
+ :maxdepth: 1
+
+ install
+
Quick Start
---------------
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 00000000..ea7d3d4f
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,20 @@
+=========
+Install
+=========
+
+Choose the install method that makes sense for you.
+
+**For most users, we recommend the** :doc:`Quick Install<./quick-start>` **guide.**
+
+`Trial, PoC, Testing, and Experimenting `_
+
+:doc:`Quick Install: for general small-to-medium use cases <./quick-start>`
+
+:ref:`Kubernetes Installation `
+
+:ref:`Non-Docker (from binary) Install `
+
+:ref:`Highly Available Installation `
+
+:doc:`Advanced Install Resources <./server-installation>`
+
diff --git a/docs/quick-start.rst b/docs/quick-start.rst
index 61232d67..e229706d 100644
--- a/docs/quick-start.rst
+++ b/docs/quick-start.rst
@@ -62,7 +62,7 @@ Caddy will create 3 subdomains with this wildcard, EX:
ssh root@your-host
sudo apt-get update
- sudo apt-get -y docker docker-compose wireguard
+ sudo apt-get install -y docker.io docker-compose wireguard
At this point you should have all the system dependencies you need.
diff --git a/docs/server-installation.rst b/docs/server-installation.rst
index d4a15f8b..539a0657 100644
--- a/docs/server-installation.rst
+++ b/docs/server-installation.rst
@@ -187,6 +187,8 @@ To run without DNS, follow the :doc:`Quick Install <./quick-start>` guide, omitt
This template is equivalent but omits CoreDNS.
+.. _NoDocker:
+
Linux Install without Docker
=============================
@@ -234,6 +236,8 @@ The following uses Nginx as an http server. You may alternatively use Apache or
CoreDNS Setup
----------------
+.. _KubeInstall:
+
Kubernetes Install
=======================
@@ -276,7 +280,7 @@ The following instructions assume you have Netmaker running and a network you wo
For a more detailed guide on integrating Netmaker with MicroK8s, `check out this guide `_.
Nginx Reverse Proxy Setup with https
-====================================
+======================================
The `Swag Proxy `_ makes it easy to generate a valid ssl certificate for the config bellow. Here is the `documentation `_ for the installation.
@@ -337,3 +341,72 @@ The following file configures Netmaker as a subdomain. This config is an adaptio
proxy_pass_request_headers on;
}
}
+
+.. _HAInstall:
+
+Highly Available Installation
+===============================
+
+For an enterprise Netmaker installation, you will need a server that is highly available, to ensure redundant WireGuard routing when any server goes down. To do this, you will need:
+
+1. A load balancer
+2. 3+ Netmaker server instances
+3. rqlite as the backing database
+
+These documents outline general HA installation guidelines. Netmaker is highly customizable to meet a wide range of enterprise environments. If you would like support with an enterprise-grade Netmaker installation, you can `schedule a consultation here `_ .
+
+The main consideration here is how to configure rqlite. Most other settings and procedures match the standardized way of making applications HA: Load balancing to multiple instances, and sharing a DB. In our case, the DB (rqlite) is distributed, making HA data more easily achievable.
+
+1. Load Balancer Setup
+------------------------
+
+Your load balancer of choice will send requests to the Netmaker servers. Setup is similar to the various guides we have created for Nginx, Caddy, and Traefik. SSL certificates must also be configured and handled by the LB.
+
+2. RQLite Setup
+------------------
+
+RQLite is the included distributed datastore for an HA Netmaker installation. If you have a different corporate database you wish to integrate, Netmaker is easily extended to other DB's. If this is a requirement, please contact us.
+
+Assuming you use Rqlite, you must run it on each Netmaker server VM, or alongside that VM as a container. Setup a config.json for database credentials (password supports BCRYPT HASHING) and mount in working directory of rqlite and specify with `-auth config.json` :
+
+.. code-block::
+
+ [{
+ "username": "netmaker",
+ "password": "",
+ "perms": ["all"]
+ }]
+
+
+Once your servers are set up with rqlite, the first instance must be started normally, and then additional nodes must be added with the "join" command. For instance, here is the first server node:
+
+.. code-block::
+
+ sudo docker run -d -p 4001:4001 -p 4002:4002 rqlite/rqlite -node-id 1 -http-addr 0.0.0.0:4001 -raft-addr 0.0.0.0:4002 -http-adv-addr 1.2.3.4:4001 -raft-adv-addr 1.2.3.4:4002 -auth config.json
+
+And here is a joining node:
+
+.. code-block::
+
+ sudo docker run -d -p 4001:4001 -p 4002:4002 rqlite/rqlite -node-id 2 -http-addr 0.0.0.0:4001 -raft-addr 0.0.0.0:4002 -http-adv-addr 2.3.4.5:4001 -raft-adv-addr 2.3.4.5:4002 -join https://netmaker:@1.2.3.4:4001
+
+- reference for rqlite setup: https://github.com/rqlite/rqlite/blob/master/DOC/CLUSTER_MGMT.md#creating-a-cluster
+- reference for rqlite security: https://github.com/rqlite/rqlite/blob/master/DOC/SECURITY.md
+
+Once rqlite instances have been configured, the Netmaker servers can be deployed.
+
+3. Netmaker Setup
+------------------
+
+Netmaker will be started on each node with default settings, except with DATABASE=rqlite and SQL_CONN set appropriately to reach the local rqlite instance. Rqlite will maintain consistency with each Netmaker backend.
+
+4. Other Considerations
+------------------------
+
+This is enough to get a functioning HA installation of Netmaker. However, you may also want to make the Netmaker UI or the CoreDNS server HA as well. The Netmaker UI can simply be added to the same servers and load balanced appropriately. For some load balancers, you may be able to do this with CoreDNS as well.
+
+
+
+
+
+
diff --git a/old-docs/API.md b/old-docs/API.md
deleted file mode 100644
index 03d88d24..00000000
--- a/old-docs/API.md
+++ /dev/null
@@ -1,167 +0,0 @@
-# API Reference Doc
-
-## GENERAL
-
-Most actions that can be performed via API can be performed via UI. We recommend managing your networks using our official netmaker-ui project. That said, Netmaker is API based, and all functions can also be achieved via API calls. If you feel the need to work with Netmaker via API, we've provided some documentation below to help guide you.
-
-#### Authentication
- In general, API calls must be authenticated via a header of the format `-H "Authorization: Bearer "` There are two methods of obtaining 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/< env >.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 `/api/nodes//authenticate` endpoint, as documented below.
-
-#### Format
-In general, requests will take the format of `curl -H "Authorization: Bearer " -H 'Content-Type: application/json' localhost:8081/api/path/to/endpoint`
-
-## NETWORKS
-
-**Get All Networks:** `/api/networks`, `GET`
-
-**Create Network:** `/api/network`, `POST`
-
-**Get Network:** `/api/networks/{network id}`, `GET`
-
-**Update Network:** `/api/networks/{network id}`, `PUT`
-
-**Delete Network:** `/api/networks/{network id}`, `DELETE`
-
-**Cycle PublicKeys on all Nodes:** `/api/networks/{network id}/keyupdate`, `POST`
-
-
-### Network API Call Examples
-
-
-**Get All Networks:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/networks | jq`
-
-**Create Network:** `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`
-
-**Get Network:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/networks/skynet | jq`
-
-**Update Network:** `curl -X PUT -d '{"displayname":"my-house"}' -H "Authorization: Bearer YOUR_SECRET_KEY" -H 'Content-Type: application/json' localhost:8081/api/networks/skynet`
-
-**Delete Network:** `curl -X DELETE -H "Authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/networks/skynet`
-
-**Cycle PublicKeys on all Nodes:** `curl -X POST -H "Authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/networks/skynet/keyupdate`
-
-## ACCESS KEYS
-
-**Get All Keys:** `/api/networks/{network id}/keys`, `GET`
-
-**Create Key:** `/api/networks/{network id}/keys`, `GET`
-
-**Delete Key:** `/api/networks/{network id}/keys/{keyname}`, `DELETE`
-
-
-### Access Key API Call Examples
-
-
-**Get All Keys:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/networks/skynet/keys | jq`
-
-**Create Key:** `curl -d '{"uses":10,"name":"mykey"}' -H "Authorization: Bearer YOUR_SECRET_KEY" -H 'Content-Type: application/json' localhost:8081/api/networks/skynet/keys`
-
-**Delete Key:** `curl -X DELETE -H "Authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/networks/skynet/keys/mykey`
-
-
-## NODES (COMPUTERS)
-
-
-**Get All Nodes:** `/api/nodes`, `GET`
-
-**Get Network Nodes:** `/api/nodes/{network id}`, `GET`
-
-**Create Node:** `/api/nodes/{network id}`, `POST`
-
-**Get Node:** `/api/nodes/{network id}/{macaddress}`, `GET`
-
-**Update Node:** `/api/nodes/{network id}/{macaddress}`, `PUT`
-
-**Delete Node:** `/api/nodes/{network id}/{macaddress}`, `DELETE`
-
-**Check In Node:** `/api/nodes/{network id}/{macaddress}/checkin`, `POST`
-
-**Create a Gateway:** `/api/nodes/{network id}/{macaddress}/creategateway`, `POST`
-
-**Delete a Gateway:** `/api/nodes/{network id}/{macaddress}/deletegateway`, `DELETE`
-
-**Uncordon (Approve) a Pending Node:** `/api/nodes/{network id}/{macaddress}/uncordon`, `POST`
-
-**Get Last Modified Date (Last Modified Node in Network):** `/api/nodes/adm/{network id}/lastmodified`, `GET`
-
-**Authenticate:** `/api/nodes/adm/{network id}/authenticate`, `POST`
-
-
-### Example Node API Calls
-
-
-**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`
-
-**Create Node:** `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`
-
-**Get Node:** `curl -H "Authorization: Bearer YOUR_SECRET_KEY" http://localhost:8081/api/nodes/skynet/{macaddress} | jq`
-
-**Update Node:** `curl -X PUT -d '{"name":"laptop1"}' -H 'Content-Type: application/json' -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/nodes/skynet/8c:90:b5:06:f1:d9`
-
-**Delete Node:** `curl -X DELETE -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/skynet/nodes/8c:90:b5:06:f1:d9`
-
-**Create a Gateway:** `curl -d '{ "rangestring": "172.31.0.0/16", "interface": "eth0"}' -H 'Content-Type: application/json' -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/nodes/skynet/8c:90:b5:06:f1:d9/creategateway`
-
-**Delete a Gateway:** `curl -X DELETE -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/nodes/skynet/8c:90:b5:06:f1:d9/deletegateway`
-
-**Approve a Pending Node:** `curl -X POST -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/nodes/skynet/8c:90:b5:06:f1:d9/approve`
-
-**Get Last Modified Date (Last Modified Node in Network):** `curl -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/nodes/adm/skynet/lastmodified`
-
-**Authenticate:** `curl -d '{"macaddress": "8c:90:b5:06:f1:d9", "password": "YOUR_PASSWORD"}' -H 'Content-Type: application/json' localhost:8081/api/nodes/adm/skynet/authenticate`
-
-
-## USERS
-
-
-**Note:** Only able to create Admin user at this time. The "user" is only used by the [user interface](https://github.com/gravitl/netmaker-ui) to authenticate the single admin user.
-
-**Get User:** `/api/users/{username}`, `GET`
-
-**Update User:** `/api/users/{username}`, `PUT`
-
-**Delete User:** `/api/users/{username}`, `DELETE`
-
-**Check for Admin User:** `/api/users/adm/hasadmin`, `GET`
-
-**Create Admin User:** `/api/users/adm/createadmin`, `POST`
-
-**Authenticate:** `/api/users/adm/authenticate`, `POST`
-
-
-### Example User API Calls
-
-
-**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`
-
-**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`
-
-**Authenticate:** `curl -d '{"username": "smartguy", "password": "YOUR_PASS"}' -H 'Content-Type: application/json' localhost:8081/api/nodes/adm/skynet/authenticate`
-
-## SERVER MGMT
-
-The Server Mgmt. API allows you to add and remove the server from networks.
-
-**Add to Network:** `/api/server/addnetwork/{network id}`, `POST`
-
-**Remove from Network:** `/api/server/removenetwork/{network id}`, `DELETE`
-
-**Add to Network:** `curl -X POST -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/server/addnetwork/{network id}`
-
-**Remove from Network:** `curl -X DELETE -H "authorization: Bearer YOUR_SECRET_KEY" localhost:8081/api/server/removenetwork/{network id}`
-
-## FILE SERVER
-
-**Get File:** `/meshclient/files/{filename}`, `GET`
-
-**Example:** `curl localhost:8081/meshclient/files/meshclient`
diff --git a/old-docs/CODE_OF_CONDUCT.md b/old-docs/CODE_OF_CONDUCT.md
deleted file mode 100644
index 3787cf1e..00000000
--- a/old-docs/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1,74 +0,0 @@
-## Code of Conduct
-
-### Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-### Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-### Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-### Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-### Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at info@gravitl.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-### Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
diff --git a/old-docs/CONTRIBUTING.md b/old-docs/CONTRIBUTING.md
deleted file mode 100644
index 35adf29a..00000000
--- a/old-docs/CONTRIBUTING.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# Contributing to Netmaker
-Welcome! If you're reading this, you might be wondering how to go about submitting some changes, whether those are features, bugfixes, or simple enhancements. You're in the right place. Please read below to learn more.
-
-## Code of Conduct
-
-Please read through our [code of conduct](./CODE_OF_CONDUCT.md), and when making contributions to the community, stay true to that text.
-
-## Report bugs and requests [here](https://github.com/gravitl/netmaker/issues)
-We use GitHub issues to track bugs, feature requests, and enhancements. If you think there's something missing or wrong with Netmaker, let us know! Try to add the appropriate tags and describe your issue thoroughly. If it's a feature request and we like it, we'll add it to the [roadmap](ROADMAP.md)
-
-## Submitting a PR
-We actively welcome contributions, and the way to do that is with a PR:
-
-1. Fork the repo
-2. Create a branch from `develop` based on what you are developing. In general this will be a feature or a bugfix branch, and should have the format of feature_vX.X_mynewfeature or bugfix_vX.X_mybugfix. Check the releases to see what minor version we are currently developing.
-3. Do your thing
-4. Document thoroughly
-5. Issue a PR to `develop`
-6. Sign the CLA
-
-## Contributor License Agreement
-
-When submitting a PR, you will be asked to sign a CLA, defined [here](https://gist.github.com/afeiszli/2f9f8133929e7d5574a9d892959d58a7). We've tried to make this as non-annoying as possible. This is adapted from the text used by the Apache Foundation in their CLA.
-
-This project is evolving quickly and we may want to move to an MIT or GPL license at some point in the near future, which would be difficult without a CLA.
-
-## Licensing
-Any contributions you make will be under the SSPL Software License. When you submit code changes, you understand that they will be under the same license that covers this project, defined [here](../LICENSE.txt). If you have any concerns around this, feel free to contact the maintainers.
diff --git a/old-docs/INSTALL_DOCKER.md b/old-docs/INSTALL_DOCKER.md
deleted file mode 100644
index 4f50b3d3..00000000
--- a/old-docs/INSTALL_DOCKER.md
+++ /dev/null
@@ -1,27 +0,0 @@
-##### https://docs.docker.com/engine/install/ubuntu/
-
-## Install Docker (Ubuntu)
-
-1. sudo apt-get install \
- apt-transport-https \
- ca-certificates \
- curl \
- gnupg \
- lsb-release
-
-2. curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
-
-3. echo \
- "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
- $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-
-
-4. sudo apt-get update
-
-5. sudo apt-get install docker-ce docker-ce-cli containerd.io
-
-## Install Docker Compose (Ubuntu)
-
-6. sudo curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-
-7. sudo chmod +x /usr/local/bin/docker-compose
diff --git a/old-docs/ROADMAP.md b/old-docs/ROADMAP.md
deleted file mode 100644
index 5cc9e2c6..00000000
--- a/old-docs/ROADMAP.md
+++ /dev/null
@@ -1,96 +0,0 @@
-# FEATURE ROADMAP
-
-### 0.1
-**Server:**
- - [x] Create Networks (virtual networks)
- - [x] Allow default settings for nodes from networks
- - [x] Admin/Superuser key
- - [x] Create multiuse keys for node signup
- - [x] JWT-based auth for post-signup
- - [x] CRUD for networks
- - [x] CRUD for nodes
- - [x] Track all important info about node for networking (port, endpoints, pub key, etc)
- - [x] Timestamps for determining if nodes need updates
-
-**Agent:**
- - [x] Self-installer
- - [x] Determine default settings w/o user input
- - [x] Systemd Service + timer
- - [x] Check-in functionality to retrieve updates from server
- - [x] Maintain list of up-to-date peers
- - [x] Update WG interface
- - [x] Config file for modifying node
-
-### 0.2
-- [x] Separate out README into DOCS folder with the following:
- - [x] API Docs
- - [x] Usage
- - [ ] Advanced Usage
- - [x] Contributing
- - [ ] Roadmap
- - [ ] Troubleshooting
-
-**Server:**
- - [x] Allow tracking multiple networks per node
- - [ ] Configure Check-in thresholds
- - [ ] Separate sign-up endpoint to allow VPN-only comms after joining network
- - [ ] Swagger Docs
- - [x] Build Out README
- - [x] Encode Server, Port, and Network into Keys
- - [ ] Switch to Unique ID for nodes instead of MacAddress
- - [x] Public Key refresh
- - [ ] Enable ipv6 addresses
- - [x] Have a "default" network created at startup
-
-**Agent:**
- - [x] Test / get working on multiple linux platforms
- - [ ] Set private DNS via etc hosts (node name + ip). Make it optional flag on agent.
- - [x] Decode Server, Port, and Network from Key
- - [ ] Service ID / unit file for SystemD Service
- - [x] Allow multiple interfaces
- - [ ] Use "Check in interval" from server
- - [x] Pre-req check on machine (wg, port forwarding)
- - [ ] Enable ipv6 addresses
-
-### 0.3
-**Server:**
- - [ ] Swagger Docs
- - [ ] Network/Node labels
- - [ ] "Read Only" mode for nodes (can't update their settings centrally, only read)
- - [ ] "No-GUI mode:" Similar to existing, just do more e2e testing and make sure flow makes sense
- - [ ] Let users set prefixes (node, interface)
-
-**Agent:**
- - [ ] Do system calls instead of direct commands
- - [ ] Add a prompt for easy setup
-
-### 0.4
-**Server:**
- - [ ] Private DNS
- - [ ] UDP Hole-Punching (via WGSD: https://github.com/jwhited/wgsd )
- - [ ] "Read Only" mode for nodes (can't update their settings centrally, only read)
-
-**Agent:**
- - [ ] Do system calls instead of direct commands [this repo](https://github.com/gravitl/netmaker-ui)
- - [ ] Add a prompt for easy setup
- - [ ] Make it work as a sidecar container!!!
-
-### 0.5
-**Server:**
- - [ ] Multi-user support
- - [ ] Oauth
- - [ ] public key cycling
-
-### Future Considerations
-**Server:**
- - [ ] Switch to distributed protocol (RAFT, Kademlia) instead of central server
- - [ ] Load balance / fault tolerant server
- - [ ] Change DB / make more scaleable (SQL?)
- - [ ] Redis
- - [ ] Network/Node labels
-
-**Agent:**
- - [ ] userspace via Docker or Golang
- - [ ] MacOS support
- - [ ] Windows support
- - [ ] Certificate-based authentication
diff --git a/old-docs/SITE_2_SITE.md b/old-docs/SITE_2_SITE.md
deleted file mode 100644
index 3b934538..00000000
--- a/old-docs/SITE_2_SITE.md
+++ /dev/null
@@ -1 +0,0 @@
-# This document will cover how to set up site to site connections using netmaker
diff --git a/old-docs/TROUBLESHOOTING.md b/old-docs/TROUBLESHOOTING.md
deleted file mode 100644
index fc292f15..00000000
--- a/old-docs/TROUBLESHOOTING.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# Netmaker Troubleshooting Help
-
-## Client (netclient)
- ### Problem: netclient-install script not working
- ### Problem: Hanging artifacts from previous install
- ### Problem: Need to change access token settings
-
-
-### Client fails to install
-
-### Cannot run install script
-
-### Issue with accesstoken created by UI
-
-
-## Server
- ### Server not added to default network
- ### Global config not found
-
-
-
-## MongoDB
-
-
-
-## UI
-
-### Incorrect backend detected. Please specify correct URL and refresh. Given: http://localhost:8081
-Solution: Front end expects a reachable address for the backend. Localhost is default. Check if server is up. If server is up, make sure you've got the right endpoint (endpoint of server. Will not be 'localhost' unless doing local testing). If server is up and endpoint is correct, check for port blockings.
diff --git a/old-docs/USAGE.md b/old-docs/USAGE.md
deleted file mode 100644
index 20f9e2ea..00000000
--- a/old-docs/USAGE.md
+++ /dev/null
@@ -1,140 +0,0 @@
-# Usage
-
-This guide covers advanced usage of Netmaker. If you are just looking to get started quickly, check out the Quick Start in the [README](../README.md).
-
-## Server Config
-Netmaker settings can be set via Environment Variables or Config file. There are also a couple of runtime arguments that can optionally be set.
-
-### Environment Variables
-**APP_ENV**: default=dev. Determines which environment file to use. Will look under config/environments/APP_ENV.yaml. For instance, you can have different environments for dev, test, and prod, and store different settinggs accordingly.
-**GRPC_PORT**: default=50051. The port for GRPC (node/client) communications
-**API_PORT**: default=8081. The port for API and UI communications
-**MASTER_KEY**: default=secretkey. The skeleton key used for authenticating with server as administrator.
-
-MongoDB Connection Env Vars:
-**MONGO_USER**:default=admin
-**MONGO_HOST**:default=password
-**MONGO_PASS**:default=localhost
-**MONGO_PORTS**:default=27017
-**MONGO_OPTS**:default=/?authSource=admin
-
-**BACKEND_URL**: default=nil. The address of the server. Used for setting token values for client/nodes. If not set, will run a command to retrieve the server URL.
-
-### Config File
-Stored as config/environments/*.yaml. Default used is dev.yaml
-
-**server**:
- - **host:** "localhost" (reachable address of this server, overriden by BACKEND_URL)
- - **apiport:** "8081" (api port, overriden by API_PORT)
- - **grpcport**: "50051" (grpc port, overridden by GRPC_PORT)
- - **masterkey**: "secretkey" (administrator server API key, overridden by MASTER_KEY)
- - **allowedorigin**: "*" (CORS policy for requests)
- - **restbackend**: true (Runs the REST server)
- - **agentbackend**: true (Runs the GRPC server)
- - **defaultnetname**: "default" (name for the default network)
- - **defaultnetrange**: "10.10.10.0/24" (range for the default network)
- - **createdefault**: true (Flag for creating the default network)
-
-**mongoconn**: (see ENV values above for explanation. ENV values override.)
- - **user**: "mongoadmin"
- - **pass**: "mongopass"
- - **host**: "localhost"
- - **port**: "27017"
- - **opts**: '/?authSource=admin'
-
-### Runtime Args
-
-**clientmode**: (default=on) E.x.: `sudo netmaker --clientmode=off` Run the Server as a client (node) as well.
-**defaultnet**: (default=on) E.x.: `sudo netmaker --defaultnet=off` Create a default network on startup.
-
-## Client Config
-
-Client config files are stored under /etc/netclient per network as /etc/netclient/netconfig-< network name >
-**server:**
- address: The address:port of the server
- accesskey: The acceess key used to sign up with the server
-
-**node:**
- name: a displayname for the node, e.g. "mycomputer"
- interface: the network interface name, by default something like "nm-"
- network: the netmaker network being attached to
- password: the node's hashed password. Can be changed by putting a value in here and setting "postchanges" to "true"
- macaddress: the mac address of the node
- localaddress: the local network address
- wgaddress: the wireguard private address
- roamingoff: flag to update the IP address automatically based on network changes
- islocal: whether or not this is a local or public network
- allowedips: the allowedips addresses that other nodes will recieve
- localrange: the local address range if it's a local network
- postup: post up rules for gateway nodes
- postdown: post down rules for gateway nodes
- port: the wiregard port
- keepalive: the default keepalive value between this and all other nodes
- publickey: the public key other nodes will use to access this node
- privatekey: the private key of the nodes (this field does nothing)
- endpoint: the reachable endpoint of the node for routing, either local or public.
- postchanges: either "true" or "false" (with quotes). If true, will post any changes you make to the remote server.
-
-
-## Non-Docker Installation
-
-### MongoDB Setup
-1. Install MongoDB on your server. For Ubuntu: `sudo apt install -y mongodb`. For more advanced installation or other operating systems, see the [MongoDB documentation](https://docs.mongodb.com/manual/administration/install-community/).
-
-2. Create a user:
-`mongo admin`
-> `db.createUser({ user: "mongoadmin" , pwd: "mongopass", roles: ["userAdminAnyDatabase", "dbAdminAnyDatabase", "readWriteAnyDatabase"]})`
-
-### Server Setup
- 1. **Run the install script:** sudo curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/v0.2/netmaker-server.sh | sh -
- 2. Check status: `sudo journalctl -u netmaker`
-2. If any settings are incorrect such as host or mongo credentials, change them under /etc/netmaker/config/environments/ENV.yaml and then run `sudo systemctl restart netmaker`
-
-### UI Setup
-1. **Download UI asset files:** `sudo wget -O /usr/share/nginx/html/netmaker-ui.zip https://github.com/gravitl/netmaker-ui/releases/download/latest/netmaker-ui.zip`
-
-2. **Unzip:** `sudo unzip /usr/share/nginx/html/netmaker-ui.zip -d /usr/share/nginx/html`
-
-3. **Copy Config to Nginx:** `sudo cp /usr/share/nginx/html/nginx.conf /etc/nginx/conf.d/default.conf`
-
-4. **Modify Default Config Path:** `sudo sed -i 's/root \/var\/www\/html/root \/usr\/share\/nginx\/html/g' /etc/nginx/sites-available/default`
-
-5. **Change Backend URL:** `sudo sh -c 'BACKEND_URL=http://:PORT /usr/share/nginx/html/generate_config_js.sh >/usr/share/nginx/html/config.js'`
-
-6. **Start Nginx:** `sudo systemctl start nginx`
-
-### Agent Setup
-
-On each machine you would like to add to the network, do the following:
-
-1. Confirm wireguard is installed: `sudo apt install wireguard-tools`
-2. Confirm ipv4 forwarding is enabled: `sysctl -w net.ipv4.ip_forward=1`
-3. Create a key or enable manual node signup at the network level
-4. Run the install command generated by key create: `sudo curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/v0.2/netclient-install.sh | KEY=YOUR_TOKEN sh -`
-4.a. For additional networks on the same machine, you can just run `sudo netclient -c install -t YOUR_TOKEN`
-4.b. For offline installs (no access to github), you can self-host a netclient file server on netmaker
-
-This will install netclient@.service and netclient-YOUR_NET.timer in systemd, which will run periodically to call the netclient binary, which will check to see if there are any updates that it needs and update WireGuard appropriately.
-
-## BUILDING
-**Back End Compilation**
-The backend can be compiled by running "go build" from the root of the repository, which will create an executable named "netmaker."
-
-**Client Compilation**
-Similarly, "go build" can be run from the netclient directory to produce a netclient executable.
-
-**Protoc command for GRPC Compilation:**
-Whenever making changes to grpc/node.proto, you will need to recompile the grpc. This can be achieved by running the following command from the root of the repository.
-
- protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative grpc/node.proto
-
-**Build binary:** `go build ./`
-
-
-## TESTING
-
-**Unit Testing**
-When making changes to Netmaker, you may wish to create nodes, networks, or keys for testing. Bash scripts have been created under the "test" directory (*.sh) which run curl commands that generate sample nodes, networks, and keys that can be used for testing purposes.
-
-**Integration Testing**
-Similarly, several go scripts have been created under the test directory (*.go) to test out changes to the code base. These will be run automatically when PR's are submitted but can also be run manually using "go test."
diff --git a/scripts/netclient-install.slim.sh b/scripts/netclient-install.slim.sh
deleted file mode 100644
index 18461d0a..00000000
--- a/scripts/netclient-install.slim.sh
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/bin/bash
-set -e
-
-if [[ $EUID -ne 0 ]]; then
- echo "This script must be run as root"
- exit 1
-fi
-
-[ -z "$KEY" ] && KEY=nokey;
-
-wget -O netclient https://github.com/gravitl/netmaker/releases/download/v0.5.11/netclient
-chmod +x netclient
-sudo ./netclient join -t $KEY
-rm -f netclient
diff --git a/scripts/netmaker-install-clientmode.sh b/scripts/netmaker-install-clientmode.sh
deleted file mode 100755
index 158000e0..00000000
--- a/scripts/netmaker-install-clientmode.sh
+++ /dev/null
@@ -1,60 +0,0 @@
-#!/bin/sh
-set -e
-
-[ -z "$SERVER_DOMAIN" ] && echo "Need to set SERVER_DOMAIN (format: 1.2.3.4 or mybackend.com)" && exit 1;
-
-
-docker volume create mongovol && docker run -d --name mongodb -v mongovol:/data/db --network host -e MONGO_INITDB_ROOT_USERNAME=mongoadmin -e MONGO_INITDB_ROOT_PASSWORD=mongopass mongo --bind_ip 0.0.0.0
-
-mkdir -p /etc/netmaker/config/environments
-wget -O /etc/netmaker/netmaker https://github.com/gravitl/netmaker/releases/download/latest/netmaker
-chmod +x /etc/netmaker/netmaker
-
-
-cat >/etc/netmaker/config/environments/dev.yaml</etc/netmaker/config/Corefile</etc/systemd/system/netmaker.service</etc/netmaker/config/environments/dev.yaml</etc/netmaker/config/dnsconfig/Corefile</etc/systemd/system/netmaker.service</etc/netmaker/config/environments/dev.yaml</etc/systemd/system/netmaker.service</root/Caddyfile</root/docker-compose.yml<
-(For a more customized install, including using your own domain, head over to [the quick start guide](https://docs.netmaker.org/quick-start.html).)
-
After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting-started-with-netmaker-a-wireguard-virtual-networking-platform-3d563fbd87f0) and [Getting Started](https://netmaker.readthedocs.io/en/master/getting-started.html) guide to begin setting up networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes.
# Why Netmaker + WireGuard?
@@ -46,10 +64,9 @@ After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting
- [Business (Subscription)](https://gravitl.com/plans/business)
-- [Email](mailto:info@gravitl.com)
-
## Disclaimer
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
## License
+
Netmaker's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found here: [LICENSE.txt](./LICENSE.txt).
diff --git a/compose/docker-compose.caddy.yml b/compose/docker-compose.caddy.yml
index 1ddb4ee2..12443984 100644
--- a/compose/docker-compose.caddy.yml
+++ b/compose/docker-compose.caddy.yml
@@ -3,7 +3,7 @@ version: "3.4"
services:
netmaker:
container_name: netmaker
- image: gravitl/netmaker:v0.8.2
+ image: gravitl/netmaker:v0.8.3
volumes:
- /etc/netclient/config:/etc/netclient/config
- dnsconfig:/root/config/dnsconfig
diff --git a/compose/docker-compose.nodns.yml b/compose/docker-compose.nodns.yml
deleted file mode 100644
index f8953d73..00000000
--- a/compose/docker-compose.nodns.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-version: "3.4"
-
-services:
- rqlite:
- container_name: rqlite
- image: rqlite/rqlite
- network_mode: host
- restart: always
- volumes:
- - sqldata:/rqlite/file/data
- netmaker:
- depends_on:
- - rqlite
- privileged: true
- container_name: netmaker
- image: gravitl/netmaker:v0.7
- volumes:
- - ./:/local
- - /etc/netclient:/etc/netclient
- - /usr/bin/wg:/usr/bin/wg
- - /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket
- - /run/systemd/system:/run/systemd/system
- - /etc/systemd/system:/etc/systemd/system
- - /sys/fs/cgroup:/sys/fs/cgroup
- cap_add:
- - NET_ADMIN
- - SYS_MODULE
- restart: always
- network_mode: host
- environment:
- SERVER_HOST: "SERVER_PUBLIC_IP"
- DNS_MODE: "off"
- SERVER_API_CONN_STRING: "api.NETMAKER_BASE_DOMAIN:443"
- SERVER_GRPC_CONN_STRING: "grpc.NETMAKER_BASE_DOMAIN:443"
- GRPC_SSL: "on"
- SERVER_HTTP_HOST: "api.NETMAKER_BASE_DOMAIN"
- SERVER_GRPC_HOST: "grpc.NETMAKER_BASE_DOMAIN"
- API_PORT: "8081"
- GRPC_PORT: "50051"
- CLIENT_MODE: "on"
- MASTER_KEY: "REPLACE_MASTER_KEY"
- SERVER_GRPC_WIREGUARD: "off"
- CORS_ALLOWED_ORIGIN: "*"
- netmaker-ui:
- container_name: netmaker-ui
- depends_on:
- - netmaker
- image: gravitl/netmaker-ui:v0.7
- links:
- - "netmaker:api"
- ports:
- - "8082:80"
- environment:
- BACKEND_URL: "https://api.NETMAKER_BASE_DOMAIN"
-volumes:
- sqldata: {}
\ No newline at end of file
diff --git a/compose/docker-compose.yml b/compose/docker-compose.yml
index f7106c0f..9f24d8e3 100644
--- a/compose/docker-compose.yml
+++ b/compose/docker-compose.yml
@@ -3,7 +3,7 @@ version: "3.4"
services:
netmaker:
container_name: netmaker
- image: gravitl/netmaker:v0.8.2
+ image: gravitl/netmaker:v0.8.3
volumes:
- /etc/netclient/config:/etc/netclient/config
- dnsconfig:/root/config/dnsconfig
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
index e6a08d24..d8ba343d 100644
Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
index 7ebdcae0..858da06a 100644
Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ
diff --git a/docs/_build/doctrees/install.doctree b/docs/_build/doctrees/install.doctree
new file mode 100644
index 00000000..8f3723d2
Binary files /dev/null and b/docs/_build/doctrees/install.doctree differ
diff --git a/docs/_build/doctrees/quick-start-nginx.doctree b/docs/_build/doctrees/quick-start-nginx.doctree
index 5d38e4bf..3019efc3 100644
Binary files a/docs/_build/doctrees/quick-start-nginx.doctree and b/docs/_build/doctrees/quick-start-nginx.doctree differ
diff --git a/docs/_build/doctrees/quick-start.doctree b/docs/_build/doctrees/quick-start.doctree
index 5eb70759..22f568d9 100644
Binary files a/docs/_build/doctrees/quick-start.doctree and b/docs/_build/doctrees/quick-start.doctree differ
diff --git a/docs/_build/doctrees/server-installation.doctree b/docs/_build/doctrees/server-installation.doctree
index e1c70e98..bfd68624 100644
Binary files a/docs/_build/doctrees/server-installation.doctree and b/docs/_build/doctrees/server-installation.doctree differ
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
index abd913e0..edd73cef 100644
--- a/docs/_build/html/_sources/index.rst.txt
+++ b/docs/_build/html/_sources/index.rst.txt
@@ -48,6 +48,16 @@ A technical overview of Netmaker, including design decisions and limitations.
architecture
+Install
+------------------------------------
+
+Choose the right install method for you.
+
+.. toctree::
+ :maxdepth: 1
+
+ install
+
Quick Start
---------------
diff --git a/docs/_build/html/_sources/install.rst.txt b/docs/_build/html/_sources/install.rst.txt
new file mode 100644
index 00000000..ea7d3d4f
--- /dev/null
+++ b/docs/_build/html/_sources/install.rst.txt
@@ -0,0 +1,20 @@
+=========
+Install
+=========
+
+Choose the install method that makes sense for you.
+
+**For most users, we recommend the** :doc:`Quick Install<./quick-start>` **guide.**
+
+`Trial, PoC, Testing, and Experimenting