System Guide

Automad is a flat-file content management system. Instead of a database, it stores all content, settings and drafts as plain JSON files in your installation directory. This makes your site fast, robust and easy to move, and it keeps the system requirements to a minimum.

Why Flat Files

A database is a powerful tool, but most websites don't need one. For a typical site, files bring several benefits.

No Database

There is no database server to install, configure, secure or update, and no credentials that connect Automad to its data. Pages are stored as folders inside the pages directory, while global data and components live in shared. All files are human-readable, so you can always inspect your content with a text editor. Features that usually require a database, such as searching, tagging and filtering pages, work out of the box.

Performance

Automad caches on multiple levels. Rendered pages are stored as finished HTML and delivered straight from the cache, without reading content files or rendering templates again. Automad watches the modification times of your pages, global data, packages and configuration, and only rebuilds the cache when something has changed. Read more about the available settings in Caching.

Stability

Fewer moving parts mean fewer things that can go wrong. Without a database, there is no connection that can fail and no separate service that can run out of resources. Files are written with exclusive locks, so concurrent saves don't overwrite each other halfway. On top of that, every page keeps its drafts and its previous versions right next to its content.

Easy Deployment

Automad only needs PHP 8.2 and a few common extensions (see the system requirements). It runs on budget shared hosting as well as on Apache, Nginx, Caddy, FrankenPHP and LiteSpeed servers, or in Docker. Since the complete site is a single directory, moving it to another server is as simple as copying files, and updates can be installed from the dashboard.

Version Control

Plain files work well with Git. You can track your site like source code, compare changes over time and restore any earlier state. The Backups page explains how to automate this with GitHub.

In This Guide

The System Guide covers everything you need to host and run your own Automad instance: configuration options such as caching, email and the RSS feed, encrypting secrets, user accounts, installing themes, the Console CLI and automated backups using Git.

Configuration
Automad is a flat-file content management system designed for performance and straightforward configuration. Configuration can be managed through several methods depending on the context and scope of the settings being configured.
Encrypting Secrets
Automad stores credentials such as the mail server password, AI provider API keys and the hashes of MCP access tokens as PHP files in the config directory of your installation. This page explains how you can encrypt those secrets with your own key and how to provide that key in different server environments.
User Accounts
Every person who works on your site signs in to the dashboard with their own user account. This page explains how to manage your own account, secure it with two-factor authentication, recover access and invite other people to collaborate with you. All of these options can be found in the Users section of the System Settings.
Themes
Themes define the look and the available templates of your site. They are distributed as packages and can be installed, updated and removed directly in the Packages section of the dashboard. Alternatively, you can manage them on the command line using Composer.
Console
The Console is Automad's command line interface. It lets you run system tasks such as clearing the cache, changing the configuration, creating users or updating Automad from a terminal. This is useful for automated deployments, scripts or in case you can't access the dashboard.
Backups
Automad is a flat-file content management system and doesn't use a database. All content, settings and themes are stored as plain files in the installation directory, so a backup is simply a copy of those files. This page explains which files matter, how to back them up and how to automate version-controlled backups to GitHub.
Plain PHP Snippets Configuration