Skip to content

Commit

Permalink
Document debug mode
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanv committed Jun 28, 2024
1 parent 2a45e36 commit d6d9de5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit d6d9de5

Please sign in to comment.