Configuration

Automad is designed to be extremely configurable.
All custom settings are stored in the JSON data format in /config/config.json and serve as overrides for the default configuration. The initial config file only includes a couple of key settings, like caching, debugging and a whitelist of file types, but you can basically add any of the available settings to the JSON object.

{
    "AM_ALLOWED_FILE_TYPES": "css, jpg, zip, png, svg, js, pdf, mp3, gif",
    "AM_CACHE_ENABLED": true,
    "AM_CACHE_MONITOR_DELAY": 120
    "AM_DEBUG_ENABLED": false,
    "AM_PAGE_GUI": "\/gui"
}

You can take a look at the /automad/const.php file for a full list of configuration options.


Configuration Via The GUI

The most convenient way to edit all common settings of your Automad installation is to use the System Settings pane of the GUI. Additional to these settings you can also administrate your users here.

cache.png

Cache

By default, caching is enabled. You only need to disable the cache, in case you don't want to use the GUI to edit your content or during developing. Normally you should always leave that option enabled!

Users

After successfully installing Automad, there is only one registered user. You can add/remove more users or change your password here.

File Types

In case you want to link to any type of media files - images, archives, videos or audio files - you have to make sure, that the file's extensions is registered here. Most common file types are registered by default.

Debugging

During development of extensions it can be handy to see what Automad is doing. Therefore it is possible to send logging information to your browser's console.
You can log any item, object or just a text notice using \Automad\Core\Debug::log(...) in your extension's or theme's PHP code. The console output is only visible, when debugging is enabled and therefore you can leave all calls for the Debug::log() method permanetly within your code.

See also