aboutsummaryrefslogtreecommitdiffstats
path: root/roles/nginx-cloudflare-mtls/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/nginx-cloudflare-mtls/README.md')
-rw-r--r--roles/nginx-cloudflare-mtls/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/roles/nginx-cloudflare-mtls/README.md b/roles/nginx-cloudflare-mtls/README.md
new file mode 100644
index 0000000..8d766ae
--- /dev/null
+++ b/roles/nginx-cloudflare-mtls/README.md
@@ -0,0 +1,19 @@
+# Role "nginx-cloudflare-mtls"
+
+Installs the certificate required for performing mutual TLS authentication
+between NGINX and Cloudflare.
+
+To use mutual TLS in your NGINX virtual hosts, add this configuration snippet:
+
+```nginx
+ssl_client_certificate {{ nginx_cloudflare_mtls_certificate_path }};
+ssl_verify_client on;
+```
+
+
+## Variables
+
+See [role defaults](./defaults/main.yml) for an annotated overview.
+
+
+<!-- vim: set textwidth=80 ts=2 ts=2: -->