You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/authentication.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,32 +33,29 @@ You can configure the gateway to use an auth plugin with the following two envir
33
33
34
34
See also: [auth plugins](https://github.com/openfaas/faas/tree/master/auth)
35
35
36
-
### OAuth2 support in the API Gateway (commercial add-on)
36
+
### OIDC and OAuth2 for the OpenFaaS API
37
37
38
-
The OpenFaaS API Gateway has support for OAuth2 and OpenID Connect as of version 0.14.4. This is enabled through the use of an [external authentication module](https://github.com/openfaas/faas/tree/master/auth) as documented above.
38
+
You can enable authentication via OpenID Connect and OAuth2 using the OpenFaaS REST API. This functionality is part of of the [OpenFaaS Premium Subscription](https://openfaas.com/support/).
39
39
40
-
You need to use the [OIDC plugin](https://github.com/alexellis/openfaas-oidc-plugin-pkg) which is available in binary format for Linux and MacOS on GitHub.
40
+
*[Get a 14-day free trial here](https://forms.gle/mFmwtoez1obZzm286)
41
41
42
-
The OIDC plugin is a commercial add-on, and you can request a trial or purchase a license from OpenFaaS Ltd via [sales@openfaas.com](mailto:sales@openfaas.com).
42
+
See also: [OpenFaaS and Okta for SSO](https://www.openfaas.com/blog/openfaas-oidc-okta/)
43
43
44
-
*[Fill out the following form for you trial](https://forms.gle/mFmwtoez1obZzm286)
44
+
#### Deploy the plugin using the helm chart
45
45
46
-
You will need two DNS A records and to enable `Ingress` for your Kubernetes cluster.
46
+
You will need two DNS A records and to enable `Ingress` for your Kubernetes cluster. In the example below the sub-zone `oauth.example.com` is used, however you can use a top-level domain or your own sub-zone.
47
47
48
48
* Gateway - `http://gw.oauth.example.com`
49
49
* Auth - `http://auth.oauth.example.com`
50
50
51
-
#### Deploy the plugin using the helm chart
52
-
53
-
These instructions are valid for 0.3.0 and higher of the commercial auth plugin.
54
-
55
51
Use `arkade` or `helm` and pass the following overrides, or edit your `values.yaml` file:
56
52
57
53
```sh
58
54
export PROVIDER=""# Set this to "azure" if using Azure AD.
59
55
export LICENSE=""# Obtain a trial from OpenFaaS Ltd, see above for instructions.
0 commit comments