• ♡ Sponsor

    System

    #Configuration #Dashboard

    Automad is designed to be extremely configurable. Managing system settings and running updates can be done by using the browser-based dashboard or a simple text editor and the console.

    Using the Dashboard

    Common system settings as well as user accounts and system updates can be managed on the System Settings section of the dashboard.

    Editing the Configuration File

    All custom settings are stored in the JSON formatted string inside the config/config.php file 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.

    <?php return <<< JSON
    {
        "AM_ALLOWED_FILE_TYPES": "dmg, ... css, js, md, pdf",
        "AM_CACHE_ENABLED": true,
        "AM_CACHE_LIFETIME": 43200,
        "AM_CACHE_MONITOR_DELAY": 120,
        "AM_DEBUG_ENABLED": false,
        "AM_HEADLESS_ENABLED": false
    }
    JSON;
    

    While it is possible to just use your favorite text editor, you can also use the dashboard to edit the configuration file in the browser by navigating to System Settings → Configuration File.

    Take a look at the Config class for a full list of configuration options.

    Command Line

    Running updates and creating users can also be done using the Automad's console.

    php automad/console <command>
    

    More in System

    • Caching
    • Users
    • Updating Automad
    • RSS Feed
    • Language
    • Debugging
    • Installing Packages
    • Console
    • Allowed File Types
    • Securing the Dashboard
    • sitemap.xml

    Related

    System  ⁄
    Caching — System

    Caching is essential to speed up your site and should generally be enabled. However under some circumstances you might want to disable or clear your cache. The dashboard provides an easy way to change your cache's behavior with a few clicks.

    System  ⁄
    Users — System

    After successfully installing Automad, there is only one registered user. You can change the account information such as the username, email address and the password in the Users tab. Here you can also add, remove or invite other users to collaborate with you on your site.

    System  ⁄
    Language — System

    You can change the language used in the dashboard in the Language tab of the system settings. There are several languages available for the Dashboard. The translations are created automatically. This feature is still in an experimental phase and therefore some translations might ...

    System  ⁄
    Debugging — System

    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 the following method in your extension or theme.

    System  ⁄
    Allowed File Types — System

    To increase the security of your Automad installation, it is only allowed to upload files which are on the whitelist of allowed file types. All common media file types are already on that list by default. In case you want to extend the whitelist, you can edit the ...

    System  ⁄
    Securing the Dashboard — System

    The default URL of Automad's dashboard is /dashboard. To add an extra layer of security to your site you can set a custom URL or disable the dashbaord entirely.

    User Guide

    Automad ships with an intuitive and clean user interface called the Dashboard. While it is recommended to use the dashboard to edit content and pages, it is also possible to use Automad with just a text editor and a file browser.

    User Guide  ⁄
    Creating Pages — User Guide

    Managing pages using the dashboard is quite self-explanatory. Pages can be added by hitting the  button on the right side of the navigation bar on top. To navigate to an existing page, you can browse the site tree on the left sidebar or start typing some letters of the page ...

    User Guide  ⁄
    General Data and Files — User Guide

    Basically general or shared content is just content without a page context. Usually that is the place to store site logos and content which is identical on all pages across your website. You can also choose your globally used theme here. Conceptually, shared content can be seen ...

    User Guide  ⁄
    Key-Combos — User Guide

    Key-combos make content editing more efficient. Automad provides a very basic list of key-combos to navigate to pages or save changes.

    • Automad
    • System
    Discuss
    Packages
    Release Notes
    Support
    Terms of Use
      Become a Sponsor
      GitHub
      Twitter
      Facebook
      Instagram
      2013-2023 by Marc Anton Dahmen
    Released under the MIT license

    A faceless machine, creating one's portrait in the internet.
  • Automad
  • Getting Started
  • System
  • User Guide
  • Developer Guide
  • Headless Mode
  • Discuss
  • Packages
  • Caching
  • Users
  • Updating Automad
  • RSS Feed
  • Language
  • Debugging
  • Installing Packages
  • Console
  • Allowed File Types
  • Securing the Dashboard
  • sitemap.xml