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: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,31 @@ Provides a SAML SP authentication proxy for backend web services
8
8
9
9
```text
10
10
-attribute-header-mappings attribute=header
11
-
Comma separated list of attribute=header pairs mapping SAML IdP response attributes to forwarded request header [SAML_PROXY_ATTRIBUTE_HEADER_MAPPINGS]
11
+
Comma separated list of attribute=header pairs mapping SAML IdP response attributes to forwarded request header (env SAML_PROXY_ATTRIBUTE_HEADER_MAPPINGS)
12
12
-authorize-attribute attribute
13
-
Enables authorization and specifies the attribute to check for authorized values [SAML_PROXY_AUTHORIZE_ATTRIBUTE]
13
+
Enables authorization and specifies the attribute to check for authorized values (env SAML_PROXY_AUTHORIZE_ATTRIBUTE)
14
14
-authorize-values values
15
-
If enabled, comma separated list of values that must be present in the authorize attribute [SAML_PROXY_AUTHORIZE_VALUES]
15
+
If enabled, comma separated list of values that must be present in the authorize attribute (env SAML_PROXY_AUTHORIZE_VALUES)
16
16
-backend-url URL
17
-
URL of the backend being proxied [SAML_PROXY_BACKEND_URL]
17
+
URL of the backend being proxied (env SAML_PROXY_BACKEND_URL)
18
18
-base-url URL
19
-
External URL of this proxy [SAML_PROXY_BASE_URL]
19
+
External URL of this proxy (env SAML_PROXY_BASE_URL)
20
20
-bind host:port
21
-
host:port to bind for serving HTTP [SAML_PROXY_BIND] (default ":8080")
21
+
host:port to bind for serving HTTP (env SAML_PROXY_BIND) (default ":8080")
22
22
-idp-ca-path path
23
-
Optional path to a CA certificate PEM file for the IdP [SAML_PROXY_IDP_CA_PATH]
23
+
Optional path to a CA certificate PEM file for the IdP (env SAML_PROXY_IDP_CA_PATH)
24
24
-idp-metadata-url URL
25
-
URL of the IdP's metadata XML [SAML_PROXY_IDP_METADATA_URL]
25
+
URL of the IdP's metadata XML (env SAML_PROXY_IDP_METADATA_URL)
26
26
-name-id-format string
27
-
One of unspecified, transient (default), email, or persistent to use a standard format or give a full URN of the name ID format [SAML_PROXY_NAME_ID_FORMAT]
27
+
One of unspecified, transient (default), email, or persistent to use a standard format or give a full URN of the name ID format (env SAML_PROXY_NAME_ID_FORMAT)
28
28
-name-id-mapping header
29
-
Name of the request header to convey the SAML nameID/subject [SAML_PROXY_NAME_ID_MAPPING]
29
+
Name of the request header to convey the SAML nameID/subject (env SAML_PROXY_NAME_ID_MAPPING)
30
30
-new-auth-webhook-url URL
31
-
URL of webhook that will get POST'ed when a new authentication is processed [SAML_PROXY_NEW_AUTH_WEBHOOK_URL]
31
+
URL of webhook that will get POST'ed when a new authentication is processed (env SAML_PROXY_NEW_AUTH_WEBHOOK_URL)
32
32
-sp-cert-path path
33
-
The path to the X509 public certificate PEM file for this SP [SAML_PROXY_SP_CERT_PATH] (default "saml-auth-proxy.cert")
33
+
The path to the X509 public certificate PEM file for this SP (env SAML_PROXY_SP_CERT_PATH) (default "saml-auth-proxy.cert")
34
34
-sp-key-path path
35
-
The path to the X509 private key PEM file for this SP [SAML_PROXY_SP_KEY_PATH] (default "saml-auth-proxy.key")
35
+
The path to the X509 private key PEM file for this SP (env SAML_PROXY_SP_KEY_PATH) (default "saml-auth-proxy.key")
36
36
```
37
37
38
38
The snake-case values, such as `SAML_PROXY_BACKEND_URL`, are the equivalent environment variables
0 commit comments