Skip to content

Plenary Cloud

Plenary Cloud is the hosted edition of Plenary. You sign up on plenarycms.com, and Plenary provisions an instance for you: the API, the admin console, media processing, a database, email delivery, and media storage. You build against it exactly as you would against a self-hosted instance. Use Cloud when you want to skip running servers; use self-hosting when you need Plenary on your own infrastructure.

Start at plenarycms.com/signup. Signup starts a free trial, with no credit card required. The page shows the trial length.

The signup wizard has five steps:

  1. Create your account. Your first and last name, a work email, and a password (at least 8 characters, with an upper-case letter, a lower-case letter, and a digit). Accept the Terms of Service and Privacy Policy.
  2. About your organization. Your organization name, plus optional industry, team size, and how you heard about Plenary.
  3. Check your email. Enter the 6-digit code sent to your email address.
  4. Secure your account. Enter a mobile number and the 6-digit code texted to it.
  5. Set up your first project. Enter a Project / site name, choose Cloud under Deployment, pick a subdomain, enter your site’s primary domain, and choose a primary use case. Click Complete setup.

Plenary then provisions your instance and shows its progress. This usually takes under two minutes. When it finishes, click Open admin dashboard and sign in with the email and password you chose in step 1.

A Cloud instance (also called a tenant) is one complete Plenary installation that belongs to your account. Its address comes from the subdomain you chose:

What URL
Instance https://<subdomain>.plenarycms.io
Admin console https://<subdomain>.plenarycms.io/cms
API https://<subdomain>.plenarycms.io/api/v1

Subdomains use lowercase letters, numbers, and hyphens, are 1 to 28 characters long, and cannot start or end with a hyphen. Some names are reserved.

Your instance starts with:

  • An admin user with the email and password from signup. It has the admin role.
  • One site, named after your project, with the site key default. Pass site_key=default (or siteKey: "default" in @plenary/client) when you read content.

Point your code at the instance URL. With @plenary/client, that is the baseUrl:

lib/plenary.ts
import { createClient } from "@plenary/client";
export const plenary = createClient({
baseUrl: "https://your-subdomain.plenarycms.io",
apiKey: process.env.PLENARY_API_KEY!,
siteKey: "default",
locale: "en-us",
});

From here, the Quickstart walks you through your first model, entry, and API key.

On Cloud, Plenary runs the infrastructure, so the console hides the settings that configure it and the API refuses them. Everything else (content models, entries, media, forms, page building, webhooks, transformers, sites, users, roles, API keys, and metrics) works the same as on a self-hosted instance.

Area Self-hosted Cloud
Email sending You configure a provider under Global Settings Managed. Mail is sent as PlenaryCMS <no-reply@plenarycms.com>.
SMS sending You configure a provider under Global Settings Managed
Media file storage You choose local disk or S3 under Global Settings Managed
License You install one under Admin Settings → License Not used. Your subscription covers the instance.
Plan and usage Not applicable Admin Settings → Subscription in the console

The Global Settings and License pages do not appear in a Cloud console; Subscription appears in their place. It shows your plan, its limits, and current usage.

If code calls one of the managed settings endpoints on a Cloud instance, the API returns 403 with the error code cloud_managed:

{ "error": { "code": "cloud_managed" } }

These endpoints return cloud_managed on Cloud:

Method Path
GET, PUT /api/v1/settings/email-sending
POST /api/v1/settings/email-sending/test
GET, PUT /api/v1/settings/sms-sending
POST /api/v1/settings/sms-sending/test
GET, PUT /api/v1/settings/file-storage
GET /api/v1/settings/message-deliveries
GET /api/v1/license
PUT /api/v1/settings/license

To check which edition an instance runs, call the health endpoint. It needs no authentication:

Terminal window
curl https://your-subdomain.plenarycms.io/api/v1/health
{ "status": "ok", "database": "ok", "version": "1.0.0", "edition": "cloud" }

Your Plenary account (the customer account you created at signup) is separate from the user accounts inside your instance. Manage it in the account portal at plenarycms.com/account:

Page What you do there
Overview See your instances, trial or renewal date, and licenses at a glance.
Profile & organization Edit your details and your organization, and invite Team members who can sign in to the account.
Cloud instances See each instance’s URL, admin dashboard link, status, version, and plan limits. Open CMS takes you to the console.
On-prem licenses Get license keys for self-hosted deployments.
Billing & invoices Choose a plan, manage the payment method, and see invoice history.

Signing in to the account portal and signing in to an instance’s console are separate. Your console password starts out the same as the one you chose at signup, but changing one does not change the other. People you add as console users under Access Management → Users do not get access to the account portal, and account team members do not automatically get console access.

If an instance shows as paused in the portal, set up billing under Billing & invoices to resume it.