README

Formerly contenir/contenir-setup; the old package is abandoned in favour of this one.

Web installer for Contenir CMS on Mezzio. It walks an operator through system diagnostics, database configuration, a connection test and the first administrator account, then validates the installation.

The package provides the request handlers, the services behind them and the setup:: templates. The application provides the routes, a template renderer, and the Contenir CMS services the installer drives (see Requirements).

Requirements

PHP 8.3, 8.4 or 8.5
mezzio/mezzio 3.18+ with a template renderer for the setup:: templates (the shipped templates use laminas-view helpers)
laminas/laminas-db 2.20+
From the Contenir CMS application, registered in the container: Contenir\Service\Database\AdapterManager (with a cms adapter), Contenir\Service\Migration\MigrationService and User\Manager\UserManager. These are not declared as Composer dependencies because no package provides them yet.

There is no earlier tagged release; see UPGRADE-2.0.md for changes from the master branch before 2.0.

Install

composer require contenir/contenir-setup-mezzio

With laminas-component-installer the Contenir\Setup\ConfigProvider is added to your configuration automatically. Then route the wizard:

// config/routes.php
$app->route('/setup', Contenir\Setup\Handler\InstallHandler::class, ['GET', 'POST'], 'setup');

The handler redirects to this exact path.

Security

The wizard closes itself. Once InstallerService::isInstalled() is true, every setup request (GET or POST, any parameters) gets an empty 404 and nothing is written: not db.local.php, not the cache, not the database, not the users. 404 rather than 403, so an installed site does not confirm the endpoint exists.
Before installation the wizard is open to anyone who can reach it, as with any web installer. Install promptly, or restrict /setup at the web server until you have.
No default administrator. The install step requires a username, an email and a password of at least 8 characters (InstallHandler::MINIMUM_PASSWORD_LENGTH). Credentials are never shown back.
Repair is not exposed over HTTP. InstallerService::repair() (back up, delete and reinstall the database) is only callable from code, such as a CLI command you register.
Reconfiguring an installed site means editing config/autoload/db.local.php yourself.

Usage

Class	Purpose
`Handler\InstallHandler`	The wizard: renders `setup::install` and handles each step's POST
`Handler\CompleteHandler`	Legacy completion route: redirects to `/setup`, or 404 once installed
`Service\DiagnosticsService`	PHP version, extensions, required and writable directories, with auto-fix
`Service\DatabaseConfigWriter`	Writes `config/autoload/db.local.php` from the database form
`Service\CacheService`	Deletes the files under the cache directory
`Service\InstallerService`	Migrates, creates the administrator, validates and repairs the CMS database
`ConfigProvider` and the `*Factory` classes	Container wiring and the `setup` template path

Every class is final. To change a service, implement its interface (InstallerServiceInterface, DiagnosticsServiceInterface, DatabaseConfigWriterInterface, CacheServiceInterface) and point the interface alias at your implementation; the handlers depend on the interfaces:

'dependencies' => [
    'aliases'   => [InstallerServiceInterface::class => SiteInstallerService::class],
    'factories' => [SiteInstallerService::class => SiteInstallerServiceFactory::class],
],

The services can be used on their own, for example from a CLI command:

$report = $container->get(DiagnosticsServiceInterface::class)->runAll();
// ['success' => bool, 'results' => [key => ['success' => bool, 'message' => string]], 'errors' => [key => message]]

$installer = $container->get(InstallerServiceInterface::class);
if (! $installer->isInstalled()) {
    $installer->install(['username' => 'admin', 'email' => 'admin@example.com', 'password' => $password]);
}
$problems = $installer->validate(); // list<string>

The docs folder covers each area:

Configuration

Key	Used by	Default
`db.cms.database`	`InstallerService`	none; the wizard writes it
`cache_dir`	`CacheService`	`data/cache`

Relative paths resolve against the working directory, which a Mezzio application's public/index.php sets to the application root.

Development

The QA toolchain is contenir/contenir-qa-tools. Mago is a standalone binary, installed separately (brew install mago).

composer check             # everything below
composer cs-check          # mago format --check && mago lint
composer static-analysis   # mago analyze
composer test              # unit suite: collaborators doubled, no I/O
composer test-integration  # integration suite: temp directories, SQLite, laminas-view templates
composer test-coverage     # both suites, clover.xml for Codecov
composer mutation-test     # Infection over both suites (needs Xdebug or PCOV)

stubs/ declares the three Contenir CMS application classes that InstallerService uses, with their real signatures, so that Mago can analyse src/ and the tests can double them. They are autoloaded for development only and are not part of the distributed package.

Some integration tests change file permissions and are skipped when run as root.

License

MIT. See LICENSE.

contenir / contenir-setup-mezzio

Package info

Security

Statistics

README

Requirements

Install

Security

Usage

Configuration

Development

License