Talorix — Dashboard

Talorix

Overview

Welcome to the Talorix ecosystem documentation.

What is Talorix?

A lightweight, modern alternative to Pterodactyl for game server management.

Architecture

Split design: The Panel handles UI/Admin, while remote Nodes run the workloads.

Centralized

Deploy images, manage files, and control power states from a single secure interface.

API Reference

This page documents Talorix's HTTP + WebSocket API. All endpoints require an API key (see Authentication). Use Bearer tokens or X-API-Key.

Authentication

Provide the API key in one of two ways:

Authorization: Bearer <API_KEY>
X-API-Key: <API_KEY>

Responses will use standard HTTP codes:

401 — Unauthorized (missing/invalid key)
403 — Forbidden (key disabled or missing permission)
404 — Not found
409 — Conflict
500 — Server error

Quick Examples

Create node (curl)

curl -X POST "https://panel.example.com/api/v1/node/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"eu-node-1","ip":"1.2.3.4","port":3000}'

Open server websocket (wscat)

wscat -c "wss://panel.example.com/api/ws/console/SERVER_ID" -H "Authorization: Bearer YOUR_API_KEY"

Nodes

Manage Talon nodes (create, list, configure, delete, allocations).

POST /api/v1/node/create

Body: {"name","ip","port"}

curl -X POST "https://panel.example.com/api/v1/node/create" \
  -H "Authorization: Bearer API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"us-west","ip":"203.0.113.10","port":3000}'

Returns: created id and key.

GET /api/v1/nodes

Returns list of nodes. Each node's status is updated on read (online/dockernotrunning/offline).

Allocations

Add single or ranges with /api/v1/node/:id/allocations/add. Accepts port or "8000-8100" ranges (batching applied).

Servers

Create servers on nodes, edit, suspend, delete.

POST /api/v1/servers/new

Body:

{
  "imageId": "IMAGE_ID",
  "nodeId": "NODE_ID",
  "allocationId": "ALLOCATION_ID",
  "name": "my-server",
  "ram": "1024",
  "core": "1",
  "disk": "500",
  "userId": "USER_ID",
  "env": {"FOO":"bar"}
}

The Panel resolves image env defaults and interpolates file URLs before instructing the node.

POST /api/v1/edit/:serverId — edit server

DELETE /api/v1/servers/delete/:id — delete server (also attempts node-side delete)

Images

CRUD for images used when creating servers.

GET /api/v1/images

POST /api/v1/images/new

POST /api/v1/images/delete/:id

Users

List, view, create, edit and delete users. Deletion cleans up their servers and attempts node-side removal.

GET /api/v1/users

GET /api/v1/user/:id

POST /api/v1/users/new

POST /api/v1/user/:id/edit

POST /api/v1/user/:id/delete

Settings

Application settings retrieval and update.

GET /api/v1/settings

POST /api/v1/settings

POST body: {"name":"AppName","registerEnabled":true}

WebSockets

Two WS endpoints are provided for interactive console logs and live stats.

Console WS

wss://YOUR_PANEL/api/ws/console/:server.idt

Requires the same Authorization header as HTTP.

Stats WS

wss://YOUR_PANEL/api/ws/stats/:server.idt

Example (wscat): wscat -c "wss://panel.example.com/api/ws/stats/SERVER_ID" -H "Authorization: Bearer API_KEY"

Notes & Best Practices

Keep API keys secret and rotate periodically.
When deleting nodes/users, the Panel attempts node-side cleanup but may log warnings if node is unreachable.
Port ranges in allocation additions are batched (150 ports per batch) for stability.
Node health checks are performed on reads and will set statuses to online, dockernotrunning, or offline.

Install Panel

Follow these commands to set up the administrative interface.

bash — admin

1. Clone & Install Dependencies

git clone https://github.com/Talorix/panel
cd panel
npm install

2. Setup Admin & Images

# Run the helper tool
npm run admin

# > Select "Fetch images"
# > Select "Create admin user"

3. Link & Start

npm link
talorix

Ensure port 3500 is open on your firewall.

Install Node

Follow these commands to set up the daemon (Talon).

bash — node

1. Installation

git clone https://github.com/Talorix/talon
cd talon
npm install

2. Configuration

Go to your Panel > Create Node. Copy the "Auto-Config" command provided there.

npm link
# Run the command copied from the panel, e.g.:
npm configure .................................

3. Start

talon

Checklist

1
Node created in Panel
2
Public IP is correct
3
Port 3000 Open