[!CAUTION]

⚠️ THIS SOFTWARE IS HIGHLY UNSTABLE — DO NOT USE IN PRODUCTION ⚠️

Airlink Panel is in early BETA. Expect breaking changes, data loss, security vulnerabilities, and incomplete features with every update. APIs, database schemas, configuration formats, and stored data may change without notice between releases.

This is a development preview only. We are not responsible for any data loss, security incidents, or damages resulting from use of this software. If you need a stable game server panel today, this is not it.

---

What is Airlink Panel?

Airlink Panel is a web-based control panel for deploying, monitoring, and managing game servers across multiple machines. It communicates with daemons on each node to handle Docker containers, files, and SFTP.

Core features:

• Web UI for admins and users (EJS templates, Tailwind CSS, Alpine.js, HTMX)
• Node-based architecture: one panel controlling many daemons
• Addon system for extending functionality without touching core files
• REST API (v2) with scoped API keys and HMAC-signed daemon communication
• Real-time console, file manager, backups, and SFTP
• Server creation, power controls, and resource management
• User management with 2FA and WebAuthn passkey support
• Analytics and player stats
• Multi-language support (i18n) — 10 languages
• Redis-backed sessions with user-index revocation
• Node.js cluster mode (auto-forks per CPU core)
• CSP headers with per-request nonces (configurable)
• TLS direct HTTPS support
• Configurable rate limiting

Documentation: airlinklabs.xyz/docs/quick-start/

---

Prerequisites

• Node.js v22 or later
• pnpm v11 or later (npm install -g pnpm)
• Git
• Docker
• Redis (default: 127.0.0.1:6379)
• PostgreSQL (default: 127.0.0.1:5432)

[!NOTE] MariaDB/MySQL is no longer supported. The database engine was migrated to PostgreSQL.

---

Installation

Option 1: Installer script

sudo su
bash <(curl -s https://raw.githubusercontent.com/airlinklabs/panel/refs/heads/main/installer.sh)

The installer handles Node.js, Docker, PostgreSQL, Redis, database setup, build, and systemd service registration.

Option 2: Setup script (recommended)

cd /var/www/
git clone https://github.com/AirlinkLabs/panel.git
cd panel
node public/scripts/setup.mjs
pnpm run start

Setup flags:

Examples:

node public/scripts/setup.mjs                          # Interactive
node public/scripts/setup.mjs --yes                    # CI / unattended
node public/scripts/setup.mjs --skip-services --db-host=db.internal --yes

Option 3: Manual

cd /var/www/
git clone https://github.com/AirlinkLabs/panel.git
cd panel

cp example.env .env
# Edit .env with your values (see Configuration below)

pnpm install
npx prisma generate
npx prisma db push
pnpm run build
pnpm run start

Running with systemd

systemctl start airlink-panel
systemctl stop airlink-panel
systemctl restart airlink-panel
journalctl -u airlink-panel -f

Running with pm2

npm install -g pm2
pm2 start "pnpm run start" --name airlink-panel
pm2 save
pm2 startup

---

Configuration

Copy example.env to .env and configure the values for your environment.

Core

Database (PostgreSQL)

[!IMPORTANT] DATABASE_URL must use the postgresql:// scheme. MariaDB/MySQL is no longer supported.

Redis

Proxy & Security

TLS (Direct HTTPS)

When both are set, the panel starts an HTTPS server directly (with HTTP fallback). Otherwise, use a reverse proxy.

Rate Limiting

SMTP (Email)

Logging

[!IMPORTANT] Set URL to the actual IP or hostname the panel is accessible from. Using http://localhost will block external access and cause CSP errors.

---

Architecture

Stack

Redis Usage

• Sessions: Stored in Redis (airlink:sess:*) with a user index (airlink:usr:{id}) for admin revocation
• Node health cache: checkNodeStatus results cached 15s per node
• Search cache: /api/search results cached 30s per user+query
• Realtime events: Pub/sub for live console output and server status updates

Directory Structure

panel/
├── src/                  # TypeScript source
│   ├── config/           # Configuration (mime, auth, limits, etc.)
│   ├── handlers/         # Middleware, utilities, realtime
│   ├── modules/          # Route handlers (admin, api, auth, user)
│   ├── services/         # Business logic (backup, daemon, file, i18n)
│   ├── types/            # TypeScript type definitions
│   └── utils/            # Shared utilities
├── views/                # EJS templates
│   ├── admin/            # Admin panel views
│   ├── auth/             # Login, register, 2FA
│   ├── components/       # Shared UI components
│   └── user/             # User dashboard, server management
├── public/               # Static assets
│   ├── javascript/       # Client-side JS + vendor bundles
│   ├── styles/           # CSS (Tailwind input)
│   └── scripts/          # Setup / install scripts
├── storage/              # Runtime data
│   ├── prisma/           # Schema + migrations
│   ├── lang/             # i18n translation files (10 languages)
│   └── addons/           # Addon storage
├── tests/                # Vitest unit tests + Docker test infra
│   └── docker/           # Dockerfile, entrypoint.sh, docker-compose.test.yml
├── docs/                 # API spec and documentation
└── .github/workflows/    # CI pipeline (10 jobs)

---

Scripts

---

API Reference

The panel exposes a REST API with 138 HTTP routes and 4 WebSocket endpoints. See docs/specsheet.md for the full route catalog, request/response formats, authentication details, and notes on daemon communication.

---

Addon System

Addons let you extend the panel without modifying core files. They live under storage/addons/ and can be managed from the /admin/addons page.

See storage/addons/README.md for the structure and API reference.

---

Testing

Unit tests use Vitest. E2e tests use Playwright.

pnpm run test              # Run all unit tests
pnpm run test:e2e          # Run e2e tests (requires Chromium)
pnpm run test:docker       # Run full test suite in Docker

Tests mock Redis and database connections where needed. The CI pipeline runs all checks across 10 jobs: SAST, Dependency Review, Audit, Lint, Typecheck, Unit Tests, Build, and more.

---

Development

pnpm install
pnpm run dev        # Start with auto-restart on file changes
pnpm run typecheck  # Type checking
pnpm run lint       # Linting
pnpm run build      # Production build

---

Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature/your-feature
3. Commit your changes: git commit -m 'feat: describe your change'
4. Push and open a pull request against main

Please run pnpm run lint and pnpm run typecheck before submitting.

---

Star History

---

Project Leads

---

Contributors

Contributions of all sizes are welcome. Take a look at the open issues if you're not sure where to start.

_{Made with contrib.rocks}

---

Links

• Website: airlinklabs.xyz
• Docs: airlinklabs.xyz/docs/quick-start
• Discord: discord.gg/ujXyxwwMHc
• GitHub: github.com/airlinklabs/panel

---

License

MIT. See LICENSE for details.