PeachCloud
/
peach-workspace
3
2
Fork 1
Code Issues 17 Pull Requests Projects Releases Wiki Activity

update auth docs

This commit is contained in:
glyph 2021-11-25 11:15:39 +02:00
parent 35ff408365
commit 5c4ef4a529
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
peach-web/README.md
View File

@ -39,9 +39,7 @@ _Note: Networking functionality requires peach-network microservice to be runnin
### Environment
Authentication is enabled by default. It can be disabled by setting the `DISABLE_ROCKET_AUTH` environment variable to `true`:
`export DISABLE_ROCKET_AUTH=true`
**Deployment Mode**
The web application deployment mode is configured with the `ROCKET_ENV` environment variable:
@ -49,6 +47,14 @@ The web application deployment mode is configured with the `ROCKET_ENV` environm
Other deployment modes are `dev` and `prod`. Read the [Rocket Environment Configurations docs](https://rocket.rs/v0.5-rc/guide/configuration/#environment-variables) for further information.
**Authentication**
Authentication is disabled in `development` mode and enabled by default when running the application in `production` mode. It can be disabled by setting the `ROCKET_DISABLE_AUTH` environment variable to `true`:
`export ROCKET_DISABLE_AUTH=true`
**Logging**
Logging is made available with `env_logger`:
`export RUST_LOG=info`