Project

General

Profile

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

Timothée Floure, 03/10/2020 09:30 PM
Add link to admin UI

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 5 Timothée Floure
"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, "Riot":https://about.riot.im/.
14 1 Timothée Floure
15 5 Timothée Floure
"Riot's features page"https://about.riot.im/features gives you a good overview of Matrix's possibilities.
16
17
h2. FAQ
18 1 Timothée Floure
19
h3. Q: How many users can I have? What are the resources allocated to my matrix server?
20 3 Timothée Floure
21 1 Timothée Floure
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).
22 5 Timothée Floure
23 3 Timothée Floure
h3. Q: What server name will I get?
24
25 8 Timothée Floure
You can either use your own domain name (see below) or ask us for $ORGANIZATION.0co2.cloud. 
26 1 Timothée Floure
27 2 Timothée Floure
h3. Q: Can I use a custom domain name?
28 3 Timothée Floure
29 2 Timothée Floure
Yes! You will have to give us two domain names:
30
31
* (A) The base server name, used in the MXIDs (e.g. ungleich.ch).
32
  - You will have to serve a file containing *{"m.server": "address_of_B:443"}* on *.well-known/matrix/server*. Example: <pre>$ curl https://ungleich.ch/.well-known/matrix/server
33 8 Timothée Floure
{"m.server": "ungleich.matrix.ungleich.cloud:443"}</pre>
34 1 Timothée Floure
* (B) An address for the Matrix server and client (e.g. matrix.ungleich.ch).
35
  - You will have to add a DNS A record poiting to 185.203.112.54
36 2 Timothée Floure
  - You will have to add a DNS AAAA record pointing to an IPv6 address dedicated to your deployment.
37
38 3 Timothée Floure
h3. Q: What server implementation and version do you use?
39 1 Timothée Floure
40
We use the "synapse reference homeserver":https://github.com/matrix-org/synapse/ package "provided by the buster-backports repository":https://packages.debian.org/buster-backports/matrix-synapse.
41 2 Timothée Floure
42 3 Timothée Floure
h3. Q: What client can I use? Do you recommend one?
43 1 Timothée Floure
44
We recommend and provide you a web version of the "Riot client":https://about.riot.im/ (desktop and mobile) but you can use "any matrix client":https://matrix.org/clients/.
45
46 3 Timothée Floure
h3. Q: Can I set option X in synapse/riot?
47 2 Timothée Floure
48 3 Timothée Floure
Yes! Contact the ungleich support with the requested changes, which we will apply to the deployment configuration of your instance.
49 2 Timothée Floure
50 3 Timothée Floure
h3. Q: Do you provide a TURN server for VoIP?
51 2 Timothée Floure
52 7 Timothée Floure
Yes.
53 3 Timothée Floure
54 6 Timothée Floure
h3. Q: What are application services can I use?
55 3 Timothée Floure
56 6 Timothée Floure
We support bridging to other services (IRC, Matrix, Telegram, Slack, ...) via "matterbridge":https://github.com/42wim/matterbridge, deployed on demand.
57 9 Timothée Floure
58
59
h3. Q: If I do not use an LDAP directory, can I still manage my users?
60
61
Yes! We provide you with a management UI on https://admin.matrix.ungleich.cloud.