From 4d02202b2c29b47695232552d41a66de38aa8c5a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pavel=20B=C5=99ou=C5=A1ek?= <brousek@ics.muni.cz>
Date: Thu, 7 Mar 2024 14:21:40 +0100
Subject: [PATCH] docs: create README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e335e03
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Conformance IdP deployment
+
+To easily run the conformance IdP, you can use docker compose:
+
+```shell
+cd docker
+docker compose up -d --build
+```
+
+This will start SimpleSAMLphp at `http://localhost/simplesaml/module.php/admin` with the conformance module installed,
+mariaDB database and nginx as a reverse proxy.
+
+You need to mount configuration and metadata folders, see `docker-compose.yml`, and add HTTPS (e.g. Let's encrypt).
-- 
GitLab