"A list of event types to include. If this list is absent then all event types are included. A '*' can be used as a wildcard to match any sequence of characters.",
"items":{
"type":"string"
}
},
"not_types":{
"type":"array",
"description":
"A list of event types to exclude. If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed in the 'types' filter. A '*' can be used as a wildcard to match any sequence of characters.",
"items":{
"type":"string"
}
},
"senders":{
"type":"array",
"description":
"A list of senders IDs to include. If this list is absent then all senders are included. A '*' can be used as a wildcard to match any sequence of characters.",
"items":{
"type":"string"
}
},
"not_senders":{
"type":"array",
"description":
"A list of sender IDs to exclude. If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the 'senders' filter. A '*' can be used as a wildcard to match any sequence of characters.",
"A list of room IDs to include. If this list is absent then all rooms are included. A '*' can be used as a wildcard to match any sequence of characters.",
"items":{
"type":"string"
}
},
"not_rooms":{
"type":"array",
"description":
"A list of room IDs to exclude. If this list is absent then no rooms are excluded. A matching room will be excluded even if it is listed in the 'rooms' filter. A '*' can be used as a wildcard to match any sequence of characters.",
"The format to use for events. 'client' will return the events in a format suitable for clients. 'federation' will return the raw event as receieved over federation. The default is 'client'.",
"type":"string",
"enum":["client","federation"]
},
"event_fields":{
"type":"array",
"description":
"List of event fields to include. If this list is absent then all fields are included. The entries may include '.' charaters to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content' object. A literal '.' character in a field name may be escaped using a '\\'. A server may include more fields than were requested.",
var et_custom = {"ajaxurl":"https:\/\/matrix.org\/blog\/wp-admin\/admin-ajax.php","images_uri":"https:\/\/matrix.org\/blog\/wp-content\/themes\/Divi-child\/images","et_load_nonce":"dc61fa2f94","subscription_failed":"Please, check the fields below to make sure you entered the correct information.","fill":"Fill","field":"field","invalid":"Invalid email","captcha":"Captcha","prev":"Prev","next":"Next"};
@ -33,6 +33,8 @@ You can use multiple clients with the same user, so you might want to also look
## Run a server and/or client yourself
## Run a server and/or client yourself
You can clone our open source projects and run clients and servers yourself. Here is how:
### Running your own client:
### Running your own client:
You can run your own Matrix client; there are [numerous clients available](https://matrix.org/blog/try-matrix-now/). You can take Matrix.org's [reference client](https://github.com/matrix-org/matrix-angular-sdk) and use it as-is - or modify it any way you want! Since it's written in JavaScript, running a client is [really easy](https://github.com/matrix-org/matrix-angular-sdk#running)!
You can run your own Matrix client; there are [numerous clients available](https://matrix.org/blog/try-matrix-now/). You can take Matrix.org's [reference client](https://github.com/matrix-org/matrix-angular-sdk) and use it as-is - or modify it any way you want! Since it's written in JavaScript, running a client is [really easy](https://github.com/matrix-org/matrix-angular-sdk#running)!
7. Even if there are no new events (as in the example above), there will be some pagination stream response keys. The client should make subsequent requests using the value of the "end" key (in this case s39_18_0) as the from query parameter e.g.
7. Even if there are no new events (as in the example above), there will be some pagination stream response keys. The client should make subsequent requests using the value of the "end" key (in this case s39_18_0) as the from query parameter e.g.
8. This ensures that you only get new events. Now you have initial rooms and presence, and a stream of events - a good client should be able to process all these events and present them to the user. And potentially you might want to add functionality to generate events as well (such as messages from the user, for example) - again please consult the [client-server API spec](http://matrix.org/docs/howtos/client-server.html)!
8. This ensures that you only get new events. Now you have initial rooms and presence, and a stream of events - a good client should be able to process all these events and present them to the user. And potentially you might want to add functionality to generate events as well (such as messages from the user, for example) - again please consult the [client-server API spec](http://matrix.org/docs/howtos/client-server.html)!
|
### Write your own server:
### Write your own server:
We are still working on the server-server spec, so the best thing to do if you are interested in writing a server, is to come talk to us in [#matrix:matrix.org](https://matrix.org/beta/#/room/%23matrix:matrix.org).
We are still working on the server-server spec, so the best thing to do if you are interested in writing a server, is to come talk to us in [#matrix:matrix.org](https://matrix.org/beta/#/room/%23matrix:matrix.org).
implementations](http://github.com/matrix-org/synapse) of the standard.
- [Client\<-\>Server API](/docs/spec#client-server-api-v1) - defines how Matrix compatible clients communicate with Matrix homeservers.
- [Server\<-\>Server API](/docs/spec#federation-api) - defines how Matrix homeservers exchange messages and synchronise history with each other.
- [Application Service API](/docs/spec/#application-service-api) - defines how to extend the functionality of Matrix with 'integrations' and bridge to other networks.
- [Modules](/docs/spec/#modules) - specifies features that must be implemented by particular classes of clients.
- Open source reference implementations of:
- Clients (Web (React), iOS, Android)
- Client SDKs (Javascript, Web (React), iOS, Android)
- Homeservers (Synapse)
- Application Services (bridges to IRC, Slack, Skype, Lync and more...)
- The actual ecosystem and community of everyone running Matrix servers and services
- Loads of 3rd party contributions of clients, SDKs, servers and services.
You can find the full list of Matrix enabled projects at https://matrix.org/blog/try-matrix-now.
##### What does this mean for users?
##### What does this mean for users?
The aim is to provide an analogous ecosystem to email - one where you
The aim is to provide an analogous ecosystem to email - one where you
can communicate with pretty much anyone, without caring what app or
can communicate with pretty much anyone, without caring what app or
server they are using, using whichever app & server you chose to use,
server they are using, using whichever app & server you chose to use,
and a nice neutral identity system like an e-mail address or phone
and use a neutral identity system like an e-mail address or phone
number to discover people to talk to.
number to discover people to talk to.
##### What kind of company is Matrix.org?
##### What kind of company is Matrix.org?
Matrix is an open initiativewhich acts as a neutral custodian of the
Matrix is an open initiativewhich acts as a neutral custodian of the
Matrix standard. It's not actually incorporated anywhere at the moment
Matrix standard. It's not actually incorporated anywhere at the moment
but we are looking at the best legal structure for the future. We are
but we are looking at the best legal structure for the future (and as
committed to keeping the Matrix project open.
of October 2015 we have hopefully found one). Whatever the legal
structure, we are committed to keeping the Matrix project open.
##### Who is funding Matrix.org?
##### Who is funding Matrix.org?
We have been given permission by our employers, Amdocs, to work on
Most of the current core contributors to Matrix work at
Matrix as an independent non-profit initiative.
[Amdocs](http://amdocs.com), who have kindly given us permission to work
on Matrix as an independent non-profit initiative. Other contributors
are funded by their own employers or donate their own time to the project.
##### Who is building Matrix?
##### Who is building Matrix?
We're a team of ~10 people with decades of experience building custom
The core team is ~10 people with extensive experience in building custom
VoIP and Messaging apps for mobile network operators. Most of us have
VoIP and Messaging apps for mobile network operators. Most of us have
day jobs at Amdocs or OpenMarket, but we are supported by a mix of
day jobs at [Amdocs](http://amdocs.com) or [OpenMarket](http://openmarket.com),
freelancers and volunteers.
but there are an increasing number of contributors from other companies and
folks all over the internet.
##### Why are you called Matrix?
##### Why are you called Matrix?
We are called Matrix because we provide a structure in which all
We are called Matrix because we provide a structure in which all
communication can be matrixed together.
communication can be matrixed together.
|
No, it's nothing to do with the film (although you could go and build virtual
worlds on top of Matrix if you wanted :)
##### Why have you released this as open source?
##### Why have you released this as open source?
We believe that any open standard defining interoperable communication
We believe that any open standard defining interoperable communication
@ -102,16 +133,18 @@ and build on top of it.
##### What do you mean by open?
##### What do you mean by open?
Matrix is an open standard, meaning that we have freely published the
Matrix is an open standard, meaning that we have freely published the
details for how to interface with Matrix compliant servers and clients,
details for how to communicate interoperably using the Matrix set of
and encourage anyone and everyone to interface with them. We also
HTTP APIs. We encourage anyone and everyone to use the APIs and build
their own projects which implement them and so benefit from
interoperability with the rest of the Matrix ecosystem. We also
ensure the standard is not encumbered by any known patent licensing
ensure the standard is not encumbered by any known patent licensing
requirements.
requirements.
|
|
Matrix is also open source, meaning that we have released the source
Matrix is also open source, meaning that we have released the source
code of thereference servers and clients to the public domain under the
code of thereference servers, clients and services to the public domain
[Apache Licence v2](http://www.apache.org/licenses/LICENSE-2.0.html), to
under the [Apache Licence v2](http://www.apache.org/licenses/LICENSE-2.0.html), to
encourage anyone and everyone to run their own servers and clients, and
encourage anyone and everyone to run their own servers and clients, and
enhancethem and contribute their enhancementsas they see fit.
enhancethem and contribute their enhancementsas they see fit.
@ -120,7 +153,7 @@ enhancethem and contribute their enhancementsas they see fit.
Federation allows separate deployments of a communication service to
Federation allows separate deployments of a communication service to
communicate with each other - for instance a mail server run by Google
communicate with each other - for instance a mail server run by Google
federates with a mail server run by Microsoft when you send email from
federates with a mail server run by Microsoft when you send email from
@gmail.com to @outlook.com.
@gmail.com to @hotmail.com.
|
|
@ -145,16 +178,18 @@ VoIP and IM.
##### Why has no-one done this before?
##### Why has no-one done this before?
There have been several attempts before including SIP, XMPP and RCS.
There have been several attempts before including SIP, XMPP and RCS.
All of these have had some level of success, but
All of these have had some level of success, but many different
technological/usability/economic factors have ended up limiting their
technological/usability/economic factors have ended up limiting their
success in providing true open federation.
success. Unfortunately, we've not ended up in a world where everyone
has a SIP URI or Jabber ID on their business card, or a phone that
actually uses RCS.
##### What is the difference between Matrix and IRC?
##### What is the difference between Matrix and IRC?
We love IRC. In fact, as of today the core Matrix team still uses it as
We love IRC. In fact, as of today the core Matrix team still uses it as
our primary communication tool. Between us we've written IRCds, IRC bots
our primary communication tool. Between us we've written IRCds, IRC bots
and admined dreamforge, UnrealIRCd, epona, ircservices and several
and admined dreamforge, UnrealIRCd, epona, ircservices and several
others. That said, it has some limitations that Matrix seeks to improve
others. That said, it has some limitations that Matrix seeks to improve
on:
on:
- Text only
- Text only
@ -163,18 +198,24 @@ on:
- No presence support
- No presence support
- Fragmented identity model
- Fragmented identity model
- No open federation
- No open federation
- No standard APIs, just an archaic TCP line protocol
- No standard APIs, just a rather limited TCP line protocol
- Non-standardised federation protocol
- Non-standardised federation protocol
- No built-in end-to-end encryption
- No built-in end-to-end encryption
- Disruptive net-splits
- Disruptive net-splits
- Non-extensible
- Non-extensible
[IRCv3](http://ircv3.net) exists and is addressing some of issues;
this is great news and we wish them well. It's almost a contradiction
in terms to get competitive between openly interoperable communication
projects - we look forward to increasing the richness of Matrix\<-\>IRC
bridges as the project progresses.
##### What is the difference between Matrix and XMPP?
##### What is the difference between Matrix and XMPP?
The Matrix team used XMPP (Openfire, ejabberd, spectrum, asmack,
The Matrix team used XMPP (Openfire, ejabberd, spectrum, asmack,
XMPPFramework) forIM before starting to experiment with open HTTP APIs
XMPPFramework) forIM before starting to experiment with open HTTP APIs
as an alternative. The main issues with XMPP that drove us in this
as an alternative in around 2012. The main issues with XMPP that
direction were:
drove us in this direction were:
- Not particularly web-friendly - you can't easily speak XMPP from a
- Not particularly web-friendly - you can't easily speak XMPP from a
web browser. (N.B. Nowadays you have options like XMPP-FTW and
web browser. (N.B. Nowadays you have options like XMPP-FTW and
@ -182,8 +223,8 @@ direction were:
- Single logical server per MUC is a single point of control and
- Single logical server per MUC is a single point of control and
availability. (MUCs can be distributed over multiple physical
availability. (MUCs can be distributed over multiple physical
servers, but they still sit behind a single logical JID and domain.
servers, but they still sit behind a single logical JID and domain.
FMUC improves this with a similar approach to Matrix, but at time of
FMUC improves this with a similar approach to Matrix, but as of Oct
writing there are no open implementations.)
2015 there are no open source implementations.)
- History synchronisation is very much a second class citizen feature
- History synchronisation is very much a second class citizen feature
- Stanzas aren't framed or reliably delivered without extensions. (See
- Stanzas aren't framed or reliably delivered without extensions. (See
or Matrix.org's own [matrix-appservice-purple](https://github.com/matrix-org/matrix-appservice-purple)
has potential to let both environments coexist and make the most of each
other's benefits.
##### What is the difference between Matrix and PSYC?
##### What is the difference between Matrix and PSYC?
PSYC is a open federated messaging protocol loosely inspired by IRC. In
PSYC is a open federated messaging protocol loosely inspired by IRC. In
version 1 it was a standalone protocol, and in version 2 it is being
version 1 it was a standalone protocol, and in version 2 it is being
reutilised as the messaging layer on top of GNUnet. We honestly don't
reutilised as a messaging layer on top of GNUnet. We honestly don't
know that much about it, beyond tryingto use psycd as an XMPP\<-\>IRC
know that much about it, beyond tryingto use psycd as an XMPP\<-\>IRC
bridge in 2010. Matrix differentiates primarily by providing simple HTTP
bridge in 2010. Matrix differentiates primarily by providing simple HTTP
APIs rather than the more exotic compact line protocol in PSYC v1 or the
APIs rather than the more exotic compact line protocol in PSYC v1 or the
complicated GNUnet stack in v2. Meanwhile, Matrix doesn't provide of
comprehensive GNUnet stack in v2, and Matrix focuses more on decentralised
the metadata protection guarantees that GNUnet/PSYC aims for.
conversation history rather than just decentralised chat servers.
On the other hand, Matrix doesn't provide the metadata protection
guarantees that GNUnet/PSYC aims for.
|
|
@ -233,29 +286,56 @@ PSYC's views on Matrix.
##### What is the difference between Matrix and Tox?
##### What is the difference between Matrix and Tox?
Tox.im looks to be a very cool clone of Skype - a fully decentralised
Tox.im looks to be a very cool clone of Skype - a fully decentralised
peer-to-peer network. Matrix is deliberately not peer-to-peer; instead
peer-to-peer network. Matrix is deliberately not a 'pure' peer-to-peer
each user has a well-defined homeserver which stores his data and that
system; instead each user has a well-defined homeserver which stores
he can depend upon. Matrix provides HTTP APIs; Tox.im provides C APIs.
his data and that he can depend upon. Matrix provides HTTP APIs;
We haven't actually played with Tox at all yet.
Tox.im provides C APIs. As of October 2015 Tox doesn't seem to have an
answer yet for decentralised conversation history storage.
##### How does Matrix compare with something like Trillian or Pidgin?
##### How does Matrix compare with something like Trillian or Pidgin?
Trillian and Pidgin and similar aggregating IM clients merge all your IM
Trillian and Pidgin and similar aggregating IM clients merge all your IM
activity into a single user experience. However, your history and
activity into a single app. However, your history and
identity is still fragmented across the networks. People can't find you
identity is still fragmented across the networks. People can't find you
easily, and your historyisfragmented (other than on the device
easily, and your historyisfragmented (other than on the device
wherethe client runs). And rather than being able to chose the right
wherethe client runs). And rather than being able to chose the right
app for the job when communicating with people, you arepushed towards
app for the job when communicating with people, you arepushed towards
relying on a specific aggregation app.
relying on a specific aggregation app.
Matrix lets you get the best of both worlds by linking to all the
different networks (XMPP, AIM, ICQ, Lync, Skype etc) on the serverside,
using bridges which can be run by anyone. Matrix then provides a simple
standard HTTP API to access any of these networks, and lets you choose
whichever client you prefer (either as a 'native' Matrix client or using
a non-Matrix client from one of the networks which has been bridged in).
##### What Matrix compliant apps are there?
##### What Matrix compliant apps are there?
None yet, other than our examples. It's early days :)
Quite a few, ranging from the glossy mass-market to the geeky command-line. There's even an emacs macro. Check out [https://matrix.org/blog/try-matrix-now] for the current
list of Matrix enabled projects.
##### What bridges to other networks are available?
The number of 'bridges' which integrate existing communication networks into
Matrix are growing on a daily basis - both written by the Matrix core team
and contributed by the wider community. The full list can be seen at
https://matrix.org/blog/try-matrix-now, but the core ones as of Oct 2015 include:
* [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) - an increasingly comprehensive Matrix\<-\>IRC bridge
* [matrix-appservice-verto](https://github.com/matrix-org/matrix-appservice-verto) - links from Matrix to FreeSWITCH via the Verto protocol
* [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) - a basic bridge to Slack
* [matrix-appservice-purple](https://github.com/matrix-org/matrix-appservice-purple) - lets you access any of the 20+ protocols supported by
[libpurple](https://developer.pidgin.im/wiki/WhatIsLibpurple), including
Skype, Lync, XMPP, etc)
* [matrix-appservice-bridge](https://github.com/matrix-org/matrix-appservice-bridge) - a general NodeJS framework for writing bridges
Writing new bridges is incredibly fun and easy - see the [matrix-appservice-bridge HOWTO](https://github.com/matrix-org/matrix-appservice-bridge/blob/master/HOWTO.md)
for an example of how to write a fully functional Slack bridge in less than 100 lines of code!
##### Why do you think existing apps will ever join this?
##### Why do you think existing apps will ever join this officially?
We firmly believe it is what is right for the consumer. As people begin
We firmly believe it is what is right for the consumer. As people begin
to use interoperable communications tools service providers will see the
to use interoperable communications tools, service providers will see the
benefit and compete on quality of service, security and features rather
benefit and compete on quality of service, security and features rather
than relying on locking people into their walled garden. We believe as
than relying on locking people into their walled garden. We believe as
soon as users see the availability and benefits of interoperable
soon as users see the availability and benefits of interoperable
@ -264,28 +344,27 @@ services they will demand it.
##### Why aren't you doing this through the IETF? or W3C? or 3GPP?
##### Why aren't you doing this through the IETF? or W3C? or 3GPP?
We do recognise the advantages of working with existingstandards
We do recognise the advantages of working with existingstandards
bodies.We have been focused on writing code and getting it out. As
bodies.We have been focused on writing code and getting it out, and the standard has been evolving rapidly since initial release in September 2014.
Matrix matures it may well be appropriate to work with an official
Once the standard has matured sufficiently it may well be appropriate to work with an official
standard body.
standard body to maintain it going forwards.
|
### Quick Start
### Quick Start
##### How do I get an account and get started?
##### How do I get an account and get started?
The quickest way is to just jump to the demo webclient at
The quickest way is to pick a client from https://matrix.org/blog/try-matrix-now and sign up.
[http://matrix.org/beta](http://matrix.org/beta) and sign up. Please note that you can point the
Please note that you can point clients to access any homeserver - you don't have to use matrix.org,
webclient to access any homeserver - you don't have to use matrix.org,
although as of day 1,matrix.org is the only communal homeserver
although as of day 1,matrix.org is the only communal homeserver
available.
available.
##### What can I actually do with this?
##### What can I actually do with this?
The demo webclient provides a simple chatroom interface to Matrix-
A typical client provides a simple chatroom interface to Matrix-
letting the user interact with users and rooms anywhere within the
letting the user interact with users and rooms anywhere within the
Matrix federation. Text and image messages are supported, and basic
Matrix federation. Text and image messages are supported, and basic
voice-only VoIP calling via WebRTC is supported in one-to-one rooms.
voice-only VoIP calling via WebRTC is supported in one-to-one rooms.
(As of October 2015, experimental multi-way calling is also available
on Vector.im).
##### How do I connect my homeserver to the public Matrix network?
##### How do I connect my homeserver to the public Matrix network?
@ -295,11 +374,21 @@ for details
##### How do I Matrix-enable my existing app?
##### How do I Matrix-enable my existing app?
See the [Client-Server API
If your app doesn't have any communication capability already, you'll want
HOWTO](http://matrix.org/docs/howtos/client-server.html) for an example
to use one of the Matrix client SDKs to add it in. These come in different
of how to use Matrix's client-server API tolet your app communicate
levels of sophistication - ranging from a simple HTTP API wrapper (like matrix-js-sdk, matrix-ios-sdk or matrix-android-sdk)
with users via Matrix. We're currently working out the best way to
through to reusable UI components (like matrix-react-sdk and matrix-ios-kit). Pick
integrate your application's existing identity system with Matrix.
the one for your platform, or a 3rd party one if none of the above work for you,
and get plugging it in. You'll probably also want to read the [Client-Server API
If you already have communication infrastructure set up (XMPP, custom HTTP, or whatever),
then you'll want to run a bridge to expose it to the wider Matrix ecosystem.
See [matrix-appservice-bridge HOWTO](https://github.com/matrix-org/matrix-appservice-bridge/blob/master/HOWTO.md) for a
guide of how to write bridges using the matrix-appservice-bridge framework, or co-opt one
from the list at https://matrix.org/blog/try-matrix-now.
[Application Service API](/docs/spec/#application-service-api) gives the details of the API
that bridges have to implement.
##### How can I write a client on Matrix?
##### How can I write a client on Matrix?
@ -308,16 +397,20 @@ HOWTO](http://matrix.org/docs/howtos/client-server.html)and the [API
docs](/docs/api)and [the Spec](/docs/spec)for all the details you need
docs](/docs/api)and [the Spec](/docs/spec)for all the details you need
to write a client.
to write a client.
##### *How can I help out with this?*
##### How can I help out with this?
Install synapse and tell us how you get on. Critique the spec. Write
Come say hi on #matrix:matrix.org! Install synapse and tell us how you get on. Critique the spec. Write
clients. Just come say hi on [\#matrix:matrix.org](/alpha) or the
clients. Write bridges! Run bridges! Nose around in [Jira](https://matrix.org/jira) and
[mailing lists](/mailman/listinfo/matrix-users)!
send us some pull requests on github to fix some bugs or add some features! You could even
try to write a homeserver (but be warned, Matrix's architecture makes homeservers orders of
magnitude harder than clients or bridges.)
See [CONTRIBUTING.rst](http://github.com/matrix-org/synapse/tree/master/CONTRIBUTING.rst) for
full details on how to contribute to the project. All are welcome!
##### Where can I get support?
##### Where can I get support?
[\#matrix:matrix.org](/alpha), \#matrix on irc.freenode.netor
\#matrix:matrix.org aka \#matrix on irc.freenode.is your best bet.
the[mailing lists](/mailman/listinfo/matrix-users)are your best bets.
##### How do I register custom matrix event types?
##### How do I register custom matrix event types?
@ -327,66 +420,108 @@ use the[mailing list](/mailman/listinfo/matrix-users)for now.
##### How mature is this?
##### How mature is this?
We started working on Matrix in July 2014, and have opened it to the
We started working on Matrix in July 2014, and opened it to the
public in September 2014. It's early days, and under no circumstances
public in September 2014. We got all the core features in place in December 2014
should you use Matrix or Synapse for anything other than experimentation
and entered beta, and since then have been iterating away on the beta refining the
and learning at this point. Obviously thespec and apps are maturing
architecture and APIs, fixing bugs and scalability, and adding new features, clients,
rapidly, but as of the time of writing APIs are not frozen and the apps
bridges etc.
are very much a work in progress.
As of October 2015 (synapse 0.10) it's good for serious experimentation and
non-production services and can absolutely be used in the real world. However, we're
still in beta and we'll want to freeze the spec and implement clustering and other
nice features before we really declare it ready for production.
### Standard
##### What is a client?
Users in Matrix use one or more clients to communicate. This could be any combination of a web client, a command line client, a mobile client - or embedded clients built into existing apps. It could even be a piece of hardware (e.g. a drone) that is Matrix enabled.
##### Can I use Matrix without installing a Matrix client?
Sure. An ever increasing number of protocols are being bridged into Matrix, so if you use something like IRC on Freenode you may well be indirectly benefiting from Matrix, as others may be connected into the IRC channel via Matrix.
##### What is a home server?
A user's clients connect to a single homeserver, which stores the communication history and account information for that user, and shares data with the wider Matrix ecosystem by synchronising communication history with other homeservers.
##### What is an identity server?
Users in Matrix are identified internally via their matrix user ID (MXID). However, existing 3rd party ID (3PID) namespaces such as email addresses or phone numbers should be used publically to identify Matrix users, at least for invitation purposes. A Matrix "Identity" describes both the user ID and any other existing IDs from third party namespaces linked to their account.
|
|
*Sorry, the FAQ is still work in progress, the rest of it will up
Matrix users can link third-party IDs (3PIDs) to their user ID. Linking 3PIDs creates a mapping from a 3PID to a user ID. This mapping can then be used by Matrix users in order to discover the MXIDs of their contacts.
soon!* *In the mean time, don't hesitate to get in touch on
[\#matrix:matrix.org](/alpha)or the[mailing
lists](/mailman/listinfo/matrix-users)!*
|
|
### Standard
In order to ensure that the mapping from 3PID to user ID is genuine, a globally federated cluster of trusted "Identity Servers" (IS) are used to verify the 3PID and persist and replicate the mappings.
Usage of an IS is not required in order for a client application to be part of the Matrix ecosystem. However, without one clients will not be able to look up user IDs using 3PIDs.
##### What is a home server?
|
##### What is an identity sever?
The precise architecture of identity servers is currently in flux and subject to change as we work to fully decentralise them.
##### Where do my conversations get stored?
##### Where do my conversations get stored?
Each homeserver stores the communication history and account information for all of its clients, and shares data with the wider Matrix ecosystem by synchronising communication history with other homeservers and their clients. Clients typically communicate with each other by emitting events in the context of a virtual room. Room data is replicated across all of the homeservers *whose users are participating in a given room*.
##### What is a 3PID?
##### What is a 3PID?
Third-party IDs (3PIDs) are IDs from other systems or contexts, such as email addresses, social network accounts and phone numbers.
##### How do you do VoIP calls on Matrix?
##### How do you do VoIP calls on Matrix?
Voice (and video) over Matrix uses the WebRTC 1.0 standard to transfer call media (i.e. the actual voice and video traffic). Matrix is used to signal the establishment and termination of the call by sending call events, like any other event. Currently calls are only supported in rooms with exactly two participants - however, one of those participants may be a conferencing bridge. We're looking at better ways to do group calling.
##### Can I log into other homeservers with my username and password?
##### Can I log into other homeservers with my username and password?
Currently, no. We are looking at options for decentralising or migrating user accounts between multiple servers, and might add this feature at a later stage.
##### Why Apache Licence?
##### Why Apache Licence?
The Apache Licence is a permissive licence. We want the Matrix protocol itself to be free and open, but people are free to create both free and commercial apps and services that uses the protocol. In our opinion, any Matrix-service only enhances the Matrix ecosystem.
##### Can I write a Matrix homeserver?
##### Can I write a Matrix homeserver?
Yes. Matrix is just a spec, so implementations of the spec are very welcome! It should be noted that as of October 2015, changes are still being made to the spec, so if you want to write a Matrix homeserver, it is strongly recommended that you chat to the Matrix.org devs in #matrix:matrix.org first! You can also read about the [Federation API here]( https://github.com/matrix-org/matrix-doc/blob/master/specification/30_server_server_api.rst).
##### How secure is this?
##### How secure is this?
##### Why aren't you using an ORM layer like SqlAlchemy?
Server-server traffic is mandatorily TLS from the outset. Server-client traffic mandates transport layer encryption other than for tinkering. Servers maintain a public/private key pair, and sign the integrity of all messages in the context of the historical conversation, preventing tampering. Server keys are distributed using a PERSPECTIVES-style system.
|
End-to-end encryption is coming shortly to clients for both 1:1 and group chats to protect user data stored on servers, using the [Olm](https://matrix.org/git/olm) cryptographic ratchet implementation. As of October 2015 this is blocked on implementing the necessary key distribution and fingerprint management.
### APIs
Privacy of metadata is not currently protected from server administrators - a malicious homeserver administrator can see who is talking to who and when, but not what is being said (once E2E encryption is enabled). See [this presentation from Jardin Entropique](http://matrix.org/~matthew/2015-06-26%20Matrix%20Jardin%20Entropique.pdf) for a more comprehensive discussion of privacy in Matrix.
### Implementations
##### What is Synapse?
Synapse is a reference "homeserver" implementation of Matrix from the core development team at matrix.org, written in Python 2/Twisted. It is intended to showcase the concept of Matrix and let folks see the spec in the context of a codebase and let you run your own homeserver and generally help bootstrap the ecosystem.
##### How do I join the global Matrix federation?
##### How do I join the global Matrix federation?
You can download and run one of the available Matrix servers - please see [this guide](http://matrix.org/docs/guides/getting_involved.html#run) for details!
##### What ports do I have to open up to join the global Matrix federation?
##### What ports do I have to open up to join the global Matrix federation?
|
We recommend servers use port 8448 for server\<-\>server HTTPS traffic. Look at ["Setting up Federation"](https://github.com/matrix-org/synapse#setting-up-federation) in the Synapse readme file for details.
### Reference Implementations
Client\<-\>Server traffic can talk directly to Synapse via port 8448, but as by default Synapse creates a self-signed TLS certificate this can cause problems for clients which can't easily trust self-signed certificates (e.g. most web browsers). Instead, you can proxy access to Synapse's HTTP listener on port 8008 via an existing HTTPS proxy with a valid certificate (e.g. an nginx listening on port 443), or you can point Synapse at a valid X.509 signed TLS certificate. In future, Synapse will probably use letsencrypt to autogenerate valid certificates rather than self-signed ones during installation, simplifying this process enormously.
##### What is Matrix built on - and why?
You can also put Synapse entirely behind an existing TLS load balancer and not expose port 8448 at all. In this situation, Synapse will need to be configured to share the same *public* TLS certificate as the load balancer (as Synapse uses the public certificate for identity in other areas too, and it has to match the certificate that other servers see when they connect).
##### How do I run my own home server?
##### How do I run my own homeserver?
Follow the instructions for the homeserver you want to run. If you want to run Synapse, the reference homeserver from Matrix.org, follow [these instructions](https://github.com/matrix-org/synapse#synapse-installation).
##### Can I run my own identity server?
##### Can I run my own identity server?
Yes - the reference implementation is
Yes - the reference implementation is
[sydent](https://github.com/matrix-org/sydent) and you can run your own
[sydent](https://github.com/matrix-org/sydent) and you can run your own
ID server cluster that tracks 3rd party to Matrix ID mappings. If you
ID server cluster that tracks 3rd party to Matrix ID mappings. This won't be very useful right now, though, and we don't recommend it.
want your server to participate in the global replicated Matrix ID
If you want your server to participate in the global replicated Matrix ID
service then please get in touch with us. Meanwhile, we are looking at
service then please get in touch with us. Meanwhile, we are looking at
ways of decentralising the 'official' Matrix identity service so that
ways of decentralising the 'official' Matrix identity service so that
identity servers are 100% decentralised and can openly federate with
identity servers are 100% decentralised and can openly federate with
@ -394,20 +529,65 @@ each other. **N.B. that you can use Matrix without ever using the
identity service - it exists only to map 3rd party IDs (e.g. email
identity service - it exists only to map 3rd party IDs (e.g. email
addresses) to matrix IDs to aid user discovery**.
addresses) to matrix IDs to aid user discovery**.
##### What is Synapse?
##### What are Synapse's platform requirements?
Synapse will use as much RAM as you give it in order to cache conversations in RAM to avoid hitting the database. For small deployments (<50activeusers)around512MBofRAMisprobablyokay.YoucanconfiguretheamountofRAMusedbysynapsewiththeevent_cache_sizeconfigparameter-themoreeventsinthecache,themoreRAMrequired.Synapseitselfrequiresrelativelylittlediskspaceotherthanforlogging(whichasofOctober2015isquiteverbosefordebuggingpurposes),butasitcachesthecontentofallthefileattachments(images,videosetc)viewedbyitsusers,youmayneedtosizestorageappropriately.Synapseiscurrentlyeffectivelysinglethreaded,andwillneverusemorethan1core.
|
For better performance, one should back Synapse with a Postgres database rather than the default SQLite - see https://github.com/matrix-org/synapse/tree/master/README.rst#using-postgresql for details.
##### Why is Synapse in Python/Twisted?
##### Why is Synapse in Python/Twisted?
##### What are Synapse's platform requirements?
This is because both provide a mature and well known event-driven async IO framework for writing serverside code. Whilst this has been okay for our initial experimentation and proof of concept, it's likely that future homeserver work will be written in a more strongly typed language (e.g. Go).
##### Why aren't you using an ORM layer like SqlAlchemy in Synapse?
##### What are the Synapse webclient's requirements?
Synapse is *very* database dependent (as of Oct 2015; this is improving in the near future however), and we like having the flexibility to sculpt our own queries.
##### Where is the mobile app?
##### Where can I find a mobile app?
The "Matrix Console" reference apps (ugly, geeky and powerful - intended for early adopter powerusers) can be downloaded from the [Google Play store](https://play.google.com/store/apps/details?id=org.matrix.androidsdk.alpha)
and [Apple store](https://itunes.apple.com/gb/app/matrix-console/id970074271).
|
For the Android app, you can also install the latest development version
built by [Jenkins](http://www.matrix.org/jenkins/job/AndroidConsoleDevelop/lastBuild/artifact/console/build/outputs/apk/console-alpha-debug.apk).
##### Where can I find a web app?
As of Oct 2015, the best web app options are to use [Vector.im](https://vector.im) - a glossy web client written on top of [matrix-react-sdk](https://github.com/matrix-org/matrix-react-sdk), or the original [AngularJS based client](https://matrix.org/beta), which has serious performance problems and is not currently being maintained. In future a "Matrix Console" reference web app built on matrix-react-sdk will be released by matrix.org to complement the mobile apps above.
|
##### What decides the room member order on the webclient?
### QUESTIONS TO BE ANSWERED!
This FAQ is a constant work in progress - patches and pull requests are *very* welcome to help us improve it. Some of the frequent questions where we need to write an answer include:
* How do I rename servers?
* How do I change the TLS key of my server?
* How do I maintain my synapse's DB (e.g. prune old conversations)?
* How do I maintain my synapse's content repository (e.g. prune old content)?
* What are redactions?
* Why is the spec so big, especially relative to the XMPP baseline spec?
* How do I contribute to the spec?
* What is the privacy policy on Matrix.org?
* How precisely does E2E work?
* How does Matrix actually work architecturally?
* What IOT use cases are there for Matrix?
* Why is are the Matrix reference implementations written in so many different languages?
* How does push work?
* What's on the roadmap?
* How can I use Matrix to talk on Freenode or other IRC networks?
* Where can I learn more about Matrix? (link to PDFs of other presentations etc)
* Why HTTP? Doesn't HTTP suck?
* Why don't you use websockets?
* Why is synapse so resource intensive immediately after federating for the first time?
Daniel Wagner-Hall
9 years ago