Add configuration options

Signed-off-by: Alex Ellis <alexellis2@gmail.com>
This commit is contained in:
Alex Ellis
2019-06-05 12:12:28 +01:00
parent d6ef9cba43
commit 3edf499fac

View File

@ -1,6 +1,11 @@
basic-auth
============
This component provides plug-in authentication for the OpenFaaS gateway using basic authentication secrets.
This component implements [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) as an OpenFaaS authentication plug-in.
Wikipedia: [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
To run this plugin you will need to create and bind a secret named `basic-auth-user` and `basic-auth-password`
| Option | Usage |
|------------------------|--------------|
| `port` | Set the HTTP port |
| `secret_mount_path` | It is recommended that this is set to `/var/openfaas/secrets` |