configuration.md 2.27 KB
Newer Older
Izalia Mae's avatar
Izalia Mae committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# Configuration

## DB

The path to the database. It contains the relay actor private key and all subscribed
instances. If the path is not absolute, it is relative to the working directory.

	db: relay.jsonld


## Listener

The address and port the relay will listen on. If the reverse proxy (nginx, apache, caddy, etc)
is running on the same host, it is recommended to change `listen` to `localhost`

	listen: 0.0.0.0
	port: 8080


## Note

A small blurb to describe your relay instance. This will show up on the relay's home page.

	note: "Make a note about your instance here."


## Post Limit

The maximum number of messages to send out at once. For each incoming message, a message will be
sent out to every subscribed instance minus the instance which sent the message. This limit
is to prevent too many outgoing connections from being made, so adjust if necessary.

	push_limit: 512


## AP

Various ActivityPub-related settings


### Host

The domain your relay will use to identify itself.

	host: relay.example.com


### Whitelist Enabled

If set to `true`, only instances in the whitelist can follow the relay. Any subscribed instances
not in the whitelist will be removed from the inbox list on startup.

	whitelist_enabled: false


### Whitelist

A list of domains of instances which are allowed to subscribe to your relay.

	whitelist:
	- bad-instance.example.com
	- another-bad-instance.example.com


### Blocked Instances

A list of instances which are unable to follow the instance. If a subscribed instance is added to
the block list, it will be removed from the inbox list on startup.

	blocked_instances:
	- bad-instance.example.com
	- another-bad-instance.example.com


### Blocked Software

A list of ActivityPub software which cannot follow your relay. This list is empty by default, but
setting this to the above list will block all other relays and prevent relay chains

	blocked_software:
	- activityrelay
	- aoderelay
	- social.seattle.wa.us-relay
	- unciarelay


## Cache

These are object limits for various caches. Only change if you know what you're doing.


### Objects

The urls of messages which have been processed by the relay.

	objects: 1024


### Actors

The ActivityPub actors of incoming messages.

	actors: 1024


### Actors

The base64 encoded hashes of messages.

	digests: 1024