From 56bf2f093ef968487dff4e20754bcde28bd890e8 Mon Sep 17 00:00:00 2001 From: Naoki Kosaka Date: Tue, 22 Jun 2021 10:00:02 +0900 Subject: [PATCH] Fix about documents. --- main.go | 8 ++++---- readme.md | 10 +++++++--- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/main.go b/main.go index 36fc07c..307aed1 100644 --- a/main.go +++ b/main.go @@ -4,16 +4,16 @@ Yet another powerful customizable ActivityPub relay server written in Go. Run Activity-Relay API Server - ./Activity-Relay -c server + ./Activity-Relay --config /path/to/config.yml server Job Worker - ./Activity-Relay -c worker + ./Activity-Relay --config /path/to/config.yml worker CLI Management Utility - ./Activity-Relay -c control + ./Activity-Relay --config /path/to/config.yml control Config YAML Format - ACTOR_PEM: actor.pem + ACTOR_PEM: /var/lib/relay/actor.pem REDIS_URL: redis://localhost:6379 RELAY_BIND: 0.0.0.0:8080 RELAY_DOMAIN: relay.toot.yukimochi.jp diff --git a/readme.md b/readme.md index 883cff1..766d569 100644 --- a/readme.md +++ b/readme.md @@ -25,19 +25,19 @@ ### API Server ```bash -relay -c server +relay --config /path/to/config.yml server ``` ### Job Worker ```bash -relay -c worker +relay --config /path/to/config.yml worker ``` ### CLI Management Utility ```bash -relay -c control +relay --config /path/to/config.yml control ``` ## Config @@ -72,6 +72,10 @@ JOB_CONCURRENCY: 50 - RELAY_ICON - 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 [![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)