Open Infrastructure

h1. Ungleich Matrix-as-a-Service (MaaS)

{{toc}}

*%{color:red}This document concerns end-users/customers. See [[The ungleich Matrix infrastructure]] page for server-side documentation.%*

h2. Status

This document is *A DRAFT*. *%{color:red}The MaaS offer has not been released yet%.*

h2. Overview

"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/.

"Riot's features page"https://about.riot.im/features gives you a good overview of Matrix's possibilities.

h2. FAQ

h3. Q: How does pricing work?

Yet to be determined.

h3. Q: How many users can I have? What are the resources allocated to my matrix server?

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).

h3. Q: What server name will I get?

You can either use your own domain name (see below) or ask us for $ANYTHING.???.??. 

h3. Q: Can I use a custom domain name?

Yes! You will have to give us two domain names:

* (A) The base server name, used in the MXIDs (e.g. ungleich.ch).

  - 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

{"m.server": "matrix.ungleich.ch:443"}</pre>

* (B) An address for the Matrix server and client (e.g. matrix.ungleich.ch).

  - You will have to add a DNS A record poiting to 185.203.112.54

  - You will have to add a DNS AAAA record pointing to an IPv6 address dedicated to your deployment.

h3. Q: What server implementation and version do you use?

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.

h3. Q: What client can I use? Do you recommend one?

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/.

h3. Q: Can I set option X in synapse/riot?

Yes! Contact the ungleich support with the requested changes, which we will apply to the deployment configuration of your instance.

h3. Q: Do you provide a TURN server for VoIP?

Not yet, but it is planned.

h3. Q: What are application services can I use?

We support bridging to other services (IRC, Matrix, Telegram, Slack, ...) via "matterbridge":https://github.com/42wim/matterbridge, deployed on demand.