rafaelcaricio/relay
1
0
Fork 0
forked from mirrors/relay
Code Pull requests Activity

Add subscription information

Browse source
This commit is contained in:
asonix 2020-03-19 22:46:13 -05:00
parent 4cce0f950d
commit c9bb5632b8
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,7 +1,7 @@
# AodeRelay # AodeRelay
_A simple and efficient activitypub relay_ _A simple and efficient activitypub relay_
### USAGE ### Usage
To simply run the server, the command is as follows To simply run the server, the command is as follows
```bash ```bash
$ ./relay $ ./relay
@ -23,6 +23,15 @@ $ ./relay -uw asonix.dog blimps.xyz
Whitelisted domains are only checked against incoming activities if `WHITELIST_MODE` is enabled Whitelisted domains are only checked against incoming activities if `WHITELIST_MODE` is enabled
### Subscribing
Mastodon admins can subscribe to this relay by adding the `/inbox` route to their relay settings.
For example, if the server is `https://relay.my.tld`, the correct URL would be
`https://relay.my.tld/inbox`.
Pleroma admins can subscribe to this relay by adding the `/actor` route to their relay settings. For
ecample, if the server is `https://relay.my.tld`, the correct URL would be
`https://relay.my.tld/actor`.
### Supported Activities ### Supported Activities
- Announce {anything}, {anything} is Announced to listening servers - Announce {anything}, {anything} is Announced to listening servers
- Create {anything}, {anything} is Announced to listening servers - Create {anything}, {anything} is Announced to listening servers
@ -30,8 +39,12 @@ Whitelisted domains are only checked against incoming activities if `WHITELIST_M
- Follow Public, become a listener of the relay - Follow Public, become a listener of the relay
- Undo Follow {self}, stop listening on the relay, an Undo Follow will be sent back - Undo Follow {self}, stop listening on the relay, an Undo Follow will be sent back
- Undo Follow Public, stop listening on the relay - Undo Follow Public, stop listening on the relay
- Delete {anything}, the Delete Anything is relayed verbatim to listening servers - Delete {anything}, the Delete {anything} is relayed verbatim to listening servers
- Update {anything}, the Update Anything is relayed verbatim to listening servers - Update {anything}, the Update {anything} is relayed verbatim to listening servers
### Supported Discovery Protocols
- Webfinger
- NodeInfo
### Configuration ### Configuration
By default, all these values are set to development values. These are read from the environment, or By default, all these values are set to development values. These are read from the environment, or