From 70aa1a7eaadae9b873b8d699ecf662c97b2af6b0 Mon Sep 17 00:00:00 2001
From: Julian Foad <julian@foad.me.uk>
Date: Fri, 2 Feb 2024 14:35:05 +0000
Subject: [PATCH] README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89999ac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+An Ansible role to deploy Quant-UX in (Docker) containers, with (optional) Traefik integration.
+
+## Requires
+
+On the controller:
+
+- Ansible
+- This role
+
+On the target machine:
+
+- Docker, including 'docker compose' command
+- Traefik configured to watch for Docker containers (optional)
+
+## Brief Instructions
+
+Download and store the role where your Ansible configuration can find it, either using ansible-galaxy or manually.
+
+Include the role in your playbook. Set the required variables, and any optional variables, in your inventory or with the 'vars' keyword. All required and optional variables are listed in 'defaults/main.yml'.
+
+Example (in 'roles' section in an Ansible playbook):
+
+```yaml
+  - role: quant-ux-docker-ansible
+    vars:
+      qux_domain: qux.example
+      qux_jwt_password: at_least_24_random_characters
+```
+
+## Routing, Traefik, Bind Ports
+
+This role puts Traefik labels on the containers, so that if Traefik is configured to watch for Docker containers, Traefik will read the labels and configure its routing.
+
+Alternatively, you can set the `qux_*_bind_port` variables to bind the container entry-points to host ports, and optionally configure your own reverse-proxy to route to them.