Activity-Relay

command module

v1.2.6 Latest Latest Go to latest Published: Feb 23, 2023 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/yukimochi/Activity-Relay

Links

Open Source Insights

README ¶

Activity Relay Server

Yet another powerful customizable ActivityPub relay server written in Go.

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

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

Document

See GitHub wiki to build / install / control relay.

License

Project Sponsors

Thank you for your support.

Monthly Donation

My Donator List

Donation Platform

Documentation ¶

Overview ¶

Yet another powerful customizable ActivityPub relay server written in Go.

Run Activity-Relay ¶

API Server

./Activity-Relay --config /path/to/config.yml server

Job Worker

./Activity-Relay --config /path/to/config.yml worker

CLI Management Utility

./Activity-Relay --config /path/to/config.yml control

Config ¶

YAML Format

ACTOR_PEM: /var/lib/relay/actor.pem
REDIS_URL: redis://localhost: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: |
	YUKIMOCHI Toot Relay Service is Running by Activity-Relay
RELAY_ICON: https://example.com/example_icon.png
RELAY_IMAGE: https://example.com/example_image.png

Environment Variable ¶

This is 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

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
api
control
deliver
models

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL