Skip to content
SuperDOCS

Quickstart

Requirements

Section titled “Requirements”
  • Node.js 24 or later
  • npm
  • A reachable Elasticsearch or OpenSearch test cluster
  • Local ports 4030 and 4031

Prepare configuration

Section titled “Prepare configuration”

Copy the environment template, then replace the administrator password, application secret, and encryption key:

Terminal window
cp .env.example .env

Never use repository example credentials in a shared or production environment.

Start development

Section titled “Start development”
Terminal window
npm install
npm run db:generate
npm run db:migrate:deploy
npm run dev

Default addresses:

  • Web: http://localhost:4031
  • API: http://localhost:4030

Add a cluster

Section titled “Add a cluster”
  1. Sign in with the administrator account.
  2. Create an Elasticsearch or OpenSearch cluster connection.
  3. Enter node addresses, authentication, and TLS settings.
  4. Test and save the connection.
  5. Select it and inspect health, indexes, and shards.

Validate all write operations against non-production clusters first. Keep a change record and rollback plan for delete, close-index, restore, and reroute operations.