290 Commits

Author	SHA1	Message	Date
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
Kristoffer Dalby	b92bd3d27e	remove oidc migration (#2411) ... * remove oidc migration Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com> * update changelog Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com> --------- Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>	2025-02-07 13:49:45 +01:00
Kristoffer Dalby	3bf7d5a9c9	add git hash to binary, print on startup (#2415) ... * add git hash to binary, print on startup Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com> * update changelog Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com> --------- Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>	2025-02-07 13:49:34 +01:00
Nbelles	22277d1fc7	Spell check	2025-02-05 17:29:30 +01:00
Florian Preinstorfer	f12cb2e048	Headscale now updates the user profile	2025-02-05 11:05:03 +01:00
Florian Preinstorfer	8c09afe20c	Headscale implements a single tailnet ... Separate the term "tailnet" from user and be more explicit about providing a single tailnet. Also be more explicit about users. Refer to "headscale users" when mentioning commandline invocations and use the term "local users" when discussing unix accounts. Fixes: #2335	2025-02-05 11:05:03 +01:00
Dmitry Gordin	1ab7b315a2	Update apple.md for latest version of iOS (#2321) ... The official iOS app now has a simpler login process for custom instances, directly within the app.	2025-01-13 12:09:53 +00:00
Stefan Majer	ede4f97a16	Fix typos	2025-01-09 10:38:25 +01:00
Rorical	b81420bef1	feat: Add PKCE Verifier for OIDC (#2314) ... * feat: add PKCE verifier for OIDC * Update CHANGELOG.md	2024-12-22 16:46:36 +00:00
Florian Preinstorfer	bbc93a90a2	Set title for code listings	2024-12-17 14:08:34 +01:00
Florian Preinstorfer	0acb2b5647	Misc doc updates	2024-12-17 14:08:34 +01:00
Florian Preinstorfer	3269cfdca0	Mention reload and SIGHUP when editing the ACL policy file ... Fixes: #2284	2024-12-17 14:08:34 +01:00
Florian Preinstorfer	319ce67c87	Update DNS documentation for dns.extra_records_path ... * Describe both ways to add extra DNS records * Use "extra" instead of "custom" to align with the configuration file * Include dns.extra_records_path in the configuration file	2024-12-17 14:08:34 +01:00
Florian Preinstorfer	65304a0ce7	Remove sealos documentation ... The referenced version is outdated (0.23.0-beta1) and seems unmaintained.	2024-12-17 14:08:34 +01:00
Shaw Drastin	7d937c6bd0	Correct macOS GUI connect guide because there's no ALT key on a mac (#2306) ... * Correct macOS GUI connect guide because there's no ALT key on a mac * also correct macOS GUI connect in hscontrol text	2024-12-17 12:11:27 +00:00
Florian Preinstorfer	75e74117db	Add FAQ entry on which database to use ... Fixes: #2257	2024-12-04 06:08:44 +01:00
Florian Preinstorfer	d2a86b1ef2	Fix broken indent	2024-12-04 06:08:44 +01:00
Florian Preinstorfer	44456497b0	Add versioned documentation ... Setup mike to provide versioned builds of the documentation. The goal is to have versioned docs for stable releases (0.23.0, 0.24.0) and development docs that can progress along with the code. This allows us to tailor docs to the next upcoming version as we no longer need to care about diversion between rendered docs and the latest release. Versions: * development (alias: unstable) on each push to the main branch * MAJOR.MINOR.PATCH (alias: stable, latest for the newest version) * for each "final" release tag * for each push to doc maintenance branches: doc/MAJOR.MINOR.PATCH The default version should the current stable version. The doc maintenance branches may be used to update the version specific documentation when issues arise after a release.	2024-12-02 16:51:50 +01:00
nblock	dc17b4d378	Documentation dependencies (#2252) ... * Use a trailing slash recommended by mkdocs-material * Update doc requirements Let mkdocs-material resolve its imaging dependencies (cairosvg and pillow) and fix a dependabot warning along the way. Reference compatible versions by major.minor.	2024-11-22 16:52:36 +00:00
Nathan Sweet	6275399327	Update tls.md to mention using the full cert chain (#2243)	2024-11-18 06:12:12 +00:00
nblock	29119bb7f4	Misc doc fixes (#2240) ... * Link back to node registration docs * adjust wording in apple docs * Mention client specific page to check if headscale works Ref: #2238	2024-11-18 05:46:58 +01:00
nblock	a7874af3d0	Use discord server invite link (#2235) ... Replace channel links with links to discord invite link and remove channel list. Fixes: #1521	2024-11-16 07:06:15 +01:00
nblock	e7245856c5	Refresh remote CLI documentation (#2216) ... * Document to either use a minimal configuration file or environment variables to connect with a remote headscale instance. * Document a workaround specific for headscale 0.23.0. * Remove reference to ancient headscale version. * Use `cli.insecure: true` or `HEADSCALE_CLI_INSECURE=1` to skip certificate verification. * Style and typo fixes Ref: #2193	2024-11-13 18:35:42 +01:00
nblock	2345c38e1e	Add a page for third-party tools (#2217) ... * Remove status from web-ui docs Rename the title to indicate that there multiple web interfaces available. Do not track the status of each web interface here as their status is subject to change over time. * Add page for third-party tools and scripts	2024-11-12 16:53:30 +01:00
Philip Henning	0089ceaf1d	Feature tvos documentation (#2226) ... * Add usage documentation for tvOS * lint and format * Change admonition to mkdocs flavoured style * fix typos * Update hscontrol/templates/apple.go Co-authored-by: Kristoffer Dalby <kristoffer@dalby.cc> * change outer quoting for where quoting in-text is used --------- Co-authored-by: Kristoffer Dalby <kristoffer@dalby.cc>	2024-11-07 14:56:18 +00:00
Pepper	0602304cea	Add headplane ... Add headplane to the list of UI's	2024-10-11 16:32:33 +02:00