mirror of
				https://github.com/juanfont/headscale.git
				synced 2025-10-28 10:51:44 +01:00 
			
		
		
		
	Restructure existing documentation
This commit is contained in:
		
							parent
							
								
									8e2aab75e2
								
							
						
					
					
						commit
						5a432ee2d3
					
				@ -1,8 +1,3 @@
 | 
			
		||||
---
 | 
			
		||||
hide:
 | 
			
		||||
  - navigation
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
# Frequently Asked Questions
 | 
			
		||||
 | 
			
		||||
## What is the design goal of headscale?
 | 
			
		||||
@ -8,7 +8,7 @@ hide:
 | 
			
		||||
 | 
			
		||||
`headscale` is an open source, self-hosted implementation of the Tailscale control server.
 | 
			
		||||
 | 
			
		||||
This page contains the documentation for the latest version of headscale. Please also check our [FAQ](faq.md).
 | 
			
		||||
This page contains the documentation for the latest version of headscale. Please also check our [FAQ](./about/faq.md).
 | 
			
		||||
 | 
			
		||||
Join our [Discord](https://discord.gg/c84AZQhmpx) server for a chat and community support.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -36,7 +36,7 @@ servers.
 | 
			
		||||
- billing.internal
 | 
			
		||||
- router.internal
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
## ACL setup
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										46
									
								
								mkdocs.yml
									
									
									
									
									
								
							
							
						
						
									
										46
									
								
								mkdocs.yml
									
									
									
									
									
								
							@ -71,7 +71,19 @@ plugins:
 | 
			
		||||
  - social: {}
 | 
			
		||||
  - redirects:
 | 
			
		||||
      redirect_maps:
 | 
			
		||||
        'iOS-client.md': 'apple-client.md#ios'
 | 
			
		||||
        acls.md: ref/acls.md
 | 
			
		||||
        android-client.md: usage/connect/android.md
 | 
			
		||||
        apple-client.md: usage/connect/apple.md
 | 
			
		||||
        dns-records.md: ref/dns.md
 | 
			
		||||
        exit-node.md: ref/exit-node.md
 | 
			
		||||
        faq.md: about/faq.md
 | 
			
		||||
        iOS-client.md: usage/connect/apple.md#ios
 | 
			
		||||
        oidc.md: ref/oidc.md
 | 
			
		||||
        remote-cli.md: ref/remote-cli.md
 | 
			
		||||
        reverse-proxy.md: ref/integration/reverse-proxy.md
 | 
			
		||||
        tls.md: ref/tls.md
 | 
			
		||||
        web-ui.md: ref/integration/web-ui.md
 | 
			
		||||
        windows-client.md: usage/connect/windows.md
 | 
			
		||||
 | 
			
		||||
# Customization
 | 
			
		||||
extra:
 | 
			
		||||
@ -132,22 +144,26 @@ markdown_extensions:
 | 
			
		||||
# Page tree
 | 
			
		||||
nav:
 | 
			
		||||
  - Home: index.md
 | 
			
		||||
  - FAQ: faq.md
 | 
			
		||||
  - About:
 | 
			
		||||
      - FAQ: about/faq.md
 | 
			
		||||
  - Usage:
 | 
			
		||||
      - Connect a node:
 | 
			
		||||
          - Android: usage/connect/android.md
 | 
			
		||||
          - Apple: usage/connect/apple.md
 | 
			
		||||
          - Windows: usage/connect/windows.md
 | 
			
		||||
  - Reference:
 | 
			
		||||
      - OIDC authentication: ref/oidc.md
 | 
			
		||||
      - Exit node: ref/exit-node.md
 | 
			
		||||
      - TLS: ref/tls.md
 | 
			
		||||
      - ACLs: ref/acls.md
 | 
			
		||||
      - DNS: ref/dns.md
 | 
			
		||||
      - Remote CLI: ref/remote-cli.md
 | 
			
		||||
      - Integration:
 | 
			
		||||
          - Reverse proxy: ref/integration/reverse-proxy.md
 | 
			
		||||
          - Web UI: ref/integration/web-ui.md
 | 
			
		||||
 | 
			
		||||
  - Getting started:
 | 
			
		||||
      - Installation:
 | 
			
		||||
          - Linux: running-headscale-linux.md
 | 
			
		||||
          - OpenBSD: running-headscale-openbsd.md
 | 
			
		||||
          - Container: running-headscale-container.md
 | 
			
		||||
      - Configuration:
 | 
			
		||||
          - Web UI: web-ui.md
 | 
			
		||||
          - OIDC authentication: oidc.md
 | 
			
		||||
          - Exit node: exit-node.md
 | 
			
		||||
          - Reverse proxy: reverse-proxy.md
 | 
			
		||||
          - TLS: tls.md
 | 
			
		||||
          - ACLs: acls.md
 | 
			
		||||
          - Custom DNS records: dns-records.md
 | 
			
		||||
          - Remote CLI: remote-cli.md
 | 
			
		||||
      - Usage:
 | 
			
		||||
          - Android: android-client.md
 | 
			
		||||
          - Apple: apple-client.md
 | 
			
		||||
          - Windows: windows-client.md
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user