Repository navigation
Expand file tree
/
Copy pathconfig.example.yaml
More file actions
212 lines (208 loc) · 11.7 KB
/
Copy pathconfig.example.yaml
File metadata and controls
212 lines (208 loc) · 11.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# Structured runtime configuration (docs/02 §6, §11). Copy to config.yaml and
# point CONFIG_FILE at it. This file owns the nested maps — the OIDC claim
# mapping and the branding theme — which environment variables intentionally
# CANNOT override (env overrides only top-level scalars). Secrets stay in env.
#
# Everything below shows the built-in defaults (the UOS skin), except the OIDC
# role block, which shows the UOS launch deployment's two-role mapping (the
# built-in default is a three-role example). A fork re-skins and re-points by
# editing this one file and restarting — no recompile.
#
# ONE EXCEPTION: FONT FILES (issue #214). Colours, logos, the favicon and the
# watermark are all runtime — config values and mounted assets. Typography is
# half: `branding.fonts` SELECTS a family at runtime, but the face itself is an
# npm dependency bundled into the SPA at build time, and there is no mount for
# a font file. So you can point a role at a bundled face or at a system stack
# without recompiling; deploying your own licensed corporate face means forking,
# adding the package, and rebuilding the image. See branding.fonts below.
# OIDC is provider-agnostic: discovery does the rest, so the same code works with
# Keycloak, Authentik, Zitadel, Auth0, Entra, etc. (docs/02 §6).
#
# Back-channel logout (logout at the IdP ends wolke sessions) needs no config
# here: register PUBLIC_URL + /auth/backchannel-logout as the client's
# back-channel logout URL at the IdP — see docs/oidc-keycloak.md.
oidc:
# issuer_url / client_id / client_secret / scopes are scalars — set via env
# (OIDC_ISSUER_URL, …) in deployments. Shown here for reference.
scopes: [openid, profile, email]
# Which claim carries affiliation, and how its values map to roles.
#
# THIS BLOCK DEFINES THE ROLE SET. The roles are the distinct slugs in
# values ∪ precedence ∪ {default} — there is no separate role list. Slugs
# match [a-z0-9-]{1,32}; `all` is reserved (the announcement audience meaning
# everyone); a violation fails startup. More than five roles works but logs a
# warning: the per-role admin screens are designed for a handful.
#
# Shown here: the UOS deployment, whose IdM can only distinguish students from
# employees. (The *built-in* defaults are a three-role example —
# faculty→teacher, employee/member→staff, student→student — so an unmounted
# config still runs.) Supplying this block replaces the built-in one WHOLE —
# claim, values, precedence, default and labels together — so set all of it,
# not just the keys you want to change.
role:
claim: eduPersonAffiliation
values: # claim value -> role slug
student: student
employee: staff
precedence: [staff, student] # if several match, first wins
default: student # if none match
labels: # optional; default = capitalized slug
student: { de: "Studierende", en: "Students" }
staff: { de: "Mitarbeitende", en: "Staff" }
# How to detect a dashboard admin (supports a nested claim path).
admin:
claim: groups
match: dashboard-admins
# Service visibility — restricted categories (docs/specs/service-visibility.md;
# issues #34, #121). A category is public unless an admin restricts it to one of
# the groups below, and a restricted category hides itself AND every service in
# it from anyone who does not hold that group. Membership comes from the IdP:
# each entry maps a (possibly nested) claim path and the value that grants it,
# exactly like oidc.admin, and it is re-derived on every login — so removing the
# group at the IdP revokes access at the next login
# (docs/runbooks/grant-visibility-group.md).
#
# Validated at startup like oidc.role: slug [a-z0-9-]{1,32}, unique, not `all`,
# not a role slug; claim and match are required. `label` is optional (defaults
# to the capitalized slug) and names the group in the admin category editor.
# Leave the list out (the default) and every category is public.
#
# There is deliberately nothing here for "experimental" services: that is the
# `beta` tag, which every deployment already has, revealed per user by the
# "Beta-Dienste anzeigen" switch in the account menu. No config, no restart.
visibility: []
# - slug: it-infra
# label: { de: "IT-Infrastruktur", en: "IT infrastructure" }
# claim: groups # nested dot-paths work too, e.g. realm_access.roles
# match: it-service-admins # membership in this group ⇒ the slug
# Branding / theme — applied by the SPA as CSS variables at runtime. Keep the
# token NAMES stable (docs/03 §2); only values change. The brand hex values are
# read from the mockups and are still TBD against the UOS Corporate Design
# manual (concept §8.1).
branding:
product_name: "wolke"
org_name: "Universität Osnabrück"
logo_light: /branding/logo-light.svg
logo_dark: /branding/logo-dark.svg
favicon: /branding/favicon.svg
# Decorative institution mark in the launcher background (issues #174, #187):
# a large, faint, accent-tinted backdrop scaled to the viewport height and
# cropped by the canvas edges, behind the opaque tiles. OFF by
# default, and deliberately so — the SPA renders no element at all while this
# is empty, which is what keeps a missing or unreachable file (a branding
# mount without it, or an installed PWA offline) from leaving an unmasked
# block on the page. To opt in, drop a `watermark.svg` into the mounted
# branding dir and uncomment the line below. Use a single-colour silhouette
# with a transparent background: the file is used as a CSS mask, so only its
# alpha matters — the colour always comes from the `accent` theme token.
# Must be a same-origin path, not an absolute URL: the content security policy
# allows img-src 'self', so a browser would refuse to load a mark hosted
# elsewhere. The server rejects an absolute URL at startup rather than let it
# fail silently in the page.
# watermark: /branding/watermark.svg
default_locale: de
# Legal footer links (institution-specific). Leave empty to hide a link.
imprint_url: "https://www.uni-osnabrueck.de/impressum/"
privacy_url: "https://www.uni-osnabrueck.de/datenschutz/"
# Right-aligned feedback link in the footer (env: FEEDBACK_URL). An http(s) URL
# or an email / mailto: address. Empty hides it.
feedback_url: ""
# Renames that link, for a deployment pointing it at a ticket system, a help
# desk or a contact form rather than at feedback (issue #222). Localized like
# every other user-facing string, and file-only: it is a map, so there is no
# env override.
#
# Leave it out (or empty) to keep the built-in "Feedback" — that is the
# default and changes nothing. Filling only one language is fine: a reader of
# the other gets the language that *is* filled, not the built-in label, which
# is what a deployment that renamed the link and translated half of it wants.
#
# Note that this names the link, it does not enable it: with feedback_url
# empty there is no link to name and nothing renders.
# feedback_label:
# de: "Störung melden"
# en: "Report a problem"
# Top-bar quick actions (env: BOT_URL / HELP_URL). Each button is hidden when
# empty. bot_url opens a chatbot in a new tab; help_url opens an http(s) URL in
# a new tab, or a phone number / tel: link (opens the dialer on a phone).
bot_url: ""
help_url: ""
# Link to the institution's news site, shown at the foot of the notification
# panel behind the bell (env: NEWS_URL). Empty hides it. http(s) only — news
# is a website, so a mailto:/tel:/relative value fails at startup rather than
# rendering a dead link.
news_url: ""
# Embedded assistant chat widget (launcher mode), e.g. eule
# (github.com/virtUOS/eule). Active only when BOTH are set; supersedes the
# bot_url top-bar link. The widget URL's origin doubles as the widget's
# gateway base URL and is added to the CSP (script-src/connect-src). The
# dashboard's own origin must be listed in the bot's embedding
# allowed_origins on the assistant side, or its API will refuse (CORS).
# (env: ASSISTANT_WIDGET_URL / ASSISTANT_BOT_ID)
assistant_widget_url: "" # e.g. "https://assistant.example.edu/widget.js"
assistant_bot_id: "" # e.g. "echo"
# The launcher greeting closes with a full stop set in the `primary` token
# (issue #220) — punctuation only, never the salutation or the name. Set this
# to false to keep the stop and drop the colour.
#
# Unlike everything else added around it, this defaults to TRUE: the accent
# uses YOUR primary, so a re-skinned deployment gets its own brand colour
# rather than ours, and there would be nothing to opt into. Note that in dark
# the default pairing (#C2355C on #161618) measures 3.4:1 — enough for text at
# the greeting's size (27/36px), not enough for body copy, which is why the
# accent is a single glyph.
greeting_accent: true
# Typography (issue #214). Two roles, each a complete CSS font stack; they
# become the --font-body / --font-display variables. NOT per-theme: a skin
# re-colours across light and dark, it does not re-face, so there is one value
# per role rather than a light/dark pair.
#
# You are SELECTING a family, not supplying one. The stack may name a face the
# build bundles (today: Hanken Grotesk Variable) or any face the user's device
# has — a system stack like `system-ui, sans-serif` needs nothing shipped and
# always resolves. It may NOT name a face this build does not carry and the
# device does not have: there is no way to mount a font file, so that stack
# would simply fall through to its fallback. Shipping your own corporate face
# is a fork + rebuild (see the header).
#
# Every stack must END IN A GENERIC FAMILY (sans-serif, serif, monospace,
# system-ui, …) — startup fails otherwise. That is the rule that keeps a
# missing face degrading to a system font instead of to the browser default.
fonts:
body: "'Hanken Grotesk Variable', system-ui, -apple-system, sans-serif"
# The greeting and the admin page title. Same stack by default: the display
# role is told apart by weight and size, not by a second face (issue #213 —
# the UOS web corporate design permits no serif).
display: "'Hanken Grotesk Variable', system-ui, -apple-system, sans-serif"
# Any token from the docs/03 §2 table may be set in either map — the five
# shown are just the ones most skins change. The rest (surface_2, border,
# text_muted, info, warning, success, danger) fall back to the bundled
# defaults when omitted. Payload keys use `_`; they become --kebab-case CSS
# variables (primary_hover → --primary-hover).
theme:
light:
primary: "#A6093D"
primary_hover: "#8A0732"
accent: "#F2C879" # the warm wash: segmented pill, tile hover, canvas tint
favorite: "#F2C879" # the favourited-service star; defaults to accent
surface: "#F4F4F5"
text: "#18181B"
dark:
primary: "#C2355C"
primary_hover: "#A6093D"
accent: "#F2C879"
favorite: "#F2C879"
surface: "#1E1E21"
text: "#F4F4F5"
# Backups are NOT configured here. The restic/S3 backup sidecar in
# compose.prod.yaml is a separate process that never reads this file — its
# settings are all scalars and secrets, so they live in the environment:
#
# RESTIC_REPOSITORY, RESTIC_PASSWORD, AWS_ACCESS_KEY_ID,
# AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION,
# BACKUP_INTERVAL_SECONDS (default 86400), BACKUP_RUN_ON_START (true),
# BACKUP_KEEP_DAILY (7), BACKUP_KEEP_WEEKLY (4), BACKUP_KEEP_MONTHLY (6),
# BACKUP_TAG (wolke-db), BACKUP_INIT_REPO (true), BACKUP_PROBE_TIMEOUT (45)
#
# See .env.example for the annotated block, README → "Backups" for the how, and
# docs/runbooks/restore-postgres.md for getting the data back.