mirror of
				https://github.com/juanfont/headscale.git
				synced 2025-10-28 10:51:44 +01:00 
			
		
		
		
	update docu
This commit is contained in:
		
							parent
							
								
									3b97c7bdec
								
							
						
					
					
						commit
						18867a4c84
					
				
							
								
								
									
										28
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										28
									
								
								README.md
									
									
									
									
									
								
							@ -39,8 +39,16 @@ Suggestions/PRs welcomed!
 | 
			
		||||
 | 
			
		||||
## Running it
 | 
			
		||||
 | 
			
		||||
1. Download the Headscale binary https://github.com/juanfont/headscale/releases, and place it somewhere in your PATH
 | 
			
		||||
 
 | 
			
		||||
1. Download the Headscale binary https://github.com/juanfont/headscale/releases, and place it somewhere in your PATH or use the docker container
 | 
			
		||||
 | 
			
		||||
  ```shell
 | 
			
		||||
  docker pull headscale/headscale:x.x.x
 | 
			
		||||
  ```
 | 
			
		||||
 | 
			
		||||
  or
 | 
			
		||||
  ```shell
 | 
			
		||||
  docker pull ghrc.io/juanfont/headscale:x.x.x
 | 
			
		||||
  ```
 | 
			
		||||
 | 
			
		||||
2. (Optional, you can also use SQLite) Get yourself a PostgreSQL DB running
 | 
			
		||||
 | 
			
		||||
@ -65,11 +73,19 @@ Suggestions/PRs welcomed!
 | 
			
		||||
  ```shell
 | 
			
		||||
  headscale namespaces create myfirstnamespace
 | 
			
		||||
  ```
 | 
			
		||||
  or docker:
 | 
			
		||||
  ```shell
 | 
			
		||||
  docker run -v ./private.key:/private.key -v ./config.json:/config.json headscale/headscale:x.x.x headscale namespace create myfirstnamespace
 | 
			
		||||
  ```
 | 
			
		||||
 | 
			
		||||
5. Run the server
 | 
			
		||||
  ```shell
 | 
			
		||||
  headscale serve
 | 
			
		||||
  ```
 | 
			
		||||
  or docker:
 | 
			
		||||
  ```shell
 | 
			
		||||
  docker run -v $(pwd)/private.key:/private.key -v $(pwd)/config.json:/config.json -v $(pwd)/derb.yaml:/derb.yaml -p 127.0.0.1:8080:8080 headscale/headscale:x.x.x headscale serve
 | 
			
		||||
  ```
 | 
			
		||||
 | 
			
		||||
6. If you used tailscale.com before in your nodes, make sure you clear the tailscaled data folder
 | 
			
		||||
 ```shell
 | 
			
		||||
@ -89,6 +105,10 @@ Suggestions/PRs welcomed!
 | 
			
		||||
  ```shell
 | 
			
		||||
  headscale -n myfirstnamespace node register YOURMACHINEKEY
 | 
			
		||||
  ```
 | 
			
		||||
  or docker:
 | 
			
		||||
  ```shell
 | 
			
		||||
  docker run -v ./private.key:/private.key -v ./config.json:/config.json headscale/headscale:x.x.x headscale -n myfirstnamespace node register YOURMACHINEKEY
 | 
			
		||||
  ```
 | 
			
		||||
 | 
			
		||||
Alternatively, you can use Auth Keys to register your machines:
 | 
			
		||||
 | 
			
		||||
@ -96,6 +116,10 @@ Alternatively, you can use Auth Keys to register your machines:
 | 
			
		||||
    ```shell
 | 
			
		||||
    headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h
 | 
			
		||||
    ```
 | 
			
		||||
  or docker:
 | 
			
		||||
  ```shell
 | 
			
		||||
  docker run -v ./private.key:/private.key -v ./config.json:/config.json headscale/headscale:x.x.x headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h
 | 
			
		||||
  ```
 | 
			
		||||
 | 
			
		||||
2. Use the authkey from your machine to register it
 | 
			
		||||
   ```shell
 | 
			
		||||
 | 
			
		||||
@ -89,7 +89,6 @@ Use "headscale [command] --help" for more information about a command.
 | 
			
		||||
 | 
			
		||||
# TODO / Ideas
 | 
			
		||||
 | 
			
		||||
- Github action to publish the docker image
 | 
			
		||||
- Interpolate `email:` option to the ClusterIssuer from site configuration.
 | 
			
		||||
  This probably needs to be done with a transformer, kustomize vars don't seem to work.
 | 
			
		||||
- Add kustomize examples for cloud-native ingress, load balancer
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user