mirror of
https://github.com/juanfont/headscale.git
synced 2026-11-19 20:04:32 +09:00
Deployed 07859e5f to development with ProperDocs 1.6.7 and mike 2.2.0
This commit is contained in:
1 parent
29600c97a9
commit
19d4dba3d4
3 files changed
+7
-5
No files matched your search
@@ -199,9 +199,11 @@ database:
|
||||
# The database file, relative to the configuration file; `:memory:` keeps
|
||||
# the database in memory.
|
||||
path: /var/lib/headscale/db.sqlite
|
||||
# Applies `database.sqlite.wal_autocheckpoint` and compacts the database
|
||||
# (`VACUUM`) on shutdown. SQLite runs in WAL mode either way; false keeps
|
||||
# SQLite's default checkpoint of 1000 frames.
|
||||
# Runs SQLite in write-ahead log (WAL) mode, applies
|
||||
# `database.sqlite.wal_autocheckpoint` and compacts the database (`VACUUM`)
|
||||
# on shutdown. False uses SQLite's rollback journal (`DELETE`) with
|
||||
# `synchronous=FULL`, and converts a database left in WAL mode when
|
||||
# headscale opens it.
|
||||
write_ahead_log: true
|
||||
# The number of WAL frames after which the WAL is checkpointed
|
||||
# automatically; zero disables automatic checkpoints. Applied only when
|
||||
|
||||
@@ -283,7 +283,7 @@
|
||||
</span><span id=__span-134-3><a id=__codelineno-134-3 name=__codelineno-134-3 href=#__codelineno-134-3></a><span class=w> </span><span class=nt>path</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">/opt/headscale/db.sqlite</span>
|
||||
</span></code></pre></div> </div> <div class=tabbed-block> <div class="language-shell highlight"><pre><span></span><code><span id=__span-135-1><a id=__codelineno-135-1 name=__codelineno-135-1 href=#__codelineno-135-1></a><span class=nb>export</span><span class=w> </span><span class=nv>HEADSCALE_DATABASE_SQLITE_PATH</span><span class=o>=</span>/opt/headscale/db.sqlite
|
||||
</span></code></pre></div> </div> <div class=tabbed-block> <div class="language-nix highlight"><pre><span></span><code><span id=__span-136-1><a id=__codelineno-136-1 name=__codelineno-136-1 href=#__codelineno-136-1></a>services<span class=o>.</span>headscale<span class=o>.</span>settings<span class=o>.</span>database<span class=o>.</span>sqlite<span class=o>.</span><span class=ss>path</span> <span class=o>=</span> <span class=s2>"/opt/headscale/db.sqlite"</span><span class=p>;</span>
|
||||
</span></code></pre></div> </div> </div> </div> <p>Replaces <code>db_path</code> (<a href=#db_path>removed</a>).</p> <h4 id=database.sqlite.write_ahead_log><code>database.sqlite.write_ahead_log</code><a class=headerlink href=#database.sqlite.write_ahead_log title="Permanent link">¶</a></h4> <ul> <li><strong>Type:</strong> <a href=#type-boolean>boolean</a></li> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Env:</strong> <code>HEADSCALE_DATABASE_SQLITE_WRITE_AHEAD_LOG</code></li> </ul> <p>Applies <a href=#database.sqlite.wal_autocheckpoint><code>database.sqlite.wal_autocheckpoint</code></a> and compacts the database (<code>VACUUM</code>) on shutdown. SQLite runs in WAL mode either way; false keeps SQLite's default checkpoint of 1000 frames.</p> <div class="tabbed-set tabbed-alternate" data-tabs=41:3><input checked=checked id=__tabbed_41_1 name=__tabbed_41 type=radio><input id=__tabbed_41_2 name=__tabbed_41 type=radio><input id=__tabbed_41_3 name=__tabbed_41 type=radio><div class=tabbed-labels><label for=__tabbed_41_1>YAML</label><label for=__tabbed_41_2>Environment</label><label for=__tabbed_41_3>NixOS</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="language-yaml highlight"><pre><span></span><code><span id=__span-137-1><a id=__codelineno-137-1 name=__codelineno-137-1 href=#__codelineno-137-1></a><span class=nt>database</span><span class=p>:</span>
|
||||
</span></code></pre></div> </div> </div> </div> <p>Replaces <code>db_path</code> (<a href=#db_path>removed</a>).</p> <h4 id=database.sqlite.write_ahead_log><code>database.sqlite.write_ahead_log</code><a class=headerlink href=#database.sqlite.write_ahead_log title="Permanent link">¶</a></h4> <ul> <li><strong>Type:</strong> <a href=#type-boolean>boolean</a></li> <li><strong>Default:</strong> <code>true</code></li> <li><strong>Env:</strong> <code>HEADSCALE_DATABASE_SQLITE_WRITE_AHEAD_LOG</code></li> </ul> <p>Runs SQLite in write-ahead log (WAL) mode, applies <a href=#database.sqlite.wal_autocheckpoint><code>database.sqlite.wal_autocheckpoint</code></a> and compacts the database (<code>VACUUM</code>) on shutdown. False uses SQLite's rollback journal (<code>DELETE</code>) with <code>synchronous=FULL</code>, and converts a database left in WAL mode when headscale opens it.</p> <div class="tabbed-set tabbed-alternate" data-tabs=41:3><input checked=checked id=__tabbed_41_1 name=__tabbed_41 type=radio><input id=__tabbed_41_2 name=__tabbed_41 type=radio><input id=__tabbed_41_3 name=__tabbed_41 type=radio><div class=tabbed-labels><label for=__tabbed_41_1>YAML</label><label for=__tabbed_41_2>Environment</label><label for=__tabbed_41_3>NixOS</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="language-yaml highlight"><pre><span></span><code><span id=__span-137-1><a id=__codelineno-137-1 name=__codelineno-137-1 href=#__codelineno-137-1></a><span class=nt>database</span><span class=p>:</span>
|
||||
</span><span id=__span-137-2><a id=__codelineno-137-2 name=__codelineno-137-2 href=#__codelineno-137-2></a><span class=w> </span><span class=nt>sqlite</span><span class=p>:</span>
|
||||
</span><span id=__span-137-3><a id=__codelineno-137-3 name=__codelineno-137-3 href=#__codelineno-137-3></a><span class=w> </span><span class=nt>write_ahead_log</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</span></code></pre></div> </div> <div class=tabbed-block> <div class="language-shell highlight"><pre><span></span><code><span id=__span-138-1><a id=__codelineno-138-1 name=__codelineno-138-1 href=#__codelineno-138-1></a><span class=nb>export</span><span class=w> </span><span class=nv>HEADSCALE_DATABASE_SQLITE_WRITE_AHEAD_LOG</span><span class=o>=</span><span class=nb>false</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
|
||||
Reference in new issue
Block a user