Deployed 9baa795d to development with MkDocs 1.6.1 and mike 2.1.3

development/ref/api/index.html

@@ -6,8 +6,8 @@
 </span></code></pre></div> </div> <div class=tabbed-block> <div class="language-console highlight"><pre><span></span><code><span id=__span-4-1><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=go>curl -H &quot;Authorization: Bearer &lt;API_KEY&gt;&quot; \</span>
 </span><span id=__span-4-2><a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a><span class=go>    https://headscale.example.com/api/v1/user?name=bob</span>
 </span></code></pre></div> </div> <div class=tabbed-block> <div class="language-console highlight"><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a><span class=go>curl -H &quot;Authorization: Bearer &lt;API_KEY&gt;&quot; \</span>
-</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a><span class=go>    -d user=&lt;USER&gt; -d key=&lt;REGISTRATION_KEY&gt; \</span>
-</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a><span class=go>    https://headscale.example.com/api/v1/node/register</span>
+</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a><span class=go>    --json &#39;{&quot;user&quot;: &quot;&lt;USER&gt;&quot;, &quot;authId&quot;: &quot;AUTH_ID&gt;&quot;}&#39; \</span>
+</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a><span class=go>    https://headscale.example.com/api/v1/auth/register</span>
 </span></code></pre></div> </div> </div> </div> <h2 id=grpc>gRPC<a class=headerlink href=#grpc title="Permanent link">&para;</a></h2> <p>The gRPC interface can be used to control a Headscale instance from a remote machine with the <code>headscale</code> binary.</p> <h3 id=prerequisite>Prerequisite<a class=headerlink href=#prerequisite title="Permanent link">&para;</a></h3> <ul> <li>A workstation to run <code>headscale</code> (any supported platform, e.g. Linux).</li> <li>A Headscale server with gRPC enabled.</li> <li>Connections to the gRPC port (default: <code>50443</code>) are allowed.</li> <li>Remote access requires an encrypted connection via TLS.</li> <li>An <a href=#api>API key</a> to authenticate with the Headscale server.</li> </ul> <h3 id=setup-remote-control>Setup remote control<a class=headerlink href=#setup-remote-control title="Permanent link">&para;</a></h3> <ol> <li> <p>Download the <a href=https://github.com/juanfont/headscale/releases><code>headscale</code> binary from GitHub's release page</a>. Make sure to use the same version as on the server.</p> </li> <li> <p>Put the binary somewhere in your <code>PATH</code>, e.g. <code>/usr/local/bin/headscale</code></p> </li> <li> <p>Make <code>headscale</code> executable: <code>chmod +x /usr/local/bin/headscale</code></p> </li> <li> <p><a href=#api>Create an API key</a> on the Headscale server.</p> </li> <li> <p>Provide the connection parameters for the remote Headscale server either via a minimal YAML configuration file or via environment variables:</p> <div class="tabbed-set tabbed-alternate" data-tabs=2:2><input checked=checked id=__tabbed_2_1 name=__tabbed_2 type=radio><input id=__tabbed_2_2 name=__tabbed_2 type=radio><div class=tabbed-labels><label for=__tabbed_2_1>Minimal YAML configuration file</label><label for=__tabbed_2_2>Environment variables</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="language-yaml highlight"><span class=filename>config.yaml</span><pre><span></span><code><span id=__span-6-1><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a><span class=nt>cli</span><span class=p>:</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><span class=nt>address</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">&lt;HEADSCALE_ADDRESS&gt;:&lt;PORT&gt;</span>
 </span><span id=__span-6-3><a id=__codelineno-6-3 name=__codelineno-6-3 href=#__codelineno-6-3></a><span class=w>    </span><span class=nt>api_key</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">&lt;API_KEY&gt;</span>

development/usage/getting-started/index.html

@@ -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;