From 5c4ef4a529ec9ef6e26e868162230b269db35b59 Mon Sep 17 00:00:00 2001 From: glyph Date: Thu, 25 Nov 2021 11:15:39 +0200 Subject: [PATCH] update auth docs --- peach-web/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/peach-web/README.md b/peach-web/README.md index c7e9a02f..018ab8d7 100644 --- a/peach-web/README.md +++ b/peach-web/README.md @@ -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`