Guides Recommended by matrix.org
| If you want to… | Then read… |
|---|---|
| Just get started! | Getting Involved, which explains various ways of getting started with Matrix or the FAQ, where we try to answer all your questions relating to Matrix |
| Get started with the CS API using … | |
| … JavaScript | Usage of the matrix-js-sdk |
| … Python | Matrix Python SDK documentation |
| Understand Application Services | The Application services guide introduces them and explains what they can be used for |
| See an example of a simple bot | tiny-matrix-bot source code |
| Create a complete working chatbot | Using Matrix to make Chatbot software from the 1960s available in 2018 goes from the basics, brings in matrix-bot-sdk, and ends with deployment on a Raspberry Pi |
| Work on Bridges to Matrix | Types of Bridging should be read by all bridge developers to ensure everyone has the same mental map of terminology when implementing bridges |
| Migrate from the old v1 CS API | the v1 migration guide which justs lists the changes from v1 to r0 |
| Use E2E in a client application | The End-to-end Encryption Implementation Guide is intended for client developers who wish to add support for end-to-end encryption to their clients |
| Install Synapse | Installing Synapse Guide |
| … using Docker | the Synapse Docker README |
| Understand Moderation in Matrix | Moderation in Matrix |
Introduction for Users
| Article | Author | Language |
|---|---|---|
| Guide to matrix.org and riot.im | Michael Snoyman | English |
| Riot Matrix from La Foresta | La Foresta team | Italian |
| IRC for the 21st Century: Introducing Riot | Justin W. Flory | English |
| Introduction à Matrix et guide d'utilisation | Adrien Luxey | French |
| Werde Teil der Matrix | Samuel | German |
Installing Synapse
To install Synapse, we recommend taking a look at the Installing Synapse guide page. Other articles are listed below.
| Article | Author | Language |
|---|---|---|
| Install Matrix Synapse | Stefan | English |
| Matrix-Riot.im : How to install Synapse-Matrix server - Raspberry PI - Rock64 | dHENRY | English |
| Running Matrix Synapse on NixOS | Kiba Fox | English |
| Run your end-to-end encrypted chat server using Matrix and Riot | Gabor Szathmari | English |
| How to Install Matrix Synapse Chat on Ubuntu 18.04 LTS | Muhammad Arul | English |
| How To Install Matrix Synapse on Ubuntu 16.04 | Oliver Lumby for DigitalOcean | English |
| Running your own encrypted chat service with Matrix and Riot | github.com/attacus | English |
| How to secure your chats with Matrix | Zachary Muller | English |
| Install Riot Matrix Chat Client On Debian and Ubuntu | Nick Congleton | English |
| Matrix homeserver (v1.0.0) with Docker and Traefik | Jon Neverland | English |
| Set up Synapse (Matrix Homeserver) on Ubuntu 16.04 | Hong Xu | English |
| Matrix Synapse auf Ubuntu Server 20.04 LTS mit nginx, PostgreSQL und Let’s Encrypt | Jan | German |
Synapse Maintenance
| Article | Author | Language |
|---|---|---|
| Compressing Synapse database | Victor Berger / Levans | English |
| How to monitor Synapse metrics using Prometheus | Synapse Team | English |
| Using Postgres | Synapse Team | English |
| How to enable VoIP relaying on your Home Server with TURN | Synapse Team | English |
| Setting up Federation | Synapse Team | English |
| Use of Server Notices | Synapse Team | English |
| Use of OpenTracing | Synapse Team | English |
| Scaling synapse via workers | Synapse Team | English |
| Boosting matrix/synapse by using workers | Mark Nowiasz | English |
Understanding End-to-End Encryption
| Article | Author | Language |
|---|---|---|
| An introduction to end-to-end encryption in Matrix and Riot | Hubert Chathi | English |
Translations
| Article | Author | Language |
|---|---|---|
| How to translate Riot-Web | Riot-Web Team | English |
Video Guides
| Article | Author | Language |
|---|---|---|
| Matrix Bridging to IRC, Slack and Telegram | Jon Spriggs | English |
| Riot - Messagerie Instantanée Décentralisée & Sécurisée ! | Nouts | French |
