Project

General

Profile

Ungleich Matrix-as-a-Service (MaaS) » History » Version 52

Sanghee Kim, 10/17/2023 12:26 PM

1 1 Timothée Floure
h1. Ungleich Matrix-as-a-Service (MaaS)
2
3 3 Timothée Floure
{{toc}}
4
5 8 Timothée Floure
*%{color:green}This document concerns end-users/customers. See [[The ungleich Matrix infrastructure]] page for server-side documentation.%*
6 1 Timothée Floure
7
h2. Status
8
9 8 Timothée Floure
This document is *in PRODUCTION*
10 2 Timothée Floure
11
h2. Overview
12
13 51 Sanghee Kim
"Matrix":https://matrix.org/ is an open and decentralized IM system supporting modern features such as end-to-end encryption, message history, bridging to other networks, VoIP and more. It is based a federated structure, similar to what is done with emails: users use a home server as 'gateway' to the network. Our MaaS offer provides you with such a server as well as an hosted web client, "Element":https://element.io/.
14 1 Timothée Floure
15 52 Sanghee Kim
"Element's features page":https://element.io/features gives you a good overview of Matrix's possibilities.
16 5 Timothée Floure
17 25 Sanghee Kim
h2. Domain
18
19 3 Timothée Floure
h3. Q: What server name will I get?
20
21 11 Nico Schottelius
You can either use your own domain name (see below) or ask us for $ORGANIZATION.0co2.cloud.
22 1 Timothée Floure
23 2 Timothée Floure
h3. Q: Can I use a custom domain name?
24 3 Timothée Floure
25 11 Nico Schottelius
Yes! You will have to give us three domain names:
26 1 Timothée Floure
27 13 Nico Schottelius
* a) *the homeserver*: this is where the actual server is running - this can be on domain "A" - in case of ungleich we use *ungleich.matrix.ungleich.cloud* and give away *YOURNAME.matrix.ungleich.cloud* for free
28
* b) *the address of the web client* - this is where people with their webbrowser go to - this should be different from "A". Often this is something like *chat.example.org* or *matrix.example.org*. In case of ungleich this domain is *matrix.ungleich.ch.*
29
* c) *the main matrix domain*: the one you use for users and rooms. This is usually your main domain and is different from A. For ungleich this is *ungleich.ch*. Most people will choose their "main domain", for instance *example.org* here.
30 11 Nico Schottelius
31
You will also need to configure 2 files below *the main matrix domain*
32
33 12 Nico Schottelius
- */.well-known/matrix/server* containing *{"m.server": "homeserver:443"}*.
34 11 Nico Schottelius
       Example: <pre>$ curl https://ungleich.ch/.well-known/matrix/server
35 1 Timothée Floure
{"m.server": "ungleich.matrix.ungleich.cloud:443"}</pre>
36 12 Nico Schottelius
   - */.well-known/matrix/client* containing *{ "m.homeserver": { "base_url": "https://homeserver" } }*. Example: <pre>
37 11 Nico Schottelius
curl https://ungleich.ch/.well-known/matrix/client 
38
{ "m.homeserver": { "base_url": "https://ungleich.matrix.ungleich.cloud" } }
39
</pre>
40 1 Timothée Floure
41 27 Sanghee Kim
42 15 Nico Schottelius
h3. Q: Why can't I use the same domain for everything?
43
44
The home server should be on a different domain to prevent possible XSS (cross site scripting) attacks.
45
You can find details about it on https://github.com/matrix-org/synapse#security-note.
46
47
For this reason we offer YOURNAME.matrix.ungleich.cloud for free for all homeservers.
48
49 16 Nico Schottelius
h3. Q: How many domains do I need for a standard matrix setup?
50
51
Typically 3 domain names are used:
52
53
* The domain that defines your *room and user names* (for ungleich this is *ungleich.ch*)
54 1 Timothée Floure
* The domain that your users type in the web browser to join the chat (for ungleich this is *matrix.ungleich.ch*)
55
* The domain on which your *homeserver* (the server providing the matrix server) is reachable (for ungleich this is *ungleich.matrix.ungleich.cloud*)
56
57
The homeserver needs to be on a different domain than the other two to avoid possible XSS attacks.
58 28 Sanghee Kim
59
h3. Q: Can I change the subdomain after the Matrix setup? 
60
61
No, since your homeserver will federate with the broader network.
62
63 1 Timothée Floure
h2. Registration
64
65
h3. Q: What kind of registration policy could be implemented for a matrix instance?
66
67
You can easily:
68
69
- Close registrations, create users by hand from the admin UI.
70
- Let anyone register.
71
- Use an external source for authentication (e.g. company directory / account system).
72
- Use a token based registration (https://matrix.org/docs/projects/other/matrix-registration)
73 41 Sanghee Kim
- Filter spam users via CAPTCHA (the admin user will need to have a Google account for managing the registration)
74 1 Timothée Floure
75
If your use case is in the above list, you can get in touch with our team to find a fitting solution.
76
77 29 Nico Schottelius
h3. Q: How can I create users if I public signup is disabled?
78
79 30 Sanghee Kim
After setup you will receive a username/password pair from us on a secure channel. You can use this information to login to https://admin.matrix.ungleich.cloud.
80 29 Nico Schottelius
81 1 Timothée Floure
h3. Q: We would like to be able to moderate registration requests. For example, we'll have a list of approved emails to reference against those submitted. Would this be possible?
82
83 30 Sanghee Kim
There is no 'approval' system in matrix/synapse right now. Either:
84 1 Timothée Floure
85
Everyone can register.
86
You register new users via the admin interface.
87
Approval is handled on a third-party service, which provides an authentication backend to matrix/synapse.
88 45 Sanghee Kim
89
h3. Q: We are receiving a lot of spam users in our Matrix. How can we control this at registration?
90
91 50 Sanghee Kim
You could enable CAPTCHA to filter new accounts registration. You can send us your CAPTCHA key following the steps below, and we can change your configuration with it with a small config change fee of 30 CHF. For enabling CAPTCHA you would need a Google account.
92 45 Sanghee Kim
93 46 Sanghee Kim
1. Register a new site at https://www.google.com/recaptcha/admin/create
94 45 Sanghee Kim
95
* Set the label to anything you want
96
* Set the type to reCAPTCHA v2 using the "I'm not a robot" Checkbox option. This is the only type of captcha that works with Synapse.
97 47 Jin-Guk Kwon
* Add the domain of element web(if you have) /  if you don't have element-web, you should public hostname for your server, as set in public\_baseurl, to the list of authorized domains. If you have not set public\_baseurl, use server\_name.
98 45 Sanghee Kim
* Agree to the terms of service and submit.
99
100
2. Copy your site key and secret key and send it to us.
101 26 Sanghee Kim
102 1 Timothée Floure
h2. Encryption
103
104
h3. Q: Are video/audio calls in Matrix End-to-end-encrypted(E2EE)?
105
106
Video & Phone is handled by a jitsi server by default - matrix adds it as an integration, but does not handle video/audio directly. So the answer is: not E2EE for audio/video.
107
108
h3. Q: Does ungleich have access to my Matrix admin UI? How does my chat content stay secure?
109
110
Once you change the initial password we do not have external access to the software anymore but we have access to the underlying server since we manage it: we can read and change things in the database 'by hand' since we have physical access to it. However end-to-end encrypted rooms stay secure. The content is encrypted with the user's keys and to us it will be shown in ciphertext.
111 26 Sanghee Kim
112 36 Sanghee Kim
h2. Configuration changes
113
114
Changing your Matrix configurations after setup requires manual work from our team. The configuration can be supported with following pricing.
115
116 49 Sanghee Kim
* Small configuration change: 30 CHF (ex: adding CAPTCHA to registration for spam control)
117
* Medium configuration change: 70 CHF (ex: adding single sign-on or changing the authentication method)
118 48 Sanghee Kim
* Other configuration changes are charged on hourly basis with an order of a minimum of 1 hour. The rate for Matrix configuration work is 250 CHF per hour.
119 36 Sanghee Kim
120 26 Sanghee Kim
h2. FAQ
121
122
h3. Q: How many users can I have? What are the resources allocated to my matrix server?
123
124
We do not enforce a limit of the number of users: you can do anythign you want as long as you fit the resources allocated to your homeserver. You are provided with 1GB of memory, 1vCPU and 20GB of storage with the base offer, which can be extended on demand (Pricing is the same as ipv6onlyhosting VMs, since that's what we use underneath).
125
126
h3. Q: What server implementation and version do you use?
127
128 42 Jin-Guk Kwon
We use the "synapse reference homeserver":https://github.com/matrix-org/synapse/ package "provided by docker hub.(https://hub.docker.com/r/matrixdotorg/synapse)
129 26 Sanghee Kim
130
h3. Q: What client can I use? Do you recommend one?
131
132 32 Sanghee Kim
We recommend and provide you a web version of the "Element client":https://element.io/ (desktop and mobile) but you can use "any matrix client":https://matrix.org/clients/.
133 26 Sanghee Kim
134
h3. Q: Can I set option X in synapse/riot?
135
136
Yes! Contact the ungleich support with the requested changes, which we will apply to the deployment configuration of your instance.
137
138
h3. Q: Do you provide a TURN server for VoIP?
139
140
Yes.
141
142
h3. Q: What are application services can I use?
143
144
We support bridging to other services (IRC, Matrix, Telegram, Slack, ...) via "matterbridge":https://github.com/42wim/matterbridge, deployed on demand.
145
146
h3. Q: If I do not use an LDAP directory, can I still manage my users?
147
148
Yes! We provide you with a management UI on https://admin.matrix.ungleich.cloud. You will have to use the full address of your matrix homeserver (e.g. ungleich.matrix.ungleich.cloud).
149
150
h3. Q: How can I delete rooms in Matrix?
151
152
To delete a room, simply everybody in the room needs to leave the room. Then the room gets removed from the server. If you are admin, you can kick everybody in the room if you want to force remove the room.
153 33 Sanghee Kim
154
h2. Matrix UI/UX development support program
155
156
On 2020-04-21 we started our new support program to specifically enhance the UI and UX of Matrix. With this program we want to enhance the usability of the web client and the apps.
157
158
h3. How the matrix support program works
159
160
If you want to support UI/UX improvements of Matrix, you can support the work financially with 15 CHF (roughly about 15 USD) as a one time or monthly payment (below 15 CHF is costing too much in transfer fees).
161
To do so, write an email with the subject "I want to support the Matrix UI/UX improvements" to support -at- ungleich.ch and include the amount that you are willing to contribute and whether you want to pay via credit card or wire transfer.
162
Also mention whether you want to be publicly listed as a supporter on this website.
163
164
h3. Development and transparency
165
166
All money that comes in will only be used to finance development and design work related to Matrix. We will continuously update this website with contributions and which tasks we work on.
167
168 34 Sanghee Kim
h3. Why is ungleich doing this?
169 33 Sanghee Kim
170
We at ungleich think that Matrix has one really, really huge edge over almost all other solutions: it is really decentralised and federated. It finally solves the problems of data silos that exists in many places in IT.
171
However we do acknowledge that Matrix can benefit a lot from UI/UX improvements and thus we wanted to create an easy way for anyone to contribute to it.
172 35 Sanghee Kim
173 33 Sanghee Kim
h3. List of tasks / work
174
175
"UI/UX improvement suggestions for matrix":https://redmine.ungleich.ch/issues/7876