Skip to content

Commit

Permalink
Document authenticion options passed ot unelash. #233
Browse files Browse the repository at this point in the history
  • Loading branch information
ivaosthu committed Jan 17, 2018
1 parent 3ef6f0f commit ce18073
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down

0 comments on commit ce18073

Please sign in to comment.