From 9b92a6249317449c6738c3b22f77da625ba170c2 Mon Sep 17 00:00:00 2001 From: ivaosthu Date: Tue, 16 Jan 2018 15:29:52 +0100 Subject: [PATCH] Document authenticion options passed ot unelash. #233 --- docs/getting-started.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index f31ae85ef2e5..7e98bfbadaa9 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -41,6 +41,11 @@ Available unleash options includes: - **serverMetrics** (boolean) - Use this option to turn of prometheus metrics. - **preHook** (function) - This is a hook if you need to provide any middlewares to express before `unleash` adds any. Express app instance is injected as first arguement. - **preRouterHook** (function) - Use this to register custom express middlewares before the `unleash` specific routers are added. This is typically how you would register custom middlewares to handle authentication. +- **secret** (string) - Set this when you want to secure unleash. Used to encrypt the user session. +- **adminAuthentication** (string) - Use this when implementing cusotm admin authentication [securing-unleash](./securing-unleash.md). Legal values are: + - `none` - Will disable autentication all together + - `unsecure` - (default) Will use simple cookie based authentication. UI will require the user to specify an email in order to use unleash. + - `custom` - Use this when you implement your own custom authentication logic. ## How do I configure the log output?