Awesome Open Source
Awesome Open Source

Automad

A flat-file content management system and template engine

Tag Language Size License Twitter

Mockup

Installation

Automad can be installed using Docker, Composer or manually.

Composer

The fastest way to get Automad up and running is to use Composer.

composer create-project automad/automad .

Follow this guide to finish the installation and get started quickly.

Docker

It is also possible to run Automad in a Docker container including Nginx and PHP 8.

docker run -dp 80:80 --name mysite automad/automad

The first time you run the image, 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.

Manual Download

Alternatively Automad can also be installed manually.

Documentation

Take a look at the documentation to get started with using Automad or to learn how to develop themes and extensions. In case you are interested in using plain PHP in your themes or to develop more complex extensions, check out Automad's API reference.

Packages

Visit the Automad package browser to get free themes and extensions for your Automad site.

Community

Join the community, ask questions or start a discussion on the Automad discussion platform.

Contributing

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.

Text Editors Plugins

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-2021 Marc Anton Dahmen
Released under the MIT license


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
php (16,611
cms (450
template-language (23
flat-file (20