App Config Reference

The app config is located at app/config/app.php. These options control core application functionality.

compile_container

Control whether or not the container is compiled.

There is no corresponding configuration option for this value in the app/config definitions because this option is applied before the application container (and configuration) is loaded.

Possible Values

false or <unset>

Default Value

<unset>

Environment Variable

COMPILE_CONTAINER

date_format

The format used for rendering dates in the application views.

Possible Values

See the PHP date format documentation for possible values.

Default Value

Y-m-d H:i:s

Environment Variable

DATE_FORMAT

debug

Enable application debugging and display error messages.

It is recommended that debug remains OFF unless troubleshooting an issue. Leaving this enabled WILL cause leakage of sensitive server information.

Possible Values

true or false

Default Value

false

Environment Variable

APP_DEBUG

display_readmes

Parse and render README files on the page.

Possible Values

true or false

Default Value

true

Environment Variable

DISPLAY_READMES

google_analytics_id

Your Google analytics tracking ID.

Possible Values

A string in the format of UA-123456789-0 or false to disable

Default Value

false

Environment Variable

GOOGLE_ANALYTICS_ID

hidden_files_list

File containing hidden file definitions. Will be merged with definitions from the 'hidden_files' configuration option.

See the Hiding Files page for additional info on hiding files.

Possible Values

A path (string) to a file

Default Value

.hidden

Environment Variable

HIDDEN_FILES_LIST

hidden_files

Array of hidden file definitions. Will be merged with definitions in the file defined in the hidden_files_list configuration option. Supports glob patterns (e.g. *.txt, file.{yml,yaml}, etc.).

See the Hiding Files page for additional info on hiding files.

Possible Values

An array of paths (strings)

Default Value

[] (an empty array)

Example

'hidden_files' => [
    'somefile.txt', // Matches 'somefile.txt' exactly
    'README.*', // Matches files named 'README' with any file extension
    'foo/*', // Matches all files in the 'foo' directory
    'schema.{ya?ml}', // Matches 'schema.yml' or 'schema.yaml'
]

hide_app_files

Hide application specific files/directories (i.e. index.php and the app folder).

Possible Values

true or false

Default Value

true

Environment Variable

HIDE_APP_FILES

hide_dot_files

Hide dot files/directories from the listing.

Possible Values

true or false

Default Value

true

Environment Variable

HIDE_DOT_FILES

hide_vcs_files

Hide the files Version Control Systems (i.e. Git and Mercurial) use to store their metadata.

Possible Values

true or false

Default Value

true

Environment Variable

HIDE_VCS_FILES

home_text

Text of the home link in the navigation breadcrumbs. If undefined or null will use the translated form of "home" from your selected language.

Possible Values

Any string

Default Value

null

Environment Variable

HOME_TEXT

language

The application's interface language.

Possible Values

See the app/translations folder for available translations.

Default Value

en (English)

Environment Variable

APP_LANGUAGE

matomo_analytics_site_id

Your Matomo analytics site ID.

Possible Values

A Matomo analytics site ID (string)

Default Value

false

Environment Variable

MATOMO_ANALYTICS_SITE_ID

matomo_analytics_url

Your Matomo analytics URL.

Possible Values

A Matomo analytics URL (string)

Default Value

false

Environment Variable

MATOMO_ANALYTICS_URL

max_hash_size

The maximum file size (in bytes) that can be hashed. This helps to prevent timeouts for excessively large files.

The larger a file is the longer it will take to calculate hashes for that file.

Possible Values

Any positive integer 0 - 9223372036854775807 (PHP_INT_MAX)

Default Value

1000000000 (1 GB)

Environment Variable

MAX_HASH_SIZE

meta_description

Meta tag description (i.e. <meta name="description">) text.

Possible Values

Any string

Default Value

Yet another directory listing, powered by Directory Lister.

Environment Variable

META_DESCRIPTION

readmes_first

Show READMEs before the file listing.

Possible Values

true or false

Default Value

false

Environment Variable

READMES_FIRST

reverse_sort

When enabled, reverses the order of files (after sorting is applied).

Possible Values

true or false

Default Value

false

Environment Variable

REVERSE_SORT

site_title

The title of your directory listing. This will be displayed in the browser tab/title bar along with the current path.

Possible Values

Any string

Default Value

Directory Lister

Environment Variable

SITE_TITLE

sort_order

Sorting order of files and folders. Can be one of several predefined values or a custom anonymous function.

When using an anonymous function it must be wrapped in a \DI\value() function. The anonymous function receives two \SplFileInfo objects as arguments and expects an integer to be returned.

Example

'sort_order' => \DI\value(
    function (SplFileInfo $file1, SplFileInfo $file2) {
        return strcmp($file1->getRealPath(), $file2->getRealPath());
    })
);

Possible Values

type, natural, name, accessed, changed, modified, <anonymous function>

Default Value

type

Environment Variable

SORT_ORDER

timezone

Time zone used for date formatting.

Possible Values

For a list of supported time zones see: https://www.php.net/manual/en/timezones.php.

Default Value

The server's timezone

Environment Variable

TIMEZONE

zip_downloads

Enable downloading of directories as a zip archive.

Possible Values

true or false

Default Value

true

Environment Variable

ZIP_DOWNLOADS

zip_compress

Compress Zip using Deflate. Enabling this option prevents file size estimation and it may prevent zip download resuming when paused.

Possible Values

true or false

Default Value

false

Environment Variable

ZIP_COMPRESS