Problem Statement

We frequently see people having problems with installing and/or updating Mautic because there are issues with their server resourcing or configuration.

In the Mautic 3 upgrade script we have a pretty comprehensive set of checks that are run to determine whether the environment is suitable, however we do not yet have all of these introduced into the regular install and upgrade process.

We also do not have particularly comprehensive or user friendly documentation for people who are using Mautic for the first time or needing to do common tasks like configuring DNS entries, email providers, installing Mautic in different environments.

Resources

https://github.com/mautic/mautic/issues/8452

Scope

Must have:

• Add the checks from the Mautic 3 upgrade scripts to the install and upgrade process, at command line and in the user interface https://github.com/mautic/mautic/issues/9607 WIP PR: https://github.com/mautic/mautic/pull/10459

• Add documentation of how to install Mautic on

  • Amazon https://mautic.atlassian.net/browse/TEDU-47 https://docs.google.com/document/d/1RBmvDNoa5NhZmEj7Pv8bkKILKxPtqw7V_ZaUzU2vF3c/edit?usp=sharing

  • Digital Ocean https://docs.google.com/document/d/1152WYN2wfJQoF2j3ZFPnSu9Kn6N0Wm6kB8S40slHSyQ/edit?usp=sharing - needs to be proof read/peer review and more detail given on specific versions to be installed maybe?

  • Linode

  • Google Cloud

• Add documentation on how to set up and configure Mautic to use

  • Amazon SES

  • Elastic Email

  • Mandrill

  • Mailjet

  • Sparkpost

  • Sendgrid

Nice to have:

• Documentation on how to install and manage Mautic using containers

  • Docker - WIP by luizeof here (https://mautic.atlassian.net/browse/TEDU-42 https://docs.google.com/document/d/1yyf99xZiyyzNOb5beOdo649qyHKvVefxU9Xy4Y8h-OE/edit?usp=sharing )

  • Kubernetes

• Documentation on how to resolve/address common problems that are encountered - eg updating PHP, file ownership/permissions, resource limitations

• A simple walk through that ships with Mautic for new installations taking them through what needs to be configured, steps needed to start your first campaign (eg using something like https://github.com/topics/product-tour these libraries)

• Related documentation/KB resources

  • Best practices / general tips: https://mautic.atlassian.net/browse/TEDU-39

  • https://docs.google.com/document/d/1fQwGJFkGNxSGH65by7wUTGFz4N3BLyUZ-hdj_kyeOBE/edit?usp=sharing

  • https://docs.google.com/document/d/1gcobcdOy8ojmQWLd7uVo_pY-l0hOr_cR9QOUByUaOYs/edit?usp=sharing

  • https://docs.google.com/document/d/1Dt8afAEbo-WNAmw4mjkqJ1-s1t8xs9RN2c_gkaStLWQ/edit?usp=sharing

Not in scope:

Add anything you don't want to include

Timeline

Plan to deploy initial set of improvements in 4.0 (May) - docs can be contributed at any time but ideally should coincide with the 4.0 release at latest.

Milestones and deadlines

Plot out milestones and deadlines using the table below. Put each milestone on its own row, @mention milestone owners, and type /date to quickly add deadlines.