mirror of
https://github.com/TeamPiped/piped-federation.git
synced 2024-08-14 23:49:43 +00:00
Add information on how to join federation.
This commit is contained in:
parent
d240ac9c1a
commit
b6c785184b
1 changed files with 19 additions and 0 deletions
19
README.md
19
README.md
|
@ -1,3 +1,22 @@
|
|||
# piped-federation
|
||||
|
||||
All information about Piped's federation protocol on Matrix.
|
||||
|
||||
## How to join?
|
||||
|
||||
Register on a homeserver with no rate-limiting, or create your own homeserver.
|
||||
|
||||
If you would like an account on the `federation.piped.video` homeserver, message [@kavin1337:matrix.org](https://matrix.to/#/@kavin1337:matrix.org) on Matrix.
|
||||
|
||||
Set the homeserver URL in `config.properties` with the `MATRIX_SERVER` property.
|
||||
Example: `MATRIX_SERVER:https://matrix-client.matrix.org`
|
||||
|
||||
Set the Matrix access token with the `MATRIX_TOKEN` property.
|
||||
|
||||
Restart your Piped backend.
|
||||
|
||||
Send a PR to add your account to the [authorized-users.json](/authorized-users.json) file.
|
||||
|
||||
## Recommended homeservers to Host
|
||||
|
||||
Conduit: https://conduit.rs/
|
||||
|
|
Loading…
Reference in a new issue