Skip to content

Latest commit

 

History

History
211 lines (182 loc) · 33.8 KB

README.md

File metadata and controls

211 lines (182 loc) · 33.8 KB

codecov

All Contributors

About Mautic

Mautic is the world’s largest open source marketing automation project. With over 200,000 organisations using Mautic and over 1,000 community volunteers, we empower businesses by making it easy to manage their marketing across a range of channels. Stay up to date about initiatives, releases and strategy via our blog.

Marketing automation has historically been difficult to implement within organisations. The Mautic Community is an example of open source at its best, offering great software and a vibrant and caring community in which to learn and share knowledge.

Open source means more than open code. Open source provides equality for all and a chance for everyone to improve.

Mautic

Get Involved

Before we tell you how to install and use Mautic, we like to shamelessly plug our awesome user and developer communities! Users, start here for inspiration, or follow us on Twitter @MauticCommunity or Facebook @MauticCommunity. Once you’re familiar with using the software, maybe you will share your wisdom with others in our Slack channel.

Calling all devs, testers and tech writers! Technical contributions are also welcome. First, read our general guidelines about contributing. If you want to contribute code, read our CONTRIBUTING.md or Contributing Code docs then check out the issues with the [T1 label][t1-isssues] to get stuck in quickly and show us what you’re made of.

If you have questions, the Mautic Community can help provide the answers.

Installing and using Mautic

Supported Versions

Branch RC Release Initial Release Active Support Until Security Support Until*
2.15 27 Sep 2019 8 Oct 2019 8 Oct 2019 8 Oct 2019
2.16 30 Jan 2020 13 Feb 2020 15 June 2020 15 December 2020
3.x 27 Jan 2020 15 June 2020 15 June 2021 15 December 2021
3.1 17 Aug 2020 24 Aug 2020 23 Nov 2020 30 Nov 2020
3.2 23 Nov 2020 30 Nov 2020 16 Feb 2021 22 Feb 2021
3.3 16 Feb 2021 22 Feb 2021 17 May 2021 24 May 2021
4.x 17 May 2021 24 May 2021 24 May 2022 20 Dec 2022

*Security support for 2.16 will only be provided for Mautic itself, not for core dependencies that are EOL, such as Symfony 2.8.

Software Downloads

The GitHub version is recommended for both development and testing. The production package (including all libraries) is available at mautic.org/download.

Installation

Disclaimer

Install from source only if you are comfortable using the command line. You'll be required to use various CLI commands to get Mautic working and keep it working. If the source/database schema gets out of sync with Mautic releases, the release updater may not work and will require manual updates. For production, we recommend the pre-packaged Mautic which is available at mautic.org/download.

Also note that source code outside of a tagged release should be considered ‘alpha’. It 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.

How to install Mautic

You must already have Composer available on your computer because this is a development release and you'll need Composer to download the vendor packages.

Also note that if you have DDEV installed, you can run 'ddev config' followed by 'ddev start'. This will kick off the Mautic first-run process which will automatically install dependencies and configure Mautic for use. ✨ 🚀 Read more here

Installing Mautic is a simple three-step process:

  1. Download the repository zip then extract the zip to your web root.
  2. Run the composer install command to install the required packages.
  3. Open your browser and complete the installation through the web installer.

If you get stuck, check our our general troubleshooting page. Still no joy? Join our lively Mautic Community for support and answers.

User Documentation

Documentation on how to use Mautic is available at docs.mautic.org.

Developer Docs

Developer documentation, including API reference docs, is available at developer.mautic.org.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Dennis Ameling

💻 📓

Mohammad Abu Musa

💻 📓 👀

John Linhart

📓 👀 💻 ⚠️

Norman Pracht - Webmecanik

📓 💻

Zdeno Kuzmany

📓 👀 💻 ⚠️

Steve Robinson

📓 🐛

Petr Šnobl

💻 🐛

Lukas Günther

💻 📖 📓

Ruth Cheesley

📓 👀 📖

Anton Vlasenko

💻 ⚠️

Miroslav Fedeleš

💻 ⚠️ 📓 👀

gabepri

🐛 💻

incentfit

📓

Lukáš Drahý

💻 👀

Alan Hartless (he/him)

💻

Mohit Aghera

💻 📓 👀

Dom Parry

📓

sensalot

📓

Rahul Shinde

👀 📓 💻

jos0405

💻 📓

Nick Veenhof

👀

Patryk Gruszka

💻 📖 ⚠️ 👀 📓

Alex Hammerschmied

💻

Dirk Spannaus

🐛 📓

Rehan Nischal

🐛

Christophe9880

📓

Saurabh Gupta

💻 👀

Tejas Navghane

⚠️ 💻 📓 👀

Florent Petitjean - Webmecanik

📓

Oluwatobi Owolabi

📋

Favour Kelvin

📖 📢

Giovanni Mascellani

💻

Raphael van der Woude

📓

mannp

🐛 📓

MarketSmart

💻

Leon

📓

bryanitamazonva

🐛

n-azimy

💻

Ikko Ashimine

💻

Max Lawton

💻 📖

Rohit Pavaskar

💻

Disha P

💻

Adrian

👀 📓 💻

vijayhrdm

🐛

julienWebmecanik

💻

Johan Buchert

📓

TS16V

🐛

rafalsk

🐛

Jonathan Dahan

🐛

j26w

📓

Theodoros Ploumis

💻

Sreenivasulu Avula

📓 👀

Mohammad Lahlouh

📓

ArnaudSau

💻

Andrew Bell

📓

Alfredo Arena

💻

mollux

💻

ekkeguembel

📓

Madlen

📓

Kathrin Schmid

🌍

Rahul Dhande

💻

Artem Lopata

📓 👀

Anthony Bailey

💻

Eloi Marques da Silva

💻

Tomasz Kowalczyk

💻

jensolsson

📓

Tony Bogdanov

💻

Brady Cargle

📓

mmarton

📓

bodrak

💻

nick-vanpraet

💻

Volha Pivavarchyk

📓

Nish Joseph

💻

Damzoneuh

💻

alinmbb

💻

Déborah Salves

📓

automatyzuj

📓

Benjamin Lévêque

💻

Benjamin

💻

Iris Amrein

📓

peter.osvath

💻

poweriguana

📓 📆

This project follows the all-contributors specification. Contributions of any kind welcome!