Skip to content

Latest commit

 

History

History
executable file
·
101 lines (78 loc) · 6.27 KB

CONFIG.md

File metadata and controls

executable file
·
101 lines (78 loc) · 6.27 KB

Configuration

Here is an overview of what each configurable option does.

These options can be found at the top of the indexer.php file.

Some of these settings can be changed by the client/user, these are only values for the script to use as defaults.

Format

Key Type Default Description
title String Index of %s Page title where %s represents the current path.
date String / Array array('d/m/y H:i', 'd/m/y') Date format as per function.date.php. Can be a string or an array. If it is an array then the first value will be shown on desktop devices and the second will be shown on mobile devices. It is a good idea to set a shorter mobile format because of the limited screen space.
sizes Array ' B', ' kB', ' MB', ' GB', ' TB' Size formats for when displaying filesizes.

Icon

Key Type Default Description
path String /favicon.png Path to a favicon.
mime String image/png Favicon MIME type

Sorting

Default sorting settings. Once the client sorts the items themselves, then those settings will be active for them instead.

Key Type Default Description
enabled Boolean false Enables a specific sorting order on page-load. If disabled, it'll use the default order used by scandir.
order Integer SORT_ASC Sorting order. SORT_ASC or SORT_DESC.
types Integer 0 What item types to sort. 0 = Both. 1 = Files only. 2 = Directories only.
sort_by String name What to sort by. Available options are name, modified, type and size.
use_mbstring Boolean false Enables mbstring. This will solve some sorting issues with cyrillic capital letters et cetera, but it'll require mbstring to be installed.

Gallery

The gallery plugin will display a gallery of the images and videos inside the current path.

Key Type Default Description
enabled Boolean true Whether the gallery plugin should be enabled or not.
fade Integer 0 Fade duration (ms) when navigating the gallery. 0 will disable the effect.
reverse_options Boolean false Whether gallery images should have reverse search options or not.
scroll_interval Integer 50 Adds a forced break between scroll events in the gallery (ms).
list_alignment Integer 0 Gallery list alignment where 0 is right and 1 is left.
fit_content Boolean false Whether images and videos should be forced to fill the available screen space.

Preview

The preview plugin displays a preview of the image or video when hovering over the filename.

Key Type Default Description
enabled Boolean true Whether the preview plugin should be enabled or not.
hover_delay Integer 75 Adds a delay (ms) before the preview is displayed.
cursor_indicator Boolean true Displays a loading cursor while the preview is loading.

Extensions

This setting decides which extensions will be marked as "media".

This basically means that the extensions included here will have previews and will be included in the gallery mode.

Key Type Default Description
image Array 'jpg', 'jpeg', 'gif', 'png', 'ico', 'svg', 'bmp', 'webp' Extensions marked as image.
video Array 'webm', 'mp4' Extensions marked as video.

Style

Various visual options for the script.

Key Type Default Description
themes => path Boolean / String false Set to a path relative to the root directory containing .css files. Example: /indexer/css/themes/ (This directory also contains a few included example themes). Every .css in the set folder will be treated as a separate theme.
themes => default Boolean / String false Default theme for new clients to use. Takes a filename without the .css extension.
compact Boolean false Makes the page use a more compact and centered style.

Filter

This option can be used if you want to filter the files or directories using regular expressions.

All filenames and directory names matching the regex will be shown.

For example, setting file to /^.{1,10}\.(jpg|png)$/ will only include .jpg and .png files with a filename between 1 - 10 characters in length when reading the directory files.

Setting the value to false will disable the filter.

Key Type Default Description
file Boolean / String false A regexp filter for what files should be included.
directory Boolean / String false A regexp filter for what directories should be included.

Other

Key Type Default Description
allow_direct_access Boolean false Whether direct access to the indexer.php should be allowed or not.
path_checking String strict Use weak if you need to support symbolic link directories. strict will use realpath when verifiying the location of the current directory, whereas weak will use a similar string-based approach which doesn't resolve symbolic links.
footer Boolean true Whether there should be a simple footer below the list of files or not.
debug Boolean false Enables PHP debugging and console.log info messages.

Advanced

Advanced settings that are not a part of the regular configuration.

Server

You can set some server variables ($_SERVER) to modify how the script works.

Key Type Description
INDEXER_BASE_PATH String Overrides the default base directory of the script. Can be used if you are dealing with a dynamic root path or if you want to place the script outside of the root directory, for example.