feat: minimal docs for janitor app

msqd · Jun 14, 2024 · 5ac9a33 · 5ac9a33
1 parent 3291b80
commit 5ac9a33
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/docs/apps/index.rst b/docs/apps/index.rst
@@ -5,7 +5,8 @@ Applications
     :maxdepth: 1
 
     dashboard/index
-    proxy/index
     http_client/index
+    janitor/index
+    proxy/index
     sqlalchemy_storage/index
     telemetry/index
diff --git a/docs/apps/janitor/index.rst b/docs/apps/janitor/index.rst
@@ -0,0 +1,16 @@
+Janitor
+=======
+
+The ``janitor`` application runs a background worker to clean up the storage. It deletes all transactions older than 2
+months, and the related orphan blobs.
+
+Loading
+:::::::
+
+The proxy application is loaded by default when using the ``harp start`` command.
+
+You can disable it (not recommended) by passing it as an argument to the ``harp start`` command:
+
+.. code-block:: bash
+
+    harp start --disable janitor ...
diff --git a/harp_apps/janitor/docs b/harp_apps/janitor/docs
@@ -0,0 +1 @@
+../../docs/apps/janitor