From d6d9de5423da6f661eff0e95b3d2a8091d86b934 Mon Sep 17 00:00:00 2001
From: Stefan van der Walt <stefanv@berkeley.edu>
Date: Fri, 28 Jun 2024 16:07:25 -0700
Subject: [PATCH] Document debug mode

---
 doc/setup.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/doc/setup.md b/doc/setup.md
index 6de7556..7e9d280 100644
--- a/doc/setup.md
+++ b/doc/setup.md
@@ -90,3 +90,22 @@ FLAGS environment variable:
 ```
 FLAGS="--config=myconfig.yaml" make run
 ```
+
+## Debug mode
+
+By default, `baselayer` runs in debug mode. In debug mode:
+
+- The server binds to localhost, not 0.0.0.0 (i.e., is not publicly
+  accessible).
+- Authentication always succeeds, but does not connect to any oauth
+  provider.
+- Code changes cause automatic reloads of the app, and recompilation
+  of Javascript bundles.
+-
+
+When switching to production mode (`debug` set to False in the config
+file):
+
+- The server binds to 0.0.0.0.
+- Javascript bundles are not compiled; they need to be pre-compiled
+  using `make bundle`.