53 lines
1.7 KiB
Markdown
53 lines
1.7 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/worker`
|
|
- `github.com/yukimochi/Activity-Relay/cli`
|
|
|
|
## Requirements
|
|
|
|
- [Redis](https://github.com/antirez/redis)
|
|
|
|
## Installation Manual
|
|
|
|
See [GitHub wiki](https://github.com/yukimochi/Activity-Relay/wiki)
|
|
|
|
## Configration
|
|
|
|
### `config.yml`
|
|
|
|
```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
|
|
# relay_summary: |
|
|
|
|
# relay_icon: https://
|
|
# relay_image: https://
|
|
```
|
|
|
|
### `Environment Variable`
|
|
|
|
This is **Optional** : When `config.yml` not exists, use environment variable.
|
|
|
|
- `ACTOR_PEM` (ex. `/actor.pem`)
|
|
- `REDIS_URL` (ex. `redis://127.0.0.1:6379/0`)
|
|
- `RELAY_BIND` (ex. `0.0.0.0:8080`)
|
|
- `RELAY_DOMAIN` (ex. `relay.toot.yukimochi.jp`)
|
|
- `RELAY_SERVICENAME` (ex. `YUKIMOCHI Toot Relay Service`)
|
|
|
|
## License
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay?ref=badge_large) |