site.ini [AdminEnvironment] #

The block [AdminEnvironment] of settings/site.ini, with 7 setting(s).

Never edit settings/site.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/site.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/site.ini.append.php for one siteaccess,
• extension/<extension>/settings/site.ini.append.php in an extension (read when the extension is active).

Level #

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.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
Level=
*/ ?>

Name #

The badge's text; empty takes the level's name (Development, Test, Staging,
Production, translated)

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
Name=
*/ ?>

ShortName #

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.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
ShortName=
*/ ?>

Release #

Free text after the name, for example a release or build; shown to signed-in
users only, not on the sign-in page

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
Release=
*/ ?>

ShowVersion #

enabled adds the Exponential version after the release (signed-in users only)

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
ShowVersion=disabled
*/ ?>

ShowInTitle #

The name before the page title: "[PRODUCTION] Dashboard - Site"; disabled
leaves the title as it is

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
ShowInTitle=enabled
*/ ?>

BadgeDisplay #

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

Default: hover.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[AdminEnvironment]
BadgeDisplay=hover
*/ ?>

Related #

• All blocks of site.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/site.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.