Setup

Server requirements

Apache or NGINX
PHP 7.4+
Document root set to /root

Setup

Make sure the make-saturn-app command is installed and working. Then execute make-saturn-app <name> to create a new application.

Settings

All settings are provided in settings.php and settings.global.php in the project's root (the former should not be committed, the latter should). By default Saturn comes with a settings.example.php file that you can use as a template. All settings can be accessed during runtime by the setting function.

Any domain names provided in the settings file should not include a www subdomain.

General application settings

settings.php

'application' => [
    'name'          => 'Saturn',
    'domain'        => 'saturn.local',
    'production'    => false,
    'secure'        => false,  // HTTPS or not
    'logo'          => '/images/logo.png'  // Optional
],

Application developer settings

settings.global.php

'developer' => [
    'name'  => 'Developer',
    'email' => 'developer@fw4.be',
],

These settings are used for error reporting and debug mails. This also determines the data for the default CMS administrator account. Make sure your SMTP settings are correct and working.

Language settings

settings.global.php

'languages' => [
    new Language('nl', 'Nederlands'),
    new Language('fr', 'Français'),
    new Language('en', 'English', false),
],

A list of languages the application will support. The third parameter determines wether or not the language should be inferred by the HTTP Accept-Language header if a selected language can be determined.

Database settings

settings.php

'database'  => [
    'host'      => 'localhost',
    'username'  => 'saturn',
    'password'  => 'saturn',
    'database'  => 'saturn'
],

SMTP settings

settings.php

'smtp'  => [
    'host'      => 'localhost',
    'username'  => 'username@fw4.be',
    'password'  => 'password',
],

Building

To improve performance, Saturn compiles routes and schema files. Changes to files are detected automatically when the production application setting is set to false. To compile changes on production, or to resolve any potential build issues during development, run php root/index.php build.