Installation

Installation

Requirements

• PHP 8.2+
• Node.js 18+
• Composer
• SQLite, MySQL 8.0+, or PostgreSQL 13+

Web-Based Installation (Recommended)

FluxDesk includes an interactive installation wizard:

git clone https://github.com/FluxDesk/FluxDesk.git
cd FluxDesk
composer install
npm install && npm run build
php artisan serve

Visit http://localhost:8000 — you'll be automatically redirected to the installation wizard.

Composer automatically:

• Creates your .env file from .env.example
• Generates your application encryption key

The wizard guides you through:

• Database setup with a live terminal showing migrations
• Admin account and organization creation
• Final configuration before going live

Security: Once installation completes, the wizard is permanently disabled.

Command Line Installation

For automated deployments:

git clone https://github.com/FluxDesk/FluxDesk.git
cd FluxDesk
composer install
composer run install

Or directly:

php artisan app:install

Manual Installation

# Clone repository
git clone https://github.com/FluxDesk/FluxDesk.git
cd FluxDesk

# Install dependencies
composer install
npm install

# Configure environment
cp .env.example .env
php artisan key:generate

# Configure database in .env, then run migrations
php artisan migrate

# Build frontend
npm run build

# Create storage link
php artisan storage:link

# Mark as installed
echo "APP_INSTALLED=true" >> .env

Next Steps

• Production Deployment — Configure for production use
• Microsoft 365 Setup or Google Workspace Setup — Connect email