Configuration reference#

Squareone is configured at runtime through a YAML configuration file. The path for this configuration file is set by the SQUAREONE_CONFIG_PATH environment variable in production, and defaults to squareone.config.yaml in development. 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

  • environmentName

Phalanx environment name

Used in telemetry

type

string

default

development

  • docsBaseUrl

Base URL for the user documentation site.

Used for computing URLs for user documentation pages for this RSP instance. The default is for the public RSP. For USDF, use https://rsp.lsst.io/v/usdfprod. Does not end in /.

type

string

default

https://rsp.lsst.io

  • 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

  • plausibleDomain

Plausible tracking domain

Domain (e.g. data.lsst.cloud) for Plausible tracking. Omit to disable Plausible.

type

string

  • mdxDir

MDX content directory

Directory path where MDX content files are located. Can be relative (development) or absolute (production with ConfigMap).

type

string

default

src/content/pages

  • sentryTracesSampleRate

Sentry traces sample rate

The percentage of traces to send to sentry. A number between 0 and 1 inclusive, where zero means don’t send any traces, and 1 means send all traces.

type

number

  • sentryReplaysSessionSampleRate

Sentry replay session sample rate

The percentage of replay sessions to send to Sentry. A number between 0 and 1 inclusive, where zero means don’t send any sessions, and 1 means send all sessions.

type

number

default

0.0

  • sentryReplaysOnErrorSampleRate

Sentry error replay session sample rate

The percentage of replay sessions to send to Sentry when an error occurs. A number between 0 and 1 inclusive, where zero means don’t send any sessions, and 1 means send all sessions.

type

number

default

1.0

  • sentryDebug

Sentry debug

Setting this option to true will print useful information to the console while you’re setting up Sentry.

type

boolean

default

False

  • enableAppsMenu

Enable the Apps menu

Setting this option to true will enable the Apps menu in the header.

type

boolean

default

False

  • appLinks

Application links

Links to be displayed in the Apps menu

type

array

default

items

type

object

properties

  • label

Display label for the link

type

string

  • href

URL or path for the link

type

string

  • internal

Whether this is an internal route or external URL

type

boolean

  • showPreview

Show preview badge

Whether to show the preview badge on the homepage hero

type

boolean

default

False

  • previewLink

Preview badge link URL

URL for the preview badge link

type

string

default

https://rsp.lsst.io/roadmap.html

additionalProperties

False