config.php.example

<?php

//======= Override Main Module Company Parameters ============
Config::set('main.application_name', 'Cmfive');
Config::set('main.company_name', '2pi Software');
Config::set('main.company_url', 'https://2pisoftware.com');
Config::set('main.company_support_email', '');

//=============== Timezone ===================================
date_default_timezone_set('Australia/Sydney');
Config::set("system.timezone", "Australia/Sydney");

//========== Database Configuration ==========================
Config::set("database", [
    "hostname"  => getenv('DB_HOST') ?: "localhost",
    "port"  => getenv('DB_PORT') ?: "",
    "username"  => getenv('DB_USERNAME') ?: "<username>",
    "password"  => getenv('DB_PASSWORD') ?: "<password>",
    "database"  => getenv('DB_DATABASE') ?: "<database>",
    "driver"    => getenv('DB') ?: "mysql",
    "backups" =>
    [
        'outputExt' => 'sql',
        'commandPath' => [
            'unix' => '/usr/bin/',
            'windows' => '"C:\\Program Files\\MySQL\\MySQL Server 5.6\\bin\\'
        ],
        'backupCommand' => [
            'unix' => 'mysqldump -u $username -h $hostname -P $port -p\'$password\' $dbname > $filename',
            'windows' => 'mysqldump.exe" -h$hostname -P$port -u$username -p$password  $dbname > $filename'
        ],
        'restoreCommand' => [
            'unix' => 'mysql -u $username -h $hostname -P $port -p\'$password\' $dbname < $filename',
            'windows' => 'mysql.exe" -D$dbname -h$hostname -P$port -u$username -p$password < $filename'
        ],
    ]
]);

//=========== Email Layer Configuration =====================
Config::append('email', [
    "layer"    => "smtp",   // smtp or sendmail or aws
    "command" => "",        // used for sendmail layer only
    "host"    => "smtp.gmail.com",
    "port"    => 465,
    "auth"    => true,
    "username"    => '<email>',
    "password"    => '<password>',
]);

//========== TestRunner Configuration ==========================
//========== must be "ENABLED" to run ==========================
Config::set(
    "tests",
    [
        "testrunner"  => "",
        "config" => '',
        "yaml" =>
        [
            "- WebDriver:" =>
            [
                "url" => "http://webapp:3000",
                "browser" => "chrome",
                "wait" => "60",
                "host" => "selenium314",
                "port" => "4444",
                "capabilities" =>
                [
                    "acceptInsecureCerts" => true,
                    "goog:chromeOptions" => "w3c: false"
                ]
            ],
            "- Db:" =>
            [
                "dsn" => (getenv('DB') ?: 'mysql')
                .":host=".(getenv('DB_HOST') ?: 'localhost')
                .":".(getenv('DB_PORT') ?: '')
                .";dbname=".(getenv('DB_DATABASE') ?: '<database>'),
                "user" => (getenv('DB_USERNAME') ?: '<username>'),
                "password" => (getenv('DB_PASSWORD') ?: '<password>'),
            ],
            "- Asserts:" => "",
        ]
    ]
);

//========= Anonymous Access ================================
// bypass authentication if sent from the following IP addresses
// specify an IP address and an array of allowed actions from that IP
Config::set("system.allow_from_ip", [
    // "10.0.0.0" => array("action1", "action2"),
]);

// or bypass authentication for the following modules
Config::set("system.allow_module", [
    // "rest", // uncomment this to switch on REST access to the database objects.
]);

// or bypass authentication for the following actions
Config::set('system.allow_action', [
    "auth/login",
    "auth/forgotpassword",
    "auth/resetpassword",
    //"admin/datamigration"
]);

//========= REST Configuration ==============================
// check the following configuration carefully to secure
// access to the REST infrastructure.
//===========================================================

// use the API_KEY to authenticate with username and password
Config::set('system.rest_api_key', "abcdefghijklmnopqrstuvwxyz1234567890");

// include class of objects that you want available via REST
// be aware that only the listed objects will be available via
// the REST API
Config::set('system.rest_include', [
    // "Contact"
]);

// Development mode
Config::set('system.environment', 'development');