~fnux/matrix-cdist-types

ref: refs/heads/master matrix-cdist-types/type/__matrix_riot/man.rst -rw-r--r-- 1.3 KiB
880a06f8Timothée Floure Adapt doc and CI for non-singleton riot type 1 year, 2 months ago
                                                                                
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
cdist-type__matrix_riot(7)
======================

NAME
----
cdist-type__matrix_riot - Install and configure Riot, a web Matrix client.


DESCRIPTION
-----------
This type install and configure the Riot web client.


REQUIRED PARAMETERS
-------------------
install_dir
  Root directory of Riot's static files.

version
  Release of Riot to install.

OPTIONAL PARAMETERS
-------------------
default_server_name
  Matrix homeserver to connect to, defaults to 'matrix.org'.

brand
  Web UI branding, defaults to 'Riot'.

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://riot.im/privacy'.

cookie_policy_url
  Defaults to 'https://matrix.org/docs/guides/riot_im_cookie_policy'.


EXAMPLES
--------

.. code-block:: sh

    __matrix_riot my-riot --install_dir /var/www/riot-web --version 1.5.6


SEE ALSO
--------
- `cdist-type__matrix_synapse(7) <cdist-type__matrix_synapse.html>`_


AUTHORS
-------
Timothée Floure <timothee.floure@ungleich.ch>


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.