2
0

index.html 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width,initial-scale=1">
  7. <meta http-equiv="x-ua-compatible" content="ie=edge">
  8. <meta name="lang:clipboard.copy" content="Copy to clipboard">
  9. <meta name="lang:clipboard.copied" content="Copied to clipboard">
  10. <meta name="lang:search.language" content="en">
  11. <meta name="lang:search.pipeline.stopwords" content="True">
  12. <meta name="lang:search.pipeline.trimmer" content="True">
  13. <meta name="lang:search.result.none" content="No matching documents">
  14. <meta name="lang:search.result.one" content="1 matching document">
  15. <meta name="lang:search.result.other" content="# matching documents">
  16. <meta name="lang:search.tokenizer" content="[\s\-]+">
  17. <link href="https://fonts.gstatic.com/" rel="preconnect" crossorigin>
  18. <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel="stylesheet">
  19. <style>
  20. body,
  21. input {
  22. font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif
  23. }
  24. code,
  25. kbd,
  26. pre {
  27. font-family: "Roboto Mono", "Courier New", Courier, monospace
  28. }
  29. </style>
  30. <link rel="stylesheet" href="_static/stylesheets/application.css"/>
  31. <link rel="stylesheet" href="_static/stylesheets/application-palette.css"/>
  32. <link rel="stylesheet" href="_static/stylesheets/application-fixes.css"/>
  33. <link rel="stylesheet" href="_static/fonts/material-icons.css"/>
  34. <meta name="theme-color" content="#3f51b5">
  35. <script src="_static/javascripts/modernizr.js"></script>
  36. <title>Welcome to the Netmaker Documentation &#8212; Netmaker 0.9.0 documentation</title>
  37. <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  38. <link rel="stylesheet" type="text/css" href="_static/material.css" />
  39. <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
  40. <script src="_static/jquery.js"></script>
  41. <script src="_static/underscore.js"></script>
  42. <script src="_static/doctools.js"></script>
  43. <link rel="author" title="About these documents" href="about.html" />
  44. <link rel="index" title="Index" href="genindex.html" />
  45. <link rel="search" title="Search" href="search.html" />
  46. <link rel="next" title="About" href="about.html" />
  47. </head>
  48. <body dir=ltr
  49. data-md-color-primary=indigo data-md-color-accent=light-blue>
  50. <svg class="md-svg">
  51. <defs data-children-count="0">
  52. <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
  53. </defs>
  54. </svg>
  55. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer">
  56. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search">
  57. <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  58. <a href="#index" tabindex="1" class="md-skip"> Skip to content </a>
  59. <header class="md-header" data-md-component="header">
  60. <nav class="md-header-nav md-grid">
  61. <div class="md-flex navheader">
  62. <div class="md-flex__cell md-flex__cell--shrink">
  63. <a href="#" title="Netmaker 0.9.0 documentation"
  64. class="md-header-nav__button md-logo">
  65. <i class="md-icon">&#xe869</i>
  66. </a>
  67. </div>
  68. <div class="md-flex__cell md-flex__cell--shrink">
  69. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  70. </div>
  71. <div class="md-flex__cell md-flex__cell--stretch">
  72. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  73. <span class="md-header-nav__topic">Netmaker Docs</span>
  74. <span class="md-header-nav__topic"> Welcome to the Netmaker Documentation </span>
  75. </div>
  76. </div>
  77. <div class="md-flex__cell md-flex__cell--shrink">
  78. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  79. <div class="md-search" data-md-component="search" role="dialog">
  80. <label class="md-search__overlay" for="__search"></label>
  81. <div class="md-search__inner" role="search">
  82. <form class="md-search__form" action="search.html" method="get" name="search">
  83. <input type="text" class="md-search__input" name="q" placeholder="Search"
  84. autocapitalize="off" autocomplete="off" spellcheck="false"
  85. data-md-component="query" data-md-state="active">
  86. <label class="md-icon md-search__icon" for="__search"></label>
  87. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  88. &#xE5CD;
  89. </button>
  90. </form>
  91. <div class="md-search__output">
  92. <div class="md-search__scrollwrap" data-md-scrollfix>
  93. <div class="md-search-result" data-md-component="result">
  94. <div class="md-search-result__meta">
  95. Type to start searching
  96. </div>
  97. <ol class="md-search-result__list"></ol>
  98. </div>
  99. </div>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. <div class="md-flex__cell md-flex__cell--shrink">
  105. <div class="md-header-nav__source">
  106. <a href="https://github.com/gravitl/netmaker/" title="Go to repository" class="md-source" data-md-source="github">
  107. <div class="md-source__icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width="28" height="28">
  109. <use xlink:href="#__github" width="24" height="24"></use>
  110. </svg>
  111. </div>
  112. <div class="md-source__repository">
  113. Netmaker
  114. </div>
  115. </a>
  116. </div>
  117. </div>
  118. <script src="_static/javascripts/version_dropdown.js"></script>
  119. <script>
  120. var json_loc = ""versions.json"",
  121. target_loc = "../",
  122. text = "Versions";
  123. $( document ).ready( add_version_dropdown(json_loc, target_loc, text));
  124. </script>
  125. </div>
  126. </nav>
  127. </header>
  128. <div class="md-container">
  129. <nav class="md-tabs" data-md-component="tabs">
  130. <div class="md-tabs__inner md-grid">
  131. <ul class="md-tabs__list">
  132. <li class="md-tabs__item"><a href="#" class="md-tabs__link">Netmaker 0.9.0 documentation</a></li>
  133. </ul>
  134. </div>
  135. </nav>
  136. <main class="md-main">
  137. <div class="md-main__inner md-grid" data-md-component="container">
  138. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  139. <div class="md-sidebar__scrollwrap">
  140. <div class="md-sidebar__inner">
  141. <nav class="md-nav md-nav--primary" data-md-level="0">
  142. <label class="md-nav__title md-nav__title--site" for="__drawer">
  143. <a href="#" title="Netmaker 0.9.0 documentation" class="md-nav__button md-logo">
  144. <i class="md-icon">&#xe869</i>
  145. </a>
  146. <a href="#"
  147. title="Netmaker 0.9.0 documentation">Netmaker Docs</a>
  148. </label>
  149. <div class="md-nav__source">
  150. <a href="https://github.com/gravitl/netmaker/" title="Go to repository" class="md-source" data-md-source="github">
  151. <div class="md-source__icon">
  152. <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width="28" height="28">
  153. <use xlink:href="#__github" width="24" height="24"></use>
  154. </svg>
  155. </div>
  156. <div class="md-source__repository">
  157. Netmaker
  158. </div>
  159. </a>
  160. </div>
  161. <ul class="md-nav__list">
  162. <li class="md-nav__item">
  163. <a href="about.html" class="md-nav__link">About</a>
  164. <ul class="md-nav__list">
  165. <li class="md-nav__item">
  166. <a href="about.html#what-is-netmaker" class="md-nav__link">What is Netmaker?</a>
  167. </li>
  168. <li class="md-nav__item">
  169. <a href="about.html#how-does-netmaker-work" class="md-nav__link">How Does Netmaker Work?</a>
  170. </li>
  171. <li class="md-nav__item">
  172. <a href="about.html#use-cases-for-netmaker" class="md-nav__link">Use Cases for Netmaker</a>
  173. </li></ul>
  174. </li>
  175. <li class="md-nav__item">
  176. <a href="architecture.html" class="md-nav__link">Architecture</a>
  177. <ul class="md-nav__list">
  178. <li class="md-nav__item">
  179. <a href="architecture.html#core-concepts" class="md-nav__link">Core Concepts</a>
  180. </li>
  181. <li class="md-nav__item">
  182. <a href="architecture.html#components" class="md-nav__link">Components</a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="architecture.html#technical-process" class="md-nav__link">Technical Process</a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="architecture.html#compatible-systems-for-netclient" class="md-nav__link">Compatible Systems for Netclient</a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="architecture.html#limitations" class="md-nav__link">Limitations</a>
  192. </li></ul>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="install.html" class="md-nav__link">Install</a>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="quick-start.html" class="md-nav__link">Quick Install</a>
  199. <ul class="md-nav__list">
  200. <li class="md-nav__item">
  201. <a href="quick-start.html#introduction" class="md-nav__link">Introduction</a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="quick-start.html#prerequisites" class="md-nav__link">0. Prerequisites</a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="quick-start.html#prepare-dns" class="md-nav__link">1. Prepare DNS</a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="quick-start.html#install-dependencies" class="md-nav__link">2. Install Dependencies</a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="quick-start.html#open-firewall" class="md-nav__link">3. Open Firewall</a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="quick-start.html#install-netmaker" class="md-nav__link">4. Install Netmaker</a>
  217. </li></ul>
  218. </li>
  219. <li class="md-nav__item">
  220. <a href="getting-started.html" class="md-nav__link">Getting Started</a>
  221. <ul class="md-nav__list">
  222. <li class="md-nav__item">
  223. <a href="getting-started.html#setup" class="md-nav__link">Setup</a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="getting-started.html#create-a-network" class="md-nav__link">Create a Network</a>
  227. </li>
  228. <li class="md-nav__item">
  229. <a href="getting-started.html#create-a-key" class="md-nav__link">Create a Key</a>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="getting-started.html#deploy-nodes" class="md-nav__link">Deploy Nodes</a>
  233. </li>
  234. <li class="md-nav__item">
  235. <a href="getting-started.html#manage-nodes" class="md-nav__link">Manage Nodes</a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="getting-started.html#uninstalling-the-netclient" class="md-nav__link">Uninstalling the netclient</a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="getting-started.html#uninstalling-netmaker" class="md-nav__link">Uninstalling Netmaker</a>
  242. </li></ul>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="quick-start-nginx.html" class="md-nav__link">Install with Nginx (depreciated)</a>
  246. <ul class="md-nav__list">
  247. <li class="md-nav__item">
  248. <a href="quick-start-nginx.html#introduction" class="md-nav__link">0. Introduction</a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="quick-start-nginx.html#prerequisites" class="md-nav__link">1. Prerequisites</a>
  252. </li>
  253. <li class="md-nav__item">
  254. <a href="quick-start-nginx.html#install-dependencies" class="md-nav__link">2. Install Dependencies</a>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="quick-start-nginx.html#prepare-vm" class="md-nav__link">3. Prepare VM</a>
  258. </li>
  259. <li class="md-nav__item">
  260. <a href="quick-start-nginx.html#install-netmaker" class="md-nav__link">4. Install Netmaker</a>
  261. </li></ul>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
  265. <ul class="md-nav__list">
  266. <li class="md-nav__item">
  267. <a href="server-installation.html#system-compatibility" class="md-nav__link">System Compatibility</a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="server-installation.html#server-configuration-reference" class="md-nav__link">Server Configuration Reference</a>
  271. </li>
  272. <li class="md-nav__item">
  273. <a href="server-installation.html#dns-mode-setup" class="md-nav__link">DNS Mode Setup</a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="server-installation.html#docker-compose-install" class="md-nav__link">Docker Compose Install</a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="server-installation.html#linux-install-without-docker" class="md-nav__link">Linux Install without Docker</a>
  280. </li>
  281. <li class="md-nav__item">
  282. <a href="server-installation.html#kubernetes-install" class="md-nav__link">Kubernetes Install</a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="server-installation.html#nginx-reverse-proxy-setup-with-https" class="md-nav__link">Nginx Reverse Proxy Setup with https</a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="server-installation.html#highly-available-installation-kubernetes" class="md-nav__link">Highly Available Installation (Kubernetes)</a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="server-installation.html#highly-available-installation-vms-bare-metal" class="md-nav__link">Highly Available Installation (VMs/Bare Metal)</a>
  292. </li></ul>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
  296. <ul class="md-nav__list">
  297. <li class="md-nav__item">
  298. <a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="oauth.html#configuring-your-provider" class="md-nav__link">Configuring your provider</a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="oauth.html#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a>
  305. </li>
  306. <li class="md-nav__item">
  307. <a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
  308. </li></ul>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="client-installation.html" class="md-nav__link">Client Installation</a>
  312. <ul class="md-nav__list">
  313. <li class="md-nav__item">
  314. <a href="client-installation.html#introduction-to-netclient" class="md-nav__link">Introduction to Netclient</a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="client-installation.html#notes-on-windows" class="md-nav__link">Notes on Windows</a>
  318. </li>
  319. <li class="md-nav__item">
  320. <a href="client-installation.html#modes-and-system-compatibility" class="md-nav__link">Modes and System Compatibility</a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="client-installation.html#prerequisites" class="md-nav__link">Prerequisites</a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="client-installation.html#configuration" class="md-nav__link">Configuration</a>
  327. </li>
  328. <li class="md-nav__item">
  329. <a href="client-installation.html#installation" class="md-nav__link">Installation</a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="client-installation.html#managing-netclient" class="md-nav__link">Managing Netclient</a>
  333. </li></ul>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="external-clients.html" class="md-nav__link">External Clients</a>
  337. <ul class="md-nav__list">
  338. <li class="md-nav__item">
  339. <a href="external-clients.html#introduction" class="md-nav__link">Introduction</a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="external-clients.html#configuring-an-ingress-gateway" class="md-nav__link">Configuring an Ingress Gateway</a>
  343. </li>
  344. <li class="md-nav__item">
  345. <a href="external-clients.html#adding-clients-to-a-gateway" class="md-nav__link">Adding Clients to a Gateway</a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="external-clients.html#configuring-dns-for-ext-clients-optional" class="md-nav__link">Configuring DNS for Ext Clients (OPTIONAL)</a>
  349. </li></ul>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="usage.html" class="md-nav__link">Using Netmaker</a>
  353. <ul class="md-nav__list">
  354. <li class="md-nav__item">
  355. <a href="usage.html#external-tutorials" class="md-nav__link">External Tutorials</a>
  356. </li></ul>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="api.html" class="md-nav__link">API Reference</a>
  360. <ul class="md-nav__list">
  361. <li class="md-nav__item">
  362. <a href="api.html#api-usage" class="md-nav__link">API Usage</a>
  363. </li>
  364. <li class="md-nav__item">
  365. <a href="api.html#authentication" class="md-nav__link">Authentication</a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="api.html#format-of-calls-for-curl" class="md-nav__link">Format of Calls for Curl</a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="api.html#api-documentation" class="md-nav__link">API Documentation</a>
  372. </li></ul>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="troubleshoot.html" class="md-nav__link">Troubleshooting</a>
  376. <ul class="md-nav__list">
  377. <li class="md-nav__item">
  378. <a href="troubleshoot.html#common-issues" class="md-nav__link">Common Issues</a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="troubleshoot.html#server" class="md-nav__link">Server</a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="troubleshoot.html#ui" class="md-nav__link">UI</a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="troubleshoot.html#netclient" class="md-nav__link">Netclient</a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="troubleshoot.html#coredns" class="md-nav__link">CoreDNS</a>
  391. </li></ul>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="support.html" class="md-nav__link">Support</a>
  395. <ul class="md-nav__list">
  396. <li class="md-nav__item">
  397. <a href="support.html#faq" class="md-nav__link">FAQ</a>
  398. </li>
  399. <li class="md-nav__item">
  400. <a href="support.html#contact" class="md-nav__link">Contact</a>
  401. </li></ul>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="conduct.html" class="md-nav__link">Code of Conduct</a>
  405. <ul class="md-nav__list">
  406. <li class="md-nav__item">
  407. <a href="conduct.html#our-pledge" class="md-nav__link">Our Pledge</a>
  408. </li>
  409. <li class="md-nav__item">
  410. <a href="conduct.html#our-standards" class="md-nav__link">Our Standards</a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="conduct.html#our-responsibilities" class="md-nav__link">Our Responsibilities</a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="conduct.html#scope" class="md-nav__link">Scope</a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="conduct.html#enforcement" class="md-nav__link">Enforcement</a>
  420. </li>
  421. <li class="md-nav__item">
  422. <a href="conduct.html#attribution" class="md-nav__link">Attribution</a>
  423. </li></ul>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="license.html" class="md-nav__link">License</a>
  427. </li>
  428. </ul>
  429. </nav>
  430. </div>
  431. </div>
  432. </div>
  433. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  434. <div class="md-sidebar__scrollwrap">
  435. <div class="md-sidebar__inner">
  436. <nav class="md-nav md-nav--secondary">
  437. <label class="md-nav__title" for="__toc">Contents</label>
  438. <ul class="md-nav__list" data-md-scrollfix="">
  439. <li class="md-nav__item"><a href="#index--page-root" class="md-nav__link">Welcome to the Netmaker Documentation</a><nav class="md-nav">
  440. <ul class="md-nav__list">
  441. <li class="md-nav__item"><a href="#about" class="md-nav__link">About</a>
  442. </li>
  443. <li class="md-nav__item"><a href="#architecture" class="md-nav__link">Architecture</a>
  444. </li>
  445. <li class="md-nav__item"><a href="#install" class="md-nav__link">Install</a>
  446. </li>
  447. <li class="md-nav__item"><a href="#quick-start" class="md-nav__link">Quick Start</a>
  448. </li>
  449. <li class="md-nav__item"><a href="#quick-start-nginx-depreciated" class="md-nav__link">Quick Start Nginx (depreciated)</a>
  450. </li>
  451. <li class="md-nav__item"><a href="#server-installation" class="md-nav__link">Server Installation</a>
  452. </li>
  453. <li class="md-nav__item"><a href="#oauth-configuration" class="md-nav__link">Oauth Configuration</a>
  454. </li>
  455. <li class="md-nav__item"><a href="#client-installation" class="md-nav__link">Client Installation</a>
  456. </li>
  457. <li class="md-nav__item"><a href="#external-clients" class="md-nav__link">External Clients</a>
  458. </li>
  459. <li class="md-nav__item"><a href="#guides" class="md-nav__link">Guides</a>
  460. </li>
  461. <li class="md-nav__item"><a href="#api-reference" class="md-nav__link">API Reference</a>
  462. </li>
  463. <li class="md-nav__item"><a href="#troubleshooting" class="md-nav__link">Troubleshooting</a>
  464. </li>
  465. <li class="md-nav__item"><a href="#support" class="md-nav__link">Support</a>
  466. </li>
  467. <li class="md-nav__item"><a href="#code-of-conduct" class="md-nav__link">Code of Conduct</a>
  468. </li>
  469. <li class="md-nav__item"><a href="#licensing" class="md-nav__link">Licensing</a>
  470. </li></ul>
  471. </nav>
  472. </li>
  473. </ul>
  474. </nav>
  475. </div>
  476. </div>
  477. </div>
  478. <div class="md-content">
  479. <article class="md-content__inner md-typeset" role="main">
  480. <a class="reference internal image-reference" href="_images/netmaker.png"><img alt="Netmaker WireGuard" class="align-center" src="_images/netmaker.png" style="width: 100%;"/></a>
  481. <p><span class="raw-html"><br/></span></p>
  482. <h1 id="index--page-root">Welcome to the Netmaker Documentation<a class="headerlink" href="#index--page-root" title="Permalink to this headline">¶</a></h1>
  483. <p>Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.</p>
  484. <p>This documentation covers Netmaker’s <a class="reference internal" href="server-installation.html"><span class="doc">installation</span></a>, <a class="reference internal" href="usage.html"><span class="doc">usage</span></a>, <a class="reference internal" href="support.html"><span class="doc">troubleshooting</span></a>, and customization, as well as reference documents for the <a class="reference internal" href="api.html"><span class="doc">API</span></a>, UI and Agent configuration. All of the <a class="reference external" href="https://github.com/gravitl/netmaker">source code</a> for Netmaker is on GitHub.</p>
  485. <h2 id="about">About<a class="headerlink" href="#about" title="Permalink to this headline">¶</a></h2>
  486. <p>A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.</p>
  487. <div class="toctree-wrapper compound">
  488. <ul>
  489. <li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
  490. <li class="toctree-l2"><a class="reference internal" href="about.html#what-is-netmaker">What is Netmaker?</a></li>
  491. <li class="toctree-l2"><a class="reference internal" href="about.html#how-does-netmaker-work">How Does Netmaker Work?</a></li>
  492. <li class="toctree-l2"><a class="reference internal" href="about.html#use-cases-for-netmaker">Use Cases for Netmaker</a></li>
  493. </ul>
  494. </li>
  495. </ul>
  496. </div>
  497. <h2 id="architecture">Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h2>
  498. <p>A technical overview of Netmaker, including design decisions and limitations.</p>
  499. <div class="toctree-wrapper compound">
  500. <ul>
  501. <li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a><ul>
  502. <li class="toctree-l2"><a class="reference internal" href="architecture.html#core-concepts">Core Concepts</a></li>
  503. <li class="toctree-l2"><a class="reference internal" href="architecture.html#components">Components</a></li>
  504. <li class="toctree-l2"><a class="reference internal" href="architecture.html#technical-process">Technical Process</a></li>
  505. <li class="toctree-l2"><a class="reference internal" href="architecture.html#compatible-systems-for-netclient">Compatible Systems for Netclient</a></li>
  506. <li class="toctree-l2"><a class="reference internal" href="architecture.html#limitations">Limitations</a></li>
  507. </ul>
  508. </li>
  509. </ul>
  510. </div>
  511. <h2 id="install">Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
  512. <p>Choose the right install method for you.</p>
  513. <div class="toctree-wrapper compound">
  514. <ul>
  515. <li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
  516. </ul>
  517. </div>
  518. <h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2>
  519. <p>A quick start guide to getting up and running with Netmaker and WireGuard as quickly as possible.</p>
  520. <div class="toctree-wrapper compound">
  521. <ul>
  522. <li class="toctree-l1"><a class="reference internal" href="quick-start.html">Quick Install</a><ul>
  523. <li class="toctree-l2"><a class="reference internal" href="quick-start.html#introduction">Introduction</a></li>
  524. <li class="toctree-l2"><a class="reference internal" href="quick-start.html#prerequisites">0. Prerequisites</a></li>
  525. <li class="toctree-l2"><a class="reference internal" href="quick-start.html#prepare-dns">1. Prepare DNS</a></li>
  526. <li class="toctree-l2"><a class="reference internal" href="quick-start.html#install-dependencies">2. Install Dependencies</a></li>
  527. <li class="toctree-l2"><a class="reference internal" href="quick-start.html#open-firewall">3. Open Firewall</a></li>
  528. <li class="toctree-l2"><a class="reference internal" href="quick-start.html#install-netmaker">4. Install Netmaker</a></li>
  529. </ul>
  530. </li>
  531. </ul>
  532. </div>
  533. <div class="toctree-wrapper compound">
  534. <ul>
  535. <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a><ul>
  536. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#setup">Setup</a></li>
  537. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#create-a-network">Create a Network</a></li>
  538. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#create-a-key">Create a Key</a></li>
  539. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#deploy-nodes">Deploy Nodes</a></li>
  540. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#manage-nodes">Manage Nodes</a></li>
  541. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#uninstalling-the-netclient">Uninstalling the netclient</a></li>
  542. <li class="toctree-l2"><a class="reference internal" href="getting-started.html#uninstalling-netmaker">Uninstalling Netmaker</a></li>
  543. </ul>
  544. </li>
  545. </ul>
  546. </div>
  547. <h2 id="quick-start-nginx-depreciated">Quick Start Nginx (depreciated)<a class="headerlink" href="#quick-start-nginx-depreciated" title="Permalink to this headline">¶</a></h2>
  548. <p>An older guide to getting up and running with Netmaker using Nginx as quickly as possible.</p>
  549. <div class="toctree-wrapper compound">
  550. <ul>
  551. <li class="toctree-l1"><a class="reference internal" href="quick-start-nginx.html">Install with Nginx (depreciated)</a></li>
  552. </ul>
  553. </div>
  554. <h2 id="server-installation">Server Installation<a class="headerlink" href="#server-installation" title="Permalink to this headline">¶</a></h2>
  555. <p>A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.</p>
  556. <div class="toctree-wrapper compound">
  557. <ul>
  558. <li class="toctree-l1"><a class="reference internal" href="server-installation.html">Advanced Server Installation</a><ul>
  559. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#system-compatibility">System Compatibility</a></li>
  560. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#server-configuration-reference">Server Configuration Reference</a></li>
  561. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#dns-mode-setup">DNS Mode Setup</a></li>
  562. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#docker-compose-install">Docker Compose Install</a></li>
  563. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#linux-install-without-docker">Linux Install without Docker</a></li>
  564. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#kubernetes-install">Kubernetes Install</a></li>
  565. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#nginx-reverse-proxy-setup-with-https">Nginx Reverse Proxy Setup with https</a></li>
  566. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#highly-available-installation-kubernetes">Highly Available Installation (Kubernetes)</a></li>
  567. <li class="toctree-l2"><a class="reference internal" href="server-installation.html#highly-available-installation-vms-bare-metal">Highly Available Installation (VMs/Bare Metal)</a></li>
  568. </ul>
  569. </li>
  570. </ul>
  571. </div>
  572. <h2 id="oauth-configuration">Oauth Configuration<a class="headerlink" href="#oauth-configuration" title="Permalink to this headline">¶</a></h2>
  573. <p>A simple guide to configuring OAuth for Netmaker.</p>
  574. <div class="toctree-wrapper compound">
  575. <ul>
  576. <li class="toctree-l1"><a class="reference internal" href="oauth.html">Integrating OAuth</a><ul>
  577. <li class="toctree-l2"><a class="reference internal" href="oauth.html#introduction">Introduction</a></li>
  578. <li class="toctree-l2"><a class="reference internal" href="oauth.html#configuring-your-provider">Configuring your provider</a></li>
  579. <li class="toctree-l2"><a class="reference internal" href="oauth.html#configuring-netmaker">Configuring Netmaker</a></li>
  580. <li class="toctree-l2"><a class="reference internal" href="oauth.html#configuring-user-permissions">Configuring User Permissions</a></li>
  581. </ul>
  582. </li>
  583. </ul>
  584. </div>
  585. <h2 id="client-installation">Client Installation<a class="headerlink" href="#client-installation" title="Permalink to this headline">¶</a></h2>
  586. <p>A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.</p>
  587. <div class="toctree-wrapper compound">
  588. <ul>
  589. <li class="toctree-l1"><a class="reference internal" href="client-installation.html">Client Installation</a><ul>
  590. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#introduction-to-netclient">Introduction to Netclient</a></li>
  591. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#notes-on-windows">Notes on Windows</a></li>
  592. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#modes-and-system-compatibility">Modes and System Compatibility</a></li>
  593. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#prerequisites">Prerequisites</a></li>
  594. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#configuration">Configuration</a></li>
  595. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#installation">Installation</a></li>
  596. <li class="toctree-l2"><a class="reference internal" href="client-installation.html#managing-netclient">Managing Netclient</a></li>
  597. </ul>
  598. </li>
  599. </ul>
  600. </div>
  601. <h2 id="external-clients">External Clients<a class="headerlink" href="#external-clients" title="Permalink to this headline">¶</a></h2>
  602. <p>A detailed guide to give clients outside of the Netmaker network access to network resources.</p>
  603. <div class="toctree-wrapper compound">
  604. <ul>
  605. <li class="toctree-l1"><a class="reference internal" href="external-clients.html">External Clients</a><ul>
  606. <li class="toctree-l2"><a class="reference internal" href="external-clients.html#introduction">Introduction</a></li>
  607. <li class="toctree-l2"><a class="reference internal" href="external-clients.html#configuring-an-ingress-gateway">Configuring an Ingress Gateway</a></li>
  608. <li class="toctree-l2"><a class="reference internal" href="external-clients.html#adding-clients-to-a-gateway">Adding Clients to a Gateway</a></li>
  609. <li class="toctree-l2"><a class="reference internal" href="external-clients.html#configuring-dns-for-ext-clients-optional">Configuring DNS for Ext Clients (OPTIONAL)</a></li>
  610. </ul>
  611. </li>
  612. </ul>
  613. </div>
  614. <h2 id="guides">Guides<a class="headerlink" href="#guides" title="Permalink to this headline">¶</a></h2>
  615. <p>A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.</p>
  616. <div class="toctree-wrapper compound">
  617. <ul>
  618. <li class="toctree-l1"><a class="reference internal" href="usage.html">Using Netmaker</a><ul>
  619. <li class="toctree-l2"><a class="reference internal" href="usage.html#external-tutorials">External Tutorials</a></li>
  620. </ul>
  621. </li>
  622. </ul>
  623. </div>
  624. <h2 id="api-reference">API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2>
  625. <p>A reference document for the Netmaker Server API, and example API calls for various use cases.</p>
  626. <p><strong>Coming Soon:</strong> Swagger Documentation</p>
  627. <div class="toctree-wrapper compound">
  628. <ul>
  629. <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
  630. </ul>
  631. </div>
  632. <h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
  633. <p>Help with common Netmaker/netclient issues.</p>
  634. <div class="toctree-wrapper compound">
  635. <ul>
  636. <li class="toctree-l1"><a class="reference internal" href="troubleshoot.html">Troubleshooting</a><ul>
  637. <li class="toctree-l2"><a class="reference internal" href="troubleshoot.html#common-issues">Common Issues</a></li>
  638. <li class="toctree-l2"><a class="reference internal" href="troubleshoot.html#server">Server</a></li>
  639. <li class="toctree-l2"><a class="reference internal" href="troubleshoot.html#ui">UI</a></li>
  640. <li class="toctree-l2"><a class="reference internal" href="troubleshoot.html#netclient">Netclient</a></li>
  641. <li class="toctree-l2"><a class="reference internal" href="troubleshoot.html#coredns">CoreDNS</a></li>
  642. </ul>
  643. </li>
  644. </ul>
  645. </div>
  646. <h2 id="support">Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
  647. <p>Where to go for help, and a FAQ.</p>
  648. <div class="toctree-wrapper compound">
  649. <ul>
  650. <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a><ul>
  651. <li class="toctree-l2"><a class="reference internal" href="support.html#faq">FAQ</a></li>
  652. <li class="toctree-l2"><a class="reference internal" href="support.html#contact">Contact</a></li>
  653. </ul>
  654. </li>
  655. </ul>
  656. </div>
  657. <h2 id="code-of-conduct">Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Permalink to this headline">¶</a></h2>
  658. <p>A statement on our expectations and pledge to the community.</p>
  659. <div class="toctree-wrapper compound">
  660. <ul>
  661. <li class="toctree-l1"><a class="reference internal" href="conduct.html">Code of Conduct</a><ul>
  662. <li class="toctree-l2"><a class="reference internal" href="conduct.html#our-pledge">Our Pledge</a></li>
  663. <li class="toctree-l2"><a class="reference internal" href="conduct.html#our-standards">Our Standards</a></li>
  664. <li class="toctree-l2"><a class="reference internal" href="conduct.html#our-responsibilities">Our Responsibilities</a></li>
  665. <li class="toctree-l2"><a class="reference internal" href="conduct.html#scope">Scope</a></li>
  666. <li class="toctree-l2"><a class="reference internal" href="conduct.html#enforcement">Enforcement</a></li>
  667. <li class="toctree-l2"><a class="reference internal" href="conduct.html#attribution">Attribution</a></li>
  668. </ul>
  669. </li>
  670. </ul>
  671. </div>
  672. <h2 id="licensing">Licensing<a class="headerlink" href="#licensing" title="Permalink to this headline">¶</a></h2>
  673. <p>A link to the Netmaker license.</p>
  674. <div class="toctree-wrapper compound">
  675. <ul>
  676. <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
  677. </ul>
  678. </div>
  679. </article>
  680. </div>
  681. </div>
  682. </main>
  683. </div>
  684. <footer class="md-footer">
  685. <div class="md-footer-nav">
  686. <nav class="md-footer-nav__inner md-grid">
  687. <a href="about.html" title="About"
  688. class="md-flex md-footer-nav__link md-footer-nav__link--next"
  689. rel="next">
  690. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
  691. class="md-flex__ellipsis"> <span
  692. class="md-footer-nav__direction"> Next </span> About </span>
  693. </div>
  694. <div class="md-flex__cell md-flex__cell--shrink"><i
  695. class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  696. </div>
  697. </a>
  698. </nav>
  699. </div>
  700. <div class="md-footer-meta md-typeset">
  701. <div class="md-footer-meta__inner md-grid">
  702. <div class="md-footer-copyright">
  703. <div class="md-footer-copyright__highlight">
  704. &#169; Copyright 2021, Alex Feiszli.
  705. </div>
  706. Created using
  707. <a href="http://www.sphinx-doc.org/">Sphinx</a> 4.3.0.
  708. and
  709. <a href="https://github.com/bashtage/sphinx-material/">Material for
  710. Sphinx</a>
  711. </div>
  712. </div>
  713. </div>
  714. </footer>
  715. <script src="_static/javascripts/application.js"></script>
  716. <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script>
  717. </body>
  718. </html>