[AdminEnvironment]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [AdminEnvironment] of settings/site.ini.
File
settings/site.ini; override it in settings/override/site.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| Level | (empty) | The environment badge of the administration (designs admin4 and admin4l): the name of this installation's environment in the header, on the sign-in page and before the page title, so a live site is not taken for a test copy. Set it per environment, for example in the variant files of EXP_ENV (settings/override/site.ini.prod.append.php, see config.env.php.example). The header's cache-blocks are keyed by the badge: a changed setting shows on the next request (clear the INI cache where EZP_INI_FILEMTIME_CHECK is false). development, test, staging or production: the color and the default name. auto takes the level from EXP_ENV: dev and development, test, stage and staging, prod, production and live. Empty (the default): no badge. |
| Name | (empty) | The badge's text; empty takes the level's name (Development, Test, Staging, Production, translated) |
| ShortName | (empty) | The text where the header is narrow (up to 767px, phones too) with BadgeDisplay=always or on touch screens; empty takes the level's code (DEV, TEST, STAGE, PROD). The name is read out. |
| Release | (empty) | Free text after the name, for example a release or build; shown to signed-in users only, not on the sign-in page |
| ShowVersion | disabled | enabled adds the Exponential version after the release (signed-in users only) |
| ShowInTitle | enabled | The name before the page title: "[PRODUCTION] Dashboard - Site"; disabled leaves the title as it is |
| BadgeDisplay | hover | hover (the default): the badge shows only while a mouse or trackpad pointer rests on the logo, or the logo has the keyboard focus (Escape hides it); on touch screens, which cannot hover, beside the logo as with always. Screen readers read it with the logo link. always: beside the logo at all times |
See also
Generated example: site.ini [AdminEnvironment]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/site.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment