Merge pull request #179 from sandrask/add-maintenance-mode

chore: Add maintenance mode
trustbloc · Nov 23, 2022 · 0cd1ccf · 0cd1ccf
2 parents 1256d0e + 71cb2f0
commit 0cd1ccf
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/readthedocs/source/orb/parameters.md b/readthedocs/source/orb/parameters.md
@@ -687,6 +687,21 @@ The maximum page size for an ActivityPub collection or ordered collection.
 
 Set to "true" to enable dev mode. When dev mode is enabled, no TLS is used.
 
+### enable-maintenance-mode
+
+| Arg                        | Env                      | Default |
+|----------------------------|--------------------------|---------|
+| --enable-maintenance-mode  | MAINTENANCE_MODE_ENABLED | false   |
+
+Set to "true" to enable maintenance mode.
+
+When maintenance mode is enabled:
+
+1) Health check returns status OK (200) even if errors are detected
+2) Sidetree operations and resolution endpoints are not available (503)
+3) Activity pub inbox is not available (503)
+
+
 ### nodeinfo-refresh-interval
 
 | Arg                         | Env                        | Default |