Skip to main content


Scuba Docs

Communicate system information to your users

Scuba provides a few mechanisms for you as an administrator to communicate with the users on your Scuba cluster. The type of information and the urgency with which you need to communicate it informs which communication method you choose.

Admin tools for communicating with users include:

  • A banner message. This is useful for service alerts.
  • A cluster information page. This is useful for orienting users to interesting boards or fields in your data, recommendations, or help resources.

Create a banner message

You can create a banner message that appears on every page of the Scuba UI in your organization. The content of the message must be in plain text.

To create a banner message:

  1. You must be assigned the UX admin capabilities bundle.
  2. Log into the machine that you normally use to run the Scuba CLI.
  3. Use the following CLI commands:
    • To create a new banner message or update an existing banner, type the following:
      $ ia settings update webapp announcementBanner '<message text>'
    • Delete a banner message:
      $ ia settings delete webapp announcementBanner
    • Check whether a banner is set (this command displays only the settings that you have access to):
      $ ia settings list
  4. You do not need to restart Scuba for the change to take effect.

Create a customized cluster information page

Each Scuba cluster has an information page that can be personalized with Markdown and images. Any user can access the information page by clicking the Info icon at the bottom left of the Scuba UI.

To add content to your cluster information page, draft the content you wish to add, using Markdown. Markdown guides are plentiful online. For example, see this Markdown cheat sheet on Github. The cluster info page supports ASCII characters and UTF-8 without BOM (byte order marks, such as 0xFE 0xFF).

To add Markdown to the cluster Info page:

  1. You must have the ux_admin capabilities bundle.
  2. Use the following CLI command to insert the contents of the Markdown file into the cluster Info page:
    $ ia settings update webapp landingPage "$(cat <markdown-file-name>)"

    For example, with a Markdown file called

    $ ia settings update webapp landingPage "$(cat"

Set a default page

You can set any URL in Scuba to be your users' default page. For example, this default page can be a board, a specific query, or the cluster information page. The default page you set is the page that all of your users land on every time they come to Scuba, or any time they click the ia icon at the top left of the Scuba UI.

To set a default landing page, contact Scuba support.




  • Was this article helpful?