← All Plugins/System & Automation/v0.1.0Official

Veap Setup Wizard

Interactive web-based setup wizard for first-time application configuration, database connection testing, and root admin creation.

bun veap add @veap/installer-plugin

[See clean architecture layers, Knex migrations & configuration below]

Purpose & Overview

Listens for 'system:not-installed' events and automatically redirects unconfigured visits to /install until setup is completed.

Installation & Setup

Install the package

bash

bun veap add @veap/installer-plugin

Register in lib/veap.ts (or auto via lib/plugins.gen.ts)

lib/veap.ts

typescript

// lib/veap.ts
import { Application } from "@veap/kernel";
import installerPlugin from "@veap/installer-plugin";

export const app = Application.configure()
  .withPlugins([installerPlugin])
  .create();

Keep in mind

Automatically redirects visitors to the `/install` setup wizard if no administrator account exists.
Guides through configuring encryption keys, database connections, and running initial migrations.
Automatically locks itself after successful installation to prevent unauthorized re-execution.