GitHubGet Hedhog updates in your inbox
New releases, fresh recipes, and breaking changes — no spam.
Back to Core modulesWired in CoreModule
Core Submodule
install
Supports platform bootstrap and initial installation operations.
Source path: libraries/core/src/install
Module file: install.module.ts
Introduction
This page documents the install submodule as part of the Core package. Use it as a quick technical reference for implementation scope, exposed APIs and MCP integration points.
HTTP Endpoints
3 endpoints
Check whether the platform has already been installed.
Run the initial installation: create the admin user and seed core data.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| appName | string | no | Default: "HedHog" |
| slogan | string | no | Default: "Administration Panel" |
| userName | string | no | Default: "Root User" |
| string | no | Valid email. Default: [email protected] | |
| password | string | no | Min 6 chars. Default: changeme |
| adminUrl | string | no | URL with protocol. Default: http://localhost:3200 |
| apiUrl | string | no | URL with protocol. Default: http://localhost:3100 |
Generate the SQL migration needed to bootstrap mail settings.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| slug | string | yes | — |
| translations | { locale_code: string, subject: string, body: string }[] | yes | — |
| variables | string[] | yes | — |
MCP Tools
No MCP tools mapped for this submodule.