From 7868bbfa1e696797b1b7e7e4e2c41a3b16e488ee Mon Sep 17 00:00:00 2001
From: Valentin Lab <valentin.lab@kalysto.org>
Date: Fri, 10 Oct 2025 08:57:08 +0200
Subject: [PATCH] new: doc: [opensem] add some ``README.org`` information

---
 README.org         |  6 +++++
 opensem/README.org | 66 ++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 67 insertions(+), 5 deletions(-)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..c493de2
--- /dev/null
+++ b/README.org
@@ -0,0 +1,6 @@
+# -*- ispell-local-dictionary: "english" -*-
+
+* What is jev-charms
+
+This contains the 0k charm recipes for a managed deployment of ~opensem~
+app on a 0k ready installation.
diff --git a/opensem/README.org b/opensem/README.org
index efc421b..a4032f6 100644
--- a/opensem/README.org
+++ b/opensem/README.org
@@ -3,11 +3,8 @@
 
 * Build source code
 
-Using a ~Dockerfile~ and forcing latest known working ~composer.lock~
-and ~yarn.lock~ to ensure reproducible build.
-
-We provide the resulting production ready application files in a
-~tar.xz~.
+Using ~opensem~ source code, with the ~./build.sh~, we can build a proper
+~opensem-X.Y.Z.tar.xz~ that is ready for deployment.
 
 * Charm usage
 
@@ -17,3 +14,62 @@ provides this relation.
 
 So you need to explicitly express this relation to a =stub= service.
 
+* Usage
+
+** Opensem
+
+Typical installation of opensem would be:
+
+#+begin_src yaml
+opensem:
+  charm: opensem
+  options:
+    env:
+      mail:
+        from:
+          name: "Boutique Jardin En Vie"
+          address: boutique@jardinenvie.com
+
+  relations:
+    publish-dir:
+      frontend:
+        domain: boutique.jardinenvie.com
+    paybox-system:
+      paybox:
+        test: true
+        rank: "001"  ## keep the double-quotes !
+        site: 2XXXX9
+        id: 2XXXXX4
+        hmac-key: "FFAXXXXX...XXXXX"
+
+paybox:
+  charm: stub
+
+letsencrypt:
+  options:
+    email: my-email@example.com
+
+frontend:
+  charm: mailcow-www
+
+logrotate:
+
+cron:
+
+jev-smtp:
+  charm: smtp-stub
+  options:
+    host: mail.jardinenvie.com
+    port: 465
+    connection-security: ssl
+    auth-method: password
+    login: boutique@jardinenvie.com
+    password: CXXXXXXXXXXg
+
+rsync-backup:
+  options:
+    ident: ext-00.jardinenvie.com
+    target: my-backup-host.com
+    private-key: |
+      # ...
+#+end_src