Improve the Installation and Upgrade Process

Objective	To improve the user experience when installing and upgrading Mautic
Due date	May 16, 2021
Key outcomes	Users are prevented from installing or upgrading Mautic in the user interface or command line if their hosting environment could cause problems Improvements to the documentation for installing and updating Mautic in the Documentation and Knowledgebase and in-app
Status	IN PROGRESS

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

Make installation/upgrade scripts more robust for different environments · Issue #8452 · mautic/mautic

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 Add checks from Mautic 3.x upgrade script into the install and upgrade process · Issue #9607 · mautic/mautic WIP PR: Add additional checks to installation + update process by dennisameling · Pull Request #10459 · mautic/mautic
Add documentation of how to install Mautic on
- Amazon TEDU-47: KB Article: Installing Mautic on AWSTo Do KB Article - Installing Mautic on AWS
- Digital Ocean KB Article: Installing Mautic on Digital Ocean - 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 (TEDU-42: KB Article: Installing Mautic with DockerDone How to install Mautic with Docker on Digital Ocean )
- 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

Not in scope:

Initiative Coordinator/s	Contributors	Stakeholder/s

Initiative Coordinator/s	Contributors	Stakeholder/s
Position vacant		Product Team (@Ruth Cheesley @Dennis Ameling @Norman Pracht (Unlicensed)) Education Team (@Ruth Cheesley @Favour Kelvin @Leon-Elias Oltmanns )

Get involved

Join the Slack channel #i-install-upgrade (get an invite at https://mautic.org/slack)
Meetings are held asynchronously on Slack <insert cadence> on <insert day>

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

Milestone	Owner	Deadline	Status

Milestone	Deadline	Status
Submit PR adding checks at install and upgrade for review by Core Team	Mar 29, 2021	NOT STARTED
Submit articles on installing Mautic in different environments for review by the Education Team Amazon Digital Ocean (note: update their article too!) Linode Google Cloud	May 23, 2021	NOT STARTED
Submit articles on configuring email providers for review by the Education Team Amazon SES Elastic Email Mandrill Mailjet Sparkpost Sendgrid	May 23, 2021	NOT STARTED