43 Commits

Author	SHA1	Message	Date
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
Vitalij Dovhanyc	c2a58a304d	feat: add autogroup:self (#2789)	2025-10-16 12:59:52 +02:00
Florian Preinstorfer	2d680b5ebb	Misc typos and spelling	2025-09-17 16:32:29 +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
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
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	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
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
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
Oleksii Samoliuk	00d5d647ed	add third-party tool headscale-pf	2025-03-17 13:20:24 +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
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	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
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
Pepper	0602304cea	Add headplane ... Add headplane to the list of UI's	2024-10-11 16:32:33 +02:00
nblock	8c7d8ee34f	Restructure headscale documentation (#2163) ... * Setup mkdocs-redirects * Restructure existing documentation * Move client OS support into the documentation * Move existing Client OS support table into its own documentation page * Link from README.md to the rendered documentation * Document minimum Tailscale client version * Reuse CONTRIBUTING.md" in the documentation * Include "CONTRIBUTING.md" from the repository root * Update FAQ and index page and link to the contributing docs * Add configuration reference * Add a getting started page and explain the first steps with headscale * Use the existing "Using headscale" sections and combine them into a single getting started guide with a little bit more explanation. * Explain how to get help from the command line client. * Remove duplicated sections from existing installation guides * Document requirements and assumptions * Document packages provided by the community * Move deb install guide to official releases * Move manual install guide to official releases * Move container documentation to setup section * Move sealos documentation to cloud install page * Move OpenBSD docs to build from source * Simplify DNS documentation * Add sponsor page * Add releases page * Add features page * Add help page * Add upgrading page * Adjust mkdocs nav * Update wording Use the term headscale for the project, Headscale on the beginning of a sentence and `headscale` when refering to the CLI. * Welcome to headscale * Link to existing documentation in the FAQ * Remove the goal header and use the text as opener * Indent code block in OIDC * Make a few pages linter compatible Also update ignored files for prettier * Recommend HTTPS on port 443 Fixes: #2164 * Use hosts in acl documentation thx @efficacy38 for noticing this Ref: #1863 * Use mkdocs-macros to set headscale version once	2024-10-10 15:24:04 +02:00