VoltexaHubDocumentation1.8.0Install the beta
Browse documentation

Getting started

Install VoltexaHub

Install a new community from a delivered release and create its first administrator.

On this page

Before you start#

Most people should use the one-command Docker installer, which sets up everything on this page for you. This guide covers a manual install from a release archive. Obtain the release archive, check its supplied SHA-256 checksum, and confirm requirements. These steps are for a new community. Existing communities use the update guide.

1. Prepare the release and dependencies#

Extract the ZIP into a new release directory. Open a terminal there:

composer install --no-dev --optimize-autoloader --no-interaction

Copy .env.example to .env using your host's file tools. Keep this file private.

2. Configure your environment#

Set APP_ENV=production, APP_DEBUG=false, and APP_URL to your HTTPS community URL. Configure DB_CONNECTION=mysql, DB_HOST, DB_PORT, DB_DATABASE, DB_USERNAME and DB_PASSWORD for your supported MySQL database. Set UPLOADS_ROOT to your persistent private uploads directory and secure session cookies behind HTTPS.

Use QUEUE_CONNECTION=database and CACHE_STORE=database for the documented worker/billing configuration. Configure outbound mail before relying on account verification or password recovery. Never put real passwords in published examples or commit .env.

3. Create the application key and administrator#

php artisan key:generate
php artisan forum:install [email protected] --name=Admin

Generate the key once for a new installation. Preserve this same APP_KEY through every upgrade and restore. Replace the sample email with your real administrator address and enter a unique password at the interactive prompt. The installer runs core/plugin migrations and initial data; it refuses to replace an existing administrator.

4. Serve and check the installation#

Set the web root to public/. Open /up, log in and visit /admin. Confirm compiled CSS/JavaScript load, create a discussion, and check search. If installing from source, run npm ci followed by npm run build before these checks.

5. Continue with setup#

Open Administration → Setup guide. Configure branding, registration, email, forums and permissions. Start the worker, create a backup, then rehearse the launch checklist.

See installation reference for protected mail and signup details and troubleshooting if an initial check fails.