PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3
element-web/docs/config.md
Travis Ralston 65adc3ba93
Add a config.json option to skip the built-in Jitsi welcome screen (#21190) 
* Add a config.json option to skip the built-in Jitsi welcome screen

Stop-gap for https://github.com/vector-im/element-web/issues/20503

* Spelling
2022-02-28 11:02:03 -07:00

18 KiB
Raw Blame History

Configuration

You can configure the app by copying config.sample.json to config.json and customising it:

For a good example, see https://develop.element.io/config.json.

  1. default_server_config sets the default homeserver and identity server URL for Element to use. The object is the same as returned by https://<server_name>/.well-known/matrix/client, with added support for a server_name under the m.homeserver section to display a custom homeserver name. Alternatively, the config can contain a default_server_name instead which is where Element will go to get that same object, although this option is deprecated - see the .well-known link above for more information on using this option. Note that the default_server_name is used to get a complete server configuration whereas the server_name in the default_server_config is for display purposes only.

    • Note: The URLs can also be individually specified as default_hs_url and default_is_url, however these are deprecated. They are maintained for backwards compatibility with older configurations. default_is_url is respected only if default_hs_url is used.
    • Element will fail to load if a mix of default_server_config, default_server_name, or default_hs_url is specified. When multiple sources are specified, it is unclear which should take priority and therefore the application cannot continue.
    • As of Element 1.4.0, identity servers are optional. See Identity servers below.

  2. sso_redirect_options: Optionally defines how Element will behave with a server which supports Single Sign On (SSO). By default, Element will do nothing special and simply show a button where needed for the user to click to navigate to the SSO system. This behaviour can be tuned with the config options below (as properties of the sso_redirect_options object). None of the options apply if Element thinks the user is already logged in, and similarly Element will assume the default server supports SSO if these redirect options are used.

    • immediate: When true (default false), Element will automatically redirect all unauthenticated users to the SSO system to log in regardless of how they reached the app. This overrides the use of other redirect options.
    • on_welcome_page: When true (default false), Element will automatically redirect all unauthenticated users to the SSO to log in if the user lands on the welcome page or no specific page. For example, https://app.element.io/#/welcome and https://app.element.io would redirect if set up to use this option. This can be useful to maintain guest experience until an account is needed.

  3. features: Lookup of optional features that may be force-enabled (true) or force-disabled (false). When features are not listed here, their defaults will be used, and users can turn them on/off if showLabsSettings allows them to. The available optional experimental features vary from release to release and are documented. The feature flag process is documented as well.

  4. showLabsSettings: Shows the "labs" tab of user settings. Useful to allow users to turn on experimental features they might not otherwise have access to.

  5. brand: String to pass to your homeserver when configuring email notifications, to let the homeserver know what email template to use when talking to you.

  6. branding: Configures various branding and logo details, such as:

    1. welcomeBackgroundUrl: An image to use as a wallpaper outside the app during authentication flows. If an array is passed, an image is chosen randomly for each visit.
    2. authHeaderLogoUrl: An logo image that is shown in the header during authentication flows
    3. authFooterLinks: a list of links to show in the authentication page footer: [{"text": "Link text", "url": "https://link.target"}, {"text": "Other link", ...}]

  7. reportEvent: Configures the dialog for reporting content to the homeserver admin.

    1. adminMessageMD: An extra message to show on the reporting dialog to mention homeserver-specific policies. Accepts Markdown.

  8. integrations_ui_url: URL to the web interface for the integrations server. The integrations server is not Element and normally not your homeserver either. The integration server settings may be left blank to disable integrations.

  9. integrations_rest_url: URL to the REST interface for the integrations server.

  10. integrations_widgets_urls: list of URLs to the REST interface for the widget integrations server.

  11. bug_report_endpoint_url: endpoint to send bug reports to (must be running a https://github.com/matrix-org/rageshake server). Bug reports are sent when a user clicks "Send Logs" within the application. Bug reports can be disabled/hidden by leaving the bug_report_endpoint_url out of your config file.

  12. uisi_autorageshake_app: If users enable the Labs flag "Automatically send debug logs on decryption errors", rageshakes submitted by that feature can be given a custom app name so that the rageshake server can file them in a separate issue tracker. If this field is absent from the config, the app name for decryption error rageshakes will be "element-web" just like for manually-submitted rageshakes.

    If bug_report_endpoint_url is set to Element's rageshake server, then this field should be set to "element-auto-uisi" as in config.sample.json. If bug_report_endpoint_url is left out, this field has no effect and can be left out as well. If you are using your own rageshake server, set this field in accordance with your rageshake server configuration.

  13. roomDirectory: config for the public room directory. This section is optional.

  14. roomDirectory.servers: List of other homeservers' directories to include in the drop down list. Optional.

  15. default_theme: name of theme to use by default (e.g. 'light')

  16. update_base_url (electron app only): HTTPS URL to a web server to download updates from. This should be the path to the directory containing macos and win32 (for update packages, not installer packages).

  17. DEPRECATED: piwik: Analytics can be disabled by setting piwik: false or by leaving the piwik config option out of your config file. If you want to enable analytics, set piwik to be an object containing the following properties:

    1. url: The URL of the Piwik instance to use for collecting analytics
    2. whitelistedHSUrls: a list of HS URLs to not redact from the analytics
    3. whitelistedISUrls: a list of IS URLs to not redact from the analytics
    4. siteId: The Piwik Site ID to use when sending analytics to the Piwik server configured above

  18. welcomeUserId: the user ID of a bot to invite whenever users register that can give them a tour

  19. embeddedPages: Configures the pages displayed in portions of Element that embed static files, such as:

    1. welcomeUrl: Initial content shown on the outside of the app when not logged in. Defaults to welcome.html supplied with Element.
    2. homeUrl: Content shown on the inside of the app when a specific room is not selected. By default, no home page is configured. If one is set, a button to access it will be shown in the top left menu.
    3. loginForWelcome: Overrides welcomeUrl to make the welcome page be the same page as the login page when true. This effectively disables the welcome page.

  20. defaultCountryCode: The ISO 3166 alpha2 country code to use when showing country selectors, like the phone number input on the registration page. Defaults to GB if the given code is unknown or not provided.

  21. settingDefaults: Defaults for settings that support the config level, as an object mapping setting name to value (note that the "theme" setting is special cased to the default_theme in the config file).

  22. disable_custom_urls: disallow the user to change the default homeserver when signing up or logging in.

  23. permalinkPrefix: Used to change the URL that Element generates permalinks with. By default, this is "https://matrix.to" to generate matrix.to (spec) permalinks. Set this to your Element instance URL if you run an unfederated server (eg: "https://element.example.org").

  24. jitsi: Used to change the default conference options. Learn more about the Jitsi options at jitsi.md.

    1. preferredDomain: The domain name of the preferred Jitsi instance. Defaults to meet.element.io. This is used whenever a user clicks on the voice/video call buttons - integration managers may use a different domain. This setting is ignored if your homeserver provides /.well-known/matrix/client in its well-known location, and the JSON file at that location has a key m.vector.riot.jitsi. In this case, the configuration found in the well-known location is used instead.

  25. jitsiWidget: Options to change the built-in Jitsi widget behaviour. jitsi controls how the widget gets created, but not how it behaves.

    1. skipBuiltInWelcomeScreen: If you'd like to skip the default "Join Conference" behaviour, set this to true. This will cause the widget to assume that there's a Jitsi welcome screen set up and point the user towards that. Note that this can cause the camera/microphone to flicker as "in use" while Jitsi tests the devices.

  26. enable_presence_by_hs_url: The property key should be the URL of the homeserver and its value defines whether to enable/disable the presence status display from that homeserver. If no options are configured, presence is shown for all homeservers.

  27. disable_guests: Disables guest access tokens and auto-guest registrations. Defaults to false (guests are allowed).

  28. disable_login_language_selector: Disables the login language selector. Defaults to false (language selector is shown).

  29. disable_3pid_login: Disables 3rd party identity options on login and registration form Defaults to false (3rd party identity options are shown).

  30. default_federate: Default option for room federation when creating a room Defaults to true (room federation enabled).

  31. desktopBuilds: Used to alter promotional links to the desktop app. By default the builds are considered available and accessible from https://element.io. This config option is typically used in the context of encouraging encrypted message search capabilities (Seshat). All the options listed below are required if this option is specified.

    1. available: When false, the desktop app will not be promoted to the user.
    2. logo: An HTTP URL to the avatar for the desktop build. Should be 24x24, ideally an SVG.
    3. url: An HTTP URL for where to send the user to download the desktop build.

  32. mobileBuilds: Used to alter promotional links to the mobile app. By default the builds are considered available and accessible from https://element.io. This config option is typically used in a context of encouraging the user to try the mobile app instead of a mobile/incompatible browser.

    1. ios: The URL to the iOS build. If null, it will be assumed to be not available. If not set, the default element.io builds will be used.
    2. android: The URL to the Android build. If null, it will be assumed to be not available. If not set, the default element.io builds will be used.
    3. fdroid: The URL to the FDroid build. If null, it will be assumed to be not available. If not set, the default element.io builds will be used.

  33. mobileGuideToast: Whether to show a toast a startup which nudges users on iOS and Android towards the native mobile apps. The toast redirects to the mobile guide if they accept. Defaults to false.

  34. audioStreamUrl: If supplied, show an option on Jitsi widgets to stream audio using Jitsi's live streaming feature. This option is experimental and may be removed at any time without notice.

  35. voip: Behaviour related to calls

    1. obeyAssertedIdentity: If set, MSC3086 asserted identity messages sent on VoIP calls will cause the call to appear in the room corresponding to the asserted identity. This must only be set in trusted environments.

  36. posthog: Posthog integration config. If not set, Posthog analytics are disabled.

    1. projectApiKey: The Posthog project API key
    2. apiHost: The Posthog API host

  37. sentry: Sentry configuration for rageshake data being sent to sentry.

    1. dsn: the Sentry DSN
    2. environment: (optional) The Environment to pass to sentry

  38. map_style_url: Map tile server style URL for location sharing. e.g. 'https://api.maptiler.com/maps/streets/style.json?key=YOUR_KEY_GOES_HERE' This setting is ignored if your homeserver provides /.well-known/matrix/client in its well-known location, and the JSON file at that location has a key m.tile_server (or the unstable version org.matrix.msc3488.tile_server). In this case, the configuration found in the well-known location is used instead.

  39. analyticsOwner: The entity that analytics data is being sent to. Used in copy when explaining to the user where data is being sent. If not set, defaults to brand.

  40. defaultDeviceDisplayName: The default device display name to use for new logins and registrations. If not set then a calculated version will be used.

Note that index.html also has an og:image meta tag that is set to an image hosted on riot.im. This is the image used if links to your copy of Element appear in some websites like Facebook, and indeed Element itself. This has to be static in the HTML and an absolute URL (and HTTP rather than HTTPS), so it's not possible for this to be an option in config.json. If you'd like to change it, you can build Element, but run RIOT_OG_IMAGE_URL="http://example.com/logo.png" yarn build. Alternatively, you can edit the og:image meta tag in index.html directly each time you download a new version of Element.

Identity servers

The identity server is used for inviting other users to a room via third party identifiers like emails and phone numbers. It is not used to store your password or account information.

As of Element 1.4.0, all identity server functions are optional and you are prompted to agree to terms before data is sent to the identity server.

Element will check multiple sources when looking for an identity server to use in the following order of preference:

  1. The identity server set in the user's account data
    • For a new user, no value is present in their account data. It is only set if the user visits Settings and manually changes their identity server.
  2. The identity server provided by the .well-known lookup that occurred at login
  3. The identity server provided by the Riot config file

If none of these sources have an identity server set, then Element will prompt the user to set an identity server first when attempting to use features that require one.

Currently, the only two public identity servers are https://vector.im and https://matrix.org, however in the future identity servers will be decentralised.

Desktop app configuration

See https://github.com/vector-im/element-desktop#user-specified-configjson

UI Features

Parts of the UI can be disabled using UI features. These are settings which appear under settingDefaults and can only be true (default) or false. When false, parts of the UI relating to that feature will be disabled regardless of the user's preferences.

Currently, the following UI feature flags are supported:

  • UIFeature.urlPreviews - Whether URL previews are enabled across the entire application.
  • UIFeature.feedback - Whether prompts to supply feedback are shown.
  • UIFeature.voip - Whether or not VoIP is shown readily to the user. When disabled, Jitsi widgets will still work though they cannot easily be added.
  • UIFeature.widgets - Whether or not widgets will be shown.
  • UIFeature.flair - Whether or not community flair is shown in rooms.
  • UIFeature.communities - Whether or not to show any UI related to communities. Implicitly disables UIFeature.flair when disabled.
  • UIFeature.advancedSettings - Whether or not sections titled "advanced" in room and user settings are shown to the user.
  • UIFeature.shareQrCode - Whether or not the QR code on the share room/event dialog is shown.
  • UIFeature.shareSocial - Whether or not the social icons on the share room/event dialog are shown.
  • UIFeature.identityServer - Whether or not functionality requiring an identity server is shown. When disabled, the user will not be able to interact with the identity server (sharing email addresses, 3PID invites, etc).
  • UIFeature.thirdPartyId - Whether or not UI relating to third party identifiers (3PIDs) is shown. Typically this is considered "contact information" on the homeserver, and is not directly related to the identity server.
  • UIFeature.registration - Whether or not the registration page is accessible. Typically useful if accounts are managed externally.
  • UIFeature.passwordReset - Whether or not the password reset page is accessible. Typically useful if accounts are managed externally.
  • UIFeature.deactivate - Whether or not the deactivate account button is accessible. Typically useful if accounts are managed externally.
  • UIFeature.advancedEncryption - Whether or not advanced encryption options are shown to the user.
  • UIFeature.roomHistorySettings - Whether or not the room history settings are shown to the user. This should only be used if the room history visibility options are managed by the server.
  • UIFeature.TimelineEnableRelativeDates - Display relative date separators (eg: 'Today', 'Yesterday') in the timeline for recent messages. When false day dates will be used.