Skip to content
Snippets Groups Projects
Unverified Commit 65e92820 authored by Matthew Hodgson's avatar Matthew Hodgson Committed by GitHub
Browse files

Merge pull request #100 from trieloff/patch-1

docs(readme): clarify synapse availability
parents ccdd8ffc 90ee9c65
No related branches found
No related tags found
No related merge requests found
...@@ -13,7 +13,7 @@ Chatterbox lets you securely embed [Hydrogen](https://github.com/vector-im/hydro ...@@ -13,7 +13,7 @@ Chatterbox lets you securely embed [Hydrogen](https://github.com/vector-im/hydro
To use Chatterbox you will need: To use Chatterbox you will need:
- A homeserver which supports [Token-authenticated registration](https://spec.matrix.org/v1.3/client-server-api/#token-authenticated-registration). Currently the only known implementation is [Synapse](https://github.com/matrix-org/synapse). - A homeserver which supports [Token-authenticated registration](https://spec.matrix.org/v1.3/client-server-api/#token-authenticated-registration). Currently the only known implementation is [Synapse](https://github.com/matrix-org/synapse) (which is available as a service from [element.io](https://element.io)).
- An account on that homeserver which can create registration tokens. Synapse requires the account to be an admin. - An account on that homeserver which can create registration tokens. Synapse requires the account to be an admin.
### Develop Instructions ### Develop Instructions
...@@ -90,4 +90,4 @@ $ curl --data '{ "uses_allowed": 50 }' -H 'Authorization: Bearer YOUR_ADMIN_TOKE ...@@ -90,4 +90,4 @@ $ curl --data '{ "uses_allowed": 50 }' -H 'Authorization: Bearer YOUR_ADMIN_TOKE
``` ```
Note that you can use `uses_allowed` to set how many chatterbox users can register via this token before no more will be permitted. Note that you can use `uses_allowed` to set how many chatterbox users can register via this token before no more will be permitted.
You can then use the value of `token` in the response inside your `config.json`. You can then use the value of `token` in the response inside your `config.json`.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment