Skip to content

GT-610/tairitsu

Repository files navigation

Tairitsu

Tairitsu banner

简体中文

Tairitsu is a self-hosted web console for a separately installed ZeroTier controller. It provides a web UI for setup, user accounts, network and member management, network settings, and controller network import.

Features

  • Setup wizard for controller connection, SQLite, and initial admin creation
  • User registration, login, password change, session handling, admin transfer, admin-created users, password reset, and user deletion
  • Network creation, detail view, and member approval / rejection / removal
  • IPv4, IPv6, managed routes, DNS, and multicast settings
  • Import takeover for controller networks not yet owned in Tairitsu
  • Experimental Planet generation

Installation

Prerequisites:

  • A ZeroTier controller that Tairitsu can reach
  • Access to the controller token file
  • A persistent directory for Tairitsu data
  • Container runtime such as Docker or Podman

Prepare the ZeroTier controller so Tairitsu can access the local controller API. Edit /var/lib/zerotier-one/local.conf:

{
  "settings": {
    "allowManagementFrom": [
      "0.0.0.0/0",
      "::/0"
    ]
  }
}

Restart the ZeroTier controller after changing local.conf.

Run Tairitsu with Docker:

docker run -d \
  --name tairitsu \
  --restart unless-stopped \
  -p 3000:3000 \
  -v /var/lib/zerotier-one:/var/lib/zerotier-one \
  -v /path/to/tairitsu-data:/app/data \
  ghcr.io/gt-610/tairitsu:latest

Or use Docker Compose:

services:
  tairitsu:
    image: ghcr.io/gt-610/tairitsu:latest
    container_name: tairitsu
    restart: unless-stopped
    ports:
      - "3000:3000"
    volumes:
      - /var/lib/zerotier-one:/var/lib/zerotier-one
      - /path/to/tairitsu-data:/app/data

Open http://<host>:3000 and complete the setup wizard:

  1. Enter the ZeroTier controller URL.
  2. Enter the token file path.
  3. Configure the SQLite database path if needed.
  4. Create the initial administrator account.

Documentation

Development

Prerequisites:

  • Go 1.25 or later with CGO enabled
  • Bun 1.3 or later
  • A local or Dockerized ZeroTier controller

Build backend:

GOCACHE=/tmp/go-build GOMODCACHE=/tmp/go-mod go build -o ./build/tairitsu ./cmd/tairitsu

Run frontend:

cd web
bun install
bun run dev

License

GNU GPL v3

Legal Notice

Since version 1.16.0, ZeroTier's controller component is licensed under a commercial source-available non-free license.

Tairitsu does not redistribute any ZeroTier controller code. It talks to a separately installed ZeroTier controller through the official API and stays outside ZeroTier's non-free controller codebase.

The Generate Planet feature is modified from ztnodeid-go under GNU GPL v3 License, not from ZeroTier itself.

Tairitsu is not a ZeroTier product and is not affiliated with, endorsed by, or supported by ZeroTier, Inc.

About

Zerotier controller Web UI. Modern, full-featured and secure.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors