diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 642a3ef6..22b086af 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/server-installation.doctree b/docs/_build/doctrees/server-installation.doctree index 47bdfe02..d601b30a 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/server-installation.rst.txt b/docs/_build/html/_sources/server-installation.rst.txt index c186e729..16a8af4e 100644 --- a/docs/_build/html/_sources/server-installation.rst.txt +++ b/docs/_build/html/_sources/server-installation.rst.txt @@ -36,8 +36,16 @@ To run a non-docker installation, you are running the Netmaker binary, CoreDNS b DNS Mode Prereqisite Setup (Ubuntu) ==================================== -If you plan on running the +If you plan on running the server in DNS Mode, you will be deploying a CoreDNS server. We recommend binding CoreDNS to port 53 of the host system (which it will do by default). On some systems, this will conflift with existing processes. Specifically on linux systems running systemd-resolved, there may be a service consuming port 53. The below steps will disable systemd-resolved, and replace it with a generic (e.g. Google) nameserver. The following was tested on Ubuntu 20.04. This may have consequences for existing private DNS so proceed with caution: +1. systemctl stop systemd-resolved +2. systemctl disable systemd-resolved +3. vim /etc/systemd/resolved.conf + * uncomment DNS and add 8.8.8.8 or whatever reachable nameserver is your preference + * uncomment DNSStubListener and set to "no" +4. sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf + +Port 53 should now be available for CoreDNS to use. Docker Compose Install ======================= diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 9658d036..9c4d72d5 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["about","api","architecture","client-installation","conduct","contribute","index","license","quick-start","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":2,"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","contribute.rst","index.rst","license.rst","quick-start.rst","server-installation.rst","support.rst","troubleshoot.rst","usage.rst"],objects:{},objnames:{},objtypes:{},terms:{"100":1,"127":9,"172":1,"200":1,"27017":9,"50051":[2,9],"50052":8,"5_doc":[],"6400":1,"8081":[1,2,9],"abstract":2,"case":[1,2,6,8,9,12],"default":[1,2,8,9],"function":[1,2,9],"import":[2,8,9],"long":[0,8],"new":[2,8],"public":[2,4,7],"return":2,"static":[2,9],"true":9,"try":10,"var":[1,9],"while":[2,9],AWS:0,Being:4,DNS:[2,6,8,12],For:[2,8,9],IPs:2,NOT:[],Not:2,That:2,The:[0,1,2,4,8,9],Then:8,There:[0,1,8,9],These:[2,8],Use:6,Used:9,Useful:9,Using:[0,1,4,6,8],Will:9,With:[2,9],aa3bvg0rnitirxdx:1,abl:[1,2],abou:8,about:[2,8],abov:[2,8,9],abus:4,acceler:2,accept:4,access:[0,2,8,9,12],accesskei:1,accesss:[],accomplish:[],account:4,achiev:[1,2],across:0,act:[2,4],action:[1,4],actual:2,adapt:4,add:[0,1,2,8,9],added:[2,8,9],adding:8,addit:[2,8,9],addnetwork:1,address:[2,4,8,9],addressrang:[1,8],adequ:9,adm:1,admin:[0,1,2,8,9],adopt:2,advanc:[1,4,8,9],after:8,age:4,agent:[0,2,6,8,9],agent_backend:9,agentbackend:9,aggreg:2,align:4,all:[0,1,2,4,6,7,8,9],allow:[1,2,8,9,12],allowedorigin:9,alreadi:[2,8,9],also:[0,1,2,8,9],altern:[2,9],alwai:9,android:2,ani:[0,2,4,8,9],annot:[],anoth:2,anyon:[],anyth:2,aorijqalrik3ajflaqrdajhkr:1,apach:[2,9],api:[2,8,9],api_port:9,apihost:9,apiport:9,appear:[4,8],appli:4,applic:1,appoint:4,appropri:[2,4],approv:[1,8],apt:9,arbitrari:0,arch:2,architectur:[8,9],arrai:2,artifact:7,ask:[],asset:9,assum:[2,9],attack:4,attent:4,attribut:6,authent:[2,8],author:1,authsourc:9,autom:0,automat:[2,9],avail:[4,7,9],awai:2,await:2,back:[2,9],backend:9,backend_url:9,background:2,ban:4,bare:2,base64:8,base:[2,8,9],bash:2,basi:2,basic:6,bearer:1,becaus:[0,9],becom:[2,9],been:2,befor:2,begin:2,behavior:4,behind:2,being:2,below:[1,2,8,9,12],best:4,better:2,between:[0,2],beyond:9,bin:9,binari:[2,8,9],bit:[9,12],block:9,bodi:4,both:[2,4,9],bottom:8,browser:8,build:6,built:2,button:9,c42wt:[],call:[0,2,6,9],can:[0,1,2,7,8,9,12],cap_add:9,carrier:2,caus:[2,9],center:0,cento:2,certain:2,cgnat:2,cgroup:9,challeng:9,chang:[0,1,2,8,9],check:[1,2,8,9],checkin:1,choos:[],chosen:2,circumst:4,clarifi:4,click:[2,8,9],client:[0,2,8],client_mod:9,clientmod:9,clone:[],cloud:[0,12],cloudnet:[],cluster:[9,12],code:[2,7],com:[4,8,9,10],come:[2,6,9],command:[2,8,9],comment:[4,9],commit:4,common:[2,6],commun:[2,4,6,9,12],compat:[6,8],compil:2,complaint:4,complet:2,complex:2,complic:2,compon:[6,9],compos:[6,8],comput:[0,2],concept:6,conf:9,confidenti:4,config:[1,2],configur:[0,1,2,6,8],conflict:[2,8],connect:[0,2,8,12],consid:[2,4],consider:2,consist:2,consol:8,construct:4,consumpt:2,contact:[4,6],contain:[2,8,9],container_nam:9,content:1,contrast:2,contribut:4,contributor:4,control:[2,8,9],copi:[8,9],cordon:[],core:[0,6],coredn:6,corefil:9,coreo:2,correct:4,cors_allowed_origin:9,could:[0,4],coupl:[],coven:4,cover:[6,9],cpu:2,creat:[0,1,2,4,6,9,12],createadmin:1,creategatewai:1,createus:9,creation:0,credenti:9,critic:4,cross:12,cryptocurr:0,curl:[8,9],current:[2,9],custom:[6,9],customiz:9,cycl:[1,2],daemon:2,data:[0,2,9],databas:2,date:1,dbadminanydatabas:9,dbu:9,debian:[2,9],decis:6,decod:[2,8],deem:4,defaultkeepal:8,defin:4,delet:[1,8],deletegatewai:1,depend:[2,9],depends_on:9,deploi:[2,6,9],deploy:[2,9],derogatori:4,descript:[],design:[2,6],desktop:2,detail:[1,2,4,6,8,9],determin:[4,9],dev:9,develop:2,devic:[0,2,6,8],diabl:9,diagram:2,differ:[0,2,4,8,9,12],direct:[],directli:[0,1,2,9],directori:9,disabl:[2,4],disable_remote_ip_check:9,disableremoteipcheck:9,discord:10,discuss:9,displai:8,displaynam:1,distribut:2,distributionshav:2,dns:[2,9],dns_mode:9,dnsconfig:9,dnsmode:9,dnsstublisten:[],doc:[8,9],docker:[2,6,8],document:[0,2,3,8,9],doe:[2,6,9],doing:0,domain:9,don:[2,12],doubl:2,down:[0,8],download:[8,9],dual:6,dynam:[0,2,6],each:[0,2,8,9],easier:[2,9],easiest:2,easili:[0,9],echo:8,edg:[],edit:4,effect:8,effici:2,either:2,electron:4,email:10,empathi:4,enabl:[2,8],encod:8,encompass:0,encount:2,encrypt:[0,2],end:[2,9],endpoint:[1,2],enforc:6,enhanc:6,enough:8,enter:8,entir:[2,8],entireti:2,entri:[],env:[1,9],environ:[0,1,2,4,9],equal:9,equival:9,escal:9,especi:9,etc:[8,9],eth0:1,ethnic:4,even:[0,2,9],event:4,everi:[2,8],everyon:4,everyth:2,evolv:2,examin:8,exampl:[2,4,6],except:9,exist:[0,2,8],expect:[4,6],experi:4,explain:[2,6,9],explicit:4,explicitli:9,expos:2,express:4,extens:2,extern:[2,6,8],face:4,fact:0,fail:8,fair:4,fairli:2,faith:4,fals:9,familiar:[0,2],faq:6,fast:[2,6],faster:[0,2],featur:[6,8],feature_v0:[],fedora:2,few:9,field:8,figur:12,file:2,filenam:1,find:[2,12],fine:0,firewal:9,first:[2,8,12],fit:12,flag:9,flat:0,flexibl:[0,2],flow:2,focus:4,folder:2,follow:[4,8,9],fork:6,foster:4,found:[0,2,7,8],free:4,freeli:7,from:[0,1,2,4,8,9,12],front:[2,9],full:[0,2],fulli:[0,2,9],fundament:9,further:4,futur:[2,8,9],gatewai:[1,2,9,12],gender:4,gener:[1,2,9],generate_config_j:9,get:[1,6,8,9,12],github:[2,6,9,10],githubusercont:[8,9],give:[2,8,9],given:[0,2,8],goal:[],goe:0,going:8,golang:2,good:[4,12],googl:[],gracefulli:4,grade:2,gravitl:[4,8,9,10],grpc:[2,8,9],grpc_port:9,grpchost:9,grpcport:9,guid:[0,2,8,9],hand:6,handl:0,harass:4,harm:4,has:[0,2,9,12],hasadmin:1,have:[0,2,4,8,9,12],header:1,heavi:2,heaviest:2,heavili:2,help:[1,2,6,9,10,12],here:[2,4,7,8,9,12],high:2,hold:[0,2],home:[0,2],homenet:[],host:[2,8,9],host_ip:[8,9],hous:1,how:[2,3,6,9],howev:[1,2,8,9],html:9,http:[1,8,9,10],http_port:9,hub:[0,2],iOS:[],icon:[],idea:[],ident:4,imag:9,imageri:4,impact:2,inappropri:4,incid:4,includ:[2,4,6,9],inclus:4,incompat:2,incorrect:9,increas:[2,9],individu:[4,9],industri:2,info:[2,4,9,10],inform:[2,4,8],insert:[8,9],instal:[0,2],instanc:[1,2,4,8,9],instead:[0,8],instruct:[8,9],insult:4,interact:[0,2],interest:4,interfac:[1,9],internet:[0,2],intro:12,introduc:2,introduct:6,invalid:8,investig:4,invis:2,iot:[0,2],iphon:2,ipsec:2,ipv4:[],ipv6:6,issu:[4,6,9],its:[0,2,4,8,9],itself:2,join:8,journalctl:9,json:1,just:[0,2,8,9],jwt:1,keep:[1,9],kei:[2,9],kernel:[0,2,9],keynam:1,keyupd:1,know:12,known:2,krckbjhwwdk:[],kubernet:[0,6],lack:9,languag:4,laptop1:1,larg:2,last:1,lastmodifi:1,latenc:2,later:[2,9],latest:[2,9],launch:[],layer:0,layout:2,leadership:4,learn:8,least:0,left:9,less:2,let:[0,12],level:[2,4,9],lighter:2,lightweight:2,like:[0,2,8,9],limit:[6,9],line:2,link:[6,9],linux:[2,6,8],list:[0,2,9],listenport:1,littl:2,load:[2,9],local:[2,6,8,9],localaddress:1,localhost:1,locat:[0,2,9],login:[8,9],lose:[],lot:2,lxc:9,mac:9,macaddress:1,machin:[0,2,3,8,9],maco:[],made:[0,2],mai:[1,2,4,8,9],mail:4,main:9,mainfram:9,maintain:4,make:[0,2,4,8,9],manag:[0,2,6,9,12],mandatori:9,mani:[0,2,9,12],manual:[2,8],map:9,master:[8,9],master_kei:9,masterkei:[1,9],match:9,mean:[2,9],meant:[],media:4,member:[4,12],memori:2,mesh:[0,12],meshclient:1,metal:2,method:[1,2,8],mgmt:1,might:[0,2,9],mind:9,mint:2,minu:9,miss:2,mode:[2,6,8],model:[0,2],modif:9,modifi:[1,2,8,9],mongo:9,mongo_admin:9,mongo_host:9,mongo_initdb_root_password:9,mongo_initdb_root_usernam:9,mongo_opt:9,mongo_pass:9,mongo_port:9,mongoadmin:9,mongoconn:9,mongodb:[],mongopass:9,mongovol:9,more:[0,1,2,6,8,9],most:[1,2,9],mostli:2,mount:9,much:[0,2],multipl:[0,8,9],must:[1,2,8,9],mykei:[1,8],mynet:8,name:[1,8,9],nameserv:[2,9],nat:2,nation:4,nativ:[],navig:8,nebula:0,necessari:[4,8,9],need:[0,1,2,8,9,10],neighborhood:0,neither:2,net_admin:9,netclient:[0,6,9],netid:1,netmak:[1,3,7,9],network:[0,3,6,8,9],network_mod:9,networknam:[],next:8,nginx:[2,9],noclient:9,node:[6,9],nodn:9,non:[2,3,9],none:0,noonewillguessthi:1,note:[1,6],notifi:2,now:[0,8],number:[2,8,9],oblig:4,obtain:1,off:[2,9],offens:4,offic:[0,12],offici:[1,4,8],offlin:4,onc:8,one:[2,8,9],onli:[1,2,8],onlin:4,onto:9,open:[2,4,9,10],openvpn:2,oper:[2,9],opt:9,option:[2,6],order:2,orient:4,origin:9,other:[0,2,4,8,9],otherwis:[0,4],our:[6,9],out:[0,2,8,9,12],outlin:[2,9],output:8,outsid:[],over:[0,2],overlai:[0,6],overrid:9,overridden:[2,9],overview:[2,6,12],overwhelm:12,own:2,pair:[2,9],pane:8,part:[2,3,9],partial:2,particip:4,particular:2,pass:[2,9],password:[1,8,9],path:[1,9],peer:[2,12],pencil:[],pend:[1,8],perform:[1,2,9],period:2,perman:4,permiss:[4,8],permit:8,persistenkeepal:8,person:4,perspect:[0,2],phone:2,physic:4,pick:[2,8],pictur:2,pidof:8,ping:8,place:9,plan:9,platform:[2,6],pleas:8,pledg:6,point:2,polici:4,polit:4,popul:9,popup:[],port:[2,8,9],posit:4,possibl:[2,6,8],post:[1,2,4],postfix:[],practic:2,pre:[8,9],preced:2,prefer:[],prepar:[],prereq:[],prereqisit:6,prerequisit:[6,9],present:8,previou:2,primari:9,privat:[2,4,6,8,12],privateapi:[],privileg:9,probabl:0,problem:9,process:[6,8,9],product:9,profession:4,project:[1,4,6],proof:0,provid:[0,2,9],publickei:1,publish:[4,7],pull:2,pure:6,put:1,pwd:9,pwlpt320ybo:[],quick:9,quickli:[6,8],race:4,rang:8,rangestr:1,rapidli:2,raspian:2,raw:[8,9],reach:[0,2],reachabl:[2,8],reactj:2,read:9,readi:[],readwriteanydatabas:9,realli:[],reallysecret:1,reason:[2,4,9],reccommend:9,recent:2,reciev:[1,2],recommend:[1,9],reconfigur:2,reduc:2,refer:[2,8],regard:[2,4],regardless:4,regist:2,reiter:2,reject:4,rel:2,relai:[2,9],releas:[2,9],reli:[0,2],relianc:2,religion:4,remot:[0,9],remov:[1,2,4,8,9],removenetwork:1,repeat:8,repercuss:4,replac:[2,9],repo:[],report:[2,4],repositori:[2,7],repres:4,represent:4,request:[1,2,9],requir:[1,2,8,9],resolv:[2,9],resolvectl:9,respect:4,respons:[2,6],rest:9,rest_backend:9,restart:9,restbackend:9,restrict:9,result:4,retriev:[0,1,2,8],review:4,rhel:2,right:[0,4],role:9,root:[8,9],rout:[0,2],router:2,run:[0,1,2,6,8,9],runtim:9,said:2,same:[0,8,9],sampl:0,save:8,scenario:[8,9],scope:6,screen:8,script:[2,8,9],second:8,secret:[1,8],secretkei:9,section:[8,9],secur:[0,1,2,6],sed:[8,9],see:[1,2,8,9],select:[8,12],send:[2,9],sens:2,sensibl:[0,2,8],separ:[2,4,9,12],serv:[2,9],server:[0,7,8],server_api_host:9,server_grpc_host:9,server_host:9,server_http_host:9,servic:[2,9],set:[1,2,4,8,9,12],setup:[0,6],sever:[2,9],sexual:4,sfl:[8,9],share:9,ship:8,should:[0,1,2,6,8,9],show:[4,8,9],side:[7,9],sign:[2,8],signific:2,signigif:2,signup:2,similar:[0,8,9],simpl:[2,8,9],simplest:2,simpli:[2,8],simultan:0,sinc:9,singl:[1,9],site:[0,6,9],situat:2,size:4,skynet:1,slim:8,slow:0,small:2,smartgui:1,snap:[],social:4,solut:2,solv:9,some:[1,2,9,12],someth:8,somewher:8,soon:[6,9],sort:[0,2],sourc:[2,6,7],space:4,special:[2,8,9],specif:[2,4],specifi:9,speed:[0,2],spoke:[0,2],spread:0,sql:2,ssh:8,sspl:7,stack:6,stake:0,standard:[2,6,8,9],start:[9,12],startup:[1,8],state:8,statement:6,statu:9,step:[2,8,9],still:[0,9],stop:[],store:[2,9],string:8,structur:2,submit:[6,8],subnet:2,substanti:[0,9],success:2,sudo:[8,9],support:[2,9],sure:9,suse:2,swagger:6,sys:9,sys_modul:9,system:[6,8],system_bus_socket:9,systemctl:9,systemd:[8,9],tab:8,tailscal:0,take:[0,1,2,4,8,9],talk:[0,2],team:4,technic:[0,6],technolog:2,tell:[0,2,3],temporari:4,temporarili:4,test:[6,8],than:2,thei:[0,2,4,9],them:[2,8,9],themselv:2,thhe:9,thi:[0,1,2,3,4,6,7,8,9],thing:[0,2,9],think:12,those:[0,2,9],though:9,thousand:0,threaten:4,three:8,through:2,ticket:10,time:[1,2,8,12],timer:2,timestamp:2,tld:[],toggl:[],token:8,tool:0,top:2,topic:12,topolog:2,toward:4,traffic:[0,2,9],transact:2,treat:2,tree:[],tricki:2,troll:4,troubleshoot:[1,8],tunnel:[0,2],turn:[2,9],tutori:6,two:[0,1,2,9],type:1,typic:[0,2,8],ubuntu:[2,6],udp:9,unabl:2,unaccept:4,uncom:[],uncordon:1,under:[7,8,9],underlai:[0,12],underli:9,understand:9,underwai:[],uninstal:6,uninstral:6,unix:[2,9],unless:9,unmanag:6,unnecessari:[],unset:[8,9],until:8,unwelcom:4,unzip:9,updat:[1,2,8],upon:2,upper:[],url:9,usag:[6,9,12],use:[0,1,2,4,6,8,9,12],used:[1,2,8,9],useful:9,user:[2,8,9],useradminanydatabas:9,usernam:[1,8,9],uses:[0,1,2,8,9],using:[0,1,2,4,6,12],usr:9,util:[],valid:2,valu:[1,2,8,9],vari:9,variabl:2,variou:[6,9],veri:[0,2],verifi:2,version:[2,4,7,9],via:[1,2,4,9,12],video:[],view:8,viewpoint:4,vim:[],virtual:[0,6,12],visibl:8,vm3ow4thatogiwnsla3thsl3894th:8,volum:[8,9],vpc:0,vpn:[2,12],wai:9,want:[0,2,8,9],web:9,webserv:2,websit:2,weight:2,welcom:4,well:[2,3,6,8],wget:[8,9],what:[2,4,6],whatev:[],when:[2,4,9],where:[2,6,8,9,12],wherev:0,whether:[0,9],which:[0,2,4,7,8,9],who:4,why:[2,6],wide:2,wider:2,wiki:4,window:[2,9],wireguard:[0,6,8,9],wish:9,within:[2,4],without:[1,2,4,6,8],work:[2,6],workstat:8,world:[0,2],wors:2,worth:2,would:[0,8,9],write:[2,9],www:9,yaml:[1,9],yml:[8,9],you:[0,1,2,3,6,8,9,10,12],your:[0,1,2,8,9,12],your_pass:1,your_password:1,your_secret_kei:1,youtu:[],zeroti:0,zip:9,zrb9vfhk8a:10},titles:["About","API Reference","Architecture","Client Installation","Code of Conduct","Contribute","Welcome to the Netmaker Documentation","License","Quick Start","Server Installation","Support","Troubleshooting","Using Netmaker"],titleterms:{"case":0,"default":[],DNS:9,Use:0,Using:12,about:[0,6],access:1,agent:11,annot:9,api:[1,6],architectur:[2,6],attribut:4,authent:1,basic:12,build:5,call:1,client:[3,6,9],code:[4,5,6],common:11,compat:[2,3,9],compon:2,compos:9,concept:2,conduct:[4,6],config:9,configur:9,contact:10,contribut:[5,6],core:2,coredn:[2,9,11],creat:8,curl:1,custom:3,deploi:8,descript:9,disabl:9,docker:[3,9],document:[1,6],doe:0,dual:12,enabl:9,enforc:4,enhanc:5,environ:[],examin:[],exampl:1,extern:12,faq:10,featur:9,file:[1,9],fork:5,format:1,full:9,guid:6,how:0,instal:[3,6,8,9],introduct:8,ipv6:12,issu:[5,11],kei:[1,8],kubernet:[3,9,12],licens:[6,7],limit:2,linux:[3,9],local:12,manag:[1,8],mesh:2,mode:9,mongodb:[2,9],netclient:[2,3,8],netmak:[0,2,6,8,12],network:[1,2,12],node:[1,2,8,12],note:9,onli:9,option:9,our:4,pledg:4,prereqisit:9,prerequisit:[3,8],process:2,pure:3,quick:[6,8],refer:[1,6,9],respons:4,scope:4,server:[1,2,6,9,11],setup:[8,9],site:12,slim:9,stack:12,standard:4,start:[6,8],submit:5,support:[6,10],system:[2,3,9],systemd:2,technic:2,test:5,troubleshoot:[6,11],tutori:12,ubuntu:9,uninstal:8,uninstral:8,unmanag:3,usag:1,user:1,variabl:9,video:12,welcom:6,what:0,wireguard:[2,3],without:9,work:0,written:12,your:3}}) \ No newline at end of file +Search.setIndex({docnames:["about","api","architecture","client-installation","conduct","contribute","index","license","quick-start","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":2,"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","contribute.rst","index.rst","license.rst","quick-start.rst","server-installation.rst","support.rst","troubleshoot.rst","usage.rst"],objects:{},objnames:{},objtypes:{},terms:{"100":1,"127":9,"172":1,"200":1,"27017":9,"50051":[2,9],"50052":8,"5_doc":[],"6400":1,"8081":[1,2,9],"abstract":2,"case":[1,2,6,8,9,12],"default":[1,2,8,9],"function":[1,2,9],"import":[2,8,9],"long":[0,8],"new":[2,8],"public":[2,4,7],"return":2,"static":[2,9],"true":9,"try":10,"var":[1,9],"while":[2,9],AWS:0,Being:4,DNS:[2,6,8,12],For:[2,8,9],IPs:2,NOT:[],Not:2,That:2,The:[0,1,2,4,8,9],Then:8,There:[0,1,8,9],These:[2,8],Use:6,Used:9,Useful:9,Using:[0,1,4,6,8],Will:9,With:[2,9],aa3bvg0rnitirxdx:1,abl:[1,2],abou:8,about:[2,8],abov:[2,8,9],abus:4,acceler:2,accept:4,access:[0,2,8,9,12],accesskei:1,accesss:[],accomplish:[],account:4,achiev:[1,2],across:0,act:[2,4],action:[1,4],actual:2,adapt:4,add:[0,1,2,8,9],added:[2,8,9],adding:8,addit:[2,8,9],addnetwork:1,address:[2,4,8,9],addressrang:[1,8],adequ:9,adm:1,admin:[0,1,2,8,9],adopt:2,advanc:[1,4,8,9],after:8,age:4,agent:[0,2,6,8,9],agent_backend:9,agentbackend:9,aggreg:2,align:4,all:[0,1,2,4,6,7,8,9],allow:[1,2,8,9,12],allowedorigin:9,alreadi:[2,8,9],also:[0,1,2,8,9],altern:[2,9],alwai:9,android:2,ani:[0,2,4,8,9],annot:[],anoth:2,anyon:[],anyth:2,aorijqalrik3ajflaqrdajhkr:1,apach:[2,9],api:[2,8,9],api_port:9,apihost:9,apiport:9,appear:[4,8],appli:4,applic:1,appoint:4,appropri:[2,4],approv:[1,8],apt:9,arbitrari:0,arch:2,architectur:[8,9],arrai:2,artifact:7,ask:[],asset:9,assum:[2,9],attack:4,attent:4,attribut:6,authent:[2,8],author:1,authsourc:9,autom:0,automat:[2,9],avail:[4,7,9],awai:2,await:2,back:[2,9],backend:9,backend_url:9,background:2,ban:4,bare:2,base64:8,base:[2,8,9],bash:2,basi:2,basic:6,bearer:1,becaus:[0,9],becom:[2,9],been:2,befor:2,begin:2,behavior:4,behind:2,being:2,below:[1,2,8,9,12],best:4,better:2,between:[0,2],beyond:9,bin:9,binari:[2,8,9],bind:9,bit:[9,12],block:9,bodi:4,both:[2,4,9],bottom:8,browser:8,build:6,built:2,button:9,c42wt:[],call:[0,2,6,9],can:[0,1,2,7,8,9,12],cap_add:9,carrier:2,caus:[2,9],caution:9,center:0,cento:2,certain:2,cgnat:2,cgroup:9,challeng:9,chang:[0,1,2,8,9],check:[1,2,8,9],checkin:1,choos:[],chosen:2,circumst:4,clarifi:4,click:[2,8,9],client:[0,2,8],client_mod:9,clientmod:9,clone:[],cloud:[0,12],cloudnet:[],cluster:[9,12],code:[2,7],com:[4,8,9,10],come:[2,6,9],command:[2,8,9],comment:[4,9],commit:4,common:[2,6],commun:[2,4,6,9,12],compat:[6,8],compil:2,complaint:4,complet:2,complex:2,complic:2,compon:[6,9],compos:[6,8],comput:[0,2],concept:6,conf:9,confidenti:4,config:[1,2],configur:[0,1,2,6,8],conflict:[2,8],conflift:9,connect:[0,2,8,12],consequ:9,consid:[2,4],consider:2,consist:2,consol:8,construct:4,consum:9,consumpt:2,contact:[4,6],contain:[2,8,9],container_nam:9,content:1,contrast:2,contribut:4,contributor:4,control:[2,8,9],copi:[8,9],cordon:[],core:[0,6],coredn:6,corefil:9,coreo:2,correct:4,cors_allowed_origin:9,could:[0,4],coupl:[],coven:4,cover:[6,9],cpu:2,creat:[0,1,2,4,6,9,12],createadmin:1,creategatewai:1,createus:9,creation:0,credenti:9,critic:4,cross:12,cryptocurr:0,curl:[8,9],current:[2,9],custom:[6,9],customiz:9,cycl:[1,2],daemon:2,data:[0,2,9],databas:2,date:1,dbadminanydatabas:9,dbu:9,debian:[2,9],decis:6,decod:[2,8],deem:4,defaultkeepal:8,defin:4,delet:[1,8],deletegatewai:1,depend:[2,9],depends_on:9,deploi:[2,6,9],deploy:[2,9],derogatori:4,descript:[],design:[2,6],desktop:2,detail:[1,2,4,6,8,9],determin:[4,9],dev:9,develop:2,devic:[0,2,6,8],diabl:9,diagram:2,differ:[0,2,4,8,9,12],direct:[],directli:[0,1,2,9],directori:9,disabl:[2,4],disable_remote_ip_check:9,disableremoteipcheck:9,discord:10,discuss:9,displai:8,displaynam:1,distribut:2,distributionshav:2,dns:[2,9],dns_mode:9,dnsconfig:9,dnsmode:9,dnsstublisten:9,doc:[8,9],docker:[2,6,8],document:[0,2,3,8,9],doe:[2,6,9],doing:0,domain:9,don:[2,12],doubl:2,down:[0,8],download:[8,9],dual:6,dynam:[0,2,6],each:[0,2,8,9],easier:[2,9],easiest:2,easili:[0,9],echo:8,edg:[],edit:4,effect:8,effici:2,either:2,electron:4,email:10,empathi:4,enabl:[2,8],encod:8,encompass:0,encount:2,encrypt:[0,2],end:[2,9],endpoint:[1,2],enforc:6,enhanc:6,enough:8,enter:8,entir:[2,8],entireti:2,entri:[],env:[1,9],environ:[0,1,2,4,9],equal:9,equival:9,escal:9,especi:9,etc:[8,9],eth0:1,ethnic:4,even:[0,2,9],event:4,everi:[2,8],everyon:4,everyth:2,evolv:2,examin:8,exampl:[2,4,6],except:9,exist:[0,2,8,9],expect:[4,6],experi:4,explain:[2,6,9],explicit:4,explicitli:9,expos:2,express:4,extens:2,extern:[2,6,8],face:4,fact:0,fail:8,fair:4,fairli:2,faith:4,fals:9,familiar:[0,2],faq:6,fast:[2,6],faster:[0,2],featur:[6,8],feature_v0:[],fedora:2,few:9,field:8,figur:12,file:2,filenam:1,find:[2,12],fine:0,firewal:9,first:[2,8,12],fit:12,flag:9,flat:0,flexibl:[0,2],flow:2,focus:4,folder:2,follow:[4,8,9],fork:6,foster:4,found:[0,2,7,8],free:4,freeli:7,from:[0,1,2,4,8,9,12],front:[2,9],full:[0,2],fulli:[0,2,9],fundament:9,further:4,futur:[2,8,9],gatewai:[1,2,9,12],gender:4,gener:[1,2,9],generate_config_j:9,get:[1,6,8,9,12],github:[2,6,9,10],githubusercont:[8,9],give:[2,8,9],given:[0,2,8],goal:[],goe:0,going:8,golang:2,good:[4,12],googl:9,gracefulli:4,grade:2,gravitl:[4,8,9,10],grpc:[2,8,9],grpc_port:9,grpchost:9,grpcport:9,guid:[0,2,8,9],hand:6,handl:0,harass:4,harm:4,has:[0,2,9,12],hasadmin:1,have:[0,2,4,8,9,12],header:1,heavi:2,heaviest:2,heavili:2,help:[1,2,6,9,10,12],here:[2,4,7,8,9,12],high:2,hold:[0,2],home:[0,2],homenet:[],host:[2,8,9],host_ip:[8,9],hous:1,how:[2,3,6,9],howev:[1,2,8,9],html:9,http:[1,8,9,10],http_port:9,hub:[0,2],iOS:[],icon:[],idea:[],ident:4,imag:9,imageri:4,impact:2,inappropri:4,incid:4,includ:[2,4,6,9],inclus:4,incompat:2,incorrect:9,increas:[2,9],individu:[4,9],industri:2,info:[2,4,9,10],inform:[2,4,8],insert:[8,9],instal:[0,2],instanc:[1,2,4,8,9],instead:[0,8],instruct:[8,9],insult:4,interact:[0,2],interest:4,interfac:[1,9],internet:[0,2],intro:12,introduc:2,introduct:6,invalid:8,investig:4,invis:2,iot:[0,2],iphon:2,ipsec:2,ipv4:[],ipv6:6,issu:[4,6,9],its:[0,2,4,8,9],itself:2,join:8,journalctl:9,json:1,just:[0,2,8,9],jwt:1,keep:[1,9],kei:[2,9],kernel:[0,2,9],keynam:1,keyupd:1,know:12,known:2,krckbjhwwdk:[],kubernet:[0,6],lack:9,languag:4,laptop1:1,larg:2,last:1,lastmodifi:1,latenc:2,later:[2,9],latest:[2,9],launch:[],layer:0,layout:2,leadership:4,learn:8,least:0,left:9,less:2,let:[0,12],level:[2,4,9],lighter:2,lightweight:2,like:[0,2,8,9],limit:[6,9],line:2,link:[6,9],linux:[2,6,8],list:[0,2,9],listenport:1,littl:2,load:[2,9],local:[2,6,8,9],localaddress:1,localhost:1,locat:[0,2,9],login:[8,9],lose:[],lot:2,lxc:9,mac:9,macaddress:1,machin:[0,2,3,8,9],maco:[],made:[0,2],mai:[1,2,4,8,9],mail:4,main:9,mainfram:9,maintain:4,make:[0,2,4,8,9],manag:[0,2,6,9,12],mandatori:9,mani:[0,2,9,12],manual:[2,8],map:9,master:[8,9],master_kei:9,masterkei:[1,9],match:9,mean:[2,9],meant:[],media:4,member:[4,12],memori:2,mesh:[0,12],meshclient:1,metal:2,method:[1,2,8],mgmt:1,might:[0,2,9],mind:9,mint:2,minu:9,miss:2,mode:[2,6,8],model:[0,2],modif:9,modifi:[1,2,8,9],mongo:9,mongo_admin:9,mongo_host:9,mongo_initdb_root_password:9,mongo_initdb_root_usernam:9,mongo_opt:9,mongo_pass:9,mongo_port:9,mongoadmin:9,mongoconn:9,mongodb:[],mongopass:9,mongovol:9,more:[0,1,2,6,8,9],most:[1,2,9],mostli:2,mount:9,much:[0,2],multipl:[0,8,9],must:[1,2,8,9],mykei:[1,8],mynet:8,name:[1,8,9],nameserv:[2,9],nat:2,nation:4,nativ:[],navig:8,nebula:0,necessari:[4,8,9],need:[0,1,2,8,9,10],neighborhood:0,neither:2,net_admin:9,netclient:[0,6,9],netid:1,netmak:[1,3,7,9],network:[0,3,6,8,9],network_mod:9,networknam:[],next:8,nginx:[2,9],noclient:9,node:[6,9],nodn:9,non:[2,3,9],none:0,noonewillguessthi:1,note:[1,6],notifi:2,now:[0,8,9],number:[2,8,9],oblig:4,obtain:1,off:[2,9],offens:4,offic:[0,12],offici:[1,4,8],offlin:4,onc:8,one:[2,8,9],onli:[1,2,8],onlin:4,onto:9,open:[2,4,9,10],openvpn:2,oper:[2,9],opt:9,option:[2,6],order:2,orient:4,origin:9,other:[0,2,4,8,9],otherwis:[0,4],our:[6,9],out:[0,2,8,9,12],outlin:[2,9],output:8,outsid:[],over:[0,2],overlai:[0,6],overrid:9,overridden:[2,9],overview:[2,6,12],overwhelm:12,own:2,pair:[2,9],pane:8,part:[2,3,9],partial:2,particip:4,particular:2,pass:[2,9],password:[1,8,9],path:[1,9],peer:[2,12],pencil:[],pend:[1,8],perform:[1,2,9],period:2,perman:4,permiss:[4,8],permit:8,persistenkeepal:8,person:4,perspect:[0,2],phone:2,physic:4,pick:[2,8],pictur:2,pidof:8,ping:8,place:9,plan:9,platform:[2,6],pleas:8,pledg:6,point:2,polici:4,polit:4,popul:9,popup:[],port:[2,8,9],posit:4,possibl:[2,6,8],post:[1,2,4],postfix:[],practic:2,pre:[8,9],preced:2,prefer:9,prepar:[],prereq:[],prereqisit:6,prerequisit:[6,9],present:8,previou:2,primari:9,privat:[2,4,6,8,9,12],privateapi:[],privileg:9,probabl:0,problem:9,proce:9,process:[6,8,9],product:9,profession:4,project:[1,4,6],proof:0,provid:[0,2,9],publickei:1,publish:[4,7],pull:2,pure:6,put:1,pwd:9,pwlpt320ybo:[],quick:9,quickli:[6,8],race:4,rang:8,rangestr:1,rapidli:2,raspian:2,raw:[8,9],reach:[0,2],reachabl:[2,8,9],reactj:2,read:9,readi:[],readwriteanydatabas:9,realli:[],reallysecret:1,reason:[2,4,9],reccommend:9,recent:2,reciev:[1,2],recommend:[1,9],reconfigur:2,reduc:2,refer:[2,8],regard:[2,4],regardless:4,regist:2,reiter:2,reject:4,rel:2,relai:[2,9],releas:[2,9],reli:[0,2],relianc:2,religion:4,remot:[0,9],remov:[1,2,4,8,9],removenetwork:1,repeat:8,repercuss:4,replac:[2,9],repo:[],report:[2,4],repositori:[2,7],repres:4,represent:4,request:[1,2,9],requir:[1,2,8,9],resolv:[2,9],resolvectl:9,respect:4,respons:[2,6],rest:9,rest_backend:9,restart:9,restbackend:9,restrict:9,result:4,retriev:[0,1,2,8],review:4,rhel:2,right:[0,4],role:9,root:[8,9],rout:[0,2],router:2,run:[0,1,2,6,8,9],runtim:9,said:2,same:[0,8,9],sampl:0,save:8,scenario:[8,9],scope:6,screen:8,script:[2,8,9],second:8,secret:[1,8],secretkei:9,section:[8,9],secur:[0,1,2,6],sed:[8,9],see:[1,2,8,9],select:[8,12],send:[2,9],sens:2,sensibl:[0,2,8],separ:[2,4,9,12],serv:[2,9],server:[0,7,8],server_api_host:9,server_grpc_host:9,server_host:9,server_http_host:9,servic:[2,9],set:[1,2,4,8,9,12],setup:[0,6],sever:[2,9],sexual:4,sfl:[8,9],share:9,ship:8,should:[0,1,2,6,8,9],show:[4,8,9],side:[7,9],sign:[2,8],signific:2,signigif:2,signup:2,similar:[0,8,9],simpl:[2,8,9],simplest:2,simpli:[2,8],simultan:0,sinc:9,singl:[1,9],site:[0,6,9],situat:2,size:4,skynet:1,slim:8,slow:0,small:2,smartgui:1,snap:[],social:4,solut:2,solv:9,some:[1,2,9,12],someth:8,somewher:8,soon:[6,9],sort:[0,2],sourc:[2,6,7],space:4,special:[2,8,9],specif:[2,4,9],specifi:9,speed:[0,2],spoke:[0,2],spread:0,sql:2,ssh:8,sspl:7,stack:6,stake:0,standard:[2,6,8,9],start:[9,12],startup:[1,8],state:8,statement:6,statu:9,step:[2,8,9],still:[0,9],stop:9,store:[2,9],string:8,structur:2,submit:[6,8],subnet:2,substanti:[0,9],success:2,sudo:[8,9],support:[2,9],sure:9,suse:2,swagger:6,sys:9,sys_modul:9,system:[6,8],system_bus_socket:9,systemctl:9,systemd:[8,9],tab:8,tailscal:0,take:[0,1,2,4,8,9],talk:[0,2],team:4,technic:[0,6],technolog:2,tell:[0,2,3],temporari:4,temporarili:4,test:[6,8,9],than:2,thei:[0,2,4,9],them:[2,8,9],themselv:2,thhe:9,thi:[0,1,2,3,4,6,7,8,9],thing:[0,2,9],think:12,those:[0,2,9],though:9,thousand:0,threaten:4,three:8,through:2,ticket:10,time:[1,2,8,12],timer:2,timestamp:2,tld:[],toggl:[],token:8,tool:0,top:2,topic:12,topolog:2,toward:4,traffic:[0,2,9],transact:2,treat:2,tree:[],tricki:2,troll:4,troubleshoot:[1,8],tunnel:[0,2],turn:[2,9],tutori:6,two:[0,1,2,9],type:1,typic:[0,2,8],ubuntu:[2,6],udp:9,unabl:2,unaccept:4,uncom:9,uncordon:1,under:[7,8,9],underlai:[0,12],underli:9,understand:9,underwai:[],uninstal:6,uninstral:6,unix:[2,9],unless:9,unmanag:6,unnecessari:[],unset:[8,9],until:8,unwelcom:4,unzip:9,updat:[1,2,8],upon:2,upper:[],url:9,usag:[6,9,12],use:[0,1,2,4,6,8,9,12],used:[1,2,8,9],useful:9,user:[2,8,9],useradminanydatabas:9,usernam:[1,8,9],uses:[0,1,2,8,9],using:[0,1,2,4,6,12],usr:9,util:[],valid:2,valu:[1,2,8,9],vari:9,variabl:2,variou:[6,9],veri:[0,2],verifi:2,version:[2,4,7,9],via:[1,2,4,9,12],video:[],view:8,viewpoint:4,vim:9,virtual:[0,6,12],visibl:8,vm3ow4thatogiwnsla3thsl3894th:8,volum:[8,9],vpc:0,vpn:[2,12],wai:9,want:[0,2,8,9],web:9,webserv:2,websit:2,weight:2,welcom:4,well:[2,3,6,8],wget:[8,9],what:[2,4,6],whatev:9,when:[2,4,9],where:[2,6,8,9,12],wherev:0,whether:[0,9],which:[0,2,4,7,8,9],who:4,why:[2,6],wide:2,wider:2,wiki:4,window:[2,9],wireguard:[0,6,8,9],wish:9,within:[2,4],without:[1,2,4,6,8],work:[2,6],workstat:8,world:[0,2],wors:2,worth:2,would:[0,8,9],write:[2,9],www:9,yaml:[1,9],yml:[8,9],you:[0,1,2,3,6,8,9,10,12],your:[0,1,2,8,9,12],your_pass:1,your_password:1,your_secret_kei:1,youtu:[],zeroti:0,zip:9,zrb9vfhk8a:10},titles:["About","API Reference","Architecture","Client Installation","Code of Conduct","Contribute","Welcome to the Netmaker Documentation","License","Quick Start","Server Installation","Support","Troubleshooting","Using Netmaker"],titleterms:{"case":0,"default":[],DNS:9,Use:0,Using:12,about:[0,6],access:1,agent:11,annot:9,api:[1,6],architectur:[2,6],attribut:4,authent:1,basic:12,build:5,call:1,client:[3,6,9],code:[4,5,6],common:11,compat:[2,3,9],compon:2,compos:9,concept:2,conduct:[4,6],config:9,configur:9,contact:10,contribut:[5,6],core:2,coredn:[2,9,11],creat:8,curl:1,custom:3,deploi:8,descript:9,disabl:9,docker:[3,9],document:[1,6],doe:0,dual:12,enabl:9,enforc:4,enhanc:5,environ:[],examin:[],exampl:1,extern:12,faq:10,featur:9,file:[1,9],fork:5,format:1,full:9,guid:6,how:0,instal:[3,6,8,9],introduct:8,ipv6:12,issu:[5,11],kei:[1,8],kubernet:[3,9,12],licens:[6,7],limit:2,linux:[3,9],local:12,manag:[1,8],mesh:2,mode:9,mongodb:[2,9],netclient:[2,3,8],netmak:[0,2,6,8,12],network:[1,2,12],node:[1,2,8,12],note:9,onli:9,option:9,our:4,pledg:4,prereqisit:9,prerequisit:[3,8],process:2,pure:3,quick:[6,8],refer:[1,6,9],respons:4,scope:4,server:[1,2,6,9,11],setup:[8,9],site:12,slim:9,stack:12,standard:4,start:[6,8],submit:5,support:[6,10],system:[2,3,9],systemd:2,technic:2,test:5,troubleshoot:[6,11],tutori:12,ubuntu:9,uninstal:8,uninstral:8,unmanag:3,usag:1,user:1,variabl:9,video:12,welcom:6,what:0,wireguard:[2,3],without:9,work:0,written:12,your:3}}) \ No newline at end of file diff --git a/docs/_build/html/server-installation.html b/docs/_build/html/server-installation.html index dddebf34..2842c41e 100644 --- a/docs/_build/html/server-installation.html +++ b/docs/_build/html/server-installation.html @@ -812,7 +812,21 @@

DNS Mode Prereqisite Setup (Ubuntu)

-

If you plan on running the

+

If you plan on running the server in DNS Mode, you will be deploying a CoreDNS server. We recommend binding CoreDNS to port 53 of the host system (which it will do by default). On some systems, this will conflift with existing processes. Specifically on linux systems running systemd-resolved, there may be a service consuming port 53. The below steps will disable systemd-resolved, and replace it with a generic (e.g. Google) nameserver. The following was tested on Ubuntu 20.04. This may have consequences for existing private DNS so proceed with caution:

+
    +
  1. systemctl stop systemd-resolved

  2. +
  3. systemctl disable systemd-resolved

  4. +
  5. +
    vim /etc/systemd/resolved.conf
      +
    • uncomment DNS and add 8.8.8.8 or whatever reachable nameserver is your preference

    • +
    • uncomment DNSStubListener and set to “no”

    • +
    +
    +
    +
  6. +
  7. sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf

  8. +
+

Port 53 should now be available for CoreDNS to use.

Docker Compose Install

diff --git a/docs/server-installation.rst b/docs/server-installation.rst index c186e729..16a8af4e 100644 --- a/docs/server-installation.rst +++ b/docs/server-installation.rst @@ -36,8 +36,16 @@ To run a non-docker installation, you are running the Netmaker binary, CoreDNS b DNS Mode Prereqisite Setup (Ubuntu) ==================================== -If you plan on running the +If you plan on running the server in DNS Mode, you will be deploying a CoreDNS server. We recommend binding CoreDNS to port 53 of the host system (which it will do by default). On some systems, this will conflift with existing processes. Specifically on linux systems running systemd-resolved, there may be a service consuming port 53. The below steps will disable systemd-resolved, and replace it with a generic (e.g. Google) nameserver. The following was tested on Ubuntu 20.04. This may have consequences for existing private DNS so proceed with caution: +1. systemctl stop systemd-resolved +2. systemctl disable systemd-resolved +3. vim /etc/systemd/resolved.conf + * uncomment DNS and add 8.8.8.8 or whatever reachable nameserver is your preference + * uncomment DNSStubListener and set to "no" +4. sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf + +Port 53 should now be available for CoreDNS to use. Docker Compose Install =======================