Skip to main content

CMP Server Installation

This page covers the server-side installation of CMP. Complete Prerequisites & System Requirements before proceeding.

Installation Overview​

flowchart TD
    A("â‘  Prepare server\nOS, dependencies") --> B("â‘¡ Database setup\nMySQL / MariaDB")
    B --> C("â‘¢ Configure environment\n.env file")
    C --> D("â‘£ Install dependencies\ncomposer install, migrate")
    D --> E("⑤ Queue workers & scheduler\nSupervisor + crontab")
    E --> F("â‘¥ Web server config\nNginx / Apache + SSL")
    F --> G("⑦ Verify & go live\nSetup wizard → super admin")

    style A fill:#4A90D9,color:#fff,stroke:#2c6fad
    style B fill:#4A90D9,color:#fff,stroke:#2c6fad
    style C fill:#4A90D9,color:#fff,stroke:#2c6fad
    style D fill:#4A90D9,color:#fff,stroke:#2c6fad
    style E fill:#4A90D9,color:#fff,stroke:#2c6fad
    style F fill:#4A90D9,color:#fff,stroke:#2c6fad
    style G fill:#27ae60,color:#fff,stroke:#1e8449

Step 1 — Prepare the Server​

sudo apt update && sudo apt upgrade -y
sudo apt install -y nginx mysql-server redis-server php8.1-fpm \
  php8.1-mysql php8.1-redis php8.1-mbstring php8.1-xml \
  php8.1-curl php8.1-zip php8.1-bcmath composer nodejs npm

Step 2 — Database Setup​

CREATE DATABASE cmp_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'cmp_user'@'localhost' IDENTIFIED BY 'strong_password';
GRANT ALL PRIVILEGES ON cmp_db.* TO 'cmp_user'@'localhost';
FLUSH PRIVILEGES;

Step 3 — Environment Configuration​

Copy the example environment file and fill in your values:

cp .env.example .env

Key variables to configure:

VariableDescription
APP_URLFull URL of your CMP frontend (e.g. https://portal.yourcompany.com)
API_URLFull URL of the API (same as APP_URL for single-domain, else separate)
DB_HOST, DB_DATABASE, DB_USERNAME, DB_PASSWORDDatabase credentials
REDIS_HOSTRedis server host
MAIL_*SMTP / mail configuration for notifications
QUEUE_CONNECTIONSet to redis for production

See Environment Variables Reference for the full list.

Step 4 — Install Dependencies & Migrate​

composer install --no-dev --optimize-autoloader
php artisan key:generate
php artisan migrate --force
php artisan db:seed --class=InitialDataSeeder
php artisan storage:link

Step 5 — Queue Workers & Scheduler​

Add to crontab (crontab -e):

* * * * * cd /var/www/cmp && php artisan schedule:run >> /dev/null 2>&1

Set up Supervisor for queue workers (/etc/supervisor/conf.d/cmp-worker.conf):

[program:cmp-worker]
command=php /var/www/cmp/artisan queue:work redis --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
numprocs=2

Then reload Supervisor:

sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start cmp-worker:*

Step 6 — Nginx Configuration​

server {
    listen 80;
    server_name portal.yourcompany.com;
    root /var/www/cmp/public;
    index index.php;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        include fastcgi_params;
    }
}
info

After configuring Nginx, enable HTTPS — see SSL / TLS Setup.

Step 7 — Verify Installation​

  • Visit https://portal.yourcompany.com — the setup wizard or login page should appear
  • Proceed to Initial Super Admin Setup