Skip to content

Latest commit

 

History

History
259 lines (231 loc) · 51.6 KB

README.md

File metadata and controls

259 lines (231 loc) · 51.6 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 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

Please check the latest supported versions on the Mautic Releases page.

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
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
Christophe9880

📓
Saurabh Gupta
Saurabh Gupta

💻 👀
Tejas Navghane
Tejas Navghane

⚠️ 💻 📓 👀
Florent Petitjean - Webmecanik
Florent Petitjean - Webmecanik

📓
Oluwatobi Owolabi
Oluwatobi Owolabi

📋
Favour Kelvin
Favour Kelvin

📖 📢
Giovanni Mascellani
Giovanni Mascellani

💻
Raphael van der Woude
Raphael van der Woude

📓
mannp
mannp

🐛 📓
MarketSmart
MarketSmart

💻
Leon
Leon

📓
bryanitamazonva
bryanitamazonva

🐛
n-azimy
n-azimy

💻
Ikko Ashimine
Ikko Ashimine

💻
Max Lawton
Max Lawton

💻 📖
Rohit Pavaskar
Rohit Pavaskar

💻
Disha P
Disha P

💻
Adrian
Adrian

👀 📓 💻
vijayhrdm
vijayhrdm

🐛
julienWebmecanik
julienWebmecanik

💻
Johan Buchert
Johan Buchert

📓
TS16V
TS16V

🐛
rafalsk
rafalsk

🐛
Jonathan Dahan
Jonathan Dahan

🐛
j26w
j26w

📓
Theodoros Ploumis
Theodoros Ploumis

💻
Sreenivasulu Avula
Sreenivasulu Avula

📓 👀
Mohammad Lahlouh
Mohammad Lahlouh

📓
ArnaudSau
ArnaudSau

💻
Andrew Bell
Andrew Bell

📓
Alfredo Arena
Alfredo Arena

💻
mollux
mollux

💻
ekkeguembel
ekkeguembel

📓
Madlen
Madlen

📓
Kathrin Schmid
Kathrin Schmid

🌍
Rahul Dhande
Rahul Dhande

💻
Artem Lopata
Artem Lopata

📓 👀 💻
Anthony Bailey
Anthony Bailey

💻
Eloi Marques da Silva
Eloi Marques da Silva

💻
Tomasz Kowalczyk
Tomasz Kowalczyk

💻
jensolsson
jensolsson

📓
Tony Bogdanov
Tony Bogdanov

💻
Brady Cargle
Brady Cargle

📓
mmarton
mmarton

📓
bodrak
bodrak

💻
nick-vanpraet
nick-vanpraet

💻
Volha Pivavarchyk
Volha Pivavarchyk

📓 💻
Nish Joseph
Nish Joseph

💻
Damzoneuh
Damzoneuh

💻
alinmbb
alinmbb

💻
Déborah Salves
Déborah Salves

📓
automatyzuj
automatyzuj

📓
KN4CK3R
KN4CK3R

💻
Benjamin Lévêque
Benjamin Lévêque

💻
Benjamin
Benjamin

💻
Iris Amrein
Iris Amrein

📓
peter.osvath
peter.osvath

💻
poweriguana
poweriguana

📓 📆
OnyXxL
OnyXxL

📓
Dominik Lacković
Dominik Lacković

📓
Omer Toledano
Omer Toledano

📓
ZebruhDivs
ZebruhDivs

📓
Alan Wierzchoń
Alan Wierzchoń

💻
Tomazz Jurich
Tomazz Jurich

📓
putzwasser
putzwasser

🐛
erk
erk

📓
Daniel
Daniel

📓
agencia904
agencia904

📓
mbfds
mbfds

📓
Lucas Lazarini
Lucas Lazarini

📓
Gonzalo Cao Cabeza de Vaca
Gonzalo Cao Cabeza de Vaca

📓
Robmobius
Robmobius

📓
Marc Beinder
Marc Beinder

💻
bergwerkweb
bergwerkweb

💻
Rembrand
Rembrand

📓 💻 👀
TechBill
TechBill

📓
Irfan Hanfi
Irfan Hanfi

💻
Anna Munk
Anna Munk

💻
Sven Döring
Sven Döring

📓
Pedro de Jesus
Pedro de Jesus

💻
Jean-Marc
Jean-Marc

📓
Paul Sanduleac
Paul Sanduleac

💻
Lenon Leite
Lenon Leite

💻
Alan Syrgak
Alan Syrgak

📓
Mohammed Header
Mohammed Header

💻
Dana Linhartová
Dana Linhartová

💻
Thanks
Thanks

⚠️
Patrick
Patrick

📓
Tomas Votruba
Tomas Votruba

💻
Tirtharaj Ghosh
Tirtharaj Ghosh

📖
Ruben Nogueira
Ruben Nogueira

💻
Oleh Vanin
Oleh Vanin

👀
Tim Mallezie
Tim Mallezie

💻
Markus Staab
Markus Staab

💻
code5rick
code5rick

🐛
jcrandell7
jcrandell7

📓
Jason Woods
Jason Woods

💻
Enkhjargal Lkhagvaa
Enkhjargal Lkhagvaa

👀
alexbusu-motork
alexbusu-motork

👀
David Gorges
David Gorges

🐛 💻
Gernot Pansy
Gernot Pansy

🐛 💻

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