mirror of
				https://github.com/juanfont/headscale.git
				synced 2025-11-04 10:01:05 +01:00 
			
		
		
		
	Improved website
More docs
This commit is contained in:
		
							parent
							
								
									ba45d7dbd3
								
							
						
					
					
						commit
						dcf2439c61
					
				@ -4,9 +4,40 @@ hide:
 | 
			
		||||
  - toc
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
# headscale documentation
 | 
			
		||||
# headscale
 | 
			
		||||
 | 
			
		||||
This site contains the official and community contributed documentation for `headscale`.
 | 
			
		||||
`headscale` is an open source, self-hosted implementation of the Tailscale control server.
 | 
			
		||||
 | 
			
		||||
If you are having trouble with following the documentation or get unexpected results,
 | 
			
		||||
please ask on [Discord](https://discord.gg/c84AZQhmpx) instead of opening an Issue.
 | 
			
		||||
This page contains the documentation for the latest version of headscale. Please also check our [FAQ](/faq/).
 | 
			
		||||
 | 
			
		||||
Join our [Discord](https://discord.gg/c84AZQhmpx) server for a chat and community support.
 | 
			
		||||
 | 
			
		||||
## Design goal
 | 
			
		||||
 | 
			
		||||
Headscale aims to implement a self-hosted, open source alternative to the Tailscale
 | 
			
		||||
control server.
 | 
			
		||||
Headscale's goal is to provide self-hosters and hobbyists with an open-source
 | 
			
		||||
server they can use for their projects and labs.
 | 
			
		||||
It implements a narrower scope, a single Tailnet, suitable for a personal use, or a small
 | 
			
		||||
open-source organisation.
 | 
			
		||||
 | 
			
		||||
## Supporting headscale
 | 
			
		||||
 | 
			
		||||
If you like `headscale` and find it useful, there is a sponsorship and donation
 | 
			
		||||
buttons available in the repo.
 | 
			
		||||
 | 
			
		||||
## Contributing
 | 
			
		||||
 | 
			
		||||
Headscale is "Open Source, acknowledged contribution", this means that any
 | 
			
		||||
contribution will have to be discussed with the Maintainers before being submitted.
 | 
			
		||||
 | 
			
		||||
This model has been chosen to reduce the risk of burnout by limiting the
 | 
			
		||||
maintenance overhead of reviewing and validating third-party code.
 | 
			
		||||
 | 
			
		||||
Headscale is open to code contributions for bug fixes without discussion.
 | 
			
		||||
 | 
			
		||||
If you find mistakes in the documentation, please submit a fix to the documentation.
 | 
			
		||||
 | 
			
		||||
## About
 | 
			
		||||
 | 
			
		||||
`headscale` is maintained by [Kristoffer Dalby](https://kradalby.no/) and [Juan Font](https://font.eu).
 | 
			
		||||
 | 
			
		||||
@ -122,6 +122,7 @@ markdown_extensions:
 | 
			
		||||
# Page tree
 | 
			
		||||
nav:
 | 
			
		||||
  - Home: index.md
 | 
			
		||||
  - FAQ: faq.md
 | 
			
		||||
  - Getting started:
 | 
			
		||||
      - Installation:
 | 
			
		||||
          - Linux: running-headscale-linux.md
 | 
			
		||||
@ -141,5 +142,5 @@ nav:
 | 
			
		||||
          - iOS: iOS-client.md
 | 
			
		||||
  - Proposals:
 | 
			
		||||
      - ACLs: proposals/001-acls.md
 | 
			
		||||
      - Better routing: proposals/002-better-routing.md
 | 
			
		||||
      - Better routing: proposals/002-better-routing.mdd
 | 
			
		||||
  - Glossary: glossary.md
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user