Difference between revisions of "Matrix-synapse"

From Free Software Directory
Jump to: navigation, search
m
(Is High Priority Project)
 
(5 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
|Name=Synapse
 
|Name=Synapse
 
|Short description=Synapse: Matrix reference homeserver
 
|Short description=Synapse: Matrix reference homeserver
|Full description=Matrix is an ambitious new ecosystem for open federated Instant Messaging and VoIP. The basics you need to know to get up and running are:
+
|Full description=Matrix specifies a set of pragmatic RESTful HTTP JSON APIs as an open standard, which handle:
  
* Everything in Matrix happens in a room. Rooms are distributed and do not exist on any single server. Rooms can be located using convenience aliases like #matrix:matrix.org or #test:localhost:8448.
+
* Creating and managing fully distributed chat rooms with no single points of control or failure
* Matrix user IDs look like @matthew:matrix.org (although in the future you will normally refer to yourself and others using a third party identifier (3PID): email address, phone number, etc rather than manipulating Matrix user IDs)
+
* Eventually-consistent cryptographically secure synchronisation of room state across a global open network of federated servers and services
 
+
* Sending and receiving extensible messages in a room with (optional) end-to-end encryption[1]
The overall architecture is:
+
* Inviting, joining, leaving, kicking, banning room members
 
+
* Managing user accounts (registration, login, logout)
<pre>
+
* Using 3rd Party IDs (3PIDs) such as email addresses, phone numbers, Facebook accounts to authenticate, identify and discover users on Matrix.
client <----> homeserver <=====================> homeserver <----> client
+
* Placing 1:1 VoIP and Video calls
      https://somewhere.org/_matrix      https://elsewhere.net/_matrix
 
</pre>
 
 
 
#matrix:matrix.org is the official support room for Matrix, and can be accessed by any client from https://matrix.org/docs/projects/try-matrix-now.html or via IRC bridge at irc://irc.freenode.net/matrix.
 
 
 
Synapse is currently in rapid development, but as of version 0.5 we believe it is sufficiently stable to be run as an internet-facing service for real usage!
 
About Matrix
 
 
 
Matrix specifies a set of pragmatic RESTful HTTP JSON APIs as an open standard, which handle:
 
 
 
    Creating and managing fully distributed chat rooms with no single points of control or failure
 
    Eventually-consistent cryptographically secure synchronisation of room state across a global open network of federated servers and services
 
    Sending and receiving extensible messages in a room with (optional) end-to-end encryption[1]
 
    Inviting, joining, leaving, kicking, banning room members
 
    Managing user accounts (registration, login, logout)
 
    Using 3rd Party IDs (3PIDs) such as email addresses, phone numbers, Facebook accounts to authenticate, identify and discover users on Matrix.
 
    Placing 1:1 VoIP and Video calls
 
  
 
These APIs are intended to be implemented on a wide range of servers, services and clients, letting developers build messaging and VoIP functionality on top of the entirely open Matrix ecosystem rather than using closed or proprietary solutions. The hope is for Matrix to act as the building blocks for a new generation of fully open and interoperable messaging and VoIP apps for the internet.
 
These APIs are intended to be implemented on a wide range of servers, services and clients, letting developers build messaging and VoIP functionality on top of the entirely open Matrix ecosystem rather than using closed or proprietary solutions. The hope is for Matrix to act as the building blocks for a new generation of fully open and interoperable messaging and VoIP apps for the internet.
Line 36: Line 19:
  
 
We'd like to invite you to join #matrix:matrix.org (via https://matrix.org/docs/projects/try-matrix-now.html), run a homeserver, take a look at the Matrix spec, and experiment with the APIs and Client SDKs.
 
We'd like to invite you to join #matrix:matrix.org (via https://matrix.org/docs/projects/try-matrix-now.html), run a homeserver, take a look at the Matrix spec, and experiment with the APIs and Client SDKs.
 +
 +
Thanks for using Matrix!
 +
 +
[1] End-to-end encryption is currently in beta: blog post.
 
|Homepage URL=https://matrix.org/
 
|Homepage URL=https://matrix.org/
 
|Is High Priority Project=Yes
 
|Is High Priority Project=Yes
 
|VCS checkout command=git clone https://github.com/matrix-org/synapse.git
 
|VCS checkout command=git clone https://github.com/matrix-org/synapse.git
 +
|Documentation note=Synapse is currently in rapid development, but as of version 0.5 we believe it is sufficiently stable to be run as an internet-facing service for real usage!
 +
|Decommissioned/Obsolete=No
 
|Accepts cryptocurrency donations=No
 
|Accepts cryptocurrency donations=No
|Last review by=David Hedlund
+
|Version download=https://github.com/matrix-org/synapse/archive/master.zip
|Last review date=2018/03/23
+
|Test entry=No
 +
|Last review by=Bendikker
 +
|Last review date=2018/04/10
 +
|Submitted by=David Hedlund
 
|Submitted date=2018/03/23
 
|Submitted date=2018/03/23
 
|Is GNU=No
 
|Is GNU=No
Line 129: Line 121:
 
|License verified by=David Hedlund
 
|License verified by=David Hedlund
 
|License verified date=2018/03/23
 
|License verified date=2018/03/23
 +
}}
 +
{{Resource
 +
|Resource audience=Debian (Ref)
 +
|Resource URL=https://tracker.debian.org/pkg/matrix-synapse
 
}}
 
}}
 
{{Software category}}
 
{{Software category}}
 
{{Featured}}
 
{{Featured}}

Latest revision as of 17:34, 13 April 2018


[edit]

Synapse

https://matrix.org/
Synapse: Matrix reference homeserver

Matrix specifies a set of pragmatic RESTful HTTP JSON APIs as an open standard, which handle:

  • Creating and managing fully distributed chat rooms with no single points of control or failure
  • Eventually-consistent cryptographically secure synchronisation of room state across a global open network of federated servers and services
  • Sending and receiving extensible messages in a room with (optional) end-to-end encryption[1]
  • Inviting, joining, leaving, kicking, banning room members
  • Managing user accounts (registration, login, logout)
  • Using 3rd Party IDs (3PIDs) such as email addresses, phone numbers, Facebook accounts to authenticate, identify and discover users on Matrix.
  • Placing 1:1 VoIP and Video calls

These APIs are intended to be implemented on a wide range of servers, services and clients, letting developers build messaging and VoIP functionality on top of the entirely open Matrix ecosystem rather than using closed or proprietary solutions. The hope is for Matrix to act as the building blocks for a new generation of fully open and interoperable messaging and VoIP apps for the internet.

Synapse is a reference "homeserver" implementation of Matrix from the core development team at matrix.org, written in Python/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.

In Matrix, every user runs one or more Matrix clients, which connect through to a Matrix homeserver. The homeserver stores all their personal chat history and user account information - much as a mail client connects through to an IMAP/SMTP server. Just like email, you can either run your own Matrix homeserver and control and own your own communications and history or use one hosted by someone else (e.g. matrix.org) - there is no single point of control or mandatory service provider in Matrix, unlike WhatsApp, Facebook, Hangouts, etc.

We'd like to invite you to join #matrix:matrix.org (via https://matrix.org/docs/projects/try-matrix-now.html), run a homeserver, take a look at the Matrix spec, and experiment with the APIs and Client SDKs.

Thanks for using Matrix!

[1] End-to-end encryption is currently in beta: blog post.





Licensing

License

Verified by

Verified on

Notes

License

Apache2.0

Verified by

David Hedlund

Verified on

23 March 2018




Leaders and contributors

Resources and communication

AudienceResource typeURI
Debian (Ref)https://tracker.debian.org/pkg/matrix-synapse


Software prerequisites




Entry







"Debian (Ref)" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.








Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.