Update screenshots and clean up README

This commit is contained in:
iFargle
2023-02-09 10:06:12 +09:00
parent 888a6456c0
commit 4ecc6eef2b
10 changed files with 20 additions and 8 deletions

View File

@@ -1,19 +1,29 @@
# headscale-webui
* This is just a simple front-end for a Headscale server. Allows you to do the following:
This is just a simple front-end for a Headscale server.
Allows you to do the following:
1. Enable/Disable routes and exit nodes
2. Add, move, rename, and remove machines
3. Add and remove users/namespaces
4. Add and expire PreAuth keys
5. Add and remove machine tags
6. View machine details (last online, IP addresses, hsotname, PreAuth key in use, enabled/disabled routes, and tags)
6. View machine details
* Hostname
* User associated with the machine
* IP addresses in the Tailnet
* Last seen by the control server
* Last update with the control server
* Creation date
* PreAuth key associated with the machine
* Enable / disable routes and exit nodes
* Add and delete machine tags
Screenshots:
![Machines](screenshots/machines.png)
![Users](screenshots/users.png)
![Add a new machine](screenshots/machine_add.png)
![Machine Details](screenshots/machines-page.JPG)
![API Key Test](screenshots/key_test.png)
![Add a new machine](screenshots/add-machine.png)
![Machine Details](screenshots/machines.png)
![API Key Test](screenshots/settings.png)
## Installation:
@@ -21,14 +31,14 @@ Screenshots:
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 GUI expects <HS_SERVER/admin>, I usually put this as "/admin"
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/`
* context: /home/username/headscale-webui/
## Traefik
* This was built assuming the use of the Traefik reverse proxy.
@@ -45,4 +55,4 @@ Screenshots:
- "traefik.http.middlewares.headscale-webui-stripprefix.stripprefix.forceslash=true"
- "traefik.http.middlewares.headscale-webui-stripprefix.stripprefix.prefixes=/admin/"
```
* Replace $DOMAIN with your domain.
* Replace $DOMAIN with your domain and update /admin to your BASE_PATH, if changed.

View File

@@ -3,6 +3,8 @@ services:
headscale-webui:
build:
context: /path/to/git/repo/root/headscale-webui/
# Alternatively, you can use a prebuilt image:
# image: git.sysctl.io/albert/headscale-webui:latest
container_name: headscale-webui
environment:
- TZ=UTC # Timezone

BIN
screenshots/add-machine.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 102 KiB

BIN
screenshots/overview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
screenshots/settings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 49 KiB