Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yukimochi/Activity-Relay

Yet another powerful customizable ActivityPub relay server written in Go.
https://github.com/yukimochi/Activity-Relay

activitypub golang mastodon misskey

Last synced: about 2 months ago
JSON representation

Yet another powerful customizable ActivityPub relay server written in Go.

Host: GitHub
URL: https://github.com/yukimochi/Activity-Relay
Owner: yukimochi
License: agpl-3.0
Created: 2018-10-28T13:08:52.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-07-31T14:34:18.000Z (5 months ago)
Last Synced: 2024-10-29T20:18:33.999Z (2 months ago)
Topics: activitypub, golang, mastodon, misskey
Language: Go
Homepage: https://relay.toot.yukimochi.jp/
Size: 1.83 MB
Stars: 283
Watchers: 7
Forks: 40
Open Issues: 16
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

awesome-fediverse - Activity Relay - Activity Relay is a powerful customizable ActivityPub relay server written in Go. (Applications)

README

# Activity Relay Server

## Yet another powerful customizable ActivityPub relay server written in Go.

[![GitHub Actions](https://github.com/yukimochi/activity-relay/workflows/Test/badge.svg)](https://github.com/yukimochi/Activity-Relay)
[![codecov](https://codecov.io/gh/yukimochi/Activity-Relay/branch/master/graph/badge.svg)](https://codecov.io/gh/yukimochi/Activity-Relay)

![Powered by Ayame](docs/ayame.png)

## 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](https://github.com/antirez/redis)

## Run

### API Server

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

### Job Worker

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

### CLI Management Utility

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

## Config

### YAML Format

```yaml config.yml
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:///inbox`

### Pleroma and their forks

Follow this actor `https:///actor`

## [Document](https://github.com/yukimochi/Activity-Relay/wiki)

See [GitHub wiki](https://github.com/yukimochi/Activity-Relay/wiki) to build / install / control relay.

## License

GNU AFFERO GENERAL PUBLIC LICENSE

## Project Sponsors

Thank you for your support!

### Monthly Donation

- [Patreon](https://www.patreon.com/yukimochi)
- [pixivFANBOX](https://yukimochi.fanbox.cc)
- [fantia](https://fantia.jp/fanclubs/11264)

**[My Donor List](https://relay.toot.yukimochi.jp#patreon-list)**

### Open Source Support Program

- [JetBrains for Open Source](https://jb.gg/OpenSourceSupport)