zishuo/netmaker
1
0
Fork 0
mirror of https://github.com/gravitl/netmaker.git synced 2025-10-26 18:30:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

updating readme and docs

Browse Source
This commit is contained in:
afeiszli
2021-10-29 15:00:38 -04:00
parent 434b33ea30
commit 8d508e646a
13 changed files with 85 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -13,8 +13,8 @@
<a href="https://hub.docker.com/r/gravitl/netmaker/tags"> <a href="https://hub.docker.com/r/gravitl/netmaker/tags">
<img src="https://img.shields.io/docker/pulls/gravitl/netmaker" /> <img src="https://img.shields.io/docker/pulls/gravitl/netmaker" />
</a> </a>
<a href="https://discord.gg/zRb9Vfhk8A"> <a href="https://goreportcard.com/report/github.com/gravitl/netmaker">
<img src="https://img.shields.io/badge/community-discord-informational" /> <img src="https://goreportcard.com/badge/github.com/gravitl/netmaker" />
</a> </a>
<a href="https://github.com/gravitl/netmaker/graphs/contributors"> <a href="https://github.com/gravitl/netmaker/graphs/contributors">
<img src="https://img.shields.io/github/commit-activity/m/gravitl/netmaker?color=blue" /> <img src="https://img.shields.io/github/commit-activity/m/gravitl/netmaker?color=blue" />
@@ -29,8 +29,8 @@
# WireGuard® Automation from Homelab to Enterprise # WireGuard® Automation from Homelab to Enterprise
- [x] Peer-to-Peer Mesh Networks - [x] Peer-to-Peer Mesh Networks
- [x] Kubernetes Multi-Cloud - [x] Kubernetes, Multi-Cloud
- [x] Private DNS - [x] OAuth and Private DNS
- [x] Linux, Mac, Windows, iPhone, and Android - [x] Linux, Mac, Windows, iPhone, and Android
# Get Started in 5 Minutes # Get Started in 5 Minutes

BIN
docs/_build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/oauth.doctree vendored
View File

Binary file not shown.

2
docs/_build/html/_sources/oauth.rst.txt vendored
View File

@@ -1,4 +1,4 @@
=================== ====================
Integrating OAuth Integrating OAuth
==================== ====================

9
docs/_build/html/external-clients.html vendored
View File

@@ -489,7 +489,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="oauth.html" class="md-nav__link">Introduction</a> <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
</li> </li>
@@ -513,6 +518,8 @@
<a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">

9
docs/_build/html/genindex.html vendored
View File

@@ -487,7 +487,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="oauth.html" class="md-nav__link">Introduction</a> <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
</li> </li>
@@ -511,6 +516,8 @@
<a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">

20
docs/_build/html/index.html vendored
View File

@@ -488,7 +488,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="oauth.html" class="md-nav__link">Introduction</a> <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
</li> </li>
@@ -512,6 +517,8 @@
<a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@@ -937,10 +944,13 @@
<p>A simple guide to configuring OAuth for Netmaker.</p> <p>A simple guide to configuring OAuth for Netmaker.</p>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="oauth.html">Introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="oauth.html">Integrating OAuth</a><ul>
<li class="toctree-l1"><a class="reference internal" href="oauth.html#configuring-your-provider">Configuring your provider</a></li> <li class="toctree-l2"><a class="reference internal" href="oauth.html#introduction">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="oauth.html#configuring-netmaker">Configuring Netmaker</a></li> <li class="toctree-l2"><a class="reference internal" href="oauth.html#configuring-your-provider">Configuring your provider</a></li>
<li class="toctree-l1"><a class="reference internal" href="oauth.html#configuring-user-permissions">Configuring User Permissions</a></li> <li class="toctree-l2"><a class="reference internal" href="oauth.html#configuring-netmaker">Configuring Netmaker</a></li>
<li class="toctree-l2"><a class="reference internal" href="oauth.html#configuring-user-permissions">Configuring User Permissions</a></li>
</ul>
</li>
</ul> </ul>
</div> </div>

38
docs/_build/html/oauth.html vendored
View File

@@ -46,7 +46,7 @@
<title>Introduction &#8212; Netmaker 0.8.5 documentation</title> <title>Integrating OAuth &#8212; Netmaker 0.8.5 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/material.css" type="text/css" /> <link rel="stylesheet" href="_static/material.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -94,7 +94,7 @@
<div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__cell md-flex__cell--stretch">
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
<span class="md-header-nav__topic">Netmaker Docs</span> <span class="md-header-nav__topic">Netmaker Docs</span>
<span class="md-header-nav__topic"> Introduction </span> <span class="md-header-nav__topic"> Integrating OAuth </span>
</div> </div>
</div> </div>
<div class="md-flex__cell md-flex__cell--shrink"> <div class="md-flex__cell md-flex__cell--shrink">
@@ -490,24 +490,33 @@
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc"> Introduction </label> <label class="md-nav__link md-nav__link--active" for="__toc"> Integrating OAuth </label>
<a href="#" class="md-nav__link md-nav__link--active">Introduction</a> <a href="#" class="md-nav__link md-nav__link--active">Integrating OAuth</a>
<nav class="md-nav md-nav--secondary"> <nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Contents</label> <label class="md-nav__title" for="__toc">Contents</label>
<ul class="md-nav__list" data-md-scrollfix=""> <ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item"><a href="#oauth--page-root" class="md-nav__link">Introduction</a> <li class="md-nav__item"><a href="#oauth--page-root" class="md-nav__link">Integrating OAuth</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#introduction" class="md-nav__link">Introduction</a>
</li> </li>
<li class="md-nav__item"><a href="#configuring-your-provider" class="md-nav__link">Configuring your provider</a> <li class="md-nav__item"><a href="#configuring-your-provider" class="md-nav__link">Configuring your provider</a>
</li> </li>
<li class="md-nav__item"><a href="#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a> <li class="md-nav__item"><a href="#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a>
</li> </li>
<li class="md-nav__item"><a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <li class="md-nav__item"><a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</nav>
</li> </li>
</ul> </ul>
</nav> </nav>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#introduction" class="md-nav__link">Introduction</a>
</li> </li>
@@ -531,6 +540,8 @@
<a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@@ -805,13 +816,17 @@
<nav class="md-nav md-nav--secondary"> <nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Contents</label> <label class="md-nav__title" for="__toc">Contents</label>
<ul class="md-nav__list" data-md-scrollfix=""> <ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item"><a href="#oauth--page-root" class="md-nav__link">Introduction</a> <li class="md-nav__item"><a href="#oauth--page-root" class="md-nav__link">Integrating OAuth</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#introduction" class="md-nav__link">Introduction</a>
</li> </li>
<li class="md-nav__item"><a href="#configuring-your-provider" class="md-nav__link">Configuring your provider</a> <li class="md-nav__item"><a href="#configuring-your-provider" class="md-nav__link">Configuring your provider</a>
</li> </li>
<li class="md-nav__item"><a href="#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a> <li class="md-nav__item"><a href="#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a>
</li> </li>
<li class="md-nav__item"><a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <li class="md-nav__item"><a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</nav>
</li> </li>
</ul> </ul>
</nav> </nav>
@@ -823,7 +838,9 @@
<article class="md-content__inner md-typeset" role="main"> <article class="md-content__inner md-typeset" role="main">
<h1 id="oauth--page-root">Introduction<a class="headerlink" href="#oauth--page-root" title="Permalink to this headline"></a></h1> <h1 id="oauth--page-root">Integrating OAuth<a class="headerlink" href="#oauth--page-root" title="Permalink to this headline"></a></h1>
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
<p>As of v0.8.5, Netmaker offers integration with the following OAuth providers:</p> <p>As of v0.8.5, Netmaker offers integration with the following OAuth providers:</p>
<ul class="simple"> <ul class="simple">
<li><p>GitHub</p></li> <li><p>GitHub</p></li>
@@ -833,7 +850,7 @@
<p>By integrating with an OAuth provider, your Netmaker users can log in via the provider, rather than the default simple auth.</p> <p>By integrating with an OAuth provider, your Netmaker users can log in via the provider, rather than the default simple auth.</p>
<h1 id="configuring-your-provider">Configuring your provider<a class="headerlink" href="#configuring-your-provider" title="Permalink to this headline"></a></h1> <h2 id="configuring-your-provider">Configuring your provider<a class="headerlink" href="#configuring-your-provider" title="Permalink to this headline"></a></h2>
<p>In order to use OAuth, configure your OAuth provider (GitHub, Google, Azure AD).</p> <p>In order to use OAuth, configure your OAuth provider (GitHub, Google, Azure AD).</p>
<p>You must configure your provider to use the Netmaker Dashboard URI dashboard.&lt;netmaker.base.domain&gt; as the origin URL.</p> <p>You must configure your provider to use the Netmaker Dashboard URI dashboard.&lt;netmaker.base.domain&gt; as the origin URL.</p>
<p>For example: <cite>https://dashboard.netmaker.mydomain.com</cite></p> <p>For example: <cite>https://dashboard.netmaker.mydomain.com</cite></p>
@@ -845,7 +862,7 @@ Instructions for Google: <a class="reference external" href="https://oauth2-prox
Instructions for Microsoft Azure AD: <a class="reference external" href="https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider/#microsoft-azure-ad-provider">https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider/#microsoft-azure-ad-provider</a></p> Instructions for Microsoft Azure AD: <a class="reference external" href="https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider/#microsoft-azure-ad-provider">https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider/#microsoft-azure-ad-provider</a></p>
<h1 id="configuring-netmaker">Configuring Netmaker<a class="headerlink" href="#configuring-netmaker" title="Permalink to this headline"></a></h1> <h2 id="configuring-netmaker">Configuring Netmaker<a class="headerlink" href="#configuring-netmaker" title="Permalink to this headline"></a></h2>
<p>After you have configured your OAuth provider, take note of the CLIENT_ID and CLIENT_SECRET.</p> <p>After you have configured your OAuth provider, take note of the CLIENT_ID and CLIENT_SECRET.</p>
<p>Next, Configure Netmaker with the following environment variables. If any are left blank, OAuth will fail.</p> <p>Next, Configure Netmaker with the following environment variables. If any are left blank, OAuth will fail.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">AUTH_PROVIDER</span><span class="o">=</span><span class="s2">"&lt;azure-ad|github|google&gt;"</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">AUTH_PROVIDER</span><span class="o">=</span><span class="s2">"&lt;azure-ad|github|google&gt;"</span>
@@ -860,7 +877,7 @@ Instructions for Microsoft Azure AD: <a class="reference external" href="https:/
<a class="reference internal image-reference" href="_images/oauth1.png"><img alt="Login Oauth" class="align-center" src="_images/oauth1.png" style="width: 80%;"/></a> <a class="reference internal image-reference" href="_images/oauth1.png"><img alt="Login Oauth" class="align-center" src="_images/oauth1.png" style="width: 80%;"/></a>
<h1 id="configuring-user-permissions">Configuring User Permissions<a class="headerlink" href="#configuring-user-permissions" title="Permalink to this headline"></a></h1> <h2 id="configuring-user-permissions">Configuring User Permissions<a class="headerlink" href="#configuring-user-permissions" title="Permalink to this headline"></a></h2>
<p>All users logging in will have zero permissions on first sign-in. An admin must configure all user permissions.</p> <p>All users logging in will have zero permissions on first sign-in. An admin must configure all user permissions.</p>
<p>Admins must navigate to the “Users” screen to configure permissions.</p> <p>Admins must navigate to the “Users” screen to configure permissions.</p>
<p>For each user, an admin must specify which networks that user has access to configure. Additionally, an Admin can elevate a user to Admin permissions.</p> <p>For each user, an admin must specify which networks that user has access to configure. Additionally, an Admin can elevate a user to Admin permissions.</p>
@@ -869,6 +886,7 @@ Instructions for Microsoft Azure AD: <a class="reference external" href="https:/
</article> </article>
</div> </div>
</div> </div>

BIN
docs/_build/html/objects.inv vendored
View File

Binary file not shown.

9
docs/_build/html/search.html vendored
View File

@@ -493,7 +493,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="oauth.html" class="md-nav__link">Introduction</a> <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
</li> </li>
@@ -517,6 +522,8 @@
<a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">

2
docs/_build/html/searchindex.js vendored
View File

File diff suppressed because one or more lines are too long

15
docs/_build/html/server-installation.html vendored
View File

@@ -56,7 +56,7 @@
<link rel="author" title="About these documents" href="about.html" /> <link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="oauth.html" /> <link rel="next" title="Integrating OAuth" href="oauth.html" />
<link rel="prev" title="Install with Nginx (depreciated)" href="quick-start-nginx.html" /> <link rel="prev" title="Install with Nginx (depreciated)" href="quick-start-nginx.html" />
@@ -579,7 +579,12 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="oauth.html" class="md-nav__link">Introduction</a> <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="oauth.html#introduction" class="md-nav__link">Introduction</a>
</li> </li>
@@ -603,6 +608,8 @@
<a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a> <a href="oauth.html#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
</li></ul>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@@ -1517,12 +1524,12 @@ This install has some notable exceptions:
</a> </a>
<a href="oauth.html" title="Introduction" <a href="oauth.html" title="Integrating OAuth"
class="md-flex md-footer-nav__link md-footer-nav__link--next" class="md-flex md-footer-nav__link md-footer-nav__link--next"
rel="next"> rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
class="md-flex__ellipsis"> <span class="md-flex__ellipsis"> <span
class="md-footer-nav__direction"> Next </span> Introduction </span> class="md-footer-nav__direction"> Next </span> Integrating OAuth </span>
</div> </div>
<div class="md-flex__cell md-flex__cell--shrink"><i <div class="md-flex__cell md-flex__cell--shrink"><i
class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>

2
docs/oauth.rst
View File

@@ -1,4 +1,4 @@
=================== ====================
Integrating OAuth Integrating OAuth
==================== ====================