From c271173904d568bae28f4fb35e15a971b64d7709 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Mon, 29 Aug 2022 13:59:12 +0200 Subject: [PATCH] update docs --- .../10_\342\234\205_Requirements.md" | 1 + .../20_\360\237\224\206_Init_a_new_project.md" | 0 .../10_init.sh.cfg.md" | 2 ++ .../20_Templates.md" | 8 ++++---- docs/_index.md | 2 +- readme.md | 2 +- 6 files changed, 9 insertions(+), 6 deletions(-) rename docs/10_Requirements.md => "docs/10_\342\234\205_Requirements.md" (55%) rename docs/20_Init_a_new_project.md => "docs/20_\360\237\224\206_Init_a_new_project.md" (100%) rename docs/30_Configuration/10_init.sh.cfg.md => "docs/30_\342\232\231\357\270\217_Configuration/10_init.sh.cfg.md" (99%) rename docs/30_Configuration/20_Templates.md => "docs/30_\342\232\231\357\270\217_Configuration/20_Templates.md" (97%) diff --git a/docs/10_Requirements.md "b/docs/10_\342\234\205_Requirements.md" similarity index 55% rename from docs/10_Requirements.md rename to "docs/10_\342\234\205_Requirements.md" index 41a319e..af02ac8 100644 --- a/docs/10_Requirements.md +++ "b/docs/10_\342\234\205_Requirements.md" @@ -2,3 +2,4 @@ * Bash (tested on Linux only) * Docker Non-root installation - see <https://docs.docker.com/engine/security/rootless/> +* ACL to enable write permissions on web data for Apache httpd in the container container and local user (you) \ No newline at end of file diff --git a/docs/20_Init_a_new_project.md "b/docs/20_\360\237\224\206_Init_a_new_project.md" similarity index 100% rename from docs/20_Init_a_new_project.md rename to "docs/20_\360\237\224\206_Init_a_new_project.md" diff --git a/docs/30_Configuration/10_init.sh.cfg.md "b/docs/30_\342\232\231\357\270\217_Configuration/10_init.sh.cfg.md" similarity index 99% rename from docs/30_Configuration/10_init.sh.cfg.md rename to "docs/30_\342\232\231\357\270\217_Configuration/10_init.sh.cfg.md" index 6f747e4..3990bd6 100644 --- a/docs/30_Configuration/10_init.sh.cfg.md +++ "b/docs/30_\342\232\231\357\270\217_Configuration/10_init.sh.cfg.md" @@ -3,6 +3,8 @@ This is the main configuration file. Its variables will be used by the templates. You can define your own additional variables to use them in templates too. +❗**It's a MUST to change this file.** + It is a MUST to change * APP_NAME diff --git a/docs/30_Configuration/20_Templates.md "b/docs/30_\342\232\231\357\270\217_Configuration/20_Templates.md" similarity index 97% rename from docs/30_Configuration/20_Templates.md rename to "docs/30_\342\232\231\357\270\217_Configuration/20_Templates.md" index 9cdad7f..366ba29 100644 --- a/docs/30_Configuration/20_Templates.md +++ "b/docs/30_\342\232\231\357\270\217_Configuration/20_Templates.md" @@ -187,11 +187,11 @@ Setup modules and the vhost including rewrites , ... </VirtualHost> ``` -## ✳️ extra-php-config.ini +## ✴️ extra-php-config.ini Custom PHP config file for you additional settings. -✳️ You **SHOULD** change this to setup Mysql database service for your needs. +✴️ You **SHOULD** change this to setup Mysql database service for your needs. ```ini # TARGET: docker/containers/web-server/php/extra-php-config.ini @@ -218,11 +218,11 @@ Custom PHP config file for you additional settings. ; xdebug.idekey="netbeans-xdebug" ``` -## ✳️ my.cnf +## ✴️ my.cnf If you use a Mariadb a 2nd container will be initialized using this my.cnf. -✳️ You **SHOULD** change this to setup Mysql database service for your needs. +✴️ You **SHOULD** change this to setup Mysql database service for your needs. ```ini # TARGET: docker/containers/db-server/mariadb/my.cnf diff --git a/docs/_index.md b/docs/_index.md index 7ad29c8..6d641ef 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -13,7 +13,7 @@ Free software and Open Source from University of Bern :: IML - Institute of Medi This template folder brings up a docker container with a PHP 8.x dev environment with Apache httpd2 + mod_php. -You also can add 2nd container with a Mariadb instance. +It can add an optionally 2nd container with a Mariadb instance.  diff --git a/readme.md b/readme.md index cc35ae7..a8d3b38 100755 --- a/readme.md +++ b/readme.md @@ -13,6 +13,6 @@ Free software and Open Source from University of Bern :: IML - Institute of Medi This template folder brings up a docker container with a PHP 8.x dev environment with Apache httpd2 + mod_php. -You also can add 2nd container with a Mariadb instance. +It can add an optionally 2nd container with a Mariadb instance.  -- GitLab