From 9a4551ca3a36ee01e67060e131b53a6f2748d60a Mon Sep 17 00:00:00 2001
From: pvincent <pvincent@artcode.re>
Date: Wed, 21 Feb 2024 23:17:42 +0400
Subject: [PATCH] first commit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2c9fedc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+MIAOU SERVER
+============
+
+provisioning tool for building opinionated architecture following these principles:
+* free software: AGPLv3
+* multi-target: DEV, BETA (alias staging), PROD
+* container-based: LXD/LXC on Debian 12 (bookworm)
+* secured: NFT
+* monitored: MONIT
+
+TODO
+----
+
+* [ ] less interactive command
+  * [ ] on lxd init during then install process
+* [ ] backup postgresql missing out on **saturday**
+* [ ] TOOLBOOX/nc (as binary)
+* [ ] nginx root domain redirects
+  * [ ] update dnsmasq as well
+* [ ] final ansible-like indicators: same/new
+* [ ] patched editor (backup+editor+diff+patch)
+* [ ] improve log journal for each `recipe` (apache, for example) in order to shorten disk space
+
+ORIGIN
+------
+
+The project name `miaou` comes up from both a French and Reunion's Creole pun
+* miaou is a shortcut for *mi aim aou*, which means 'I love you'
+* miaou means 'meow' in french, related to the acronym C.H.A.T.O.N.S
+
+ARCHITECTURE
+------------
+
+to draw... (mermaid?)
+
+* DEV (sync from PROD via SAVE, sync from BETA, push new to BETA)
+* BETA (sync from PROD via SAVE, push new to PROD)
+* PROD (backup to SAVE, full backup, recipe data backup)
+* SAVE (dedicated server, home local)
+
+ACTIVE COMPONENTS
+-----------------
+
+* grub
+  * cgroup1
+* linux
+* rust
+  * tera
+* go
+* perl
+* python
+  * ovh
+* bash
+  * miaou-bash
+
+
+Nested container test drive
+----------------------------
+
+* CONTAINER=nested
+* lxc-miaou-create $CONTAINER -o sameuser,nesting
+* lxc sameuser $CONTAINER
+  * /opt/miaou/lib/install.sh dev
+
+Hardening server
+----------------
+
+* /opt/miaou/lib/harden.sh
+
+Development mode
+----------------
+
+* # requirement Codium IDE
+* sudo apt install y shellcheck shfmt
+