cdist-type__matrix_element(7)¶
NAME¶
cdist-type__matrix_element - Install and configure Element, a web Matrix client.
DESCRIPTION¶
This type install and configure the Element web client.
REQUIRED PARAMETERS¶
- install_dir
Root directory of Element’s static files.
- version
Release of Element to install.
OPTIONAL PARAMETERS¶
- default_server_name
Name of matrix homeserver to connect to, defaults to ‘matrix.org’.
- default_server_url
URL of matrix homeserver to connect to, defaults to ‘https://matrix-client.matrix.org’.
- identity_server_url
URL of matrix identity server to connect to, defaults to ‘https://vector.im’. See element documentation <https://github.com/vector-im/element-web/blob/develop/docs/config.md#identity-servers>_ for details.
- owner
Owner of the deployed files, passed to chown. Defaults to ‘root’.
- brand
Web UI branding, defaults to ‘Element’.
- branding_auth_header_logo_url
A logo image that is shown in the header during authentication flows.
- branding_welcome_background_url
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.
- branding_auth_footer_links
a list of links to show in the authentication page footer: [{“text”: “Link text”, “url”: “https://link.target”}, {“text”: “Other link”, …}]
- default_country_code
ISO 3166 alpha2 country code to use when showing country selectors, such as phone number inputs. Defaults to GB.
- privacy_policy_url
Defaults to ‘https://element.io/privacy’.
- cookie_policy_url
Defaults to ‘https://matrix.org/docs/guides/element_im_cookie_policy’.
- jitsi_domain
Domain name of preferred Jitsi instance (default is jitsi.element.im). This is used whenever a user clicks on the voice/video call buttons.
- homepage
Path to custom homepage, displayed once logged in.
- welcomepage
Path to custom welcome (= login) page.
- custom_asset
Serve a file a the top-level directory (e.g. /my-custom-logo.svg). Can be specified multiple times.
BOOLEAN PARAMETERS¶
- disable_custom_urls
Disallow the user to change the default homeserver when signing up or logging in.
EXAMPLES¶
__matrix_element my-element --install_dir /var/www/element-web --version 1.5.6
SEE ALSO¶
COPYING¶
Copyright (C) 2019 Timothée Floure. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.