SciGateway settings - ral-facilities/scigateway GitHub Wiki

Below is a full reference for what each setting you can set for SG in the settings.json file.

• plugins: The list of plugins to load. Each plugin must be an object with the following fields:
  • name: The name of the plugin. The name must be the name the plugin has been built with (i.e. what was the value of webpackConfig.output.library). See an example here.
  • src: Where to find the plugin. The src is either a relative path from the public folder (e.g. /plugins/plugin1) or more likely a URL (e.g. http://localhost:5002/main.js).
  • enable: Is the plugin enabled? Useful so you don't have to delete the config to stop loading a plugin
  • location: (Theoretically) where the plugin should load. This currently isn't used and should be set to "main"
• features: turn specific features of the site on or off. It must be an object with the following potential properties
  • showHelpPageButton: Whether a Help page button should be shown in the main app bar, which links to a static help page
  • singlePluginLogo: SciGateway can change it's logo according to each plugin. This setting will just use the first plugin's logo for everything
• ui-strings: where to find file that details the strings the UI will use for text - see /public/res/default.json for the defaults
• auth-provider: what authentication provider to use
  • jwt: run your own auth server which accepts "username" and "password" as valid credentials
  • github: use github account to sign in via redirect
  • icat: to use a server like scigateway-auth which offers multiple different ICAT authenticators
• authUrl: URL to the authentication server
• autoLogin: Boolean which tells an authenticator whether it should try and auto-login. This currently only works with the icat authenticator (to automatically login as anon)
• help-tour-steps: an array of objects with a CSS selector as the target and the text to display in the tooltip as the content e.g. {target: "#my-tour-step", content: "This is my tour step!"}
• ga-tracking-id: The google analytics tracking ID to use - see the Analytics page for info on how to find this
• title: Unused
• logo: URL (can be relative) to a custom logo to display in the main app bar
• navigationDrawerLogo: An object which must contain the following properies, which configures the logo shown at the bottom of the navigation menu
  • light: The logo to display when in light mode
  • dark: The logo to display when in dark mode
  • altTxt: Alt text to describe the logo
• primaryColour: Accepts a string with a HTML colour/hex colour code to use as the primary colour to replace the default dark blue
• adminPageDefaultTab: Accepts a string for a potential alterative starting tab for the admin page. For anything except maintenance, this requires a plugin which adds an admin tab
• contactUsAccessibilityFormUrl: Link to a form (usually a microsoft office 365 form) for us to embed in the accessibility page so we can gather feedback