miaou-server/README.md

MIAOU 
=====

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

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

Debian12 fresh install
----------------------

* # log as normal user with sudo group
* sudo apt install -y git
* git clone https://git.artcode.re/miaou/miaou-server.git
* # EITHER:
  * ./miaou/lib/install.sh dev
  * # OR:
  * EMAIL=`<your email>` ./miaou/lib/install.sh dev
* # then, FINALLY
* miaou

Nested container test drive
----------------------------

* CONTAINER=nested
* lxc-miaou-create $CONTAINER -o sameuser,nesting
* lxc sameuser $CONTAINER
  * /opt/miaou-server/lib/install.sh dev

Hardening server
----------------

* /opt/miaou-server/lib/harden.sh

Development mode
----------------

* # requirement Codium IDE
* sudo apt install y shellcheck shfmt

Different Targets + experimental
--------------------------------

* BETA: the 'exp' mode stands for experimental and allow bypassing the SMTP dropped connection limitation
* PROD: the 'exp' mode is not recommanded and triggers a warning issue
* DEV: the 'exp' mode is not recommanded and triggers a warning issue