Mirrors/headscale-webui
1
0
Fork 1
mirror of https://github.com/iFargle/headscale-webui.git synced 2026-03-17 15:43:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README with changes @qiangyt provided.

Browse Source
This commit is contained in:
iFargle
2023-02-14 08:23:35 +09:00
parent 42763297d3
commit 69fd3e9bec
2 changed files with 54 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
README.md
View File

@@ -1,5 +1,7 @@
# headscale-webui
#### This is a simple front-end for a Headscale server.
## This is a simple front-end for a Headscale server.
#### PR's, questions, bug-fixes, feature requests are welcome!
---
Allows you to do the following:
1. Enable/Disable routes and exit nodes
2. Add, move, rename, and remove machines
@@ -17,6 +19,56 @@ Allows you to do the following:
* Enable / disable routes and exit nodes
* Add and delete machine tags
---
# Installation:
## Docker Compose changes:
1. Change the following variables in docker-compose.yml:
1. TZ - Change to your timezone. Example: Asia/Tokyo
2. HS_SERVER - Change to your headscale's URL
3. BASE_PATH - This will be the path your server is served on. Because the Windows Tailscale GUI expects <HS_SERVER/admin>, I usually put this as "/admin"
4. KEY - Your encryption key to store your headscale API key on disk. Generate a new one with "openssl rand -base64 32". Do not forget the quotations around the key when entering.
2. You will also need to change the volumes:
1. /data - Where your encryption key will reside. Can be anywhere
2. /etc/headscale/ - This is your Headscale configuration file.
3. Update the build context location to the directory with the Dockerfile.
1. Example: If Dockerfile is in /home/username/headscale-webui, your context will be:
* context: /home/username/headscale-webui/
## Traefik example with SSL:
* docker-compose labels:
```
labels:
# Traefik Configs
- "traefik.enable=true"
- "traefik.http.routers.headscale-webui.entrypoints=web-secure"
- "traefik.http.routers.headscale-webui.rule=Host(`headscale.$DOMAIN`) && (PathPrefix(`/$BASE_PATH/`) || PathPrefix(`/$BASE_PATH`))"
- "traefik.http.services.headscale-webui.loadbalancer.server.port=5000"
- "traefik.http.routers.headscale-webui.tls.certresolver=letsencrypt"
```
* Replace $DOMAIN with your domain and update $BASE_PATH to your BASE_PATH.
* If you do not need SSL, remove the tls.certresolver=letsencrypt line
## Nginx example:
* Thanks to @qiangyt for their contributions!
* nginx reverse proxy config:
```
location /admin {
proxy_pass http://127.0.0.1:5000/admin;
proxy_http_version 1.1;
proxy_set_header Host $server_name;
proxy_buffering off;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
auth_basic "Administrator's Area";
auth_basic_user_file /etc/nginx/htpasswd;
}
```
---
# Screenshots:
Overview Page:
![Overview](screenshots/overview.png)
@@ -28,35 +80,3 @@ Machines Page:
![Machine Details](screenshots/machines.png)
Settings Page showing an API Key Test:
![API Key Test](screenshots/settings.png)
# Installation:
1. This assumes you have traefik as your reverse proxy. I'm sure it will work with others, but I don't have experience with any.
2. Change the following variables in docker-compose.yml:
1. TZ - Change to your timezone. Example: Asia/Tokyo
2. HS_SERVER - Change to your headscale's URL
3. BASE_PATH - This will be the path your server is served on. Because the Windows Tailscale GUI expects <HS_SERVER/admin>, I usually put this as "/admin"
4. KEY - Your encryption key to store your headscale API key on disk. Generate a new one with "openssl rand -base64 32". Do not forget the quotations around the key when entering.
3. You will also need to change the volumes:
1. /data - Where your encryption key will reside. Can be anywhere
2. /etc/headscale/ - This is your Headscale configuration file.
4. Update the build context location to the directory with the Dockerfile.
1. Example: If Dockerfile is in /home/username/headscale-webui, your context will be:
* context: /home/username/headscale-webui/
# Traefik
* This was built assuming the use of the Traefik reverse proxy.
* Exmaple config:
```
labels:
# Traefik Configs
- "traefik.enable=true"
- "traefik.http.routers.headscale-webui.entrypoints=web-secure"
- "traefik.http.routers.headscale-webui.rule=Host(`headscale.$DOMAIN`) && (PathPrefix(`/admin/`) || PathPrefix(`/admin`))"
- "traefik.http.services.headscale-webui.loadbalancer.server.port=5000"
- "traefik.http.routers.headscale-webui.tls.certresolver=letsencrypt"
# redirect /admin to /
- "traefik.http.middlewares.headscale-webui-stripprefix.stripprefix.forceslash=true"
- "traefik.http.middlewares.headscale-webui-stripprefix.stripprefix.prefixes=/admin/"
```
* Replace $DOMAIN with your domain and update /admin to your BASE_PATH, if changed.

12
docker-compose.yml
View File

@@ -10,14 +10,4 @@ services:
- KEY="YourKeyBetweenQuotes" # Generate with "openssl rand -base64 32"
volumes:
- ./volume:/data # Headscale-WebUI's storage
- ./headscale/config/:/etc/headscale/:ro # Headscale's config storage location. Used to read your Headscale config.
labels:
# Traefik Configs
- "traefik.enable=true"
- "traefik.http.routers.headscale-webui.entrypoints=web-secure"
- "traefik.http.routers.headscale-webui.rule=Host(`headscale.$DOMAIN`) && (PathPrefix(`/admin/`) || PathPrefix(`/admin`))"
- "traefik.http.services.headscale-webui.loadbalancer.server.port=5000"
- "traefik.http.routers.headscale-webui.tls.certresolver=letsencrypt"
# redirect /admin to /
- "traefik.http.middlewares.headscale-webui-stripprefix.stripprefix.forceslash=true"
- "traefik.http.middlewares.headscale-webui-stripprefix.stripprefix.prefixes=/admin/"
- ./headscale/config/:/etc/headscale/:ro # Headscale's config storage location. Used to read your Headscale config.