Getting started with NeXusOS

Welcome! On this page you learn how to get NeXusOS up and running in just a few minutes.

Step 1: Check system requirements

Make sure your server has at least PHP 8.2, Composer, and a supported database (SQLite or PostgreSQL) installed.

Step 2: Clone the repository

git clone https://github.com/thegenzcode/nexusos.git
cd nexusos

Step 3: Install dependencies

composer install

Step 4: Adjust configuration

Copy .env.example to .env and fill in your values — especially database connection, app URL, and language.

Step 5: Migrate the database

php bin/console nexusos:migrate

Step 6: Create an admin user

php bin/console nexusos:user:create --admin

Afterwards you can sign in and start configuring.