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

additionalProperties

False