System on CloudBolt Documentation

Branded portals

Mon, 01 Jan 0001 00:00:00 +0000

See Theme configurations for designing color schemes that can be used across portals.

How CMP chooses a portal

Each request is matched against the Domain/IP of every portal. If none match, the default portal is used. One portal must always be the default, and the default cannot be deleted.

The portal’s Name replaces references to CloudBolt anywhere a non-admin can see them, and its images replace the ones in the header, the loading indicator, and the splash screen.

Limit recently viewed items

Mon, 01 Jan 0001 00:00:00 +0000

The limit is controlled by a setting rather than by anything on screen. To change it, add the setting to customer_settings.py, which overrides the shipped defaults in settings.py.

How the limit works

MAX_RECENTLY_VIEWED_ITEMS_TO_TRACK caps how many items CMP keeps in a user’s recently viewed list, counted separately for each kind of object it tracks. It defaults to 5.

The list is held most recent first. When a user opens an item and the list is already at the cap, the oldest entry drops off.

Internationalization

Mon, 01 Jan 0001 00:00:00 +0000

CMP ships with English only. Translating it consists of generating message files from the strings marked in the product, translating those files, compiling them, and then telling CMP which language to serve. This is carried out on the appliance, and the files are stored in the proserv directory where they will not be overwritten during an upgrade.

Generate the message files

Run these commands on the appliance. Replace fr with your target language code from the ISO 639-1 list.

Miscellaneous settings

Mon, 01 Jan 0001 00:00:00 +0000

The Admin > Miscellaneous Settings page is divided into five tabs, and a search box above them filters across all tabs. Within a tab, toggles save once changed. Other settings are read-only until you select Edit, which opens a dialog that saves on submission.

Sessions, single sign-on, embedded mode, and legal notices.

Setting	Default	Description
Automatically Login to SSO	Disabled	Redirects users to the configured SSO provider for login instead of showing the CMP login form.
Display Legal Notice on every Login	Enabled	Shows the Legal Notice Text after every login. Disable it to show the notice to each user only once.
Require New Users to Self-Assign Passwords	Disabled	Sends a password-reset email to each newly created user so they can set their own password, rather than an admin assigning one. See Create a user.
Enforce Single Sessions for Users	Disabled	Logs a user out of their first session when they log in from a second browser or location.
Require User Email Verification	Enabled	Sends a verification email automatically whenever a user’s email address changes.
Disable Edit Email By User	Disabled	Prevents users from changing their own email address in Manage profile.
Show ResourceType for Profile	Disabled	Limits the resource types a user sees to those with at least one resource visible to that user.
Embedded Mode	Disabled	Allows CMP to render inside an iframe without the navigation bar. Set Embed URLs / Frame Ancestors and Allowed Global Roles in Embedded Mode to finish the configuration. See Embed in ServiceNow.
Hide ‘Domain’ dropdown	Disabled	Removes the Domain dropdown from the login page. Domain users then log in with `username@domain` in the Username field.

Setting	Default	Description
Allowed Global Roles in Embedded Mode	Super Admin	The global roles that reach CMP directly while Embedded Mode is enabled: Super Admin, Devops Admin, or Global Viewer. Everyone else is redirected to the same page with `?frame=true` appended. Super Admin must always be included. See Global roles.
Embed URLs / Frame Ancestors	Empty	A space-separated list of the parent sites allowed to embed CMP in an iframe. It sets the frame-ancestors directive in the appliance’s Content-Security-Policy. Entries can mix formats: `example.com`, `*.example.com`, or a full URL with a port and path.
Legal Notice Text	Empty	Text shown to users at login. They must select Agree to continue; Disagree logs them out. Leave the field blank to turn the notice off.
Default Redirect (restart Web Server)	/dashboard/	Where CMP sends a user who navigates to the site root or selects the logo in the navigation bar. Other common values are `/catalog/` and `/servers/`. Restart the web server for a change to take effect.

UI

Branding, navigation links, security messaging, and inactivity timeouts.

System status

Mon, 01 Jan 0001 00:00:00 +0000

Go to Admin > System Status. The page is limited to CB Admins and Super Admins.

(opens full-size image in a new tab)

Admin-only mode

Under CloudBolt Mode, Enable admin-only mode stops anyone who is not a CMP admin from logging in or using CMP until disabled. The button becomes Disable admin-only mode while enabled.

Jobs are unaffected, including scheduled and recurring ones. To stop those, use maintenance mode.

Theme configurations

Mon, 01 Jan 0001 00:00:00 +0000

Themes live at Admin > Theme Configurations, where you can add a new theme or clone an existing one to start. Each portal has a Default Theme and can also have an Alternate Theme, and a single theme can serve multiple portals.

(opens full-size image in a new tab)

Theme settings

Open a theme and edit it to set its name and layout.

Using HTML in descriptions

Mon, 01 Jan 0001 00:00:00 +0000

Most description fields in Cloud Management Platform (CMP) accept simple HTML without any configuration. To display more advanced HTML, such as style tags or attributes, you have to override one or more settings in customer_settings.py.

CMP sanitizes user-supplied HTML with the Python library bleach, using its clean method. Four settings control what survives sanitizing. Three of them map directly to keyword arguments of bleach.clean; the fourth configures bleach’s CSS sanitizer.

Import a setting before changing part of it. customer_settings.py is loaded as a module of its own, so a line that edits an entry of a setting the file has not imported raises an error and CMP does not start. Replacing a setting outright needs no import.

System on CloudBolt Documentation

Branded portals

How CMP chooses a portal

Limit recently viewed items

How the limit works

Internationalization

Generate the message files

Miscellaneous settings

Login

Quick toggles

Settings

UI

System status

Admin-only mode

Theme configurations

Theme settings

Using HTML in descriptions