From c4ea83cca90315817e28307758bd1e42ab10d16a Mon Sep 17 00:00:00 2001
From: pvincent <pvincent@artcode.re>
Date: Mon, 30 Aug 2021 21:47:25 +0400
Subject: [PATCH] better README

---
 README.md | 102 ++++++++++++++++++++++++++++++++----------------------
 1 file changed, 61 insertions(+), 41 deletions(-)

diff --git a/README.md b/README.md
index 2dd3368..3ba238f 100755
--- a/README.md
+++ b/README.md
@@ -1,67 +1,84 @@
 CAGETTE PEI
 ===========
 
-Fourche du logiciel [Cagette.net](https://github.com/CagetteNet) à partir de la version 0.9.2 Novembre 2018
+> <french>
+> Fourche du logiciel [Cagette.net](https://github.com/CagetteNet) à partir de la version 0.9.2 Novembre 2018
+> 
+> Certaines portions du code source de Cagette.net n'étant plus disponibles en téléchargement à partir de cette date, 
+> j'ai repris sur la base d'un existant pour adapter au marché local réunionnais et leurs AMAPéi.
+> </french>
+
+## PREREQUISITE MARIADB
+
+```bash
+apt install -y mariadb-server
+mysql -u root <<EOF
+CREATE DATABASE cagettepei;
+GRANT ALL ON cagettepei.* TO 'cagettepei'@'%' IDENTIFIED BY 'cagettepei';
+EOF
+```
+
+## INSTALL FROM SCRATCH
 
-Certaines portions du code source de Cagette.net n'étant plus disponibles en téléchargement, 
-j'ai repris sur la base d'un existant pour adapter au marché local réunionnais et leurs AMAPéi.
+Rk: Works on any Debian (>=Buster) compatible server!
 
-## INSTALL FROM SCRATCH (debian-buster)
+```
+apt install -y curl 
+curl -L https://deb.nodesource.com/setup_8.x | bash -
+apt install -y nodejs=8.17.0-1nodesource1
+apt install -y sudo haxe apache2 make git imagemagick gettext libapache2-mod-neko mariadb-server sendemail libio-socket-ssl-perl libnet-ssleay-perl
 
-* apt install -y curl 
-* curl -L https://deb.nodesource.com/setup_8.x | bash -
-* apt install -y nodejs=8.17.0-1nodesource1
-* apt install -y sudo haxe apache2 make git imagemagick gettext libapache2-mod-neko mariadb-server
-* mysql -u root <<EOF
+mysql -u root <<EOF
 CREATE DATABASE cagettepei;
 GRANT ALL ON cagettepei.* TO 'cagettepei'@'%' IDENTIFIED BY 'cagettepei';
 EOF
-* cd /var/www
-  * git clone https://git.artcode.re/cagetters/cagettepei.git
-  * cd cagettepei
-    * make install ENV=dev # first time
-      * make compile # classes
-      * make templates # templates + i18n
-* vim /etc/apache2/sites-available/cagettepei.conf
+
+cd /var/www
+git clone https://git.artcode.re/cagetters/cagettepei.git
+cd cagettepei
+make install ENV=dev
+vim /etc/apache2/sites-available/cagettepei.conf
+```
+
 ```
 <VirtualHost *:80>
   ServerName cagettepei
   DirectoryIndex index.n
   DocumentRoot /var/www/cagettepei/www/
 
-  
+  CustomLog ${APACHE_LOG_DIR}/cagettepei/access.log combined
+  ErrorLog ${APACHE_LOG_DIR}/cagettepei/debug.log
+  ErrorLogFormat "[%{uc}t] %M"
 </VirtualHost>
 ```
-* sed -i '/<Directory \/var\/www\/>/,/<\/Directory>/ s/AllowOverride None/AllowOverride All/' /etc/apache2/apache2.conf
-* a2dissite 000-default.conf
-* a2ensite cagettepei.conf
-* a2enmod neko rewrite
-* systemctl restart apache2
+
+```bash
+sed -i '/<Directory \/var\/www\/>/,/<\/Directory>/ s/AllowOverride None/AllowOverride All/' /etc/apache2/apache2.conf
+a2dissite 000-default.conf
+a2ensite cagettepei.conf
+a2enmod rewrite
+mkdir -p /var/log/apache2/cagettepei
+systemctl restart apache2
+```
 
 ## CONFIGURATION
 
-* cd /var/www/cagettepei
-* vim config.xml
+```bash
+cd /var/www/cagettepei
+vim config.xml
+```
 ```
 <config
 host="<DOMAIN.TLD>"
+database="mysql://cagettepei:cagettepei@localhost/cagettepei"
 key="<SECRET_PHRASE>"
-name = "CagettePéi"
 default_email = "<EMAIL>"
 webmaster_email = "<EMAIL>"
-database="mysql://cagettepei:cagettepei@localhost/cagettepei"
-
-smtp_host="localhost"
-smtp_port="25"
-smtp_user=""
-smtp_pass=""
 
-lang="fr"
-langs="fr"
-langnames="Français"
-maintain="0"
 debug="0"
 sqllog="0"
+maintain="0"
+
 cache="1"
 cachetpl="0"
 />
@@ -72,16 +89,19 @@ ADMIN RESET PASSWORD
 
 go to http://localhost for ERROR + table regeneration, then
 
-* cd /var/www/cagettepei
-* SECRET=$(grep key= config.xml | cut -d= -f2 | cut -d'"' -f2)
-* echo "insert into User values (1,'fr',MD5('${SECRET}cagettepei'),1,'Administrateur','Cagette Péi', 'admin', null, null, null, null, null, null, null, null, null, now(), now(),6,null, null)" | mysql -h localhost -u cagettepei -pcagettepei cagettepei
+```
+cd /var/www/cagettepei
+SECRET=$(grep key= config.xml | cut -d= -f2 | cut -d'"' -f2)
+echo "insert into User values (1,'fr',MD5('${SECRET}cagettepei'),1,'Administrateur','Cagette Péi', 'admin', null, null, null, null, null, null, null, null, null, now(), now(),6,null, null)" | mysql -h localhost -u cagettepei -pcagettepei cagettepei
+```
 
 then, connect with admin / cagettepei
 
 ### change admin password
 
-* echo "update User set pass=MD5('${SECRET}cagettepei') where id=1" | mysql -h localhost -u cagettepei -pcagettepei cagettepei
-
+```
+echo "update User set pass=MD5('${SECRET}cagettepei') where id=1" | mysql -h localhost -u cagettepei -pcagettepei cagettepei
+```
 
 SYSTEMD-TIMERS
 --------------
@@ -98,7 +118,7 @@ SYSTEMD-TIMERS
 
 	SELECTOR=$1
 
-	for i in /var/www/cagettepei-* ; do
+	for i in /var/www/cagettepei* ; do
 		if [[ -d $i ]]; then
 			cd $i/www
 			echo "cron-$SELECTOR in: $i"