mautic README

The project's README from github.com/mautic/mautic. As one markdown file: README.md.

Mautic Open Source Marketing Automation

Mautic

Open Source Marketing Automation Software.
🌐 mautic.org

DPG Badge

Request a trial · Self-host/download · Community channels

Codecov Best Practices All Contributors

⭐ Like what we're doing? Give us a star ⬆️

🗒️ About Mautic

Mautic is the world’s largest open source marketing automation project. We empower businesses and organizations to deliver fully integrated marketing campaigns by providing powerful, world-class open source marketing automation software supported by a thriving, worldwide community of passionate contributors.

Our vision is to be the most privacy-focused, accessible and extendable marketing automation product on the market, giving everyone the power to understand, manage and grow their business or organization while respecting and safeguarding the privacy of their end users.

In short: Mautic is the most privacy-focused, accessible and extendable marketing automation product on the market.

✨ Benefits over regular marketing automation tools

Stay up to date about initiatives, releases and strategy via our [blog][mautic-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 Open Source Marketing Automation

Get Involved Quickly

Calling all potential contributors to open source! Get started quickly and show us what you’re made of.

If you have questions, check how to contribute.

Using Mautic

☁️ Deploy instantly with our Trials

[Request a trial][mautic-trials] filling up a form to deploy in minutes and test Mautic now.

🚀 Self-host completely free, forever

Please check the latest supported versions on the [Mautic Releases][mautic-releases] page.

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

Check out the [requirements for installation][requirements] and [supported versions][supported-versions].

Installation

[!WARNING] Install from GitHub only if you are comfortable using the command line and are working locally. 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 installing with Composer, or using the pre-packaged Mautic which is available at [mautic.org/download][download-mautic]. Also note that source code outside of a [tagged release][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][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 start' as a DDEV project’s configuration is present in the repo. This will kick off the Mautic first-run process which will automatically install dependencies and configure Mautic for use. ✨ 🚀 Read more [here][ddev-mautic]

We recommend installing via Composer following the documentation at the [command line][install-mautic-composer].

If you must install from the zip file, it's a three-step process:

  1. [Download the repository zip][download-zip] then extract the zip to your web root, or pull it in through Composer at the .
  2. Run the composer install command to install the required packages.
  3. Open your browser and complete the installation through the web installer.

You must already have [Composer][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][ddev-mautic]

🚨 Need help?

There are lots of good conversations and resources in our Forums. If you're struggling with something, chances are, someone's already solved what you're up against. :point_down:

🙋 Contribution

Alt

Thank you for your desire to develop Mautic together!

❤️ This project and everyone involved in it is governed by the Code of Conduct.

🧑‍💻 Check out our [contributing guide][contributing-md] and [Contributing Code][contribute-developer] to learn about asking questions, creating issues, or submitting pull requests.

🫢 For security findings, please fill this form and refer to our security guide for more information.

🤝 Follow us on Github, [Twitter][twitter], [Facebook][facebook] and our [Slack][slack] channel.

Thanks goes to these wonderful people (emoji key):

Dennis Ameling
Dennis Ameling

💻 📓
Mohammad Abu Musa
Mohammad Abu Musa

💻 📓 👀
John Linhart
John Linhart

📓 👀 💻 ⚠️
Norman Pracht - Webmecanik
Norman Pracht - Webmecanik

📓 💻
Zdeno Kuzmany
Zdeno Kuzmany

📓 👀 💻 ⚠️
Steve Robinson
Steve Robinson

📓 🐛
Petr Šnobl
Petr Šnobl

💻 🐛
Lukas Günther
Lukas Günther

💻 📖 📓
Ruth Cheesley
Ruth Cheesley

📓 👀 📖
Anton Vlasenko
Anton Vlasenko

💻 ⚠️
Miroslav Fedeleš
Miroslav Fedeleš

💻 ⚠️ 📓 👀
gabepri
gabepri

🐛 💻
incentfit
incentfit

📓
Lukáš Drahý
Lukáš Drahý

💻 👀
Alan Hartless (he/him)
Alan Hartless (he/him)

💻
Mohit Aghera
Mohit Aghera

💻 📓 👀
Dom Parry
Dom Parry

📓
sensalot
sensalot

📓
Rahul Shinde
Rahul Shinde

👀 📓 💻
jos0405
jos0405

💻 📓
Nick Veenhof
Nick Veenhof

👀
Patryk Gruszka
Patryk Gruszka

💻 📖 ⚠️ 👀 📓
Alex Hammerschmied
Alex Hammerschmied

💻 📓
Dirk Spannaus
Dirk Spannaus

🐛 📓
Rehan Nischal
Rehan Nischal

🐛
Christophe9880

mautic (mautic/mautic)

Searching Database…

10.8K ·GitHub
What is this?Mautic is the world's largest open source marketing automation platform — a PHP web app businesses self-host to run integrated, multi-channel marketing campaigns.
Is Mautic a hosted service I sign up for, or software I run on my own server?Either: you can request a hosted trial that deploys in minutes, or self-host it completely free forever on your own server with your own database.
How do I get it up and running?The recommended path is installing via Composer following the command-line docs. From a zip it's three steps: extract to your web root, run composer install, then finish in the browser installer. If you use DDEV, 'ddev start' kicks off the first-run setup automatically.
What do I need to have in place before installing?Composer must already be on your machine, since it pulls all the vendor packages; check the requirements and supported-versions pages for the server stack. With DDEV installed, dependencies are fetched automatically.
Can I just deploy the GitHub source straight to production?No — the GitHub version is recommended only for development and testing. Code outside tagged releases counts as alpha and may contain bugs or even cause data corruption or loss; for production use Composer or the pre-packaged download from mautic.org.
Where do my contacts and campaign data end up?In your own database — Mautic runs on infrastructure you control, and building the most privacy-focused marketing automation product on the market is an explicit project goal.
What are the perks of Mautic over a regular SaaS marketing tool?It's open source and free to use with no strings attached, runs on your own stack so you own the data, has no vendor lock-in, and gives you multi-channel campaigns plus unlimited segmentation and automation without feature limitations or extra costs.
Can I customize it or build my own integrations?Yes — both the frontend and backend are 100% customizable, and creating any integration you need is listed among the project's core benefits.
Is it safe to build on — how active is the project?It's billed as the world's largest open source marketing automation project, backed by a worldwide contributor community, over 10k GitHub stars, and active Hacktoberfest participation.
Creator
mautic
Size
312.7 MB
Stars
10.8K
Age
13y
Commits · 90 Days