Downloading Neos

This page has instructions to install Neos with composer, which downloads Neos and all of it's dependencies.
If you don't want to use composer, scroll down to the bottom of the page - We also have instructions on how to download an archive instead. 


1. Installation of Composer

First of all, we need to install composer, if you've already got composer installed on your system, you can safely move on to the next step.

curl -s https://getcomposer.org/installer | php

This will download the composer binary to your current directory. 

2. Installation of Neos

Afterwards we can begin installing Neos. In an empty folder of your choice, execute the following command. 

php /path/to/composer.phar create-project --no-dev neos/neos-base-distribution .

This command creates the necessary folder structure and downloads Neos with all of its dependencies.

Please note: You need to adjust the path pointing to the composer binary which you've downloaded in the first step.

3. Starting Neos

For development, you can start a simple PHP web server with the following command:

./flow server:run

Please note: You need to have a Doctrine compatible database server, like MySQL, running on your system. For production we recommend using a web server like apache or nginx. 

4. Setup

After composer finished downloading the dependencies, open the configured domain for the directory in your favorite browser. Please note that you need to visit the /setup page.

http://127.0.0.1:8081/setup

5. Done

After you've completed filling out all necessary infos in the setup, you are up and running. You can visit either the frontend or the backend by appending /neos to your url.

Do you want to create a new site? We recommend you to start reading the latest documentation, and if you need any help, get in touch with us, we are eager to help you! 


Requirements

Web Server

Not surprisingly, Neos needs a web server to run (at least for production mode) , we recommend you to use Apache or nginx (though IIS and others work too). Please make sure that the mod_rewrite module is enabled. For development, we recommend to run Neos by using the internal server of PHP by executing ./flow server:run in the directory where you have installed Neos, as this is the easiest way to get started.

Database

Neos of course requires a database. We support all databases which are compatible with Doctrine DBAL. We currently ship database migration scripts for MySQL/MariaDB and PostgreSQL, so use one of them if possible. If unsure, use MySQL/MariaDB.

PHP

Make sure you have PHP 7 or later installed. Also Neos needs the PHP CLI binary to be available in the same version as well. 

The default settings and extensions of the PHP distribution should work fine, but it doesn't hurt checking if the PHP modules mbstringtokenizer and pdo_mysql are enabled, especially if you compiled PHP yourself.

Make sure the PHP functions system(), shell_exec()escapeshellcmd() and escapeshellarg() are not disabled in your PHP installation. They are required for the system to run.

For more information on the system requirements check the relevant part of the Flow documentation.



Installation from an Archive

Installing Neos from an archive is convenient if you just want to try Neos for the first steps. If you want to dive deeper into Neos and create a real site with it, we recommend using the installation via composer instead.

To install Neos from an archive, head to the changelog page of the version you want to install and unpack the archive to your webserver document root directory. Afterwards just continue with the setup as described on the top of the page.