kitFramework # Configuration

The kitFramework will be installed in multiple steps.

• Within WebsiteBaker or LEPTON CMS the Admin-Tool kitFramework for WebsiteBaker will be executed
• Within BlackCat CMS the Admin-Tool kitFramework for BlackCat CMS will be executed.
• ... other Content Management Systems will be supported in the future.

The Admin-Tool proceed the following steps:

• Check if at minimum PHP 5.3.3 is installed
• Check if the PHP cURL library is installed
• Download the last kitFramework Release directly from the GitHub repository
• Unzip the kitFramework to /kit2
• Create the configuration files cms.json, doctrine.cms.json, framework.json, swift.cms.json in the protected directory /kit2/config

All configuration parameters are taken from the parent CMS settings, therefore there is no user input needed.

At the first start the kitFramework will download and configure additional needed extensions, create database tables and finish the setup procedure.

cms.json

The cms.json configuration file contains all information about the parent Content Management System:

• cms_path - from WB_PATH or LEPTON_PATH or CAT_PATH,
• cms_url ...
• CMS_MEDIA_PATH ...
• CMS_MEDIA_URL ...
• CMS_TEMP_PATH ...
• CMS_TEMP_URL ...
• CMS_ADMIN_PATH ...
• CMS_ADMIN_URL ...
• CMS_TYPE - can contain WebsiteBaker or LEPTON or BlackCat
• CMS_VERSION - the version number of the CMS

doctrine.cms.json

The doctrine.cms.json configuration file contains all information for configuring the database access with Doctrine DBAL:

• DB_TYPE - in general mysql
• DB_HOST - the database host, often localhost
• DB_PORT - the database port, by default 3306
• DB_NAME - the database name
• DB_USERNAME - the username for the access
• DB_PASSWORD - the password
• TABLE_PREFIX - the used table prefix

framework.json

The framework.json configuration file contains the base settings for the kitFramework:

• CACHE - can be true (default) or false. If true the kitFramework will load templates directly from cache. You should disable the caching while you are changing existing templates.
• CATALOG_ACCEPT_EXTENSION - array of the development status of the extensions which will be shown by the kitFramework extension catalog. By default this are beta, pre-release and release versions, which mean you can install extensions of this status. If you add alpha you can also access extensions with alpha status.
• CONNECT_CMS_USERS - (optional) can be true (default) or false. If true the kitFramework will automatically authenticate user which are logged in the CMS backend also for the kitFramework.
• DEBUG - can be true or false. If true the kitFramework will log additional information in the logging file /kit2/logfile/kit2.log and extend the error mode to give you more detailed information if a problem occur.
• FRAMEWORK_TEMPLATES - specify the templates which shall be used. Keep in mind that you must always add the default template as last entry.
• FRAMEWORK_TEMP_PATH - (optional) the path to the temporary directory used by the kitFramework, by default the kitFramework will use /kit2/temp
• FRAMEWORK_TEMP_URL - (optional) the URL to the temporary directory used by the kitFramework
• FRAMEWORK_URL - the URL to the kitFramework root directory,
• FRAMEWORK_SETUP - true until the first start of the kitFramework. You can force the kitFramework to re-initialize and rewrite the framework.json if you set this value to true.
• LOGFILE_EMAIL_ACTIVE - can be true (default) or false. If true you will receive a email if an error is logged by the kitFramework
• LOGFILE_EMAIL_LEVEL - possible integer values: 100 (DEBUG), 200 (INFO), 250 (NOTICE), 300 (WARNING), 400 (ERROR, default). 500 (CRITICAL), 550 (ALERT) and 600 (EMERGENCY). You will receive an email if the logging level is identical or higher as specified. By default the level is 400.
• LOGFILE_EMAIL_SUBJECT - the subject of the email send by the logger
• LOGFILE_EMAIL_TO - the email address of the webmaster who receive the logging notifications.
• LOGFILE_ROTATE_MAXFILES - (optional) the kitFramework logfile will be stored as /kit2/logfile/framework-yyyy-mm-dd.log with the actual date and one logfile for each day. By default the kitFramework will keep 10 logfiles for the last 10 days before they will be deleted (rotation).

proxy.json

The proxy.json enable you to configure the kitFramework for the usage behind a Proxy:

{
  "PROXYAUTH":"NONE",
  "PROXY":"",
  "PROXYPORT":"",
  "PROXYUSERPWD":""
}

recaptcha.json

the kitFramework comes with a ReCaptcha Spam Protection. By default the service is enabled, the public and private key are set for the global valid domain recaptcha.phpmanufaktur.de - you may replace them with keys for the used domain.

{
  "enabled": true,
  "key": {
    "public": "xyz",
    "private": "xyz"
  },
  "use_ssl": false,
  "theme": "red",
  "custom_theme": ""
}

Please read the ReCaptcha API documentation for more information.

swift.cms.json

The swift.cms.json configuration file contains the email settings for the Swift Mailer:

• SERVER_EMAIL - the email address which is used by kitFramework to sending out emails,
• SERVER_NAME - the name which is used for sending emails by kitFramework,
• SMTP_HOST - the server name or IP address,
• SMTP_PORT - the port, by default 25,
• SMTP_USERNAME - the SMTP username,
• SMTP_PASSWORD - the SMTP password