aperimau/mautic repository overview

Table of Contents

1. About The Project⁠
   • Built With⁠
2. Getting Started⁠
   • Prerequisites⁠
   • Installation⁠
3. Usage⁠
4. Roadmap⁠
5. Contributing⁠
6. License⁠
7. Contact⁠
8. Acknowledgments⁠

⁠About The Project

We could never get the official mautic docker containers to work. They'd always fail if they ever worked in the first place - so we made a container that works, and can even keep your mautic version up-to-date.

This is the best docker container to use for mautic, don't waste your time trying to get others working.

Here's why:

• This container works
• It doesn't waste your time
• It works

Of course, there's no guarantee it will actually work for you. It does for us, so that's great - so it should work for you. No promises though.

Use the docker-compose.yaml to get started.

(back to top⁠)

⁠Built With

We aren't responsible for mautic - it's a great tool, and we love it. We are only responsible for getting it into a working container.

(back to top⁠)

⁠Getting Started

Use the example compose file to see how you can use mautic in a container.

⁠Prerequisites

You need docker, a database server and other things needed for successful operation of a business, we can't go into that here.

⁠Installation

There's not really anything to install per-se.

1. Get Docker https://docker.com⁠
2. Create a docker compose file

   vi docker-compose.yaml
   

   Copy
3. Configure it as needed
4. Run it

   docker-compose up -d
   

   Copy

(back to top⁠)

⁠Usage

There's only really one use for this container - running mautic.

For more examples, please refer to the Documentation⁠

(back to top⁠)

⁠Roadmap

• Add Readme
• Add example compose
• Make the readme actually helpful
• Improve the starup script
• Better examples
  • Full with mysql
  • Not so fancy

See the open issues⁠ for a full list of proposed features (and known issues).

(back to top⁠)

⁠Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top⁠)

⁠License

This is distributed under the Apache License. See LICENSE for more information.

(back to top⁠)

⁠Contact

Your Name - @aperimstudio⁠ - [email protected]⁠

Project Link: https://github.com/mautic⁠

(back to top⁠)

⁠Acknowledgments

This collection of files was created on the unceded Aboriginal land. We acknowledge the Gadigal people of the Eora Nation as the Traditional Custodians of the Country we work on. We recognise their continuing connection to the land and waters, and thank them for protecting this coastline and its ecosystems since time immemorial.

We'd like to thank the Internet, for existing. The mautic team and contributers for ... mautic. And you, for (hopefully) making the world a better place.

(back to top⁠)