Documentation
Practical guides and reference material for running and contributing to AirLink.
Project
Features
Server Management
Create, manage, and monitor game servers with resource controls and Docker isolation.User Management
Manage users, roles, permissions, and account settings.Node Management
Add and monitor daemon nodes that host server containers.Database Management
Provision and manage PostgreSQL databases for game servers.Backups
Schedule and manage server backups with restore support.File Manager
Browse, edit, upload, and manage server files in-browser.Schedules
Create cron jobs and one-time tasks for server automation.Console & Logs
Live terminal output, server logs, and resource monitoring.Analytics & Activity
Track server usage, user activity, and system events.Addon System
Extend the panel with custom addons from the marketplace.Image Store
Manage server image definitions for game hosting.Onboarding
First-run setup wizard and configuration guides.Panel Settings
Configure panel branding, features, rate limits, and more.Power Actions
Server start, stop, restart, and kill operations.Sub-Users
Grant other users access to your servers.Server Folders
Organize servers into groups.Startup Configuration
Configure server startup variables and commands.Mounts
Share directories between servers.Administration
Admin Getting Started
Set up your panel, configure nodes, and create your first server.Roles & Permissions
Define user roles and control access to servers and features.Security
HMAC authentication, CSRF protection, rate limiting, and hardening.Deployment Guide
Production deployment with Docker, PostgreSQL, and Redis.API
Panel
Realtime System
WebSocket events, console streaming, and live updates.Caching System
Redis caching, invalidation, and performance optimization.Service Layer
Backend services for business logic, queueing, and data access.Middleware & Handlers
Request middleware, authentication, validation, and security layers.Configuration
Development
Contributing
Development setup, coding guidelines, and PR process.Project Structure
Codebase layout, module system, and key files.Database Schema
Prisma schema, migrations, and database operations.Addon Development
Build and register addons with Express routers, database access, and UI hooks.CI/CD Workflows
GitHub Actions workflows for build, test, and deployment.Architecture
Daemon
Daemon Overview
Architecture and purpose of the airlinkd node-side agent.Daemon API Reference
All daemon HTTP endpoints with methods, auth, and response formats.Daemon Security
HMAC authentication, rate limiting, and request validation for the daemon API.WebSocket Protocol
Real-time WebSocket endpoints for container management and console access.Container Management
Deploy, configure, and monitor game server containers across runtimes.SFTP System
Native TypeScript SFTP server for container file access over SSH.Radar Scanner
Pattern-based file scanner for detecting malicious plugins and modified files.File System Operations
HTTP API for browsing, reading, writing, and uploading files in container volumes.Backup System
Create, restore, upload, download, and delete container volume backups.Log System
Real-time log collection, storage, and archival for containers.Statistics & Monitoring
Host, Docker, and process metrics via REST and WebSocket streams.