README.md 1006 Bytes
Newer Older
Eugen Rochko's avatar
Eugen Rochko committed
1 2
pub-relay
=========
3

Eugen Rochko's avatar
Eugen Rochko committed
4
...is a service-type ActivityPub actor that will re-broadcast anything sent to it to anyone who subscribes to it.
5

Eugen Rochko's avatar
Eugen Rochko committed
6
![](https://i.imgur.com/5q8db54.jpg)
7

Eugen Rochko's avatar
Eugen Rochko committed
8
Endpoints:
9

Eugen Rochko's avatar
Eugen Rochko committed
10 11 12
- `GET /actor`
- `POST /inbox`
- `GET /.well-known/webfinger`
13

Eugen Rochko's avatar
Eugen Rochko committed
14
Operations:
15

Eugen Rochko's avatar
Eugen Rochko committed
16 17 18 19 20 21
- Send a Follow activity to the inbox to subscribe
  (Object: `https://www.w3.org/ns/activitystreams#Public`)
- Send an Undo of Follow activity to the inbox to unsubscribe
  (Object of object: `https://www.w3.org/ns/activitystreams#Public`)
- Send anything else to the inbox to broadcast it
  (Supported types: `Create`, `Update`, `Delete`, `Announce`, `Undo`)
22

Eugen Rochko's avatar
Eugen Rochko committed
23
Requirements:
24

Eugen Rochko's avatar
Eugen Rochko committed
25 26 27 28 29 30 31 32 33
- All requests must be HTTP-signed with a valid actor
- Only payloads that contain a linked-data signature will be re-broadcast
- Only payloads addressed to `https://www.w3.org/ns/activitystreams#Public` will be re-broadcast

## Installation

Download the binaries.

## Usage
34

Eugen Rochko's avatar
Eugen Rochko committed
35
TODO
36 37 38

## Contributors

Eugen Rochko's avatar
Eugen Rochko committed
39
- [RX14](https://source.joinmastodon.org/RX14) creator, maintainer