lilfade/Activity-Relay
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Fix about documents.

Browse Source
This commit is contained in:
Naoki Kosaka 2021-06-22 10:00:02 +09:00
parent 7242e75647
commit 56bf2f093e
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
main.go
View File

@ -4,16 +4,16 @@ Yet another powerful customizable ActivityPub relay server written in Go.
Run Activity-Relay Run Activity-Relay
API Server API Server
./Activity-Relay -c <Path of config file> server ./Activity-Relay --config /path/to/config.yml server
Job Worker Job Worker
./Activity-Relay -c <Path of config file> worker ./Activity-Relay --config /path/to/config.yml worker
CLI Management Utility CLI Management Utility
./Activity-Relay -c <Path of config file> control ./Activity-Relay --config /path/to/config.yml control
Config Config
YAML Format YAML Format
ACTOR_PEM: actor.pem ACTOR_PEM: /var/lib/relay/actor.pem
REDIS_URL: redis://localhost:6379 REDIS_URL: redis://localhost:6379
RELAY_BIND: 0.0.0.0:8080 RELAY_BIND: 0.0.0.0:8080
RELAY_DOMAIN: relay.toot.yukimochi.jp RELAY_DOMAIN: relay.toot.yukimochi.jp

10
readme.md
View File

@ -25,19 +25,19 @@
### API Server ### API Server
```bash ```bash
relay -c <Path of config file> server relay --config /path/to/config.yml server
``` ```
### Job Worker ### Job Worker
```bash ```bash
relay -c <Path of config file> worker relay --config /path/to/config.yml worker
``` ```
### CLI Management Utility ### CLI Management Utility
```bash ```bash
relay -c <Path of config file> control relay --config /path/to/config.yml control
``` ```
## Config ## Config
@ -72,6 +72,10 @@ JOB_CONCURRENCY: 50
- RELAY_ICON - RELAY_ICON
- RELAY_IMAGE - RELAY_IMAGE
## [Document](https://github.com/yukimochi/Activity-Relay/wiki)
See [GitHub wiki](https://github.com/yukimochi/Activity-Relay/wiki) to build / install / manage relay.
## License ## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay?ref=badge_large) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fyukimochi%2FActivity-Relay?ref=badge_large)