362 commits

Author	SHA1	Message	Date
Florian Preinstorfer	f1494a32ce	Update links to Tailscale documentation	2026-04-18 09:33:41 +02:00
Florian Preinstorfer	7e6c7924ad	Document availability of autgroup:internet	2026-04-18 09:33:41 +02:00
Florian Preinstorfer	813eb2d733	Update docs for new HA tracking ... Also shorten the description in config-example.yaml a bit.	2026-04-17 16:59:57 +02:00
Florian Preinstorfer	32e1d77663	Install config-example.yaml as example for the debian package ... The directory /usr/share/doc/headscale/examples may be used to install arbitrary example files. This is useful to get a matching configuration for the release which gets also overwritten automatically.	2026-04-13 20:49:39 +02:00
Kristoffer Dalby	4d0b273b90	types: add node.expiry config, deprecate oidc.expiry ... Introduce a structured NodeConfig that replaces the flat EphemeralNodeInactivityTimeout field with a nested Node section. Add node.expiry config (default: no expiry) as the unified default key expiry for all non-tagged nodes regardless of registration method. Remove oidc.expiry entirely — node.expiry now applies to OIDC nodes the same as all other registration methods. Using oidc.expiry in the config is a hard error. determineNodeExpiry() returns nil (no expiry) unless use_expiry_from_token is enabled, letting state.go apply the node.expiry default uniformly. The old ephemeral_node_inactivity_timeout key is preserved for backwards compatibility. Updates #1711	2026-04-08 13:00:22 +01:00
Kristoffer Dalby	fda72ad1a3	Update main.md ... Co-authored-by: nblock <nblock@users.noreply.github.com>	2026-03-31 13:36:31 +02:00
Kristoffer Dalby	dfaf120f2a	docs: add development builds install page ... Move the container image and binary download details from the README into a dedicated documentation page at setup/install/main. This gives development builds a proper home in the docs site alongside the other install methods. The README now links to the docs page instead.	2026-03-31 13:36:31 +02:00
Florian Preinstorfer	f3512d50df	Switch to mkdocs-materialx ... The project mkdocs-material is in maintenance-only mode and their successor is not ready yet. Use the modern, refreshed theme and drop the pymdownx.magiclink extension.	2026-03-25 22:30:03 +01:00
Florian Preinstorfer	efd83da14e	Explicitly mention that a headscale username should *not* end with @ ... See: #3149	2026-03-20 19:44:33 +01:00
Florian Preinstorfer	9baa795ddb	Update docs for auth-id changes ... - Replace "headscale nodes register" with "headscale auth register" - Update from registration key to Auth ID - Fix API example to register a node	2026-03-01 13:38:22 +01:00
Florian Preinstorfer	acddd73183	Reformat docs with mdformat	2026-03-01 09:24:52 +01:00
Stefan Bethke	0f12e414a6	Explain one approach to update OIDC provider info ... See #3112	2026-02-27 10:06:50 +01:00
Stefan Bethke	df339cd290	Add a link to Authentik's integration guide	2026-02-27 09:56:18 +01:00
Brandon Sprague	a0d6802d5b	Fix minor formatting issue in FAQ ... This just fixes a small issue I noticed reading the docs: the two 'scenarios' listed in the scaling section end up showing up as a numbered list of five items, instead of the desired two items + their descriptions.	2026-02-20 16:59:14 +01:00
Florian Preinstorfer	cfb308b4a7	Add FAQ entry to migrate back to default IP prefixes	2026-02-19 17:16:40 +01:00
Florian Preinstorfer	4bb0241257	Require to update from one version to the next	2026-02-19 17:16:40 +01:00
Florian Preinstorfer	d556df1c36	Extend upgrade guide with backup instructions	2026-02-19 17:16:40 +01:00
Florian Preinstorfer	faf55f5e8f	Document how to use the provider identifier in the policy	2026-02-18 10:24:05 +01:00
Florian Preinstorfer	e3323b65e5	Describe how to set username instead of SPN for Kanidm	2026-02-18 10:24:05 +01:00
Florian Preinstorfer	8f60b819ec	Refresh update path	2026-02-16 15:22:46 +01:00
Florian Preinstorfer	c29bcd2eaf	Release planning happens in milestones	2026-02-16 15:22:46 +01:00
Florian Preinstorfer	890a044ef6	Add more UIs	2026-02-16 15:22:46 +01:00
Florian Preinstorfer	8028fa5483	No longer consider autogroup:self experimental	2026-02-16 15:22:46 +01:00
Florian Preinstorfer	5d300273dc	Add a tags page and describe a few common operations	2026-01-28 15:52:57 +01:00
Florian Preinstorfer	7f003ecaff	Add a page to describe supported registration methods	2026-01-28 15:52:57 +01:00
Florian Preinstorfer	2695d1527e	Use registration key instead of machine key	2026-01-28 15:52:57 +01:00
Florian Preinstorfer	d32f6707f7	Add missing words	2026-01-28 15:52:57 +01:00
Florian Preinstorfer	a445278f76	Mention tags on the features page	2026-01-16 14:54:04 +01:00
Florian Preinstorfer	8387c9cd82	Fix ownership description for auto approved routers/exits ... Just the tags tag:router and tag:exit are owned by alice. Upon join, those nodes will have their ownership transferred from alice to the system user "tagged-devices".	2026-01-16 14:54:04 +01:00
Florian Preinstorfer	183a38715c	Fix list-routes examples	2026-01-16 14:54:04 +01:00
Florian Preinstorfer	99d35fbbbc	Document oidc.email_verification_required	2026-01-16 14:54:04 +01:00
Florian Preinstorfer	6d21a4a3fe	Document /version in the API docs	2026-01-16 14:54:04 +01:00
Florian Preinstorfer	7d81dca9aa	Document how to disable the metrics interfaces	2026-01-16 14:54:04 +01:00
chen	bb30208f97	Add headscale-piying web UI to docs	2026-01-14 12:56:05 +01:00
Florian Preinstorfer	c3e2e57f8e	Clarify autogroup:member ... Fixes: #3007	2026-01-14 12:44:18 +01:00
Florian Preinstorfer	9146140217	Add headscale-operator ... Ref: #1523	2025-12-23 20:22:57 +01:00
Florian Preinstorfer	bba91a89be	Use lists for integration docs ... Refactor the tables in "Tools" and "WebUI" integration pages to lists. Lists are easier to extend and contributions are easier to review.	2025-12-08 12:50:19 +01:00
adinhodovic	d2fcd5b95b	docs(tools): Add tailscale-exporter ... A Prometheus exporter for Tailscale and Headscale that provides tailnet-level metrics using the Tailscale/Headscale API.	2025-12-07 14:39:08 +01:00
Florian Preinstorfer	f00c412cde	Move static doc assets into docs/assets	2025-11-28 21:27:54 +01:00
Florian Preinstorfer	2010805712	Provide Headscale's favicon at its expected place ... Assets need to reside within the docs/ directory for mkdocs to pick them up.	2025-11-28 21:27:54 +01:00
Florian Preinstorfer	c5133ee5d3	Fix trailing whitespace	2025-11-28 21:27:54 +01:00
János Benjamin Antal	14af9b3ab1	Add docs to manage headscale from another local user	2025-11-24 06:37:35 +01:00
Florian Preinstorfer	72d5fd04a7	Remove duplicated documentation and link to getting started instead	2025-11-18 11:07:49 +01:00
Florian Preinstorfer	e86d063056	Mention /health instead of /windows	2025-11-18 11:07:49 +01:00
Acha	e0c9e18e22	Update OIDC documentation for allowed groups filter ... Clarify configuration for allowed groups filter with Microsoft Entra ID.	2025-11-15 17:44:00 +01:00
Florian Preinstorfer	21af106f68	Containers should be read-only ... This improves security and explicitly fails on startup when a user picks the wrong directory to store its data. - Run in read-only mode - Make /var/run/headscale a read-write tmpfs - Mount the config volume read-only - Use the /health endpoint to check if Headscale is up	2025-11-14 14:51:27 +01:00
Florian Preinstorfer	249630bed8	Add API documentation ... Document the API endpoint and the built-in swagger docs at /swagger. The remote control docs are just a use case for gRPC - move it in the API docs and update links to it.	2025-11-13 15:22:55 +01:00
Kristoffer Dalby	6d24afba1c	add pre-commit hooks, move claude to agents. (#2877)	2025-11-11 20:35:23 +01:00
Florian Preinstorfer	abed534628	Document how to restrict access to exit nodes per user/group ... Updates: #2855 Ref: #2784	2025-11-11 11:51:35 +01:00
Florian Preinstorfer	0a43aab8f5	Use Debian 12 as minimum version for the deb package	2025-10-28 05:55:26 +01:00