From be2c5b144af519c9cf5a4308cbdadbb3eedc9f34 Mon Sep 17 00:00:00 2001 From: Izalia Mae Date: Sun, 18 Feb 2024 08:02:43 -0500 Subject: [PATCH] update docs --- docs/commands.md | 59 ++++++++++++++++++++++++++++++++++++++----- docs/configuration.md | 7 +++-- 2 files changed, 55 insertions(+), 11 deletions(-) diff --git a/docs/commands.md b/docs/commands.md index f56d24c..f437c8f 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -9,7 +9,7 @@ use `python3 -m relay` if installed via pip or `~/.local/bin/activityrelay` if i ## Run -Run the relay. +Run the relay. Optionally add `-d` or `--dev` to enable auto-reloading on code changes. activityrelay run @@ -58,6 +58,50 @@ Set a value for a config option activityrelay config set +## User + +### List + +List all available users. + + activityrelay user list + + +### Create + +Create a new user. You will be prompted for the new password. + + activityrelay user create [associated ActivityPub handle] + + +### Delete + +Delete a user. + + activityrelay user delete + + +### List Tokens + +List all API tokens for a user. + + activityrelay user list-tokens + + +### Create Token + +Generate a new API token for a user. + + activityrelay user create-token + + +### Delete Token + +Delete an API token. + + activityrelay user delete-token + + ## Inbox Manage the list of subscribed instances. @@ -75,7 +119,7 @@ List the currently subscribed instances or relays. Add an inbox to the database. If a domain is specified, it will default to `https://{domain}/inbox`. If the added instance is not following the relay, expect errors when pushing messages. - activityrelay inbox add + activityrelay inbox add --actor --followid --software ### Remove @@ -155,7 +199,7 @@ List the currently banned instances. Add an instance to the ban list. If the instance is currently subscribed, it will be removed from the inbox list. - activityrelay instance ban + activityrelay instance ban --reason --note ### Unban @@ -167,9 +211,10 @@ Remove an instance from the ban list. ### Update -Update the ban reason or note for an instance ban. +Update the ban reason or note for an instance ban. Either `--reason` and/or `--note` must be +specified. - activityrelay instance update bad.example.com --reason "the baddest reason" + activityrelay instance update bad.example.com --reason --note ## Software @@ -194,7 +239,7 @@ name via nodeinfo. If the name is `RELAYS` (case-sensitive), add all known relay software names to the list. - activityrelay software ban [-f/--fetch-nodeinfo] + activityrelay software ban [-f/--fetch-nodeinfo] --reason --note ### Unban @@ -214,4 +259,4 @@ If the name is `RELAYS` (case-sensitive), remove all known relay software names Update the ban reason or note for a software ban. Either `--reason` and/or `--note` must be specified. - activityrelay software update relay.example.com --reason "begone relay" + activityrelay software update relay.example.com --reason --note diff --git a/docs/configuration.md b/docs/configuration.md index 36f0463..ec8212f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -19,11 +19,10 @@ proxy is on the same host. port: 8080 -### Push Workers +### Web Workers -The relay can be configured to use threads to push messages out. For smaller relays, this isn't -necessary, but bigger ones (>100 instances) will want to set this to the number of available cpu -threads. +The number of processes to spawn for handling web requests. Leave it at 0 to automatically detect +how many processes should be spawned. workers: 0