https://github.com/iFargle/headscale-webui

A simple Headscale web UI for small-scale deployments.
https://github.com/iFargle/headscale-webui

docker docker-compose docker-container dockerfile flask headscale javascript jquery python tailscale webui

Last synced: 3 months ago
JSON representation

A simple Headscale web UI for small-scale deployments.

• Host: GitHub
• URL: https://github.com/iFargle/headscale-webui
• Owner: iFargle
• License: other
• Created: 2023-02-09T00:46:29.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-20T10:20:22.000Z (5 months ago)
• Last Synced: 2024-11-05T04:10:20.316Z (3 months ago)
• Topics: docker, docker-compose, docker-container, dockerfile, flask, headscale, javascript, jquery, python, tailscale, webui
• Language: Python
• Homepage:
• Size: 2.34 MB
• Stars: 654
• Watchers: 10
• Forks: 62
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - iFargle/headscale-webui - A simple Headscale web UI for small-scale deployments. (Python)
• awesome-starred - iFargle/headscale-webui - A simple Headscale web UI for small-scale deployments. (python)

README

        


  

    

  



Headscale-WebUI




  A simple Headscale web UI for small-scale deployments.





  Screenshots | Installation | Issues



---

# Features

1.  Enable/Disable routes and exit nodes

    * Manage failover routes as well

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

    * 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

    * Expiration date (will also display a badge when nearing expiration)

    * PreAuth key associated with the machine

    * Enable / disable routes and exit nodes

    * Add and delete machine tags

7.  Basic and OIDC Authentication

    * OIDC Authentication tested with Authelia and Keycloak

8.  Change your color theme! See MaterializeCSS Documentation for Colors for examples.

9.  Search your machines and users.

    * Machines have tags you can use to filter search:

        * `tag:tagname` Searches only for specific tags

        * `machine:machine-name` Searches only for specific machines

        * `user:user-name` Searches only for specific users

---

# Installation

* See [SETUP.md](SETUP.md) for installation and configuration instructions.

---

# Screenshots:

![Overview](screenshots/overview.png)

![Routes](screenshots/routes.png)

![Machines](screenshots/machines.png)

![Users](screenshots/users.png)

![Settings](screenshots/settings.png)

---

# Tech used:

* Python - [Link](https://www.python.org/)

* Poetry - [Link](https://python-poetry.org/)

* MaterializeCSS - [Link](https://github.com/Dogfalo/materialize)

* jQuery - [Link](https://jquery.com/)

For Python libraries, see [pyproject.toml](pyproject.toml)

If you use this project, please reach out!  It keeps me motivated!  Thank you!