Giter Club home page Giter Club logo

activity-relay's Introduction

Activity Relay Server

Yet another powerful customizable ActivityPub relay server written in Go.

GitHub Actions codecov

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

My Donor List

Open Source Support Program

activity-relay's People

Contributors

danorton avatar fossabot avatar hezhizhen avatar mhamzahkhan avatar shleeable avatar skehmatics avatar yukimochi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.