Documentation
v1.0.0 · Release preparation

Prepare your installation

  1. Extract your purchased release package into a private working directory.
  2. Locate backend/. Run application commands from that directory.
  3. Create a dedicated database and a user restricted to that database.
  4. Point an application hostname, such as hr.example.com, to the application server.
  5. Configure HTTPS and set the web document root to the full path of backend/public.
  6. Arrange SMTP delivery, scheduled tasks and worker services.

Do not expose the repository root, .env, source, backups or private uploads through the public document root.

Install dependencies

cd backend
composer install --no-dev --prefer-dist --optimize-autoloader
composer check-platform-reqs --no-dev
npm ci
npm run build

Use the supplied lockfiles. If Node.js is unavailable on the server, build on a trusted machine and upload the matching public/build with the release source. Do not deploy a development public/hot file. Composer dependencies must match the server's PHP platform.

Create private configuration

On a new installation only:

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

Continue with configuration. Do not overwrite an existing .env or regenerate encryption/authentication keys during updates.