mirror of
https://github.com/juanfont/headscale.git
synced 2026-11-19 20:04:32 +09:00
Deployed ce295d67 to development with ProperDocs 1.6.7 and mike 2.2.0
This commit is contained in:
1 parent
19d4dba3d4
commit
11e80bd416
4 files changed
+10
-10
No files matched your search
@@ -309,11 +309,11 @@ dns:
|
||||
- 149.112.112.112:53
|
||||
# The DNS provider that writes challenge records: `name` selects it, the
|
||||
# other keys are its settings. Keys are lowercased on load, at every depth;
|
||||
# two that differ only in case are an error. A string setting may be
|
||||
# `file:<path>` to read it from a file. `headscale generate config
|
||||
# --running` and `/debug/config` show `name` and `file:` references; every
|
||||
# other setting is `<redacted>`, as any may be a credential. See [DNS-01
|
||||
# challenge
|
||||
# two that differ only in case are an error. Any setting may be
|
||||
# `file:<path>` to read it from a file; a non-string one, such as acme-dns
|
||||
# `config`, is the JSON in it. `headscale generate config --running` and
|
||||
# `/debug/config` show `name` and `file:` references; every other setting is
|
||||
# `<redacted>`, as any may be a credential. See [DNS-01 challenge
|
||||
# provider](https://headscale.net/stable/ref/dns/#dns-01-challenge-provider)
|
||||
# to set a provider up, acme-dns included, and to set it from environment
|
||||
# variables.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
</span></code></pre></div> <div class="language-yaml highlight"><span class=filename>docker-compose.yaml</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=nt>environment</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=nt>HEADSCALE_PREFIXES_V6</span><span class=p>:</span><span class=w> </span><span class=s>'""'</span>
|
||||
</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=w> </span><span class=nt>HEADSCALE_DERP_URLS</span><span class=p>:</span><span class=w> </span><span class=s>'[]'</span>
|
||||
</span></code></pre></div> <p>An env file (a Compose <code>env_file</code>, a systemd <code>EnvironmentFile=</code>) and a systemd <code>Environment=</code> strip one level of quotes, so <code>KEY=""</code> there arrives empty and keeps the default: write <code>KEY='""'</code> in an env file and <code>Environment='KEY=""'</code> in a unit.</p> <p>A list is a JSON array or, unless its values are objects, its values separated by spaces. A map is a JSON object, which replaces the map in the configuration file instead of merging into it. The examples below write every list and map as JSON.</p> <p>A <code>HEADSCALE_</code> variable that names no key logs a warning, and one for a removed key also says what to do instead. Other software uses the same prefix, so neither stops headscale.</p> <p>A DNS provider setting that takes text can also be set on its own as <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_<SETTING></code>, e.g. <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_API_TOKEN</code>; see <a href=#dns.challenge.provider><code>dns.challenge.provider</code></a>.</p> <h3 id=secrets>Secrets<a class=headerlink href=#secrets title="Permanent link">¶</a></h3> <p>A secret takes the value itself or <code>file:<path></code>, which reads it from that file. Environment variables in the path are expanded, as in <code>file:${CREDENTIALS_DIRECTORY}/oidc_client_secret</code>, and whitespace around the file's contents is trimmed; an empty file is an error. Headscale reads the file only where the secret is used, and <code>headscale check config</code> and <code>headscale check all</code> never read it. <code>headscale generate config --running</code> and <code>/debug/config</code> show a literal secret as <code><redacted></code> and a <code>file:</code> reference as written.</p> <p>The secrets are <a href=#database.postgres.pass><code>database.postgres.pass</code></a>, <a href=#oidc.client_secret><code>oidc.client_secret</code></a>, <a href=#cli.api_key><code>cli.api_key</code></a> and every string setting of <a href=#dns.challenge.provider><code>dns.challenge.provider</code></a>.</p> <p>On NixOS, keep a secret out of the Nix store: load it as a systemd credential and point the key at it.</p> <div class="language-nix highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>services<span class=o>.</span>headscale<span class=o>.</span>settings<span class=o>.</span>oidc<span class=o>.</span><span class=ss>client_secret</span> <span class=o>=</span> <span class=s2>"file:</span><span class=se>\$</span><span class=s2>{CREDENTIALS_DIRECTORY}/oidc_client_secret"</span><span class=p>;</span>
|
||||
</span></code></pre></div> <p>An env file (a Compose <code>env_file</code>, a systemd <code>EnvironmentFile=</code>) and a systemd <code>Environment=</code> strip one level of quotes, so <code>KEY=""</code> there arrives empty and keeps the default: write <code>KEY='""'</code> in an env file and <code>Environment='KEY=""'</code> in a unit.</p> <p>A list is a JSON array or, unless its values are objects, its values separated by spaces. A map is a JSON object, which replaces the map in the configuration file instead of merging into it. The examples below write every list and map as JSON.</p> <p>A <code>HEADSCALE_</code> variable that names no key logs a warning, and one for a removed key also says what to do instead. Other software uses the same prefix, so neither stops headscale.</p> <p>A DNS provider setting that takes text can also be set on its own as <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_<SETTING></code>, e.g. <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_API_TOKEN</code>; see <a href=#dns.challenge.provider><code>dns.challenge.provider</code></a>.</p> <h3 id=secrets>Secrets<a class=headerlink href=#secrets title="Permanent link">¶</a></h3> <p>A secret takes the value itself or <code>file:<path></code>, which reads it from that file. Environment variables in the path are expanded, as in <code>file:${CREDENTIALS_DIRECTORY}/oidc_client_secret</code>, and whitespace around the file's contents is trimmed; an empty file is an error. Headscale reads the file only where the secret is used, and <code>headscale check config</code> and <code>headscale check all</code> never read it. <code>headscale generate config --running</code> and <code>/debug/config</code> show a literal secret as <code><redacted></code> and a <code>file:</code> reference as written.</p> <p>The secrets are <a href=#database.postgres.pass><code>database.postgres.pass</code></a>, <a href=#oidc.client_secret><code>oidc.client_secret</code></a>, <a href=#cli.api_key><code>cli.api_key</code></a> and every setting of <a href=#dns.challenge.provider><code>dns.challenge.provider</code></a>, where a non-string one, such as acme-dns <code>config</code>, is the JSON in the file.</p> <p>On NixOS, keep a secret out of the Nix store: load it as a systemd credential and point the key at it.</p> <div class="language-nix highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>services<span class=o>.</span>headscale<span class=o>.</span>settings<span class=o>.</span>oidc<span class=o>.</span><span class=ss>client_secret</span> <span class=o>=</span> <span class=s2>"file:</span><span class=se>\$</span><span class=s2>{CREDENTIALS_DIRECTORY}/oidc_client_secret"</span><span class=p>;</span>
|
||||
</span><span id=__span-2-2><a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a>systemd<span class=o>.</span>services<span class=o>.</span>headscale<span class=o>.</span>serviceConfig<span class=o>.</span><span class=ss>LoadCredential</span> <span class=o>=</span> <span class=p>[</span> <span class=s2>"oidc_client_secret:/run/secrets/oidc_client_secret"</span> <span class=p>];</span>
|
||||
</span></code></pre></div> <h2 id=server_url><code>server_url</code><a class=headerlink href=#server_url title="Permanent link">¶</a></h2> <ul> <li><strong>Type:</strong> <a href=#type-string>string</a></li> <li><strong>Required</strong></li> <li><strong>Env:</strong> <code>HEADSCALE_SERVER_URL</code></li> </ul> <p>The URL clients connect to, with its <code>http://</code> or <code>https://</code> scheme, e.g. <code>https://headscale.example.com:443</code>. A trailing slash is trimmed on load. Its host must not be <a href=#dns.base_domain><code>dns.base_domain</code></a> or a name below it.</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:3><input checked=checked id=__tabbed_1_1 name=__tabbed_1 type=radio><input id=__tabbed_1_2 name=__tabbed_1 type=radio><input id=__tabbed_1_3 name=__tabbed_1 type=radio><div class=tabbed-labels><label for=__tabbed_1_1>YAML</label><label for=__tabbed_1_2>Environment</label><label for=__tabbed_1_3>NixOS</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="language-yaml highlight"><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=nt>server_url</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">https://headscale.example.com</span>
|
||||
</span></code></pre></div> </div> <div class=tabbed-block> <div class="language-shell 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=nb>export</span><span class=w> </span><span class=nv>HEADSCALE_SERVER_URL</span><span class=o>=</span>https://headscale.example.com
|
||||
@@ -487,7 +487,7 @@
|
||||
</span><span id=__span-210-2><a id=__codelineno-210-2 name=__codelineno-210-2 href=#__codelineno-210-2></a> <span class=s2>"9.9.9.9:53"</span>
|
||||
</span><span id=__span-210-3><a id=__codelineno-210-3 name=__codelineno-210-3 href=#__codelineno-210-3></a> <span class=s2>"[2620:fe::fe]:53"</span>
|
||||
</span><span id=__span-210-4><a id=__codelineno-210-4 name=__codelineno-210-4 href=#__codelineno-210-4></a><span class=p>];</span>
|
||||
</span></code></pre></div> </div> </div> </div> <h4 id=dns.challenge.provider><code>dns.challenge.provider</code><a class=headerlink href=#dns.challenge.provider title="Permanent link">¶</a></h4> <ul> <li><strong>Type:</strong> <a href=#type-map>map of <code><setting></code> → value</a></li> <li><strong>Default:</strong> <code>{}</code></li> <li><strong>Env:</strong> <code>HEADSCALE_DNS_CHALLENGE_PROVIDER</code> (<a href=#env>JSON object</a>)</li> </ul> <p>The DNS provider that writes challenge records: <code>name</code> selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. A string setting may be <code>file:<path></code> to read it from a file. <code>headscale generate config --running</code> and <code>/debug/config</code> show <code>name</code> and <code>file:</code> references; every other setting is <code><redacted></code>, as any may be a credential. See <a href=../dns/#dns-01-challenge-provider>DNS-01 challenge provider</a> to set a provider up, acme-dns included, and to set it from environment variables.</p> <table> <thead> <tr> <th>Provider</th> <th>Settings</th> </tr> </thead> <tbody> <tr> <td><code>acmedns</code></td> <td><code>config</code>, <code>password</code>, <code>server_url</code>, <code>subdomain</code>, <code>username</code></td> </tr> <tr> <td><code>cloudflare</code></td> <td><code>api_token</code>, <code>zone_token</code></td> </tr> <tr> <td><code>gigahost</code></td> <td><code>api_key</code></td> </tr> <tr> <td><code>hetzner</code></td> <td><code>api_token</code></td> </tr> <tr> <td><code>powerdns</code></td> <td><code>api_token</code>, <code>debug</code>, <code>server_id</code>, <code>server_url</code></td> </tr> <tr> <td><code>rfc2136</code></td> <td><code>key</code>, <code>key_alg</code>, <code>key_name</code>, <code>server</code></td> </tr> </tbody> </table> <p>Each text setting can also be set on its own as <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_<SETTING></code>, e.g. <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_API_TOKEN</code>, which wins over the same setting in <code>HEADSCALE_DNS_CHALLENGE_PROVIDER</code> and in the configuration file. An object setting, such as the <code>config</code> of <code>acmedns</code>, goes inside the JSON object of <code>HEADSCALE_DNS_CHALLENGE_PROVIDER</code>; see <a href=../dns/#environment-variables>Environment variables</a>.</p> <div class="tabbed-set tabbed-alternate" data-tabs=64:3><input checked=checked id=__tabbed_64_1 name=__tabbed_64 type=radio><input id=__tabbed_64_2 name=__tabbed_64 type=radio><input id=__tabbed_64_3 name=__tabbed_64 type=radio><div class=tabbed-labels><label for=__tabbed_64_1>YAML</label><label for=__tabbed_64_2>Environment</label><label for=__tabbed_64_3>NixOS</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="language-yaml highlight"><pre><span></span><code><span id=__span-211-1><a id=__codelineno-211-1 name=__codelineno-211-1 href=#__codelineno-211-1></a><span class=nt>dns</span><span class=p>:</span>
|
||||
</span></code></pre></div> </div> </div> </div> <h4 id=dns.challenge.provider><code>dns.challenge.provider</code><a class=headerlink href=#dns.challenge.provider title="Permanent link">¶</a></h4> <ul> <li><strong>Type:</strong> <a href=#type-map>map of <code><setting></code> → value</a></li> <li><strong>Default:</strong> <code>{}</code></li> <li><strong>Env:</strong> <code>HEADSCALE_DNS_CHALLENGE_PROVIDER</code> (<a href=#env>JSON object</a>)</li> </ul> <p>The DNS provider that writes challenge records: <code>name</code> selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. Any setting may be <code>file:<path></code> to read it from a file; a non-string one, such as acme-dns <code>config</code>, is the JSON in it. <code>headscale generate config --running</code> and <code>/debug/config</code> show <code>name</code> and <code>file:</code> references; every other setting is <code><redacted></code>, as any may be a credential. See <a href=../dns/#dns-01-challenge-provider>DNS-01 challenge provider</a> to set a provider up, acme-dns included, and to set it from environment variables.</p> <table> <thead> <tr> <th>Provider</th> <th>Settings</th> </tr> </thead> <tbody> <tr> <td><code>acmedns</code></td> <td><code>config</code>, <code>password</code>, <code>server_url</code>, <code>subdomain</code>, <code>username</code></td> </tr> <tr> <td><code>cloudflare</code></td> <td><code>api_token</code>, <code>zone_token</code></td> </tr> <tr> <td><code>gigahost</code></td> <td><code>api_key</code></td> </tr> <tr> <td><code>hetzner</code></td> <td><code>api_token</code></td> </tr> <tr> <td><code>powerdns</code></td> <td><code>api_token</code>, <code>debug</code>, <code>server_id</code>, <code>server_url</code></td> </tr> <tr> <td><code>rfc2136</code></td> <td><code>key</code>, <code>key_alg</code>, <code>key_name</code>, <code>server</code></td> </tr> </tbody> </table> <p>Each text setting can also be set on its own as <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_<SETTING></code>, e.g. <code>HEADSCALE_DNS_CHALLENGE_PROVIDER_API_TOKEN</code>, which wins over the same setting in <code>HEADSCALE_DNS_CHALLENGE_PROVIDER</code> and in the configuration file. An object setting, such as the <code>config</code> of <code>acmedns</code>, goes inside the JSON object of <code>HEADSCALE_DNS_CHALLENGE_PROVIDER</code>; see <a href=../dns/#environment-variables>Environment variables</a>.</p> <div class="tabbed-set tabbed-alternate" data-tabs=64:3><input checked=checked id=__tabbed_64_1 name=__tabbed_64 type=radio><input id=__tabbed_64_2 name=__tabbed_64 type=radio><input id=__tabbed_64_3 name=__tabbed_64 type=radio><div class=tabbed-labels><label for=__tabbed_64_1>YAML</label><label for=__tabbed_64_2>Environment</label><label for=__tabbed_64_3>NixOS</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="language-yaml highlight"><pre><span></span><code><span id=__span-211-1><a id=__codelineno-211-1 name=__codelineno-211-1 href=#__codelineno-211-1></a><span class=nt>dns</span><span class=p>:</span>
|
||||
</span><span id=__span-211-2><a id=__codelineno-211-2 name=__codelineno-211-2 href=#__codelineno-211-2></a><span class=w> </span><span class=nt>challenge</span><span class=p>:</span>
|
||||
</span><span id=__span-211-3><a id=__codelineno-211-3 name=__codelineno-211-3 href=#__codelineno-211-3></a><span class=w> </span><span class=nt>provider</span><span class=p>:</span>
|
||||
</span><span id=__span-211-4><a id=__codelineno-211-4 name=__codelineno-211-4 href=#__codelineno-211-4></a><span class=w> </span><span class=nt>api_token</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">file:/run/secrets/cloudflare</span>
|
||||
|
||||
@@ -1 +1 @@
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Welcome to headscale","text":"<p>Headscale is an open source, self-hosted implementation of the Tailscale control server.</p> <p>This page contains the documentation for the latest version of headscale. Please also check our FAQ.</p> <p>Join our Discord server for a chat and community support.</p>"},{"location":"#design-goal","title":"Design goal","text":"<p>Headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. Headscale's goal is to provide self-hosters and hobbyists with an open-source server they can use for their projects and labs. It implements a narrow scope, a single Tailscale network (tailnet), suitable for a personal use, or a small open-source organisation.</p>"},{"location":"#supporting-headscale","title":"Supporting headscale","text":"<p>Please see Sponsor for more information.</p>"},{"location":"#contributing","title":"Contributing","text":"<p>Headscale is \"Open Source, acknowledged contribution\", this means that any contribution will have to be discussed with the Maintainers before being submitted.</p> <p>Please see Contributing for more information.</p>"},{"location":"#about","title":"About","text":"<p>Headscale is maintained by Kristoffer Dalby and Juan Font.</p>"},{"location":"about/clients/","title":"Client and operating system support","text":"<p>We aim to support the last 10 releases of the Tailscale client on all provided operating systems and platforms. Some platforms might require additional configuration to connect with headscale.</p> OS Supports headscale Linux Yes OpenBSD Yes FreeBSD Yes Windows Yes (see docs and <code>/windows</code> on your headscale for more information) Android Yes (see docs for more information) macOS Yes (see docs and <code>/apple</code> on your headscale for more information) iOS Yes (see docs and <code>/apple</code> on your headscale for more information) tvOS Yes (see docs and <code>/apple</code> on your headscale for more information)"},{"location":"about/clients/#update-clients","title":"Update clients","text":"<p>Tailscale clients can update themselves. <code>auto_update.enabled: true</code> in the configuration file turns auto-updates on by default, but a node takes the default only while its own setting is unset. Once it has stored a value, from an earlier default or from <code>tailscale set --auto-update</code>, it keeps it. Headscale always sends a default, so turning the option on later does not reach nodes that joined while it was off.</p> <p>A connected node can also be asked to update right away:</p> <pre><code>headscale nodes update-client --identifier <NODE_ID>\n</code></pre> <p>The node must allow remote updates (<code>tailscale set --auto-update</code>) and run on a platform that can update itself. As on Tailscale, a node that does not, is not connected, or refuses (for example, with active Tailscale SSH sessions) is answered \"not found\". Headscale logs the reason a node gives. The command returns once the update has started.</p> <p>The same request is available in the API as <code>POST /api/v2/device/<NODE_ID>/update-client</code>, with no body. It needs an API key or an OAuth token with the <code>devices:core</code> scope. <code>GET /api/v2/device/<NODE_ID>/update-status</code> answers <code>{\"status\": \"updating\"}</code> from a started update until the node runs another version, for at most 10 minutes, and <code>{\"status\": \"not-updating\"}</code> otherwise. It needs the <code>devices:core:read</code> scope.</p>"},{"location":"about/contributing/","title":"Contributing","text":"<p>Headscale is \"Open Source, acknowledged contribution\", this means that any contribution will have to be discussed with the maintainers before being added to the project. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code.</p>"},{"location":"about/contributing/#why-do-we-have-this-model","title":"Why do we have this model?","text":"<p>Headscale has a small maintainer team that tries to balance working on the project, fixing bugs and reviewing contributions.</p> <p>When we work on issues ourselves, we develop first hand knowledge of the code and it makes it possible for us to maintain and own the code as the project develops.</p> <p>Code contributions are seen as a positive thing. People enjoy and engage with our project, but it also comes with some challenges; we have to understand the code, we have to understand the feature, we might have to become familiar with external libraries or services and we think about security implications. All those steps are required during the reviewing process. After the code has been merged, the feature has to be maintainLine truncated
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Welcome to headscale","text":"<p>Headscale is an open source, self-hosted implementation of the Tailscale control server.</p> <p>This page contains the documentation for the latest version of headscale. Please also check our FAQ.</p> <p>Join our Discord server for a chat and community support.</p>"},{"location":"#design-goal","title":"Design goal","text":"<p>Headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. Headscale's goal is to provide self-hosters and hobbyists with an open-source server they can use for their projects and labs. It implements a narrow scope, a single Tailscale network (tailnet), suitable for a personal use, or a small open-source organisation.</p>"},{"location":"#supporting-headscale","title":"Supporting headscale","text":"<p>Please see Sponsor for more information.</p>"},{"location":"#contributing","title":"Contributing","text":"<p>Headscale is \"Open Source, acknowledged contribution\", this means that any contribution will have to be discussed with the Maintainers before being submitted.</p> <p>Please see Contributing for more information.</p>"},{"location":"#about","title":"About","text":"<p>Headscale is maintained by Kristoffer Dalby and Juan Font.</p>"},{"location":"about/clients/","title":"Client and operating system support","text":"<p>We aim to support the last 10 releases of the Tailscale client on all provided operating systems and platforms. Some platforms might require additional configuration to connect with headscale.</p> OS Supports headscale Linux Yes OpenBSD Yes FreeBSD Yes Windows Yes (see docs and <code>/windows</code> on your headscale for more information) Android Yes (see docs for more information) macOS Yes (see docs and <code>/apple</code> on your headscale for more information) iOS Yes (see docs and <code>/apple</code> on your headscale for more information) tvOS Yes (see docs and <code>/apple</code> on your headscale for more information)"},{"location":"about/clients/#update-clients","title":"Update clients","text":"<p>Tailscale clients can update themselves. <code>auto_update.enabled: true</code> in the configuration file turns auto-updates on by default, but a node takes the default only while its own setting is unset. Once it has stored a value, from an earlier default or from <code>tailscale set --auto-update</code>, it keeps it. Headscale always sends a default, so turning the option on later does not reach nodes that joined while it was off.</p> <p>A connected node can also be asked to update right away:</p> <pre><code>headscale nodes update-client --identifier <NODE_ID>\n</code></pre> <p>The node must allow remote updates (<code>tailscale set --auto-update</code>) and run on a platform that can update itself. As on Tailscale, a node that does not, is not connected, or refuses (for example, with active Tailscale SSH sessions) is answered \"not found\". Headscale logs the reason a node gives. The command returns once the update has started.</p> <p>The same request is available in the API as <code>POST /api/v2/device/<NODE_ID>/update-client</code>, with no body. It needs an API key or an OAuth token with the <code>devices:core</code> scope. <code>GET /api/v2/device/<NODE_ID>/update-status</code> answers <code>{\"status\": \"updating\"}</code> from a started update until the node runs another version, for at most 10 minutes, and <code>{\"status\": \"not-updating\"}</code> otherwise. It needs the <code>devices:core:read</code> scope.</p>"},{"location":"about/contributing/","title":"Contributing","text":"<p>Headscale is \"Open Source, acknowledged contribution\", this means that any contribution will have to be discussed with the maintainers before being added to the project. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code.</p>"},{"location":"about/contributing/#why-do-we-have-this-model","title":"Why do we have this model?","text":"<p>Headscale has a small maintainer team that tries to balance working on the project, fixing bugs and reviewing contributions.</p> <p>When we work on issues ourselves, we develop first hand knowledge of the code and it makes it possible for us to maintain and own the code as the project develops.</p> <p>Code contributions are seen as a positive thing. People enjoy and engage with our project, but it also comes with some challenges; we have to understand the code, we have to understand the feature, we might have to become familiar with external libraries or services and we think about security implications. All those steps are required during the reviewing process. After the code has been merged, the feature has to be maintainLine truncated
|
||||
+2
-2
@@ -10,8 +10,8 @@
|
||||
"version": "0.29.7",
|
||||
"title": "0.29.7",
|
||||
"aliases": [
|
||||
"stable",
|
||||
"latest"
|
||||
"latest",
|
||||
"stable"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user