Configuration reference#

Squareone is configured at runtime through a YAML configuration file. This page documents the schema of that configuration file.

Squareone Configuration#

Publicly-viewable configuration for a Squareone instance.

squareone.config.schema.json

type

object

properties

  • siteName

Site name

Used as the basis of the HTML title tag. This should be customized for each science platform deployment.

type

string

default

Rubin Science Platform

  • siteDescription

Site description

Used as the default site description in the HTML meta..

type

string

default

Welcome to the Rubin Science Platform

  • baseUrl

Base URL for the public ingress

Used for computing absolute URLs

type

string

default

http://localhost:3001

  • semaphoreUrl

Semaphore URL

URL prefix of the Semaphore API service for obtaining notifications and broadcasts. Does not end in /. Omit or set as null to disable Semaphore features.

type

string

  • timesSquareUrl

Times Square API URL

URL prefix of the Times Square API service. Does not end in /. Omit or set as null to disable the /times-square/ pages.

type

string

  • coManageRegistryUrl

COmanage registry URL (e.g. https://id.lsst.cloud). Omit or set as null for non-COmanage deployments.

type

string

  • apiAspectPageMdx

/api-aspect Page MDX content

type

string

  • docsPageMdx

/docs Page MDX content

type

string

  • supportPageMdx

/support Page MDX content

type

string

  • verifyEmailPageMdx

/enrollment/thanks-for-signing-up content (MDX).

type

string

  • emailVerifiedPageMdx

/enrollment/thanks-for-verifying content (MDX).

type

string

  • pendingApprovalPageMdx

/enrollment/pending-approval content (MDX).

type

string

  • pendingVerificationPageMdx

/enrollment/pending-confirmation content (MDX).

type

string

additionalProperties

False