Settings

This page covers the Settings area, which every signed-in user has, and the Gateway settings and Project pages under Gateway, which are for administrators. It also says which settings are yours and which are the gateway's.

Personal settings and gateway settings

Kind	Stored	Who can change it
Preferences (colour mode, density, sidebar side, watchlist)	Per user, in the gateway database, so they follow you to every computer	Each user, their own
Logo	In the browser, on this computer only	Anyone, for that browser
App settings (open the start screen on launch, project directory)	Once per gateway	Engineer; the project directory needs admin

Appearance

Open Settings, then Appearance. "These apply to your account, on every computer you sign in from."

• Colour mode: light, dark or follow the system. Dark is meant for long shifts; light suits bright rooms and printouts.
• Density: compact, normal or comfortable. Tables and panels scale together.
• Status colours are shown for reference and cannot be changed, so anyone can read any screen.

The API accepts more than the page shows (accent, radius, corner shape, font); see the table under API.

Sidebar

Open Settings, then Sidebar. Side chooses which side of the screen the navigation sits on. It stays open; on a phone it slides in from that side.

Logo

Open Settings, then Logo. Under Brand you choose what the sidebar shows. The Scadex wordmark is the default. This setting lives in this browser only, not in your account.

Gateway settings

Open Gateway, then System, then Gateway settings. The page is titled Gateway ("The server this dashboard is connected to"). Only administrators can see it.

Status

Fact	Meaning
Address	The host this dashboard is served from
Live link	The state of the dashboard's /sync socket
Version	The gateway's version, from @gateway.version
Uptime	From @gateway.uptime
Modules	How many are running, with a link to Modules

Performance ("How hard the gateway process is working. Updates every 10 seconds."): Memory in use (with the managed heap), CPU time used across the processors, Threads (with busy pool threads), Runtime (.NET version) and System (OS). These come from GET /api/v1/admin/diagnostics; the same figures are published as the @gateway.performance.* tags described in Logs and diagnostics.

History storage ("as the historian module reports it"): State, Retention in days, Holds data from, Tags recorded, Behind the stream and, when there is one, Last cleanup failed. See Historian.

Project

Open Gateway, then System, then Project. Screens and start screens are stored as JSON files, so you can keep them under version control.

1. Enter the Project directory: a path on the gateway's host.
2. Save. The gateway creates or opens the folder; a path it cannot open answers 400 "Cannot open project directory: …".
3. Run git init in that folder to start tracking changes to your HMI.

Setting the project directory needs the admin role, because it decides where the gateway reads and writes files on its host. Screens describes what goes in it.

Limits

• The logo is per browser, not per gateway: there is no gateway-wide branding setting yet.
• Light and dark theme names (lightTheme, darkTheme) are stored but the Appearance page offers only the colour mode.
• One project directory per gateway.

API

The full reference is in Other APIs.

Route	Role	Purpose
GET /api/v1/preferences	viewer (cookie session only)	Your preferences
PATCH /api/v1/preferences	viewer (cookie session only)	Change any of the fields below; unknown values are ignored
GET /api/v1/app-settings	viewer	openStartOnLaunch, projectDir, startScreenId (read-only history)
PATCH /api/v1/app-settings	engineer; admin for projectDir	{openStartOnLaunch?, projectDir?}; an empty projectDir clears it

Preference fields and their accepted values:

Field	Values
mode	light, dark, system
accent	default, teal, blue, violet, rose, amber, emerald, pink, cyan, orange, indigo
density	compact, normal, comfortable
radius	none, sm, default, lg, xl
cornerShape	squircle, round
font	system, serif, mono
sidebarSide	left, right
sidebarVariantOpen, sidebarVariantCollapsed	sidebar, floating, inset
sidebarCollapsible	offcanvas, icon, none
watchlist	Up to 24 tag paths, each up to 512 characters; shown on Home, Watchlist
lightTheme, darkTheme	Free text

Preferences are personal, so API keys cannot read or change them: the routes accept the cookie session only.