Skip to main content

76 docs tagged with "platform"

View all tags

Accounts & onboarding

The client account exists but the user cannot log in and status stays Pending. Is there an approval dashboard?

Add Products

Create catalogue items under Settings → Products → Products → Add Product.

Affiliate

Affiliate documentation is still in progress. Pages may be incomplete or updated as the module evolves.

Affiliate Dashboard

After an admin approves their account, affiliates log in to the affiliate portal at /affiliate/login.

Affiliate Details (Admin)

Open an active affiliate from Affiliates → Manage Affiliates → Active Affiliates to manage account data, referrals, commissions, and settings.

Affiliate Registration

Prospective affiliates sign up through a public registration link. After they complete the flow, the request is sent to the admin for approval — the affiliate account is not active until an admin approves it.

Affiliate Workflow

End-to-end flow from affiliate registration through customer referral, commission, and payout.

APIs

CMP is built on REST-based APIs. Use this page to enable API access, generate tokens, authenticate, and configure role-based permissions for integrations.

Application credentials email

When a customer deploys a VM from a Marketplace App, CMP can send an email with application credentials and environment details (for example WordPress admin URL, username, and password) — not only the generic “VM created successfully” message with OS, RAM, and storage.

Auto Pay

Auto Pay automatically purchases infra credits when an account’s available balance falls to or below a configured threshold. That helps prepaid customers keep services running without manually topping up every time the wallet runs low.

Automation limitations

CMP automates infrastructure provisioning — virtual machines, storage, and networking. Application-level automation depends on what runs inside the guest OS and what you explicitly pass through Marketplace environment variables and startup scripts.

Billing & pricing

Platform Q&A for pay-as-you-go, invoices, pricing formulas, snapshot charges, and tax. Full product guides: Billing overview, Pricing formulas.

Billing Behaviour

Billing for a product starts immediately when the order is placed. CMP uses the configured payment type, billing cycle, and billing rule. No separate activation step is required for billing to begin.

Branding & themes

How can a provider add external document URLs from their own website?

CAPTCHA

CMP can protect customer portal forms (login, registration, and similar) from spam and automated bot submissions using CAPTCHA providers.

Categories

Categories organize products in CMP and drive category tabs in the customer Store (for example Backups, Support).

Customer Dashboard

This section documents customer-facing areas of the CMP portal — what end users see on the Dashboard, under Profile, Billing, Quota, and related menus.

Customer Store

Customers purchase standalone products from the Store in the customer portal.

Dashboard

The affiliate Dashboard is the home page after login at /affiliate/login.

enable_mobile_verification

Enable Mobile Verification controls whether CMP triggers SMS OTP verification for customer mobile numbers during registration and when updating mobile numbers from the customer profile.

enable_phone_input

Enable Phone Input is the primary global setting for phone number fields across the platform. When it is off, all phone inputs — billing phone, profile phone, signup phone, and related fields — are hidden.

Enforce Terms & Conditions

When one-liner mode is disabled, use this flag to require (or allow skipping) acceptance of the full in-product Terms and Conditions.

enforce_mobile_verification

Enforce Mobile Verification dictates whether completing mobile number OTP verification is mandatory (compulsory) or optional for customers to finish onboarding.

Environment variables

During Marketplace App deployment, some application settings must be configured dynamically — for example username, password, database name, or site URL for a WordPress or PostgreSQL image.

Global Settings

CMP exposes 200+ application-level flags under Admin Panel → Global Settings. Each flag controls platform-wide behaviour — registration fields, billing rules, login policy, and more.

hide_billing_phone

Hide Billing Phone removes the billing phone number field from organization and billing forms. It applies only when enable_phone_input is also enabled (true).

hide_postal_code

Hide Postal Code removes the postal / zip code field from all applicable forms. When enabled, users are not prompted for a postal code and can complete registration, onboarding, and billing updates without it.

In-step form (registration flow)

In this approach, the full Terms and Conditions are shown inside the registration flow (for example the Accept T&C step after email verification and payment). Customers review and accept without leaving CMP for an external website.

Keycloak

CMP supports Keycloak as an external identity provider for SSO, social login (Google, GitHub), and 2FA when Keycloak is the active provider.

Marketplace Apps

Marketplace apps are VM templates with pre-installed applications. The service provider prepares the image (OS + application) so end users can deploy a ready-to-use app without installing software manually.

MSG91

This document lists the mandatory configuration details required to enable CMP to send transactional SMS messages (such as registration verification OTPs) via MSG91.

Multi-language

CMP can present the customer (end-user) portal in multiple languages. Multi-language is disabled by default (English only) until the StackConsole team enables it for your deployment.

Notifications

CMP notification system for customer and admin alerts — email (and related channels), event-driven messages, and notification preferences.

One-liner (checkbox + URL)

One-liner Terms and Conditions shows a checkbox on the frontend Signup form. The label includes a link that opens the provider’s public Terms and Conditions page in a new browser tab.

Orders

When a customer places a product order, CMP:

Platform Features

This section covers CMP-level capabilities that are not tied to a single orchestrator — APIs, notifications, store/marketplace, and other cross-cutting product features.

Platform Q&A

Questions about CMP product behaviour — billing, branding, auth, accounts, and packaging — that apply regardless of which orchestrator is connected.

Product Billing

Configure product prices on the rate card after the product exists.

Product Vendors

Vendors identify who supplies a product (procurement, support contacts, reporting).

Production Requirements

What cloud provider administrators need before enabling StackAI in a production CMP deployment.

Products changelog

This page lists what is new in Products / Store. Most of the Store & Products documentation describes capabilities that were not available before this release.

Public IP & network billing

How CMP charges public IPs vs VPC / isolated / shared network packages. Feature context: Isolated Network, VPC Network, Shared Network, IP Address (CloudStack) · IP Address (Proxmox).

Quota Reports and Usage Sync

Customers can review how much quota their account is using and sync usage when reported numbers do not match their live services.

Reseller

CMP supports Reseller and Vendor partner account types in addition to end Customers. Resellers get a white-labeled portal and control customer billing; vendors onboard customers on the provider portal and are billed for aggregated customer usage.

Reseller billing

This page covers provider (super admin) → reseller billing and reseller → reseller’s customer billing, plus vendor billing notes and current limitations.

Reseller vs Vendor

Use this page to choose the right partner model and explain differences to providers and partners.

Sanctum Token Expiration

These global settings control how long API login tokens stay valid. They apply to normal API TOKEN authentication — not long-lived REST API TOKEN tokens (see Notes below).

Security

StackConsole implements multiple layers of security and fraud prevention across the application, authentication, API, network, billing, and infrastructure layers.

SMS Gateways & Verification

CMP supports sending transactional SMS messages — including one-time passwords (OTP) for mobile verification during customer registration — through external SMS service providers.

Spinning Disk

This document describes the configuration parameters required to enable transactional SMS delivery and mobile verification in CMP using the Spinning Disk SMS Gateway.

StackAI

StackAI is in beta. Capabilities, suggested prompts, and enabled tools may vary by tenant. Confirm with StackConsole which features are active on your deployment.

StackAI Roadmap

What's live today, what we're building now, and what's planned next.

Startup script size (CloudStack)

Marketplace Apps usually rely on an administrator startup script on the template. Customers may also enter their own startup script at deploy time. Both are combined into UserData sent to CloudStack, so size limits must be aligned.

Store & Products

This documentation describes an improvement on the basic Products / Store feature. It is not yet rolled out to all deployments — you may find that some of these capabilities are not available on your CMP today. They will become available in upcoming updates.

Terms and Conditions

CMP can require customers to accept Terms and Conditions during signup and onboarding. Admins choose how terms are shown (external link vs in-product content) and whether acceptance is mandatory.

Tickets and Rate Limiting

CMP includes admin-configurable rate limiting for support ticket creation and feedback submission. Limits control how many records a user can create within a configured time window.

Twilio

This document lists the mandatory configuration details required to enable CMP to send transactional SMS messages (including registration verification OTPs) globally via Twilio.

VM packages & storage

Override root disk, free OS disk, scheduled stop, and related packaging choices. CloudStack offering mapping: Virtual Machine packages.

Zitadel Machine User & PAT

Create a Zitadel service account (machine user) and Personal Access Token (PAT) so CMP can create or link users during user migration.

Zitadel Overview

Zitadel integration is currently in Beta. It is fully functional for OIDC customer/affiliate authentication and user migration, with continuous enhancements being added.

Zitadel Setup

Step-by-step setup for a Zitadel instance, Stack Console Web/OIDC application, and CMP Social Login configuration.

Zitadel User Migration

When transitioning to Zitadel, existing CMP accounts can be migrated so that users can seamlessly sign in through Login with Zitadel using their registered email addresses.