From 130111c847fadb1981feac94cb95b09f7db55a62 Mon Sep 17 00:00:00 2001
From: Izalia Mae <izalia@barkshark.xyz>
Date: Sat, 26 Nov 2022 20:53:06 -0500
Subject: [PATCH] update documentation

---
 docs/commands.md      | 14 +++++++++++
 docs/configuration.md | 55 ++++++++++++++++++++-----------------------
 2 files changed, 39 insertions(+), 30 deletions(-)

diff --git a/docs/commands.md b/docs/commands.md
index 6e7da54..f8880f6 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -24,6 +24,20 @@ Run the setup wizard to configure your relay.
 	activityrelay setup
 
 
+## Config
+
+List the current configuration key/value pairs
+
+	activityrelay config
+
+
+### Set
+
+Set a value for a config option
+
+	activityrelay config set <key> <value>
+
+
 ## Inbox
 
 Manage the list of subscribed instances.
diff --git a/docs/configuration.md b/docs/configuration.md
index ecadac3..d52ca9e 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,6 +1,8 @@
 # Configuration
 
-## DB
+## General
+
+### DB
 
 The path to the database. It contains the relay actor private key and all subscribed
 instances. If the path is not absolute, it is relative to the working directory.
@@ -8,7 +10,7 @@ instances. If the path is not absolute, it is relative to the working directory.
 	db: relay.jsonld
 
 
-## Listener
+### Listener
 
 The address and port the relay will listen on. If the reverse proxy (nginx, apache, caddy, etc)
 is running on the same host, it is recommended to change `listen` to `localhost`
@@ -17,22 +19,41 @@ is running on the same host, it is recommended to change `listen` to `localhost`
 	port: 8080
 
 
-## Note
+### Note
 
 A small blurb to describe your relay instance. This will show up on the relay's home page.
 
 	note: "Make a note about your instance here."
 
 
-## Post Limit
+### Post Limit
 
 The maximum number of messages to send out at once. For each incoming message, a message will be
 sent out to every subscribed instance minus the instance which sent the message. This limit
 is to prevent too many outgoing connections from being made, so adjust if necessary.
 
+Note: If the `workers` option is set to anything above 0, this limit will be per worker.
+
 	push_limit: 512
 
 
+### Push 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.
+
+	workers: 0
+
+
+### JSON GET cache limit
+
+JSON objects (actors, nodeinfo, etc) will get cached when fetched. This will set the max number of
+objects to keep in the cache.
+
+	json_cache: 1024
+
+
 ## AP
 
 Various ActivityPub-related settings
@@ -82,29 +103,3 @@ setting this to the below list will block all other relays and prevent relay cha
 	- aoderelay
 	- social.seattle.wa.us-relay
 	- unciarelay
-
-
-## Cache
-
-These are object limits for various caches. Only change if you know what you're doing.
-
-
-### Objects
-
-The urls of messages which have been processed by the relay.
-
-	objects: 1024
-
-
-### Actors
-
-The ActivityPub actors of incoming messages.
-
-	actors: 1024
-
-
-### Actors
-
-The base64 encoded hashes of messages.
-
-	digests: 1024