nobigtech
/
pleroma-relay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README: document how to follow other relays

This commit is contained in:
kaniini 2018-11-18 14:43:28 +00:00
parent 332fd6992e
commit 26ed936019
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -56,3 +56,16 @@ Performance is very good, with all data being stored in memory and serialized to
JSON-LD object graph. Worker coroutines are spawned in the background to distribute
the messages in a scatter-gather pattern. Performance is comparable to, if not
superior to, the Mastodon relay software, with improved memory efficiency.
## Management
You can perform a few management tasks such as peering or depeering other relays by
invoking the `relay.manage` module.
This will show the available management tasks:
$ python3 -m relay.manage
When following remote relays, you should use the `/actor` endpoint as you would in
Pleroma and other LitePub-compliant software.