mirror of
https://github.com/gravitl/netmaker.git
synced 2025-10-24 17:30:29 +08:00
updating readme and docs
This commit is contained in:
afeiszli
38
docs/_build/html/oauth.html
vendored
38
docs/_build/html/oauth.html
vendored
@@ -46,7 +46,7 @@
|
||||
|
||||
|
||||
|
||||
<title>Introduction — Netmaker 0.8.5 documentation</title>
|
||||
<title>Integrating OAuth — Netmaker 0.8.5 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.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>
|
||||
@@ -94,7 +94,7 @@
|
||||
<div class="md-flex__cell md-flex__cell--stretch">
|
||||
<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"> Introduction </span>
|
||||
<span class="md-header-nav__topic"> Integrating OAuth </span>
|
||||
</div>
|
||||
</div>
|
||||
<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">
|
||||
<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">
|
||||
<label class="md-nav__title" for="__toc">Contents</label>
|
||||
<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 class="md-nav__item"><a href="#configuring-your-provider" class="md-nav__link">Configuring your provider</a>
|
||||
</li>
|
||||
<li class="md-nav__item"><a href="#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a>
|
||||
</li>
|
||||
<li class="md-nav__item"><a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
|
||||
</li></ul>
|
||||
</nav>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
|
||||
|
||||
<a href="#introduction" class="md-nav__link">Introduction</a>
|
||||
|
||||
|
||||
</li>
|
||||
@@ -531,6 +540,8 @@
|
||||
<a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
|
||||
|
||||
|
||||
</li></ul>
|
||||
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
|
||||
@@ -805,13 +816,17 @@
|
||||
<nav class="md-nav md-nav--secondary">
|
||||
<label class="md-nav__title" for="__toc">Contents</label>
|
||||
<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 class="md-nav__item"><a href="#configuring-your-provider" class="md-nav__link">Configuring your provider</a>
|
||||
</li>
|
||||
<li class="md-nav__item"><a href="#configuring-netmaker" class="md-nav__link">Configuring Netmaker</a>
|
||||
</li>
|
||||
<li class="md-nav__item"><a href="#configuring-user-permissions" class="md-nav__link">Configuring User Permissions</a>
|
||||
</li></ul>
|
||||
</nav>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -823,7 +838,9 @@
|
||||
<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>
|
||||
<ul class="simple">
|
||||
<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>
|
||||
|
||||
|
||||
<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>You must configure your provider to use the Netmaker Dashboard URI dashboard.<netmaker.base.domain> as the origin URL.</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>
|
||||
|
||||
|
||||
<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>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">"<azure-ad|github|google>"</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>
|
||||
|
||||
|
||||
<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>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>
|
||||
@@ -869,6 +886,7 @@ Instructions for Microsoft Azure AD: <a class="reference external" href="https:/
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user