Installation

Automad is a PHP application. Therefore it doesn't have any installer or similar. Installing is a matter of moving the right files to the right place. As all PHP web applications, Automad requires a webserver - Apache or Nginx - to be running.
Please also take a look at the system requirements before installing.
You can find additional information, how to get a webserver running on your local computer here.


Installing on an Apache server

  1. Grab your copy of Automad here.

  2. Unpack the downloaded .zip archive and upload the complete content of the www directory to your webspace, using your favorite FTP program - for example Cyberduck.
    Be careful to upload all the files in www including the .htaccess file, which might be invisible on Mac OS X and Linux machines.

  3. Your webserver needs to have write access to the following directories and its subdirectories:

    • cache - all cached files and pages are stored here
    • config - your site's configuration
    • pages - your pages
    • shared - shared content and the site's settings

    Therefore you have to change the UNIX permission of these directories recursively to 777.
    In case you use Cyberduck, you can find instructions how to do that here.

  4. Finally you can optionally activate the browser-based GUI.


Installing on a Nginx server

  1. The installation on a Nginx server is basically the same like on an Apache server - plus one additional step. So first, follow steps 1-3 from the Apache guide above.

  2. Edit your nginx.conf to enable rewriting. Therefore your configuration should contain something similar to this:

    root    /path/to/your/automad/directory;
    index   index.php index.html;
    
    location / {
        try_files $uri $uri/ /index.php?$request_uri;
    }
    
  3. Optionally activate the GUI.


Activating The GUI (optional)

Using the browser-based GUI is optional. If you don't intend to use the GUI, you can skip this step and disable the GUI permanently.
Otherwise follow these steps:

  1. Navigate the to http://yoursite.com/gui.
    A registration dialog will show up.

  2. Fill out the form and download the accounts.php file to your local computer.

  3. Upload that generated file again manually to the /config directory in your Automad installation's root via FTP, to identify you as the site's owner.

Also the GUI should now be working fine and ready to use. When navigating the next time to http://yoursite.com/gui (NOT by refreshing the page), you should be prompted for your credentials.


Adding a sitemap file (optional)

To enable search engines to easily track all your pages, Automad generates a file called sitemap.xml and tries to save it to your base directory, whenever you add, move or update a page. To avoid permission issues and make sure, Automad has access to that file, follow this guide.

See also