The GitHub version is recommended for development or testing. Production package ready for install with all the libraries is at https://www.mautic.org/download.
Documentation on how to use Mautic is available at https://www.mautic.org/docs.
This is a simple 3 step installation process. You'll want to make sure you already have Composer available on your computer as this is a development release and you'll need to use Composer to download the vendor packages.
| Step 1 | Step 2 | Step 3 |
|
Download the repository zip Extract this zip to your web root. |
Run the following command to install required packages.composer install
|
Open your browser and complete the installation through the web installer. |
Get stuck? No problem. Check out general troubleshooting and if it won't solve your issue join us at the Mautic community for help and answers.
Installing from source is only recommended if you are comfortable using the command line. You'll be required to use various CLI commands to get Mautic working and to keep it working. If the source and/or database schema gets out of sync with Mautic's releases, the release updater may not work and will require manual updates. For production the pre-packaged Mautic available at mautic.org/download is recommended.
Also note that the source outside a tagged release should be considered "alpha" and may contain bugs, cause unexpected results, data corruption or loss, and is not recommended for use in a production environment. Use at your own risk.
- Mautic uses Git as a version control system. Download and install git for your OS from https://git-scm.com/.
- Install a server, PHP and MySql to be able to run Mautic locally. Easy option is _AMP package for your OS.
- Install Composer, the dependency manager for PHP.
- Install NPM.
- Install Grunt.
- See Mautic requirements.
- PHP modules:
- required:
zip,xml,mcrypt,imap,mailparse - recommended:
openssl,opcache/apcu/memcached - recommended for development:
xdebug
- required:
- Recommended memory limit: minimally 256 MB for testing, 512 MB and more for production.
- Open a Terminal/Console window.
- Change directory to the server root (i.e.
cd /var/wwwif your local server root is at /var/www). - Clone the repository (
git clone https://github.com/mautic/mautic.git) - The mautic directory should appear in the server root. Change directory to mautic directory (
cd mautic). - Install dependencies (
composer install). - Visit Mautic in a browser (probably at http://localhost/mautic) and follow installation steps.
Each time you update Mautic's source after the initial setup/installation via a new checkout, download, git pull, etc; you will need to clear the cache. To do so, run the following command:
$ cd /your/mautic/directory
$ php app/console cache:clear
(Note that if you are accessing Mautic through the dev environment (via index_dev.php), you would need to add the --env=dev from the command).
Run composer install to ensure new vendors are installed and/or existing upgraded.
Before running these commands, please make a backup of your database.
If updating from a tagged release to a tagged release, schema changes will be included in a migrations file. To apply the changes, run
$ php app/console doctrine:migrations:migrate
