Skip to content

Commit f3ef263

Browse files
committed
Add missing branding config to docs
Mostly copied from the code, with some additions from matrix-org/matrix-authentication-service#2325
1 parent 98f2776 commit f3ef263

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/reference/configuration.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -772,6 +772,37 @@ upstream_oauth2:
772772
#template: "@{{ user.preferred_username }}"
773773
```
774774

775+
## `branding`
776+
777+
Configuration section for tweaking the branding of the service.
778+
779+
```yaml
780+
branding:
781+
# A human-readable name. Defaults to the server's address.
782+
#service_name:
783+
784+
# Link to a privacy policy, displayed in the footer of web pages and
785+
# emails. It is also advertised to clients through the `op_policy_uri`
786+
# OIDC provider metadata.
787+
#policy_uri:
788+
789+
# Link to a terms of service document, displayed in the footer of web
790+
# pages and emails. It is also advertised to clients through the
791+
# `op_tos_uri` OIDC provider metadata.
792+
#
793+
# This also adds a mandatory checkbox during registration. The value of
794+
# this config item will be stored in the `user_terms` table to indicate
795+
# which ToS document the user accepted. Note that currently changing this
796+
# value will not force existing users to re-accept terms.
797+
#tos_uri:
798+
799+
# Legal imprint, displayed in the footer in the footer of web pages and emails.
800+
#imprint:
801+
802+
# Logo displayed in some web pages.
803+
#logo_uri:
804+
```
805+
775806
## `experimental`
776807

777808
Settings that may change or be removed in future versions.

0 commit comments

Comments
 (0)