MyFavMirrors/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-07-17 04:32:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Deployed a98d9bd0 to development with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions 2025-07-16 07:53:39 +00:00
parent f424f64a6e
commit b814b8377c
6 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
development/search/search_index.json
View File

File diff suppressed because one or more lines are too long

4
development/setup/install/container/index.html
View File

@ -33,8 +33,8 @@
</span></code></pre></div> </li> </ol> <h3 id=register-a-machine-normal-login>Register a machine (normal login)<a class=headerlink href=#register-a-machine-normal-login title="Permanent link">&para;</a></h3> <p>On a client machine, execute the <code>tailscale up</code> command to login:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-7-1><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a>tailscale<span class=w> </span>up<span class=w> </span>--login-server<span class=w> </span>YOUR_HEADSCALE_URL
</span></code></pre></div> <p>To register a machine when running headscale in a container, take the headscale command and pass it to the container:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-8-1><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a>docker<span class=w> </span><span class=nb>exec</span><span class=w> </span>-it<span class=w> </span>headscale<span class=w> </span><span class=se>\</span>
</span><span id=__span-8-2><a id=__codelineno-8-2 name=__codelineno-8-2 href=#__codelineno-8-2></a><span class=w> </span>headscale<span class=w> </span>nodes<span class=w> </span>register<span class=w> </span>--user<span class=w> </span>myfirstuser<span class=w> </span>--key<span class=w> </span>&lt;YOUR_MACHINE_KEY&gt;
</span></code></pre></div> <h3 id=register-a-machine-using-a-pre-authenticated-key>Register a machine using a pre authenticated key<a class=headerlink href=#register-a-machine-using-a-pre-authenticated-key title="Permanent link">&para;</a></h3> <p>Generate a key using the command line:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-9-1><a id=__codelineno-9-1 name=__codelineno-9-1 href=#__codelineno-9-1></a>docker<span class=w> </span><span class=nb>exec</span><span class=w> </span>-it<span class=w> </span>headscale<span class=w> </span><span class=se>\</span>
</span><span id=__span-9-2><a id=__codelineno-9-2 name=__codelineno-9-2 href=#__codelineno-9-2></a><span class=w> </span>headscale<span class=w> </span>preauthkeys<span class=w> </span>create<span class=w> </span>--user<span class=w> </span>myfirstuser<span class=w> </span>--reusable<span class=w> </span>--expiration<span class=w> </span>24h
</span></code></pre></div> <h3 id=register-a-machine-using-a-pre-authenticated-key>Register a machine using a pre authenticated key<a class=headerlink href=#register-a-machine-using-a-pre-authenticated-key title="Permanent link">&para;</a></h3> <p>Generate a key using the command line for the user with ID 1:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-9-1><a id=__codelineno-9-1 name=__codelineno-9-1 href=#__codelineno-9-1></a>docker<span class=w> </span><span class=nb>exec</span><span class=w> </span>-it<span class=w> </span>headscale<span class=w> </span><span class=se>\</span>
</span><span id=__span-9-2><a id=__codelineno-9-2 name=__codelineno-9-2 href=#__codelineno-9-2></a><span class=w> </span>headscale<span class=w> </span>preauthkeys<span class=w> </span>create<span class=w> </span>--user<span class=w> </span><span class=m>1</span><span class=w> </span>--reusable<span class=w> </span>--expiration<span class=w> </span>24h
</span></code></pre></div> <p>This will return a pre-authenticated key that can be used to connect a node to headscale with the <code>tailscale up</code> command:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-10-1><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a>tailscale<span class=w> </span>up<span class=w> </span>--login-server<span class=w> </span>&lt;YOUR_HEADSCALE_URL&gt;<span class=w> </span>--authkey<span class=w> </span>&lt;YOUR_AUTH_KEY&gt;
</span></code></pre></div> <h2 id=debugging-headscale-running-in-docker>Debugging headscale running in Docker<a class=headerlink href=#debugging-headscale-running-in-docker title="Permanent link">&para;</a></h2> <p>The Headscale container image is based on a "distroless" image that does not contain a shell or any other debug tools. If you need to debug headscale running in the Docker container, you can use the <code>-debug</code> variant, for example <code>docker.io/headscale/headscale:x.x.x-debug</code>.</p> <h3 id=running-the-debug-docker-container>Running the debug Docker container<a class=headerlink href=#running-the-debug-docker-container title="Permanent link">&para;</a></h3> <p>To run the debug Docker container, use the exact same commands as above, but replace <code>docker.io/headscale/headscale:x.x.x</code> with <code>docker.io/headscale/headscale:x.x.x-debug</code> (<code>x.x.x</code> is the version of headscale). The two containers are compatible with each other, so you can alternate between them.</p> <h3 id=executing-commands-in-the-debug-container>Executing commands in the debug container<a class=headerlink href=#executing-commands-in-the-debug-container title="Permanent link">&para;</a></h3> <p>The default command in the debug container is to run <code>headscale</code>, which is located at <code>/ko-app/headscale</code> inside the container.</p> <p>Additionally, the debug container includes a minimalist Busybox shell.</p> <p>To launch a shell in the container, use:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a>docker<span class=w> </span>run<span class=w> </span>-it<span class=w> </span>docker.io/headscale/headscale:x.x.x-debug<span class=w> </span>sh
</span></code></pre></div> <p>You can also execute commands directly, such as <code>ls /ko-app</code> in this example:</p> <div class="language-shell highlight"><pre><span></span><code><span id=__span-12-1><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a>docker<span class=w> </span>run<span class=w> </span>docker.io/headscale/headscale:x.x.x-debug<span class=w> </span>ls<span class=w> </span>/ko-app

56
development/sitemap.xml
View File

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

BIN
development/sitemap.xml.gz
View File

Binary file not shown.

4
development/usage/getting-started/index.html
View File

File diff suppressed because one or more lines are too long

4
versions.json
View File

@ -10,8 +10,8 @@
"version": "0.26.1",
"title": "0.26.1",
"aliases": [
"stable",
"latest"
"latest",
"stable"
]
},
{