Activity-Relay/readme.md
2021-06-20 18:18:37 +09:00

2.2 KiB

Activity Relay Server

Yet another powerful customizable ActivityPub relay server written in Go.

GitHub Actions codecov FOSSA Status

Powered by Ayame

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

Run

API Server

relay -c <Path of config file> server

Job Worker

relay -c <Path of config file> worker

CLI Management Utility

relay -c <Path of config file> control

Config

YAML Format

ACTOR_PEM: /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

This is Optional : When config.yaml not exists, use environment variable.

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

License

FOSSA Status

Project Sponsors

Thank you for your support.

Monthly Donation

My Donator List

Donation Platform