From c0833bb69a3e34bbfcda765d74a184b53259de63 Mon Sep 17 00:00:00 2001
From: Brandon Thomas <echelon@gmail.com>
Date: Sun, 16 Jan 2022 10:41:11 -0500
Subject: [PATCH] Docs on Redis schema

---
 _docs/redis_schema.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/_docs/redis_schema.md b/_docs/redis_schema.md
index d5f1386a13..4b3ed5420f 100644
--- a/_docs/redis_schema.md
+++ b/_docs/redis_schema.md
@@ -1,3 +1,27 @@
 redis schema
 ============
 
+Database 0: TTS / RateLimiter
+-----------------------------
+
+TODO: Document rate limiter
+
+Public statistics on usage displayed on the website:
+
+* `ttsUseCount:{model_token}`: INCR, GET
+* `w2lUseCount:{template_token}`: INCR, GET
+  
+Temporary job progress reports to the user:
+
+These are written as a single string, such as "downloading model", "uploading model", 
+"generating preview", "executing", etc.
+
+* `ttsDownloadExtraStatus:{inference_job_token}`: SETEX, GET
+* `ttsInferenceExtraStatus:{inference_job_token}`: SETEX, GET
+* `w2lDownloadExtraStatus:{inference_job_token}`: SETEX, GET
+* `w2lInferenceExtraStatus:{inference_job_token}`: SETEX, GET
+
+Database 1: Obs / Twitch
+------------------------
+
+* WIP