Ungleich Matrix-as-a-Service (MaaS)¶

• Table of contents
• Ungleich Matrix-as-a-Service (MaaS)
  • Status
  • Overview
  • FAQ
    • Q: How many users can I have? What are the resources allocated to my matrix server?
    • Q: What server name will I get?
    • Q: Can I use a custom domain name?
    • Q: What server implementation and version do you use?
    • Q: What client can I use? Do you recommend one?
    • Q: Can I set option X in synapse/riot?
    • Q: Do you provide a TURN server for VoIP?
    • Q: What are application services can I use?
    • Q: If I do not use an LDAP directory, can I still manage my users?

This document concerns end-users/customers. See The ungleich Matrix infrastructure page for server-side documentation.

Status¶

This document is in PRODUCTION

Overview¶

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

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

FAQ¶

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

Q: What server name will I get?¶

You can either use your own domain name (see below) or ask us for $ORGANIZATION.0co2.cloud.

Q: Can I use a custom domain name?¶

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

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

You will also need to configure 2 files below the main matrix domain

- /.well-known/matrix/server containing {"m.server": "homeserver:443"}.
Example:

$ curl https://ungleich.ch/.well-known/matrix/server
{"m.server": "ungleich.matrix.ungleich.cloud:443"}

- /.well-known/matrix/client containing { "m.homeserver": { "base_url": "https://homeserver" } }. Example:

curl https://ungleich.ch/.well-known/matrix/client 
{ "m.homeserver": { "base_url": "https://ungleich.matrix.ungleich.cloud" } }

Checkout https://github.com/matrix-org/synapse#security-note to understand why you need separate domain names for the homeserver and the other domains.

Q: What server implementation and version do you use?¶

We use the synapse reference homeserver package provided by the buster-backports repository.

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

We recommend and provide you a web version of the Riot client (desktop and mobile) but you can use any matrix client.

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.

Q: Do you provide a TURN server for VoIP?¶

Yes.

Q: What are application services can I use?¶

We support bridging to other services (IRC, Matrix, Telegram, Slack, ...) via matterbridge, deployed on demand.

Q: If I do not use an LDAP directory, can I still manage my users?¶

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