public/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-05-10 04:34:44 +09:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 9baa795d to development with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions
2026-03-01 12:38:56 +00:00
parent dea02c58ed
commit bc30316c4d
5 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -18,9 +18,9 @@
</span></code></pre></div> </div> <div class=tabbed-block> <div class="language-shell highlight"><pre><span></span><code><span id=__span-6-1><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-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-6-2><a id=__codelineno-6-2 name=__codelineno-6-2 href=#__codelineno-6-2></a><span class=w> </span>headscale<span class=w> </span>users<span class=w> </span>list
</span></code></pre></div> </div> </div> </div> <h2 id=register-a-node>Register a node<a class=headerlink href=#register-a-node title="Permanent link">&para;</a></h2> <p>One has to <a href=../../ref/registration/ >register a node</a> first to use headscale as coordination server with Tailscale. The following examples work for the Tailscale client on Linux/BSD operating systems. Alternatively, follow the instructions to connect <a href=../connect/android/ >Android</a>, <a href=../connect/apple/ >Apple</a> or <a href=../connect/windows/ >Windows</a> devices. Read <a href=../../ref/registration/ >registration methods</a> for an overview of available registration methods.</p> <h3 id=web-authentication><a href=../../ref/registration/#web-authentication>Web authentication</a><a class=headerlink href=#web-authentication title="Permanent link">&para;</a></h3> <p>On a client machine, run the <code>tailscale up</code> command and provide the FQDN of your headscale instance as argument:</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>&lt;YOUR_HEADSCALE_URL&gt;
</span></code></pre></div> <p>Usually, a browser window with further instructions is opened. This page explains how to complete the registration on your headscale server and it also prints the registration key required to approve the node:</p> <div class="tabbed-set tabbed-alternate" data-tabs=4:2><input checked=checked id=__tabbed_4_1 name=__tabbed_4 type=radio><input id=__tabbed_4_2 name=__tabbed_4 type=radio><div class=tabbed-labels><label for=__tabbed_4_1>Native</label><label for=__tabbed_4_2>Container</label></div> <div class=tabbed-content> <div class=tabbed-block> <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>headscale<span class=w> </span>nodes<span class=w> </span>register<span class=w> </span>--user<span class=w> </span>&lt;USER&gt;<span class=w> </span>--key<span class=w> </span>&lt;REGISTRATION_KEY&gt;
</span></code></pre></div> <p>Usually, a browser window with further instructions is opened. This page explains how to complete the registration on your headscale server and it also prints the Auth ID required to approve the node:</p> <div class="tabbed-set tabbed-alternate" data-tabs=4:2><input checked=checked id=__tabbed_4_1 name=__tabbed_4 type=radio><input id=__tabbed_4_2 name=__tabbed_4 type=radio><div class=tabbed-labels><label for=__tabbed_4_1>Native</label><label for=__tabbed_4_2>Container</label></div> <div class=tabbed-content> <div class=tabbed-block> <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>headscale<span class=w> </span>auth<span class=w> </span>register<span class=w> </span>--user<span class=w> </span>&lt;USER&gt;<span class=w> </span>--auth-id<span class=w> </span>&lt;AUTH_ID&gt;
</span></code></pre></div> </div> <div class=tabbed-block> <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>nodes<span class=w> </span>register<span class=w> </span>--user<span class=w> </span>&lt;USER&gt;<span class=w> </span>--key<span class=w> </span>&lt;REGISTRATION_KEY&gt;
</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>auth<span class=w> </span>register<span class=w> </span>--user<span class=w> </span>&lt;USER&gt;<span class=w> </span>--auth-id<span class=w> </span>&lt;AUTH_ID&gt;
</span></code></pre></div> </div> </div> </div> <h3 id=pre-authenticated-key><a href=../../ref/registration/#pre-authenticated-key>Pre authenticated key</a><a class=headerlink href=#pre-authenticated-key title="Permanent link">&para;</a></h3> <p>It is also possible to generate a preauthkey and register a node non-interactively. First, generate a preauthkey on the headscale instance. By default, the key is valid for one hour and can only be used once (see <code>headscale preauthkeys --help</code> for other options):</p> <div class="tabbed-set tabbed-alternate" data-tabs=5:2><input checked=checked id=__tabbed_5_1 name=__tabbed_5 type=radio><input id=__tabbed_5_2 name=__tabbed_5 type=radio><div class=tabbed-labels><label for=__tabbed_5_1>Native</label><label for=__tabbed_5_2>Container</label></div> <div class=tabbed-content> <div class=tabbed-block> <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>headscale<span class=w> </span>preauthkeys<span class=w> </span>create<span class=w> </span>--user<span class=w> </span>&lt;USER_ID&gt;
</span></code></pre></div> </div> <div class=tabbed-block> <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><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-11-2><a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-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>&lt;USER_ID&gt;