MyFavMirrors/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-12-24 21:25:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deployed b81420be to development with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions 2024-12-22 17:38:35 +00:00
parent d81cc891b3
commit acea92d748
4 changed files with 46 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
development/ref/oidc/index.html
View File

@ -31,11 +31,23 @@
</span><span id=__span-0-31><a id=__codelineno-0-31 name=__codelineno-0-31 href=#__codelineno-0-31></a><span class=w> </span><span class=nt>allowed_users</span><span class=p>:</span> </span><span id=__span-0-31><a id=__codelineno-0-31 name=__codelineno-0-31 href=#__codelineno-0-31></a><span class=w> </span><span class=nt>allowed_users</span><span class=p>:</span>
</span><span id=__span-0-32><a id=__codelineno-0-32 name=__codelineno-0-32 href=#__codelineno-0-32></a><span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">alice@example.com</span> </span><span id=__span-0-32><a id=__codelineno-0-32 name=__codelineno-0-32 href=#__codelineno-0-32></a><span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">alice@example.com</span>
</span><span id=__span-0-33><a id=__codelineno-0-33 name=__codelineno-0-33 href=#__codelineno-0-33></a> </span><span id=__span-0-33><a id=__codelineno-0-33 name=__codelineno-0-33 href=#__codelineno-0-33></a>
</span><span id=__span-0-34><a id=__codelineno-0-34 name=__codelineno-0-34 href=#__codelineno-0-34></a><span class=w> </span><span class=c1># If `strip_email_domain` is set to `true`, the domain part of the username email address will be removed.</span> </span><span id=__span-0-34><a id=__codelineno-0-34 name=__codelineno-0-34 href=#__codelineno-0-34></a><span class=w> </span><span class=c1># Optional: PKCE (Proof Key for Code Exchange) configuration</span>
</span><span id=__span-0-35><a id=__codelineno-0-35 name=__codelineno-0-35 href=#__codelineno-0-35></a><span class=w> </span><span class=c1># This will transform `first-name.last-name@example.com` to the user `first-name.last-name`</span> </span><span id=__span-0-35><a id=__codelineno-0-35 name=__codelineno-0-35 href=#__codelineno-0-35></a><span class=w> </span><span class=c1># PKCE adds an additional layer of security to the OAuth 2.0 authorization code flow</span>
</span><span id=__span-0-36><a id=__codelineno-0-36 name=__codelineno-0-36 href=#__codelineno-0-36></a><span class=w> </span><span class=c1># If `strip_email_domain` is set to `false` the domain part will NOT be removed resulting to the following</span> </span><span id=__span-0-36><a id=__codelineno-0-36 name=__codelineno-0-36 href=#__codelineno-0-36></a><span class=w> </span><span class=c1># by preventing authorization code interception attacks</span>
</span><span id=__span-0-37><a id=__codelineno-0-37 name=__codelineno-0-37 href=#__codelineno-0-37></a><span class=w> </span><span class=c1># user: `first-name.last-name.example.com`</span> </span><span id=__span-0-37><a id=__codelineno-0-37 name=__codelineno-0-37 href=#__codelineno-0-37></a><span class=w> </span><span class=c1># See https://datatracker.ietf.org/doc/html/rfc7636</span>
</span><span id=__span-0-38><a id=__codelineno-0-38 name=__codelineno-0-38 href=#__codelineno-0-38></a><span class=w> </span><span class=nt>strip_email_domain</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">true</span> </span><span id=__span-0-38><a id=__codelineno-0-38 name=__codelineno-0-38 href=#__codelineno-0-38></a><span class=w> </span><span class=nt>pkce</span><span class=p>:</span>
</span><span id=__span-0-39><a id=__codelineno-0-39 name=__codelineno-0-39 href=#__codelineno-0-39></a><span class=w> </span><span class=c1># Enable or disable PKCE support (default: false)</span>
</span><span id=__span-0-40><a id=__codelineno-0-40 name=__codelineno-0-40 href=#__codelineno-0-40></a><span class=w> </span><span class=nt>enabled</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
</span><span id=__span-0-41><a id=__codelineno-0-41 name=__codelineno-0-41 href=#__codelineno-0-41></a><span class=w> </span><span class=c1># PKCE method to use:</span>
</span><span id=__span-0-42><a id=__codelineno-0-42 name=__codelineno-0-42 href=#__codelineno-0-42></a><span class=w> </span><span class=c1># - plain: Use plain code verifier</span>
</span><span id=__span-0-43><a id=__codelineno-0-43 name=__codelineno-0-43 href=#__codelineno-0-43></a><span class=w> </span><span class=c1># - S256: Use SHA256 hashed code verifier (default, recommended)</span>
</span><span id=__span-0-44><a id=__codelineno-0-44 name=__codelineno-0-44 href=#__codelineno-0-44></a><span class=w> </span><span class=nt>method</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">S256</span>
</span><span id=__span-0-45><a id=__codelineno-0-45 name=__codelineno-0-45 href=#__codelineno-0-45></a>
</span><span id=__span-0-46><a id=__codelineno-0-46 name=__codelineno-0-46 href=#__codelineno-0-46></a><span class=w> </span><span class=c1># If `strip_email_domain` is set to `true`, the domain part of the username email address will be removed.</span>
</span><span id=__span-0-47><a id=__codelineno-0-47 name=__codelineno-0-47 href=#__codelineno-0-47></a><span class=w> </span><span class=c1># This will transform `first-name.last-name@example.com` to the user `first-name.last-name`</span>
</span><span id=__span-0-48><a id=__codelineno-0-48 name=__codelineno-0-48 href=#__codelineno-0-48></a><span class=w> </span><span class=c1># If `strip_email_domain` is set to `false` the domain part will NOT be removed resulting to the following</span>
</span><span id=__span-0-49><a id=__codelineno-0-49 name=__codelineno-0-49 href=#__codelineno-0-49></a><span class=w> </span><span class=c1># user: `first-name.last-name.example.com`</span>
</span><span id=__span-0-50><a id=__codelineno-0-50 name=__codelineno-0-50 href=#__codelineno-0-50></a><span class=w> </span><span class=nt>strip_email_domain</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span></code></pre></div> <h2 id=azure-ad-example>Azure AD example<a class=headerlink href=#azure-ad-example title="Permanent link">&para;</a></h2> <p>In order to integrate headscale with Azure Active Directory, we'll need to provision an App Registration with the correct scopes and redirect URI. Here with Terraform:</p> <div class="language-hcl highlight"><span class=filename>terraform.hcl</span><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=kr>resource</span><span class=w> </span><span class=nc>&quot;azuread_application&quot;</span><span class=w> </span><span class=nv>&quot;headscale&quot;</span><span class=w> </span><span class=p>{</span> </span></code></pre></div> <h2 id=azure-ad-example>Azure AD example<a class=headerlink href=#azure-ad-example title="Permanent link">&para;</a></h2> <p>In order to integrate headscale with Azure Active Directory, we'll need to provision an App Registration with the correct scopes and redirect URI. Here with Terraform:</p> <div class="language-hcl highlight"><span class=filename>terraform.hcl</span><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=kr>resource</span><span class=w> </span><span class=nc>&quot;azuread_application&quot;</span><span class=w> </span><span class=nv>&quot;headscale&quot;</span><span class=w> </span><span class=p>{</span>
</span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=w> </span><span class=na>display_name</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>&quot;Headscale&quot;</span> </span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=w> </span><span class=na>display_name</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>&quot;Headscale&quot;</span>
</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a> </span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a>

2
development/search/search_index.json
View File

File diff suppressed because one or more lines are too long

56
development/sitemap.xml
View File

@ -2,114 +2,114 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>https://juanfont.github.io/headscale/development/</loc> <loc>https://juanfont.github.io/headscale/development/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/clients/</loc> <loc>https://juanfont.github.io/headscale/development/about/clients/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/contributing/</loc> <loc>https://juanfont.github.io/headscale/development/about/contributing/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/faq/</loc> <loc>https://juanfont.github.io/headscale/development/about/faq/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/features/</loc> <loc>https://juanfont.github.io/headscale/development/about/features/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/help/</loc> <loc>https://juanfont.github.io/headscale/development/about/help/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/releases/</loc> <loc>https://juanfont.github.io/headscale/development/about/releases/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/about/sponsor/</loc> <loc>https://juanfont.github.io/headscale/development/about/sponsor/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/acls/</loc> <loc>https://juanfont.github.io/headscale/development/ref/acls/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/configuration/</loc> <loc>https://juanfont.github.io/headscale/development/ref/configuration/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/dns/</loc> <loc>https://juanfont.github.io/headscale/development/ref/dns/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/exit-node/</loc> <loc>https://juanfont.github.io/headscale/development/ref/exit-node/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/oidc/</loc> <loc>https://juanfont.github.io/headscale/development/ref/oidc/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/remote-cli/</loc> <loc>https://juanfont.github.io/headscale/development/ref/remote-cli/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/tls/</loc> <loc>https://juanfont.github.io/headscale/development/ref/tls/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/integration/reverse-proxy/</loc> <loc>https://juanfont.github.io/headscale/development/ref/integration/reverse-proxy/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/integration/tools/</loc> <loc>https://juanfont.github.io/headscale/development/ref/integration/tools/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/ref/integration/web-ui/</loc> <loc>https://juanfont.github.io/headscale/development/ref/integration/web-ui/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/setup/requirements/</loc> <loc>https://juanfont.github.io/headscale/development/setup/requirements/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/setup/upgrade/</loc> <loc>https://juanfont.github.io/headscale/development/setup/upgrade/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/setup/install/community/</loc> <loc>https://juanfont.github.io/headscale/development/setup/install/community/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/setup/install/container/</loc> <loc>https://juanfont.github.io/headscale/development/setup/install/container/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/setup/install/official/</loc> <loc>https://juanfont.github.io/headscale/development/setup/install/official/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/setup/install/source/</loc> <loc>https://juanfont.github.io/headscale/development/setup/install/source/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/usage/getting-started/</loc> <loc>https://juanfont.github.io/headscale/development/usage/getting-started/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/usage/connect/android/</loc> <loc>https://juanfont.github.io/headscale/development/usage/connect/android/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/usage/connect/apple/</loc> <loc>https://juanfont.github.io/headscale/development/usage/connect/apple/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
<url> <url>
<loc>https://juanfont.github.io/headscale/development/usage/connect/windows/</loc> <loc>https://juanfont.github.io/headscale/development/usage/connect/windows/</loc>
<lastmod>2024-12-17</lastmod> <lastmod>2024-12-22</lastmod>
</url> </url>
</urlset> </urlset>

BIN
development/sitemap.xml.gz
View File

Binary file not shown.