Installation

This article describes how to install HarmonyCMS in your system.

Last updated 6 years ago

1. Initiating a new HarmonyCMS project

To create your new HarmonyCMS project, first make sure to fulfill the and have installed. If you don't, start by on your system.

Now, create your new HarmonyCMS project by running:

composer create-project harmony/skeleton my-project

This will create a new my-project directory, download all needed dependencies into it and generate the basic HarmonyCMS structure directories and files you'll need to have a complete functional project. In other words, your new new website will be ready!

Installation may sometimes fail, see troubleshooting for the

2. Database installation

HarmonyCMS is currently supporting SQL and No-SQL databases. To do that, this CMS is fully decoupled from any database system. This means, you will have to choose between SQL and No-SQL.

Such has Symfony, HarmonyCMS doesn't provide a component to work with the database, but it does provide tight integration with a third-party library called .

SQL

You will need to install the emulienfou/orm-pack if your database server is one of MySQL, MariaDB, Oracle, Microsoft SQL Server, PostgreSQL, SAP Sybase SQL Anywhere, SQLite or Drizzle by executing the next command:

composer require emulienfou/orm-pack

Full documentation available in the Symfony page. The full list of supported platform by Doctrine DBAL are listed .

This pack also provide 2 virtual packages who can be used to require a doctrine database support:

doctrine/implementation
doctrine/orm-implementation

No-SQL

If your database server is MongoDB, you should install the next pack by executing the both commands:

composer config "platform.ext-mongo" "1.6.16"
composer require emulienfou/mongodb-pack

This pack also provide 2 virtual packages who can be used to require a doctrine database support:

doctrine/implementation
doctrine/mongodb-implementation