Configuration

A site's configuration is one PHP file that returns an array. The installer writes it once from the template configs/system.config.default.php; no command changes it later — edit it by hand. Everything else — the site's name, languages, users, mail templates — is kept in the database and edited in the admin.

The file

  • The site reads only web/system.config.php. The installer writes the configuration to configs/system.config.<host>.php in the repository — readable by its owner only and ignored by git — and makes web/system.config.php a link to it.
  • With --config=FILE the installer reads or writes that file and makes no link: link it as web/system.config.php yourself.
  • Without the file every page shows Configuration file … not found.
  • Every setup command except install and demo reads the configuration first and stops if it lacks site.debug or modules.

The keys of the template

Key In the template What it does
modules share, user, seo The core's modules and their folders. Their names also resolve the short class names of components.
database.host, database.port, database.socket written by the installer Where MariaDB is: localhost and 3306 by default; a socket, when set, replaces host and port.
database.db, database.username, database.password written by the installer The database, its user and the password.
site.domain written by the installer The site's host, with :port if the port is not standard — the only source of the site's address. See Site address and settings.
site.root / The site's path.
site.debug 0 Debug mode: 1 on, 0 off. See Errors and debugging.
site.aggressive_cleanup 1 Clean the HTML of texts with PHP's tidy before saving; works only when the tidy extension is loaded.
site.action_log Energine\share\components\ActionLog Writes «Журнал действий» (Action log) at /admin/action-log/; empty — no entries.
document.transformer main.xslt The main XSLT view, in site/modules/main/transformers/. See Theme.
thumbnails [] Named preview sizes of pictures. See Files.
session.lifespan 108000 How long a session lives after the last request, in seconds: 30 hours.
session.timeout 6000 Not used.
mail.from [email protected] The sender of every letter. See Mail.
mail.smtp commented out The SMTP server; without host letters go through PHP's mail().
repositories.mapping repo/local → FileRepositoryLocal The class of the file repository.
repositories.quick_upload_path uploads/public The folder of quick uploads from file fields.
seo.sitemapSegment, seo.sitemapTemplate google-sitemap, google_sitemap The address and the template of the XML sitemap. Without the seo block robots.txt closes the whole site.
setup_dir ROOT_DIR . '/setup' The folder of the console tool.

Keys removed from the template in 2026 — project, site.useTimer, site.asXML, site.vars — are not read; an older configuration that still has them works.

Keys outside the template

Key What it does
site.static, site.media, site.resizer Other base addresses for static files, media and the resizer; by default the site's own address.
database.persistent A persistent database connection; off by default.
document.errorTransformer The XSLT view of the 403 and 404 pages; by default document.transformer.
mail.smtp.helo The name the SMTP client gives in EHLO; by default the site's host.

Fixed in the code: the time zone is Europe/Kyiv, and the session cookie is called NRGNSID.

The environment

  • The site reads no environment variables while it runs. The installer reads ENERGINE_DB_PASSWORD and ENERGINE_ADMIN_PASSWORD.
  • PHP's upload_max_filesize and post_max_size limit uploads. The resizer keeps its cache in upload_tmp_dir, or in the system's temporary folder, and raises memory_limit to 256M for big pictures.
  • The PHP extensions the site needs are listed in Installation.

Settings in the database

When an update brings new keys into the template, copy them into your configuration — see Updating.