Skip to content

Commit

Permalink
You probably don't want Sydent
Browse files Browse the repository at this point in the history
Fixes #22.
  • Loading branch information
David Robertson committed Mar 9, 2023
1 parent 110a40b commit f1e96a6
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
What is Sydent?
===============

Sydent is an `identity server <https://spec.matrix.org/v1.6/identity-service-api/>`_ for the `Matrix communications protocol <matrix.org>`_. It allows Matrix users to prove that they own an email address or phone number, and allows _other_ Matrix users to look them up using that email address or phone number.

Do I need to run Sydent to run my own homeserver?
-------------------------------------------------

Short answer: **no**.

Medium answer: **probably not**. Most homeservers and clients use the Sydent
instance run by `matrix.org`, or use no identity server whatsoever.

Longer answer: if you want to allow user lookup via emails and phone numbers in
a private federation of multiple homeservers, Sydent _might_ be useful for you.
If you want to your homeserver to be able to verify phone numbers via SMS and
you have an API token for the `OpenMarket HTTP SMS API
<https://www.openmarket.com/docs/Content/apis/v4http/overview.htm>`_, then
Sydent might be useful for you.


Installation
============

Expand Down Expand Up @@ -127,7 +148,7 @@ Environment variables
+--------------------+-----------------+-----------------------+
| Variable Name | Sydent default | Dockerfile default |
+====================+=================+=======================+
| SYDENT_SERVER_NAME | *empty* | *empty* |
| SYDENT_SERVER_NAME | **empty* | *empty* |
+--------------------+-----------------+-----------------------+
| SYDENT_CONF | ``sydent.conf`` | ``/data/sydent.conf`` |
+--------------------+-----------------+-----------------------+
Expand Down

0 comments on commit f1e96a6

Please sign in to comment.