From 59ef23fb6cb44aeb7a230af55a18fba02f7bd94b Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch> Date: Fri, 8 Sep 2023 13:37:38 +0200 Subject: [PATCH] update docs --- docs/20_Installation.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/20_Installation.md b/docs/20_Installation.md index d6c95e7..06deacb 100644 --- a/docs/20_Installation.md +++ b/docs/20_Installation.md @@ -1,4 +1,30 @@ -## Start from scratch +## First steps + +This project contains files for docker, the docs and webroot with a demo of implemented components. +To bring up and running: + +You need + +* a rootless docker instance (if it is working with docker as root I didn't tested). +* docker compose +* facl + +Steps: + +* start ./docker/init.sh +* press ``i`` to apply write permissions with setfacl command +* press ``u`` to startup the container + +In your browser open http://localhost:8008/. + +## Start a new project using demo page + +Steps: + +* delete the directories .git + docs +* delete the files .gitignore + readme.md + +## Start from scratch (WIP) If you have no AdminLTE page and want to jump in from point zero: -- GitLab