315 commits

Author	SHA1	Message	Date
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
Jacob Yundt	03a91693ac	feat: Create headscale user and group as system user/groups (#2322) ... When creating the headscale user and group, create both as system groups rather than creating them as 'user' groups. FIXES #2278	2025-05-03 09:13:54 +00:00
nblock	18d21d3585	Add documentation for routes (#2496) ... * Add documentation for routes * Rename exit-node to routes and add redirects * Add a new section on subnet routers * Extend the existing exit-node documentation * Describe auto approvers for subnet routers and exit nodes * Provide ACL examples for subnet routers and exit nodes * Describe HA and its current limitations * Add a troubleshooting section with IP forwarding * Update features page for 0.26 Add auto approvers and link to our documentation if available. * Prefer the console lexer when commandline and output mixed	2025-05-03 10:16:45 +02:00
Janne Johansson	7dc86366b4	Update source.md ... If we assume someone doesn't already have the required go package, they might also not have the required git package installed either, so pkg_add both of them.	2025-05-02 10:43:56 +02:00
Pamplemousse	f3a1e693f2	Mention "Network flow logs" as a missing feature	2025-04-22 11:28:41 +02:00
alteriks	3287aa8bba	Update oidc.md ... Authelia docs	2025-04-18 10:16:08 +02:00
Christoph	d2a6356d89	Add unraid-headscale-admin web UI to docs (#2515) ... * Add unraid-headscale-admin link	2025-04-02 20:54:32 +02:00
Florian Preinstorfer	24ad235917	Explicitly handle /headscale/{config,lib,run} in container docs ... Fixes: #2304	2025-03-19 06:12:14 +01:00
Oleksii Samoliuk	00d5d647ed	add third-party tool headscale-pf	2025-03-17 13:20:24 +01:00
Florian Preinstorfer	586a20fbff	Add a FAQ entry about two nodes seeing each other ... See: #2431 See: #2174	2025-03-14 18:48:44 +01:00
Kristoffer Dalby	818046f240	add faq section on scaling/performance (#2476) ... * add faq section on scaling/performance Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com> * Apply suggestions from code review Co-authored-by: nblock <nblock@users.noreply.github.com> --------- Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com> Co-authored-by: nblock <nblock@users.noreply.github.com>	2025-03-14 17:09:30 +00:00
nblock	fe06a00d45	Container images are also available on GHCR (#2470) ... Fixes: #2456	2025-03-11 06:54:05 +01:00
Kristoffer Dalby	7891378f57	Redo route code (#2422) ... Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>	2025-02-26 16:22:55 +01:00