Skip to content

airlinklabs/panel

Repository files navigation

Caution

AirLink is currently in active development. A stable release has not yet shipped use in production at your own risk.

Airlink Panel

Open-source game server management

TypeScript Prisma License Discord


Overview

Airlink Panel is an open-source platform for deploying, monitoring, and managing game servers. It ships with an addon system that lets you extend core functionality without modifying the base installation.

For full documentation, visit airlinklabs.github.io/home.


Prerequisites

  • Node.js v16 or later
  • npm v8 or later
  • Git
  • PostgreSQL or MySQL

Installation

Option 1 — Installer script

Run as root:

  • run sudo su then run the below script.
bash <(curl -s https://raw.githubusercontent.com/airlinklabs/panel/refs/heads/main/installer.sh)

Manage the panel with systemd:

systemctl start airlink-panel 
systemctl stop airlink-panel

Option 2 — Manual

  1. Clone the repository:

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

    sudo chown -R www-data:www-data /var/www/panel
    sudo chmod -R 755 /var/www/panel
  3. Install dependencies:

    npm install -g typescript
    npm install --omit=dev
  4. Run database migrations:

    npm run migrate:dev
  5. Build and start:

    npm run build
    npm run start

Running with pm2 (optional)

npm install pm2 -g
pm2 start dist/app.js --name "panel"
pm2 save
pm2 startup

Addon System

Addons let you add features, modify existing behavior, and integrate with external services — without touching the core codebase.

To create an addon:

  1. Create a directory under panel/storage/addons/ named after your addon's slug
  2. Add a package.json with your addon's metadata
  3. Create an entry point (default: index.ts)
  4. Implement your addon's logic

Documentation:


Star History

Star History Chart

Contributing

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

Guidelines: follow TypeScript best practices, write tests for new features, keep code readable, and update docs alongside code changes.


License

MIT see LICENSE for details.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!