90 lines
2.2 KiB
Markdown
90 lines
2.2 KiB
Markdown
# Activity Relay Server
|
|
|
|
## Yet another powerful customizable ActivityPub relay server written in Go.
|
|
|
|
[](https://github.com/yukimochi/Activity-Relay)
|
|
[](https://codecov.io/gh/yukimochi/Activity-Relay)
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay?ref=badge_shield)
|
|
|
|
|
|
|
|
## 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 -c <Path of config file> server
|
|
```
|
|
|
|
### Job Worker
|
|
|
|
```bash
|
|
relay -c <Path of config file> worker
|
|
```
|
|
|
|
### CLI Management Utility
|
|
|
|
```bash
|
|
relay -c <Path of config file> control
|
|
```
|
|
|
|
## Config
|
|
|
|
### YAML Format
|
|
|
|
```yaml config.yml
|
|
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
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay?ref=badge_large)
|
|
|
|
## Project Sponsors
|
|
|
|
Thank you for your support.
|
|
|
|
### Monthly Donation
|
|
|
|
**[My Donner List](https://relay.toot.yukimochi.jp#patreon-list)**
|
|
|
|
#### Donation Platform
|
|
- [Patreon](https://www.patreon.com/yukimochi)
|
|
- [pixiv fanbox](https://yukimochi.fanbox.cc)
|
|
- [fantia](https://fantia.jp/fanclubs/11264)
|