Installation

Installation

This is a quick-start guide. For the complete production setup (nginx, Redis, Supervisor, SSL) see DEPLOYMENT.md.

Requirements

• PHP 8.3+ with pdo_mysql, mbstring, openssl, tokenizer, xml, ctype, json, fileinfo, bcmath
• MySQL 8.0 / MariaDB 10.6+
• Redis 6+
• Composer 2.x, Node.js 20+
• A web server (nginx or Apache)

Steps

1. Get the code — download a release ZIP and extract it, or clone the repository.

2. Install dependencies

   composer install --no-dev --optimize-autoloader
   npm ci && npm run build

3. Configure the environment

   cp .env.example .env
   php artisan key:generate

   Edit .env — set APP_URL, database credentials, Redis, and mail.

4. Point your web server at the public/ directory.

5. Run the installer — open https://your-domain.com/install and follow the wizard: requirements check, database, admin account, site settings, finish.

Once installed, the admin panel is at /admin.

Background services

Do this before you call the install finished. Two processes have to run for server queries, email and telemetry to work at all — without them the site loads but never sends an email or updates a player count.

HybridCore prints the service files for you, filled in with your paths and user:

php artisan hybridcore:systemd

See Background Services for what they do, what breaks without them, and how to check they're running.

Optionally, php artisan reverb:start adds websockets for live notifications and online counts. The site works without it, just without the live updates.