Activity-Relay/config.yml.example at master · thystra/Activity-Relay · GitHub

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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
ACTOR_PEM: /var/lib/relay/actor.pem
REDIS_URL: redis://redis:6379

RELAY_BIND: 0.0.0.0:8080
# Optional separate metrics and probe listener; disabled when unset.
# Keep it on a private container network and do not publish it publicly.
# OBSERVABILITY_BIND: 0.0.0.0:9090
RELAY_DOMAIN: relay.example.org
RELAY_SERVICENAME: Community ActivityPub Relay
JOB_CONCURRENCY: 50
MAX_ACTIVITY_BYTES: 1048576
MAX_FANOUT_TARGETS: 5000
MAX_QUEUE_JOBS: 100000
# Outbound authorized-fetch GET and delivery POST signature policy.
# Supported values: legacy, rfc9421, and dual. Empty or omitted defaults to
# dual for backward- and forward-compatible destination negotiation. Unknown
# deliveries still start with legacy and a delivery POST is never retried under
# another profile. Set legacy explicitly only when a peer population requires it.
OUTBOUND_SIGNATURE_PROFILE: dual
# Controls which broadly addressable activities enter public relay fan-out.
# explicit_public_only relays only when Public is in the primary `to` field.
# public_and_unlisted also relays when Public appears only in `cc`, preserving
# pre-3.0 behavior. Neither value makes followers-only or direct activities
# eligible unless they are explicitly addressed to the relay through another
# supported protocol path.
PUBLIC_ADDRESS_DISTRIBUTION_POLICY: explicit_public_only

# Optional Activity-Relay Directory entries. The list is absent by default and
# each entry is independently disabled unless explicitly enabled. The scheduler
# gate is also off by default and is honored only by the API server process.
# Example public Directory (disabled until explicitly enabled):
#   https://directory.argentwolf.org
# Maintained Directory index:
#   https://github.com/thystra/Activity-Relay/blob/master/docs/DIRECTORY-INDEX.md
DIRECTORY_SCHEDULER_ENABLED: false
# DIRECTORIES:
#   - origin: https://directory.argentwolf.org
#     enabled: false
#   - origin: https://directory.example.org
#     enabled: false
# Optional descriptive profile synchronized to v2/v3-capable Directories. This is
# public metadata only; it never changes relay delivery or follow policy.
# DIRECTORY_PROFILE:
# YAML top-level keys begin at column 1; indent only values nested below them.
#   # Registration status: open, restricted, or closed. Any other value is
#   # ignored with an operator warning and is not transmitted.
#   participation_mode: open
#   availability: public
#   relay_type: general
#   languages: [en]
#   countries: [US]
#   regions: []
#   topics: [general]
#   contact_fediverse: "@relay@example.social"
#   contact_email: relay@example.org
#   contact_url: https://relay.example.org/contact
#   participation_url: https://relay.example.org/join
#   notes: Public community relay
# Optional public support methods used by the bundled static landing site.
# Each entry requires a title and exactly one absolute HTTPS url or plain-text
# value. The relay runtime ignores this presentation-only block.
# SUPPORT:
#   - title: "Liberapay"
#     url: "https://liberapay.com/example/"
#   - title: "Bitcoin"
#     value: "bc1qexample"

# Single-disk defaults used by contrib/ops/resource-guard.py. These should
# match RELAY_STORAGE_DIR and RELAY_CACHE_DIR in the deployment environment.
STORAGE_DIR: /var/lib/activity-relay/redis
CACHE_DIR: /var/cache/activity-relay

# Limits accept plain bytes, decimal units (KB, MB, GB, TB), or binary units
# (KiB, MiB, GiB, TiB). Units are case-insensitive; decimals such as 1.5GB work.
STORAGE_LIMIT: 10GB
CACHE_LIMIT: 1GB
STORAGE_REQUIRE_MOUNT: false
CACHE_REQUIRE_MOUNT: false
RESOURCE_WARNING_PERCENT: 75
RESOURCE_CRITICAL_PERCENT: 100

ADMIN_EMAIL: root
MAIL_BACKEND: mail
MAIL_COMMAND: /usr/bin/mail
# Abort a blocked local mail submission instead of blocking future timer runs.
MAIL_TIMEOUT_SECONDS: 60
# MAIL_BACKEND: sendmail
# MAIL_COMMAND: /usr/sbin/sendmail

# Optional scheduled operational summaries.
#
# Times use the server's local timezone and zero-padded 24-hour HH:MM format.
# Each configured time is an independent daily slot and sends at most once.
# The five-minute resource-guard timer processes a due slot on its first run at
# or after the configured time, so delivery may be several minutes later.
#
# If several slots were missed during downtime, only the most recent due slot
# is mailed. The catch-up email records the skipped slots and explains how to
# inspect or reset them. Successful report bodies are archived in the guard
# state directory.
DAILY_SUMMARY_EMAIL: false
DAILY_SUMMARY_TIMES:
  - "08:00"
# Deprecated single-time settings. Ignored when DAILY_SUMMARY_TIMES is present.
# DAILY_SUMMARY_HOUR: 8
# DAILY_SUMMARY_MINUTE: 0
SUMMARY_STATUS_URL: http://127.0.0.1:8080/status.json

# Optional split-storage example. STORAGE_MOUNT_POINT lets the monitor validate
# the parent mount while Redis uses a dedicated child directory.
# STORAGE_DIR: /mnt/activity-relay-nas/redis
# STORAGE_LIMIT: 50GB
# STORAGE_REQUIRE_MOUNT: true
# STORAGE_MOUNT_POINT: /mnt/activity-relay-nas

# RELAY_SUMMARY: |
# Optional public relay branding. These are interoperability recommendations,
# not protocol limits; clients may crop or rescale the supplied images.
# RELAY_ICON: square logo/avatar; 512x512 px recommended (128x128 minimum).
# Keep important icon content centered and use a public HTTPS URL.
# RELAY_ICON: https://relay.example.org/assets/relay-icon.png
# RELAY_IMAGE: wide header/banner; 1500x500 px (3:1) recommended.
# Public fediverse contact shown in the optional website footer.
# The underscore spelling is canonical. Hyphenated aliases are accepted
# by the static-site builder only for backward compatibility.
# FEDIVERSE_OPERATOR_ID: "@operator@social.example"
# Optional explicit profile URL. This cannot be derived reliably from a handle
# because profile URL layouts differ among fediverse server applications.
# FEDIVERSE_OPERATOR_URL: "https://social.example/@operator"

# Keep important banner content away from the outer edges.
# RELAY_IMAGE: https://relay.example.org/assets/relay-banner.webp