Module installer - Quick Start

The documentation is constantly evolving and updated alongside the project's progress. Since it is developed in parallel with the code, some sections may temporarily refer to earlier versions of the system-these are gradually adapted to the current state of the application. If you notice any outdated information, please report it or open an Issue / Pull Request.

Documentation

# Module installer - Quick Start

This page describes the installer-oriented starter experience in DBM Platform. It is not required when building a standalone application on DBM Framework.

# Choose a starting path

The starter page offers two paths: begin a custom project by editing the application's index controller and routes, or launch the DBM CMS installer to add the CMS and its administration modules. The installed modules and available buttons depend on the platform distribution.

Before running the installer, configure the root .env, point the web server document root to public/, and confirm that URL rewriting forwards requests to public/index.php. See Environment Configuration.

# Installer manifest

An installable platform module may use a module.json manifest to describe its identity and the source-to-target file map:

{
  "name": "Module Name",
  "version": "1.0.0",
  "description": "Module description",
  "files": {
    "controller": "_Documents/install/src/Controller/InstallController.php",
    "templates": "_Documents/install/templates"
  },
  "target": {
    "controller": "src/Controller/InstallController.php",
    "templates": "templates"
  }
}

The manifest format and installer behavior belong to the platform installer, not to the framework module lifecycle API. Keep keys aligned between files and target, and use paths relative to the project as expected by the installer. If the installer backs up selected base files for uninstall, follow its exact path rules and verify them against the current installer implementation.

# Accounts and language configuration

Some starter distributions seed demonstration accounts. Treat any supplied credentials as temporary: change or remove them immediately after installation, and never expose default accounts on a public deployment. User roles and account management are platform features.

The platform can use APP_LANGUAGES to enable interface language selection. The precise URL parameter, persistence, and available catalogs depend on the deployed platform version.

# After installation

Review all generated configuration, rotate secrets, inspect logs, and disable/remove installer routes or modules when the platform's installation flow is complete. Consult the platform's current installation checks for required database extensions and writable directories.