MCM Platform — Single VM Deployment GuideCopy Anchor Link

Get MCM up and running in under 30 minutes. This guide provides the essential commands, network requirements, and validation steps for deploying the platform on a Single VM.

1. Prerequisites & VM SpecificationsCopy Anchor Link

Ensure your target virtual machine meets the following minimum specifications:

2. Network & Connectivity RequirementsCopy Anchor Link

Deploying the MCM platform on a Single VM requires provisioning the underlying hosting server. The instance should be configured with the operating system and resources specified in Prerequisites & VM Specifications (Ubuntu 24.04 LTS, 8 CPU, 32 GB RAM, 150 GB Disk).

3. Firewall & Security RulesCopy Anchor Link

To secure the single-node deployment, only administrative SSH and web traffic (HTTP/HTTPS) should be allowed inbound. Since the platform utilizes Docker Swarm internally, all cluster management ports (2377, 7946, 4789) must remain blocked from external inbound access to prevent unauthorized cluster probes. The same applies to the MCM management service (port 8642) — it is used only by the platform itself on the same host and must not be exposed.

Security Rule RationaleCopy Anchor Link

1. Port 22 (TCP): Used for administrative SSH access to the host.
2. Port 80 (TCP): Used for standard HTTP traffic. Port 80 automatically redirects incoming requests to secure HTTPS (port 443) so users do not experience connection errors if they access the site via http://.
3. Port 443 (TCP): Used for the primary secure application gateway access.

# 1. Set default policies
sudo ufw default deny incoming
sudo ufw default allow outgoing

# 2. Allow SSH and Web traffic
sudo ufw allow 22/tcp comment "SSH Administrative Access"
sudo ufw allow 80/tcp comment "HTTP Gateway Redirection"
sudo ufw allow 443/tcp comment "HTTPS Ingress Gateway"

# 3. Enable the firewall
sudo ufw enable

Outbound Connection RequirementsCopy Anchor Link

The MCM platform requires outbound HTTPS (port 443) connectivity to the following main domains:

4. Installation ProcedureCopy Anchor Link

Step 1: Account Registration & Portal AccessCopy Anchor Link

Follow these steps on the MCM Nexus Portal to set up your account:

1. Visit MCM Portal Landing Page: Navigate to https://nexus.mcm.revdau.ai and click the Continue button.

   

2. Complete the Sign-Up Form: Fill in your organizational and contact details in the registration form to create your account.

   

3. Receive Verification & Credentials Email: Check your inbox for the welcome email containing your initial credentials and verification details.

   

4. Sign In to MCM Portal: Go to the login screen and sign in using your registered email and temporary password.

   

5. Set Your Account Password: On your first login, configure a secure password for your account.

   

Step 2: License Request & Approval WorkflowCopy Anchor Link

1. Access Portal Workspace Dashboard: After logging in, access your workspace dashboard.

   

2. Navigate to the Request Tab: Click on the Request tab in the top navigation bar.

   

3. Submit License Request & Wait for Approval: Fill out and submit your license entitlement request.

   
   Administrator Approval

   The MCM Administrator team reviews and approves submitted license requests. Once approved, the software package download and license entitlements become accessible under the License tab.

Step 3: Generate Download Command & Server DeploymentCopy Anchor Link

1. Open Your License: In the MCM Nexus portal, open Licenses and select your license. Under Subscription key, click Create key if you have not already. Copy the key when it is shown — it is displayed only once, and you can Rotate key at any time. You will use it both to download the installer and to activate the platform.

   

2. Select Release Version & Copy Download Command: Under Download installation package, select version 2.0.0 from the Version dropdown and click Copy next to the wget command. If your server reaches the internet through a proxy, enter it in Proxy URL (optional) first and the command is adjusted for you. You can also click Download to save the package through your browser.

   

3. Connect to the server via SSH:

   Copy Text

   ssh [VM_SSH_USER]@<SERVER_IP>

4. Execute the Copied Download Command:

   Copy Text

   wget -c --header="Authorization: ApiKey <YOUR_SUBSCRIPTION_KEY>" \
     "https://nexus.mcm.revdau.ai/api/mcm-app/downloads/package?version=2.0.0" -O mcm-installer.tar.gz

   Replace <YOUR_SUBSCRIPTION_KEY> with your subscription key. The -c flag resumes an interrupted download — re-run the same command to continue.

5. Extract and Launch the Installer:

   Copy Text

   tar -xzf mcm-installer.tar.gz
   cd mcm_artifacts
   sudo ./mcm install --env=main --mode=single

   MCM 2.0 is installed with a single mcm command-line tool (it replaces the install.sh and upgrade.sh scripts used in v1.2). Run it from inside the extracted mcm_artifacts folder.

Installation Details:

• Installation Time: Installation takes 15–30 minutes. Outbound internet access is required on the server during installation to install dependencies.
• Pre-flight checks: Before deploying, the installer checks the server's CPU, free memory and free disk space, and tests outbound connectivity to the domains listed above. If a check fails it reports the exact issue; fix it and re-run the command.
• Forward proxy: If the server reaches the internet through a corporate proxy, add --http-proxy=http://<PROXY_HOST>:<PORT> and --https-proxy=http://<PROXY_HOST>:<PORT> (and optionally --no-proxy=<COMMA_SEPARATED_DESTINATIONS>) to the install command. You can change the proxy later under Settings > Proxy in the MCM console or with sudo mcm proxy configure (see the Helper Scripts and Commands Guide).
• Docker: If Docker is not already installed, the installer installs it. All secrets, passwords and internal certificates are generated automatically — you do not need to create them.
• Management service: The installer also sets up the mcm management service (mcm.service) that powers the mcm status, mcm upgrade and other commands described in the Helper Scripts and Commands Guide. Running the install command again on an already-installed server does nothing unless you pass --force.

Step 4: Platform Activation & Super Admin SetupCopy Anchor Link

Once deployment completes, navigate to https://<DOMAIN_OR_IP>/subscription in your browser:

1. Activate Subscription: Enter your Subscription Key and click Continue. Review the license details (organization, license name, plan, status, validity and owner), then click Activate.

   

2. Owner Account Created: Activation creates the account for the license owner and emails their login details. When you see Owner account created, click Continue to login.

   

3. Log In to Platform: Log in with the credentials from the email and proceed to the User Guide: first-run activation.

5. Operations & Health VerificationCopy Anchor Link

You can verify the status and health of all deployed services with the mcm tool (optional):

mcm status         # platform version, URL and per-service replica status
mcm healthcheck    # point-in-time health snapshot of every service

A service that is still starting, or running below its expected replica count, is reported as unhealthy. Allow about 5 minutes after installation for all services to initialize.

General Verification and ControlCopy Anchor Link

For verification steps, stack teardown commands, and utility control scripts (starting, stopping, restarting, or upgrading the platform components), please refer to the Helper Scripts and Commands Guide.

For custom domain configuration and SSL/TLS certificate management, please refer to the Domain and TLS Certificate Configuration Guide.

For troubleshooting configuration, certificate, or service initialization errors, refer to the Troubleshooting Guide.