A flat-file content management system and template engine
A flat-file content management system and template engine.
Note that this repository only contains source code. Please follow the instructions below in order to install a fully bundled
version of Automad using Docker or Composer.
It is also possible to manually download
and install Automad.
The fastest way to get Automad up and running is to use Composer.
composer create-project automad/automad . v2.x-dev
Follow this guide to finish the installation and get started quickly.
It is also possible to run Automad in a Docker container including Nginx and PHP 8.3.
docker run -dp 80:80 -v ./app:/app --name mysite automad/automad:v2
This will essentially make your site available at port 80
and mount a directory called app
in the current working directory for data persistence.
A new user account for the Automad dashboard will be created automatically. The account details will be logged by the running container.
You can show these logs using the following command:
docker logs mysite
Your can now navigate to localhost to view your new site.
In case you are not able to use Docker or Composer, you can also deploy Automad manually.
/dashboard
route of your site and create the first user.Take a look at the documentation to get started with Automad.
Visit the Automad package browser to get free themes and extensions for your Automad site.
Join the community, ask questions or start a discussion on the Automad discussion platform.
In case you are interested in contributing, the following types of contribution are welcome:
However, I do not exclude at this point using parts of Automad’s source in future projects under different licenses. In order to avoid having to ask anybody for permission when doing so, I will not accept any contributions to this repository. Please understand that pull requests will therefore be ignored.
To make the development of themes more efficient, plugins providing syntax highlighting and snippets for Automad’s template language are available for the following editors:
© 2013-2024 Marc Anton Dahmen
Released under the MIT license