readme.md

Activity Relay Server

Yet another powerful customizable ActivityPub relay server written in Go.

Packages

• github.com/yukimochi/Activity-Relay
• github.com/yukimochi/Activity-Relay/api
• github.com/yukimochi/Activity-Relay/deliver
• github.com/yukimochi/Activity-Relay/control
• github.com/yukimochi/Activity-Relay/models

Requirements

• Redis

Run

API Server

relay --config /path/to/config.yml server

Job Worker

relay --config /path/to/config.yml worker

CLI Management Utility

relay --config /path/to/config.yml control

Config

YAML Format

ACTOR_PEM: /var/lib/relay/actor.pem
REDIS_URL: redis://redis:6379

RELAY_BIND: 0.0.0.0:8080
RELAY_DOMAIN: relay.toot.yukimochi.jp
RELAY_SERVICENAME: YUKIMOCHI Toot Relay Service
JOB_CONCURRENCY: 50
# RELAY_SUMMARY: |

# RELAY_ICON: https://
# RELAY_IMAGE: https://

Environment Variable

Optional : When config file not exist, use environment variables.

• ACTOR_PEM
• REDIS_URL
• RELAY_BIND
• RELAY_DOMAIN
• RELAY_SERVICENAME
• JOB_CONCURRENCY
• RELAY_SUMMARY
• RELAY_ICON
• RELAY_IMAGE

How to Use Relay (for Relay Customers)

Mastodon, Misskey and their forks

Subscribe this inbox https://<your-relay-server-address>/inbox

Pleroma and their forks

Follow this actor https://<your-relay-server-address>/actor

Document

See GitHub wiki to build / install / control relay.

License

GNU AFFERO GENERAL PUBLIC LICENSE

Project Sponsors

Thank you for your support!

Monthly Donation

• Patreon
• pixivFANBOX
• fantia

My Donor List

Open Source Support Program

• JetBrains for Open Source