Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document debug mode #385

Merged
merged 1 commit into from
Jun 28, 2024
Merged

Document debug mode #385

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions doc/setup.md
View file
Open in desktop
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`.
Loading