new: doc: [opensem] add some `README.org` information

This commit is contained in:
Valentin Lab
2025-10-10 08:57:08 +02:00
parent 688536b1bd
commit 7868bbfa1e
2 changed files with 67 additions and 5 deletions

6
README.org Normal file
View File

@@ -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.

View File

@@ -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