327 Commits

Author	SHA1	Message	Date
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
Florian Preinstorfer	ed38d00aaa	Fix autogroup:self alternative example ... Also indent and split the comment into two lines to avoid horizontal scrolling.	2025-10-21 14:28:03 +02:00
Florian Preinstorfer	8010cc574e	Remove outdated hint about an empty config file	2025-10-19 17:14:15 +02:00
Florian Preinstorfer	047dbda136	Add FAQ on how to disable log submission ... Fixes: #2793	2025-10-19 08:24:23 +02:00
Florian Preinstorfer	2a1392fb5b	Add healthcheck to container docs	2025-10-19 08:22:30 +02:00
Vitalij Dovhanyc	c2a58a304d	feat: add autogroup:self (#2789)	2025-10-16 12:59:52 +02:00
yckwan	3fbde7a1b6	Update official.md ... in the step 5 file default value is [line11] ExecStart=/usr/bin/headscale serve	2025-10-13 17:06:56 +02:00
Florian Preinstorfer	bd35fcf338	Add FAQ entry about policy migration in the database	2025-09-17 16:32:29 +02:00
Florian Preinstorfer	2d680b5ebb	Misc typos and spelling	2025-09-17 16:32:29 +02:00
Florian Preinstorfer	30d12dafed	Add FAQ entry about the recommended upgrade path	2025-09-13 08:15:01 +02:00
Oleksii Samoliuk	3f6657ae57	fix: documentation	2025-09-09 20:54:47 +02:00
Florian Preinstorfer	c6427aa296	Use group id instead of group name for Entra ID	2025-09-09 12:23:34 +02:00
Florian Preinstorfer	4e6d42d5bd	Keycloak's group format is configurable	2025-09-09 12:23:34 +02:00
Florian Preinstorfer	8ff5baadbe	Refresh OIDC docs ... The UserInfo endpoint is always queried since 5d8a2c2. This allows to use all OIDC related features without any extra configuration on Authelia. For Keycloak, its sufficient to add the groups mapper to the userinfo endpoint.	2025-09-09 12:23:34 +02:00
Florian Preinstorfer	2f3c365b68	Describe how to remove a DERP region ... Add documentation for d29feaef. Fixes: #2450	2025-09-09 11:05:30 +02:00
Dylan Blanqué	860a8a597f	Update tools.md ... Share/Contribute Headscale Zabbix Monitoring scripts and templates. Thank you for the awesome application to everyone involved in Headscale's development!	2025-08-24 06:05:21 +02:00
Florian Preinstorfer	e949859d33	Add DERP docs	2025-08-22 12:09:31 +02:00
afranco	3e3c72ea6f	docs(acls): Add example for allow/deny all acl policy	2025-08-18 16:13:14 +02:00
Florian Preinstorfer	7b8b796a71	docs: connect Android using a preauthkey ... Fixes: #2616	2025-08-18 16:06:17 +02:00
Florian Preinstorfer	30cec3aa2b	Document ports in use ... Ref: #1767	2025-08-14 09:24:09 +02:00
Luke Watts	b2a18830ed	docs: fix typos	2025-07-28 10:28:49 +02:00
Florian Preinstorfer	bcd80ee773	Add debugging and troubleshooting guide	2025-07-22 14:56:45 +02:00
Kian-Meng Ang	3123d5286b	Fix typos ... Found via `codespell -L shs,hastable,userr`	2025-07-21 12:06:07 +02:00
Florian Preinstorfer	a98d9bd05f	The preauthkeys commands expect a user id instead of a username	2025-07-16 09:53:05 +02:00
Mohammad Javad Naderi	a8f2eebf66	Fix config param name in TLS doc	2025-07-13 12:56:25 +02:00
Florian Preinstorfer	d461db3abd	Refactor OpenID Connect documentation ... Restructure and rewrite the OpenID Connect documentation. Start from the most minimal configuration and describe what needs to be done both in Headscale and the identity provider. Describe additional features such as PKCE and authorization filters in a generic manner with examples. Document how Headscale populates its user profile and how it relates to OIDC claims. This is a revised version from the table in the changelog. Document the validation rules for fields and extend known limitations. Sort the provider specific section alphabetically and add a section for Authelia, Authentik, Kanidm and Keycloak. Also simplify and rename Azure to Entra ID. Update the description for the oidc section in the example configuration. Give a short explanation of each configuration setting. All documentend features were tested with Headscale 0.26 (using a fresh database each time) using the following identity providers: * Authelia * Authentik * Kanidm * Keycloak Fixes: #2295	2025-07-04 10:51:37 +02:00
Kristoffer Dalby	081af2674b	ci: fix golangci-lint flag for v2 compatibility (#2654)	2025-06-24 08:14:50 +02:00
Shubham Hibare	df69840f92	feat(tools): Add Go client implementation	2025-05-23 17:52:31 +02:00
lucarickli	76ca7a2b50	Add headscale-console	2025-05-22 06:52:02 +02:00
Florian Preinstorfer	cd704570be	Drop support for Ubuntu 20.04 ... Its old and our service file logs warning about unsupported options.	2025-05-21 15:40:32 +02:00
Florian Preinstorfer	4a941a2cb4	Refactor Debian/Ubuntu package ... Move files for packaging outside the docs directory into its own packaging directory. Replace the existing postinstall and postremove scripts with Debian maintainerscripts to behave more like a typical Debian package: * Start and enable the headscale systemd service by default * Does not print informational messages * No longer stop and disable the service on updates This package also performs migrations for all changes done in previous package versions on upgrade: * Set login shell to /usr/sbin/nologin * Set home directory to /var/lib/headscale * Migrate to system UID/GID The package is lintian-clean with a few exceptions that are documented as excludes and it passes puipars (both tested on Debian 12). The following scenarious were tested on Ubuntu 22.04, Ubuntu 24.04, Debian 11, Debian 12: * Install * Install same version again * Install -> Remove -> Install * Install -> Purge -> Install * Purge * Update from 0.22.0 * Update from 0.26.0 See: #2278 See: #2133 Fixes: #2311	2025-05-21 15:40:32 +02:00
Vitalij Dovhanyc	6750414db1	feat: add autogroup:member, autogroup:tagged (#2572)	2025-05-17 11:07:34 +02:00
Florian Preinstorfer	c15aa541bb	Document HEADSCALE_CONFIG	2025-05-16 19:33:00 +02:00
nblock	833e0f66f1	Remove subnet router visibility workaround from docs (#2569) ... Previous Headscale versions required a dedicated rule to make a subnet router visible to clients. This workaround is no longer required.	2025-05-05 15:24:59 +02:00
nblock	9a86ffc102	Misc doc fixes (#2562) ... * Link to stable and development docs in the README * Add Tailscale SSH and autogroup:nonroot to features page * Use @ when referencing users in policy * Remove unmaintained headscale-webui The project seems to be unmaintained (last commit: 2023-05-08) and it only supports Headscale 0.22 or earlier. * Use full image URL in container docs This makes it easy to switch the container runtime from docker <-> podman. * Remove version from docker-compose.yml example This is now deprecated and yields a warning.	2025-05-04 21:55:08 +02:00
Alexey Tarasov	53d9c95160	Update container.md	2025-05-03 12:51:46 +02:00