Installation

Work in progress

Not all information is included in the docs yet, but we are working on it!

Our ultimate goal is to have an easy-to-use web installer for MUM that generates a .env file based on your input. Unfortunately, someone has to write the necessary code. If you would like to contribute, we highly appreciate your help.

For now, you will need to perform the following manual steps to install MUM.

If you are worried about installing all of the requirements and MUM yourself, maybe have a look at our Debian Installation Guide that explains every step along the way and provides the necessary shell commands for fast copy'n'pasting.

Requirements

MUM and it's underlying framework Laravel have a few server requirements that need to be installed beforehand. Please ensure that your server meets the following requirements:

PHP >= 7.1.3
OpenSSL PHP Extension
PDO PHP Extension
Mbstring PHP Extension
Tokenizer PHP Extension
XML PHP Extension
Ctype PHP Extension
JSON PHP Extension

You will also need a working webserver like Apache2 or NGINX and a MySQL/MariaDB database.

Quick Start

Clone the repository from GitHub and open the resulting directory:
```
git clone https://github.com/mum-project/mum.git
cd mum/
```

Install the dependencies:

composer install --optimize-autoloader --no-dev

Create a .env file for your local environment (and configure it) with
```
cp .env.example .env
nano .env
```
Generate an application key with
```
php artisan key:generate
```

Create your first user with

php artisan domains:create example.com
php artisan mailboxes:create admin example.com --super_admin --name='Super Admin'