Guides

Here is a collection of guides that might help you get involved with Matrix.

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
Understand the CS API How to use the client-server API, which explains in detail how to use the CS API.
Useful if you want to write a client (or modify an existing one) - or if you’re just interested in how it works “under the hood”
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
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

Guides List

This collection of guides is taken from around the web. If you have used a guide, and recommend it, please go ahead and click “Recommend” on the right, and we’ll use this to sort the articles by recommendations.

Introduction for Users

Article Author Language Action
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 for Developers

Article Author Language Action
Enter the Matrix Brendan English  
Obtain Access Tokens from Riot TravisR English  
Testing the matrix.org client-server API using cURL Rick Cogley English  
Made for Matrix Badge Guidelines (add this to your project page) matrix.org English  

Installing Synapse

To install Synapse, we recommend taking a look at the Installing Synapse guide page. Other articles are listed below.

Article Author Language Action
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  
Create a Chat Server Using Matrix Synapse and Riot on CentOS 7 Vultr Docs English  
How to Create a Chat Server Using Matrix Synapse on Ubuntu 16.04 alibabacloud.com English  
How to install Matrix Synapse Home Server UpCloud Tutorials 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  
Introduction and tutorials for Riot.im @geleeroyale:matrix.org English  
Install Riot Matrix Chat Client On Debian and Ubuntu Nick Congleton English  

Understanding End-to-End Encryption

Article Author Language Action
An introduction to end-to-end encryption in Matrix and Riot Hubert Chathi English  

Riot Customisation

Article Author Language Action
Setting a default color scheme (tint) for Riot on your account TravisR English  

Video Guides

Article Author Language Action
Matrix Bridging to IRC, Slack and Telegram Jon Spriggs English  
Riot - Messagerie Instantanée Décentralisée & Sécurisée ! Nouts French  
How helpful was this page? Click to give a rating