This is the document source of luca's security concept. Please go here for the HTML version: https://luca-app.de/securityconcept

This document is written as a jupyter-book. Install the python requirements via pip:

pip install -r requirements.txt

To render the diagrams you need plantuml. Install it via your package manager or download the .jar file directly:

wget -O - "https://sourceforge.net/projects/plantuml/files/plantuml-nodot.1.2021.1.jar/download" > plantuml.jar

Finally, run the buildhtml.sh from this directoy:

./buildhtml.sh

You can render a PDF document using LaTeX. First, install LaTeX on your system. Currently you will need to run ./buildhtml.sh once, to set up jupyter-book's _config.yml and then run:

PLANTUMLPATH='<your path to plantuml.jar>' PLANTUMLFORMAT='png' jupyter-book build content --builder pdflatex

Please adhere to the following rules when editing this document:

• in text blocks, write one sentence per line in the markdown file for Git-friendliness
• section headlines should have a Target Header marker following the form (chapter:section)= (e.g. (process:location_registration)=)
• prefer List Tables over markdown tables
• use underscores _ instead of spaces in file names
• don't skip header levels (i.e. no ### outside # and ##)
• use exactly one first level header (#) per page
• Python code must be black formatted