Installation Guide

Server Requirements

Before installing Mongo My Admin, ensure your server meets the following minimum requirements:

Quick Start

Get up and running in minutes with these steps:

# Create directory
mkdir mongo-my-admin
cd mongo-my-admin

# Extract files
unzip mongo-my-admin.zip -d .

npm install

# Copy example file
cp .env.example .env

# Edit the file with your settings
nano .env

npm run build

npm start

Database Seeding

After configuring your .env file, you must seed the database with initial data before using the platform. Seeding creates the admin user, default packages, demo company, payment gateways, email templates, and platform settings.

Run the Seed Script

# Run the primary seed script
node server/scripts/seed.js

What Gets Seeded

The seed script creates the following data:

Alternative: Minimal Seeder

For a minimal setup without demo data (only creates admin, packages, and settings):

# Run minimal seeder (non-destructive, won't overwrite existing data)
node server/seeders/adminSeeder.js

Prefix Migration Script

If you need to update existing company prefixes to the 12-digit format:

# Update company prefixes (safe, non-destructive)
node server/scripts/migrate-prefixes.js

Default Login Credentials

After seeding, use these credentials to log into the platform:

SaaS Super Admin

Company Admin (Demo Company)

Complete Setup Flow

Here is the recommended order after installation:

cPanel Installation

Deploy Mongo My Admin on shared hosting using cPanel with Node.js support (requires cPanel with Phusion Passenger).

Prerequisites

• cPanel hosting with Node.js selector (CloudLinux)
• SSH access to your hosting account
• External MongoDB server (cPanel usually doesn't include MongoDB)

NODE_ENV = production
PORT = (leave empty, Passenger handles this)
MONGODB_URI = mongodb+srv://user:pass@cluster.mongodb.net/db
JWT_SECRET = your-secret-key
...

# SSH into server
ssh username@yourserver.com

# Navigate to app directory
cd /home/username/mongo-my-admin

# Build the application
npm run build

VPS Installation

Deploy on a VPS (DigitalOcean, AWS, Linode, etc.) for full control and performance.

Initial Server Setup

# Update system packages
sudo apt update && sudo apt upgrade -y

# Install Node.js 20.x
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

# Verify installation
node --version
npm --version

# Install PM2 globally (process manager)
sudo npm install -g pm2

Application Setup

# Create app directory
sudo mkdir -p /var/www/mongo-my-admin
cd /var/www/mongo-my-admin

# Extract or clone your files here
# Then set proper permissions
sudo chown -R $USER:$USER /var/www/mongo-my-admin

# Install dependencies
npm install

# Configure environment
cp .env.example .env
nano .env

# Build application
npm run build

Run with PM2

# Start with PM2
pm2 start npm --name "mongo-my-admin" -- start

# Save PM2 configuration
pm2 save

# Setup PM2 to start on boot
pm2 startup

# View logs
pm2 logs mongo-my-admin

# Monitor
pm2 monit

Nginx Reverse Proxy (Recommended)

Configure Nginx as a reverse proxy for better performance and SSL:

# Install Nginx
sudo apt install nginx -y

# Create site configuration
sudo nano /etc/nginx/sites-available/mongo-my-admin

Add the following configuration:

server {
    listen 80;
    server_name yourdomain.com www.yourdomain.com;

    location / {
        proxy_pass http://127.0.0.1:6008;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_cache_bypass $http_upgrade;
    }

    # Handle WebSocket connections
    location /socket.io/ {
        proxy_pass http://127.0.0.1:6008;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

# Enable site
sudo ln -s /etc/nginx/sites-available/mongo-my-admin /etc/nginx/sites-enabled/

# Test configuration
sudo nginx -t

# Restart Nginx
sudo systemctl restart nginx

Docker Installation

Deploy using Docker for easy containerization and portability.

Dockerfile

Create a Dockerfile in your project root:

FROM node:20-alpine

WORKDIR /app

# Copy package files
COPY package*.json ./

# Install dependencies
RUN npm ci --only=production

# Copy application files
COPY . .

# Build Next.js
RUN npm run build

# Expose port
EXPOSE 6008

# Start server
CMD ["npm", "start"]

Docker Compose

Create a docker-compose.yml file:

version: '3.8'

services:
  app:
    build: .
    ports:
      - "6008:6008"
    environment:
      - NODE_ENV=production
      - PORT=6008
      - MONGODB_URI=mongodb://mongo:27017/mongo_saas
      - JWT_SECRET=your-secret-key
    depends_on:
      - mongo
    restart: unless-stopped

  mongo:
    image: mongo:7
    volumes:
      - mongo_data:/data/db
    restart: unless-stopped

volumes:
  mongo_data:

Build and Run

# Build and start containers
docker-compose up -d --build

# View logs
docker-compose logs -f app

# Stop containers
docker-compose down

SSL Certificate Setup

Secure your installation with HTTPS using Let's Encrypt (free SSL).

Using Certbot (Nginx)

# Install Certbot
sudo apt install certbot python3-certbot-nginx -y

# Obtain certificate
sudo certbot --nginx -d yourdomain.com -d www.yourdomain.com

# Auto-renewal is set up automatically
# Test renewal
sudo certbot renew --dry-run

Update Environment

After SSL is set up, update your .env file:

COMPANY_ADMIN_URL=https://yourdomain.com
SAAS_ADMIN_URL=https://yourdomain.com/saas
API_BASE_URL=https://yourdomain.com

Updating to a New Version

When a new version of Mongo My Admin is released, follow these steps to update safely.

Step-by-Step Update

# Backup your database
mongodump --uri="your_mongodb_uri" --out=./backup/$(date +%Y%m%d)

# Backup your .env file
cp .env .env.backup

# Backup uploads folder (logos, images)
cp -r uploads uploads.backup

# If using PM2
pm2 stop mongo-my-admin

# If using systemd
sudo systemctl stop mongo-my-admin

# Extract new version to a temporary folder
mkdir temp-update
unzip mongo-my-admin-v2.0.zip -d temp-update

# Copy new files (excluding .env and uploads)
rsync -av --exclude='.env' --exclude='uploads/' --exclude='node_modules/' temp-update/ /var/www/mongo-my-admin/

# Clean up
rm -rf temp-update

# Compare env files
diff .env .env.example

npm install

npm run build

# Example: prefix migration (if upgrading from older version)
node server/scripts/migrate-prefixes.js

# If using PM2
pm2 restart mongo-my-admin

# If using systemd
sudo systemctl start mongo-my-admin

# Verify it's running
pm2 logs mongo-my-admin --lines 20

Rollback If Needed

If the update causes issues, restore from your backup:

# Stop the application
pm2 stop mongo-my-admin

# Restore database from backup
mongorestore --uri="your_mongodb_uri" --drop ./backup/20240115

# Restore .env file
cp .env.backup .env

# Restore uploads
cp -r uploads.backup/* uploads/

# Reinstall and rebuild
npm install
npm run build

# Restart
pm2 restart mongo-my-admin

Troubleshooting

Common Issues

Verify Installation

# Check if server is running
curl http://localhost:6008/api/v1/health

# Check PM2 status
pm2 status

# View real-time logs
pm2 logs mongo-my-admin --lines 100