# NexCMP Docs > Documentation for NexCMP 1.6.1: a self-hosted cloud management and billing platform for CloudStack and Proxmox VE (customer portal, billing, resellers, AI chat/agent, API). Every page below is also available as raw Markdown by adding .md to the URL; the whole documentation is in llms-full.txt. - [Overview](https://nexcmp.com/docs/): what is in these docs ## Getting started - [What is NexCMP](https://nexcmp.com/docs/getting-started/what-is-nexcmp.md): NexCMP is a self-hosted customer portal, billing system and admin console that sells virtual machines and cloud services running on your own CloudStack or Proxmox VE. - [Requirements for the NexCMP server](https://nexcmp.com/docs/getting-started/requirements.md): Hardware, operating system, network and DNS requirements for the server that runs NexCMP itself. - [License and purchase](https://nexcmp.com/docs/getting-started/license-and-purchase.md): How NexCMP licensing works — getting a license key, binding it to a domain, reseller domains, update entitlement, and what happens when a license lapses. - [Install NexCMP](https://nexcmp.com/docs/getting-started/installation.md): Install NexCMP on Ubuntu with the one-line installer — parameters, what the installer does, TLS and nginx, and how to reach the setup wizard. - [DNS and Cloudflare](https://nexcmp.com/docs/getting-started/dns-and-cloudflare.md): Point your domain at the NexCMP server, optionally through Cloudflare, and get a valid certificate with the right SSL mode. - [Setup wizard](https://nexcmp.com/docs/getting-started/setup-wizard.md): Walk through the first-run wizard at /setup — setup code, license, CloudStack or Connect later, administrator and brand. - [First login and next steps](https://nexcmp.com/docs/getting-started/first-login.md): Sign in to the admin console for the first time and complete the recommended configuration checklist. - [Updating NexCMP](https://nexcmp.com/docs/getting-started/updating.md): Update NexCMP from the admin console or the command line, how releases are verified, and what you are entitled to receive. - [Release notes](https://nexcmp.com/docs/getting-started/release-notes.md): Changes from NexCMP 1.3 to 1.6.1 and what to check when upgrading: AI administration, VPN metering, customer services and Bare Metal. - [Backup and restore](https://nexcmp.com/docs/getting-started/backup-and-restore.md): Take a consistent backup of NexCMP data and configuration with nexcmp backup, and restore it on the same or a new server. - [Uninstall NexCMP](https://nexcmp.com/docs/getting-started/uninstall.md): Remove the NexCMP services and program, with or without deleting data, and what stays on your infrastructure. - [nexcmp command reference](https://nexcmp.com/docs/getting-started/cli-reference.md): Every subcommand of the nexcmp server command-line tool — status, update, backup, uninstall, open-port, close-port and fix-owner. ## Infrastructure - [Infrastructure requirements](https://nexcmp.com/docs/infrastructure/requirements.md): One table: for every NexCMP module, the minimum infrastructure it needs and the page that explains how to prepare and connect it. - [Architecture](https://nexcmp.com/docs/infrastructure/architecture.md): How NexCMP is put together: domain, nginx, the panel and worker services, and every system they connect to, with the ports and data each path uses. - [Modules](https://nexcmp.com/docs/infrastructure/modules.md): Every NexCMP module with its default state, what it adds, what infrastructure it needs and where to turn it on; including the add-on modules read at start-up. - [Zones](https://nexcmp.com/docs/infrastructure/zones.md): How NexCMP zones work: the location customers pick when they order, how a zone connects to CloudStack, Proxmox VE, VPN and S3, and when it is ready to sell. - [CloudStack](https://nexcmp.com/docs/infrastructure/cloudstack.md): Connect Apache CloudStack to NexCMP: create a dedicated domain, account and API key with cmk, then enter them in the setup wizard or the admin console. - [Proxmox VE](https://nexcmp.com/docs/infrastructure/proxmox.md): Add Proxmox VE clusters as a VM source: least-privilege API token, storage, cloud-image templates, IP pools, TLS pinning and per-plan source. - [OS templates and ISOs](https://nexcmp.com/docs/infrastructure/templates.md): Prepare the OS images customers deploy from: build and register CloudStack templates, and make Proxmox VE cloud-image templates. - [Dedicated servers (bare metal)](https://nexcmp.com/docs/infrastructure/dedicated.md): Sell Dell servers managed through iDRAC and Redfish: network and ISO server prerequisites, importing servers, safety switches, templates and plans. - [VPN and IPv6 proxy nodes](https://nexcmp.com/docs/infrastructure/vpn-proxy-nodes.md): Prepare Linux hosts as VPN nodes (cmp-agent) and IPv6 proxy nodes: operating system, IP addresses and IPv6 prefixes, ports, sysctl, install and heartbeat. - [AI Models](https://nexcmp.com/docs/infrastructure/ai-models.md): Sell AI model access through your own gateway: add your OpenAI-compatible or Anthropic-compatible providers, sync models, set prices, and let customers call one endpoint with their own keys and wallet. - [Object Storage (S3, Ceph RGW)](https://nexcmp.com/docs/infrastructure/s3.md): Sell pay-as-you-go S3 storage on your Ceph cluster: RGW requirements, the admin user and caps, and how to attach the backend to a zone in NexCMP. - [Kubernetes and Private Cloud](https://nexcmp.com/docs/infrastructure/kubernetes-and-private-cloud.md): Sell Kubernetes clusters (CKS) and dedicated-bandwidth Private Cloud (VPC) on CloudStack: required offerings and where to connect them. ## Catalog & pricing - [Plans and pricing](https://nexcmp.com/docs/catalog/plans.md): Create and price VM plans: sizes, hourly and monthly prices, billing cycles, custom plans, cloning, and what a price change does to running VMs. - [Bandwidth quotas and add-ons](https://nexcmp.com/docs/catalog/bandwidth.md): How NexCMP meters traffic per service from CloudStack statistics, default quotas, 80% and 100% alerts, overage actions and add-ons. - [Currency and exchange rates](https://nexcmp.com/docs/catalog/currency-and-exchange-rates.md): How NexCMP keeps money in US dollars, shows other currencies by language, and how an administrator publishes the USD/VND rate and the display rates. ## Billing & payments - [Payment channels](https://nexcmp.com/docs/billing/payment-channels.md): How customers top up their wallet in NexCMP — the available channels, how to enable each one, fees, limits and how to watch them. - [Stripe](https://nexcmp.com/docs/billing/stripe.md): Connect Stripe to NexCMP for card payments, Apple Pay, Google Pay, Link and Alipay — API keys, webhook, domain registration and a test payment. - [PayPal](https://nexcmp.com/docs/billing/paypal.md): Connect PayPal to NexCMP for wallet top-ups — REST app credentials, webhook, sandbox testing and saved PayPal accounts. - [USDT (Binance)](https://nexcmp.com/docs/billing/usdt.md): Accept USDT wallet top-ups by watching a Binance deposit address — read-only API key, network choice, address verification and unmatched deposits. - [Bank transfer (Vietnam)](https://nexcmp.com/docs/billing/bank-transfer-vn.md): Accept Vietnamese bank transfers (VND) with Sepay — receiving account, memo prefix, webhook, limits, and how to assign unmatched transfers. - [Minimum top-up](https://nexcmp.com/docs/billing/minimum-top-up.md): Set the smallest and largest wallet top-up per payment, and understand the other balance floors that decide whether a customer can order. - [Saved payment methods](https://nexcmp.com/docs/billing/saved-payment-methods.md): How customers save a card, a Stripe wallet or a PayPal account for automatic top-up, how to remove them, and what NexCMP stores. - [Auto top-up](https://nexcmp.com/docs/billing/auto-top-up.md): Keep customer wallets funded automatically from a saved card or PayPal account — usage-based and fixed modes, global limits and failure handling. - [Invoices and ledger](https://nexcmp.com/docs/billing/invoices-and-ledger.md): Where money is recorded in NexCMP — the wallet ledger, invoices, top-up payments, refunds and payouts, vouchers and revenue reports. - [Promotions](https://nexcmp.com/docs/billing/promotions.md): Issue top-up codes: wallet bonuses, service-only credit and percentage discounts with a cap and a minimum order — create, distribute and track them. - [Quotas](https://nexcmp.com/docs/billing/quotas.md): Limit what a new customer can create until they have funded their wallet — VM resource tiers, VM count and per-service quotas, with per-customer overrides. ## Customers & resellers - [Managing customers](https://nexcmp.com/docs/customers/managing-customers.md): Find and support customers: the customer list, country by IP, referral source, account actions, deletion requests and service transfers. - [Log in as a customer](https://nexcmp.com/docs/customers/login-as.md): Open the customer portal as a specific customer for one hour to reproduce a problem — conditions, safeguards, and what is blocked and logged. - [Resellers (white-label)](https://nexcmp.com/docs/customers/resellers.md): Let partners sell your cloud under their own brand and domain — create a reseller, set domains and DNS, wholesale pricing, defaults and license slots. - [Branding](https://nexcmp.com/docs/customers/branding.md): Put your own name, logo, colour and currency on the customer portal, the admin console and e-mails — upload rules and where each setting appears. - [Legal pages](https://nexcmp.com/docs/customers/legal.md): Write the Terms of Service and Privacy Policy shown at /terms and /privacy — default neutral text, English and Vietnamese versions, and safe markdown rules. ## Customer portal - [Customer portal overview](https://nexcmp.com/docs/portal/overview.md): A tour of the customer portal: dashboard, menu, wallet, virtual machines, account settings, language and currency. - [Sign-up, wallet and top-up](https://nexcmp.com/docs/portal/sign-up-and-wallet.md): How customers register, verify their e-mail, add credit to the wallet, redeem codes, and read their billing history. - [Ordering a service](https://nexcmp.com/docs/portal/ordering.md): The order page step by step: service, location, plan, billing cycle, operating system, hostname and quantity, then pay from the wallet. - [Virtual machines](https://nexcmp.com/docs/portal/virtual-machines.md): Managing a virtual machine from the portal: overview, power actions, password reset, reinstall, monitoring, network, configuration and activity. - [Console](https://nexcmp.com/docs/portal/console.md): Open a VM console in the browser (VNC), and optionally a web SSH terminal; what each needs from your infrastructure. - [Snapshots and backups](https://nexcmp.com/docs/portal/snapshots.md): Take, restore and delete VM snapshots from the portal, schedule them, and what each source supports. - [Support for customers](https://nexcmp.com/docs/portal/support.md): How customers get help: the chat bubble with AI answers, Telegram and Zalo shortcuts, and tickets. ## AI - [AI provider](https://nexcmp.com/docs/ai/ai-providers.md): Connect an OpenAI-compatible AI endpoint for AI Chat and the AI Agent — switch the AI module on, enter the endpoint and key, test it, and set limits. - [AI Chat](https://nexcmp.com/docs/ai/ai-chat.md): Automatic support chat for signed-in customers: what it can do, hand-off to your staff through Telegram, Zalo and Telegram shortcut buttons, and the limits you control. - [AI Agent](https://nexcmp.com/docs/ai/ai-agent.md): Let customers administer their Linux VMs by describing a task in plain language — how the Agent connects over SSH, what it may run on its own, and what you must have in place. ## Developers - [REST API](https://nexcmp.com/docs/developers/api.md): Call the customer API of your NexCMP installation: authentication, the interactive reference, OpenAPI and Postman downloads, errors, rate limits, idempotency and curl examples. - [API keys and scopes](https://nexcmp.com/docs/developers/api-keys.md): How customers create API keys (vk_ prefix), choose scopes, limit them by IP and expiry, and how administrators review and revoke them. - [cmp command-line tool](https://nexcmp.com/docs/developers/cmp-cli.md): Install and use the cmp CLI served by your own panel: browser login with a one-time code, commands generated from the API, output and exit codes, CI use and signed updates. - [MCP server](https://nexcmp.com/docs/developers/mcp.md): Connect AI assistants (Claude, Cursor, VS Code and others) to your installation's API through the built-in MCP endpoint at /mcp — authentication, client configuration, tools and safety rules. ## Configure with AI - [Configure with AI](https://nexcmp.com/docs/configure-with-ai/overview.md): Let an AI assistant set up and run your NexCMP: AI Chat in the admin, your own AI client over MCP, or a YAML file. What it can do, and the safety rules around it. - [AI Chat in the admin](https://nexcmp.com/docs/configure-with-ai/ai-chat-in-admin.md): Configure NexCMP by chatting in the admin: choose an AI source, review confirmation cards for every change, pass secrets safely and keep a daily spending cap. - [AI accounts and subscriptions](https://nexcmp.com/docs/configure-with-ai/ai-accounts-and-subscriptions.md): Connect the AI source for AI Chat (API keys, OpenRouter or Google sign-in, the panel provider) and use your own Claude, ChatGPT or Gemini subscription through the official CLIs. - [Admin API keys](https://nexcmp.com/docs/configure-with-ai/admin-api-keys.md): Create and revoke ak_ admin keys for AI agents and scripts: the eight scopes, expiry, IP ranges, rate limit, what keys can never do and every error code. - [Connect an AI client (MCP)](https://nexcmp.com/docs/configure-with-ai/mcp-admin.md): Connect Claude Code, Codex CLI, Gemini CLI, Cursor, Claude Desktop, claude.ai, ChatGPT or the OpenAI SDKs to your panel's admin MCP endpoint, with the full tool list. - [claude.ai and ChatGPT connectors](https://nexcmp.com/docs/configure-with-ai/oauth-connectors.md): Connect web AI apps such as claude.ai and ChatGPT to your panel with OAuth 2.1: sign in as admin, choose scopes and duration, and revoke the connection when you want. - [Configuration as code](https://nexcmp.com/docs/configure-with-ai/config-as-code.md): Export your panel configuration to a YAML file, preview the changes and apply them with nexcmp config or the Import/Export page; secrets stay out of the file and the JSON Schema checks it. - [Example prompts](https://nexcmp.com/docs/configure-with-ai/example-prompts.md): Copy-ready prompts for AI Chat or your own AI client: first setup, adding Proxmox, a plan table with margin, SMTP, Stripe, Telegram, customer credit and exporting your configuration. - [Setup progress checklist](https://nexcmp.com/docs/configure-with-ai/setup-checklist.md): The Setup progress card on the admin Overview shows the ten steps to a working shop and lets an AI assistant do the next one for you with Do it for me. ## Administration - [SMTP and e-mail templates](https://nexcmp.com/docs/administration/smtp-and-emails.md): Configure outgoing e-mail (SMTP), send a test message, edit the e-mail templates in each language, and read the delivery log. - [Telegram and admin alerts](https://nexcmp.com/docs/administration/telegram-notifications.md): Send operational alerts and customer sign-up and deposit events to a Telegram group, a webhook or e-mail, and set up the support shortcuts shown to customers. - [Audit log and activity](https://nexcmp.com/docs/administration/audit-log.md): Read who did what: the unified activity timeline, admin actions, customer logins, VM events and sent e-mails, and how to search by event code. - [Security](https://nexcmp.com/docs/administration/security.md): Protect the admin console with two-factor authentication and IP allow-lists, manage administrator roles, and configure customer sign-in: passkeys, Google and GitHub, captcha and blocked e-mail domains. - [General settings](https://nexcmp.com/docs/administration/general-settings.md): Brand name and URLs, seller details printed on invoices, invoice number prefix, default language, and customer maintenance mode. - [Report a bug](https://nexcmp.com/docs/administration/report-a-bug.md): Send a bug report from the admin console straight to the NexCMP team as a ticket: the form, exactly what is sent, what is never sent, limits and fixes for common errors. ## Troubleshooting & FAQ - [Installation errors](https://nexcmp.com/docs/troubleshooting/installation-errors.md): Every error message the NexCMP installer can print, what causes it and how to fix it — requirements, license activation, download verification, services and nginx/TLS. - [Update errors](https://nexcmp.com/docs/troubleshooting/update-errors.md): Why an NexCMP update can fail — entitlement, download verification, signature, restart — and how to recover or roll back. - [FAQ](https://nexcmp.com/docs/troubleshooting/faq.md): Frequently asked questions about installing, licensing, connecting infrastructure and running NexCMP. - [Support](https://nexcmp.com/docs/troubleshooting/support.md): How to get help with NexCMP: what to collect, what to include in your message and where to send it. ## Optional - [Full documentation in one file](https://nexcmp.com/docs/llms-full.txt) - [Sitemap](https://nexcmp.com/docs/sitemap.xml) - [Product site](https://nexcmp.com)