TS6 Viewer

A lightweight, fast, and modern web viewer for TeamSpeak 6 servers.
TS6 Viewer connects to ServerQuery (SSH, Port 10022) and displays live server, channel, and client information.

The viewer is designed to be:

• Simple to deploy
• Fast and lightweight
• Fully client‑side auto‑refreshing
• Compatible with any TS6 server
• Customizable via a single config.json file

---

Features

• Live TeamSpeak 6 server viewer
• Auto‑refresh with configurable interval
• Dark and light themes
• Channel tree rendering with clients
• Spacer and full‑width channel support
• Caching + rate‑limit protection
• Pure ServerQuery (SSH) backend
• Optional voice status (mute status, audio status, talking)

---

ServerQuery (SSH)

TS6 Viewer communicates exclusively via ServerQuery over SSH.

Advantages:

• Persistent SSH connection
• Very fast, even with many clients
• clientlist -voice provides all audio/mute/talker info in a single call
• No REST overhead
• No per-client requests
• No rate limits

---

Configuration Files in the Project

The repository includes two important configuration templates:

config.example.json

This file is included in the project and serves as the template for your actual configuration.
You can:

• rename it manually to config.json, or
• let Docker generate config.json automatically using environment variables.

---

Docker Support

The repository includes:

• Dockerfile.sh — multi‑stage build for Go + Alpine
• entrypoint.sh — generates config.json dynamically using environment variables
• docker-compose.yml — ready to run the viewer with one command

This allows you to run TS6 Viewer fully containerized.

---

Dockerfile.sh explained

The Dockerfile uses two stages:

1) Builder Stage

• Based on golang:1.20-alpine
• Copies the entire repository into /app
• Ensures config.example.json exists
• Normalizes go.mod to avoid Go version parsing issues
• Builds a static Linux binary: cmd/server/ts6viewer

2) Runtime Stage

• Based on alpine:latest
• Installs CA certificates + gettext (envsubst)
• Copies the built binary and assets from the builder
• Copies entrypoint.sh
• Exposes port 8080
• Starts the viewer via the entrypoint script

---

entrypoint.sh explained

The entrypoint script:

1. Loads environment variables
2. Applies defaults if variables are missing
3. Uses envsubst to generate config.json from config.example.json
4. Starts the TS6 Viewer binary

Environment variables include:

• SERVER_PORT
• THEME
• REFRESH_INTERVAL
• HOST
• PORT
• USER
• PASSWORD
• ENABLE_VOICE_STATUS
• SERVER_ID

This makes the Docker container fully configurable without editing files.

docker-compose.yml

A ready‑to‑use compose file is included in the project.
You can start the viewer with:

docker compose up -d

---

Building the Program

The project is written in Go.

Build on Linux

git clone https://github.com/Maxallica/ts6-viewer.git
cd ts6viewer
go build -o ts6viewer

Build Windows binary on Linux

cd "*/ts6-viewer/cmd/server"
GOOS=windows GOARCH=amd64 go build -o ts6viewer.exe

Running on Linux

./ts6viewer

Build on Windows

git clone https://github.com/Maxallica/ts6-viewer.git
cd ts6viewer
go build -o ts6viewer.exe

Build Linux binary on Windows

cd "*/ts6-viewer/cmd/server"
$env:GOOS="linux"
$env:GOARCH="amd64"
go build -o ts6viewer

Running on Windows

.\ts6viewer.exe

---

Navigate to the TS6 Viewer page

http(s)//<ip>:<port>/ts6viewer

---

❤️ Made with love in Germany