webCOMAND

comand Configuration

This primary configuration file includes the following options.

  • backups - An associative array of the webCOMAND repository backup related options below.
    • backups_path - The base path where COMAND backups should be created and restored from when a full path is not provided.
    • enable_zip64 - Enable Zip 64 compression.  Default is TRUE.
    • large_file_size - Maximum size of files to compress within a backup ZIP archive.  Default is 10MB.  If files larger than this size are added to the ZIP archive, they will not be compressed to reduce memory and processing requirements.
    • max_backup_count - Maximum number of backups to keep in the backups path.  When a new backup is created, if more than this number of backups exist, the oldest will be removed.
  • connect - An associative array of repository connection options, as defined for the comand\connect() method.
  • files_path - The base directory where all user-accessible files will be stored.
  • instance_title - A string to define the title of this COMAND instance.  It will be displayed in the <title> of the web interface, among other places.
  • loader - An associative array of COMAND loader options, as defined for the comand\loader::init_paths() method.  (base_paths, package_paths)
    • package_paths - array of folder paths to look in for packages.
    • safe_include - TRUE (default) will perform a syntax check before auto-loading a package class to avoid failures that can be caused when a Content Type Model or other auto-loaded class contains syntax errors.  FALSE will skip the syntax check and simply load class files, even if they will cause execution to fail.
  • log_level - The default log level to use.
  • output_path - The directory where #OUTPUT will put files when not called from a publish process.
  • package_install - A string defining the path to the folder where new COMAND packages will be installed.  The path can be an absolute path or relative to comand.php.
  • router - A string defining the class of the router to use to route web and command line interface (CLI) requests.
  • system_path - The directory for auto-generated and semi-persistent data (like process files and cache data).
  • temp_path - The directory for temporary files.
  • time_zone - Timezone to use for this instance of COMAND (ie. 'America/New_York').  For a full list of options, see PHP: List of Supported Timezones.
  • timer_enabled - If TRUE, will allow \io_comand_util\timer to be called. Otherwise performance/memory improves without it.

Example config.php

To override defaults, add the following section to the COMAND Configuration.

<?php
/**
 * COMAND Configuration
 */
$config = [
    'io_comand' => [
        'comand' => [
            'connect' => [
                'url' => 'comand://localhost',
                'auth' => [
                    'type' => 'password',
                    'username' => 'admin',
                    'password' => '<password>'
                ],
                'mode' => 2
            ],
            'loader' => [
                'base_paths' => [],
                'package_paths' => [
                    '/var/www/webcomand/files/packages/'
                ]
            ],
            'package_install' => '/var/www/webcomand/packages/',
            'system_path' => '/var/www/webcomand/system',
            'files_path' => '/var/www/webcomand/files',
            'output_path' => '/var/www/wecomand/files',
            'backup_path' => '/var/www/webcomand/files/backups',
            'temp_path' => '/tmp',
            'time_zone' => 'America/New_York',
            'router' => '\\comand\\router',
            'instance_title' => 'Instance Title',
        ]
    ]
];