Documentation Portal

System Manual

2. Getting Started & Configuration

This section provides comprehensive step-by-step instructions for initial setup.

Prerequisite Checks

  1. Verified Node.js v18+ installation.
  2. Ensure Docker engine is active for optional production container deployments.
  3. Accessible PostgreSQL database for production usage OR SQLite configured for local usage.

Installation Sequence

  1. Clone the repository and install dependencies locally.
  2. Initialize environment configurations (.env) via copying .env.example.
  3. Start the application servers matching your target environment (npm run dev:web).

Workflow Example: First-Time User Registration

  • Context: A new security engineer needs platform access.
  • Action: Direct the user to the /register portal or utilize Single Sign-on (Google OAuth).
  • Outcome: User profile is created with standard 'USER' privileges. Administrator can later upgrade permissions via /admin/users interface.
v2.4.0-stable
|Updated 2 days ago
Helpful?