Quick Install

This guide is for users who already have a web hosting environment configured, such as:

• cPanel, Plesk, or DirectAdmin
• Pre-configured LAMP/LEMP stack
• Managed hosting with PHP and MySQL

Prerequisites

Before starting, ensure you have:

• Web hosting with PHP 8.3+ and MySQL 8.0+
• FTP access or File Manager
• phpMyAdmin or database management tool
• Valid license key from your Mumara purchase
• Domain/subdomain pointing to your hosting

Check Requirements

Review the System Requirements page to verify your hosting meets all specifications.

Step 1: Download Mumara Campaigns

1. Log into your Mumara Client Area
2. Navigate to Services → Mumara License
3. Download the latest release ZIP file

Step 2: Upload Files

Using File Manager (cPanel/Plesk)

1. Log into your hosting control panel
2. Open File Manager
3. Navigate to your domain's web root (usually public_html or www)
4. Click Upload and select the ZIP file
5. Wait for upload to complete

Using FTP

1. Connect to your server using an FTP client (FileZilla, WinSCP, etc.)
2. Navigate to your web root directory
3. Upload the ZIP file

Step 3: Extract Files

In File Manager

1. Right-click the uploaded ZIP file
2. Select Extract or Unzip
3. Ensure files extract to the web root (not a subdirectory)

Via SSH (if available)

cd /path/to/public_html
unzip mumara-campaigns.zip

Your directory structure should look like:

public_html/
├── app/
├── bootstrap/
├── config/
├── public/
├── storage/
├── .env.example
└── ...

Document Root

If your hosting requires the document root to be public_html, you have several options:

1. Move public files: Copy contents of the public folder to public_html and update paths accordingly
2. Subdomain: Configure a subdomain to point directly to the public directory
3. Use .htaccess: Add an .htaccess file in your web root to redirect all requests to the public folder:

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteRule ^(.*)$ public/$1 [L]
</IfModule>

Step 4: Set File Permissions

Set the following permissions (chmod 777):

Path	Permission	Type
.env	777	File
/geoip	777	Folder
/bootstrap	777 (recursive)	Folder
/storage	777 (recursive)	Folder
/temp	777 (recursive)	Folder

Using File Manager

1. Right-click each folder/file
2. Select Change Permissions or chmod
3. Set to 777 (read, write, execute for all)
4. For folders, check Recurse into subdirectories

Using SSH

chmod 777 .env
chmod -R 777 geoip bootstrap storage temp

Step 5: Create Database

Using phpMyAdmin

1. Log into phpMyAdmin from your control panel
2. Click Databases tab
3. Enter database name (e.g., mumara_campaigns)
4. Select utf8mb4_unicode_ci collation
5. Click Create

Create Database User

In cPanel:

1. Go to MySQL Databases
2. Under MySQL Users, create a new user
3. Under Add User to Database, grant ALL PRIVILEGES

Note down:

• Database name
• Database username
• Database password
• Database host (usually localhost)

Step 6: Run Web Installer

Open your browser and navigate to:

https://your-domain.com/install

Web Installer Steps

Step 1: System Requirements Check

The installer verifies your server configuration:

PHP Version

• Required: PHP >= 8.3
• Displays your current version

Required PHP Extensions

Extension	Purpose
openSSL	Encryption and security
PDO	Database abstraction
MySQLi	MySQL connectivity
mbstring	Multibyte string handling
Tokenizer	PHP parsing
XML	XML processing
cURL	HTTP requests
Ioncube	License protection
Zip	Archive handling
Iconv	Character encoding
fileinfo	File type detection
putenv	Environment variables
proc_open	Process control

Optional Extensions

Extension	Purpose
IMAP	Bounce email processing
FTP	FTP functionality
shell_exec	Shell command execution
mod_rewrite	URL rewriting (Apache)
allow_url_fopen	Remote file access
allow_url_include	Remote includes

Folder Permissions

All must show as writable (777):

• .env file
• /geoip folder
• /bootstrap folder (recursive)
• /storage folder (recursive)
• /temp folder (recursive)

Failed Checks

If any check fails, fix the issue and click Re-check before proceeding.

Step 2: License Verification

Enter your license key from your Mumara purchase.

The system validates against the Mumara license server and shows one of:

Status	Meaning	Action
Active	Valid license	Proceed to next step
Invalid	Key not recognized	Verify key is correct
Expired	License has expired	Renew at billing.mumara.com
Suspended	License suspended	Contact Mumara support

Step 3: Database Configuration

Enter your database details:

Field	Description	Example
Database Host	Server hosting MySQL	localhost
Database Port	MySQL port	3306 (default)
Database Name	Name from Step 5	mumara_campaigns
Database Username	User from Step 5	mumara_user
Database Password	Password from Step 5	your_password

Click Test Connection to verify credentials before proceeding.

Connection Issues

If connection fails:

• Verify credentials are correct
• Check MySQL is running
• Ensure user has privileges on the database
• Try 127.0.0.1 instead of localhost

Step 4: Application Setup

Configure your application:

Basic Settings

Field	Description
Application URL	Full URL with https://
Application Title	Name shown in browser tab and emails
Admin Email	Your administrator email address
Admin Password	Secure password (enter twice to confirm)
Timezone	Select your timezone from dropdown

Optional: FTP Details

For auto-update functionality:

• FTP Host
• FTP Username
• FTP Password
• FTP Port (default: 21)

Installation Process

When you click Install, the system:

1. Runs database migrations (creates tables)
2. Creates your admin user account
3. Saves license information
4. Configures application settings
5. Generates encryption keys

This may take a few moments depending on your server.

Post-Installation

Installation Complete

Upon successful installation, you'll see a confirmation page with:

• Admin panel URL
• Login credentials reminder

First Login

1. Navigate to your application URL
2. Log in with your admin email and password
3. Navigate to Settings → Application Settings → General
4. Configure the Queue Driver based on your setup (see below)
5. Complete the initial setup wizard

Set Up Cron Job

For scheduled tasks to work, add a cron job. In cPanel:

1. Go to Cron Jobs
2. Add a new cron job:
   • Common Settings: Once Per Minute
   • Command: php /path/to/mumara/folder/artisan schedule:run >> /dev/null 2>&1

Cron Path

Replace /path/to/mumara/folder with your actual installation path (e.g., /home/username/public_html).

Configure Queue Processing

Mumara Campaigns offers three queue driver options. Configure this in Settings → Application Settings → General.

Option	Description	Use Case
Realtime	Processes jobs immediately in the request	Very small usage only. Not recommended for production as it blocks the web request.
Cronjob	Processes jobs via scheduled cron task	Moderate usage without Supervisor access
Supervisor	Processes jobs via Supervisor workers	Recommended for production. Requires Supervisor to be configured and running.

Realtime Mode

Realtime mode is dangerous for any significant email volume as it processes everything synchronously, blocking the user interface and potentially causing timeouts.

Option 1: Cronjob Queue Processing

If you selected Cronjob as your queue driver, add another cron job running every minute:

php /path/to/mumara/folder/artisan queue:work --stop-when-empty >> /dev/null 2>&1

Option 2: Supervisor Queue Processing (Recommended)

If you have SSH access and can install Supervisor:

1. Follow the setup in Custom Install - Queue Workers
2. Set Queue Driver to Supervisor in Settings → Application Settings → General

info

When using Supervisor, the queue is processed exclusively by Supervisor workers. Make sure Supervisor is properly configured and running before selecting this option.

Next Steps

• Initial Setup - Configure sending infrastructure
• User Interface - Learn the dashboard
• Troubleshooting - Solve common issues