diff --git a/doc/doc.tex b/doc/doc.tex new file mode 100644 index 0000000..fda9105 --- /dev/null +++ b/doc/doc.tex @@ -0,0 +1,19 @@ +\documentclass[a4paper,11pt]{article} +\usepackage[T1]{fontenc} +\usepackage[utf8]{inputenc} +\usepackage{lmodern} + +\title{UPschooling Ticket System Technische Dokumentation} +\author{Benedikt Ziemons} + +\begin{document} + +\maketitle +\tableofcontents + +\begin{abstract} +\end{abstract} + +\section{} + +\end{document} diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000..8351683 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,65 @@ +--- +title: UPschooling Ticket System +subtitle: Technische Dokumentation +author: +- Benedikt Ziemons +--- + +# Einleitung + +Das UPschooling Ticket System ist ein Hilfstool für die Umsetzung +des UPschooling Projekts an Schulen. +Das System soll, vereinfacht, eine Möglichkeit für Schüler\*innen bieten, +technische Fragen zu Hardware zu stellen und von kompetenten +Helfenden Antworten zu bekommen. + +Zuerst werden in diesem Dokument die in der Planung festgehaltenen wichtigen +Zielsetzungen beschrieben, welche die Auswahl der verwendeten Software und +die notwendige Programmierung maßgeblich bestimmten. Anschließend wird die +bisherige Umsetzung (Stand August 2023) dieser und weitere geplante +Umsetzungen erläutert. + +# Zielstellungen + +1. __Keine persönlichen Daten der Schüler\*innen werden auf externe Server übertragen__ + Die einzigen zu speichernden und zu übertragenden Daten werden durch + die Kommunikation mit der Helfer\*in bestimmt. Für einen zusätzlichen Schutz + empfiehlt sich das Gespräch zusammen mit einer Aufsichtsperson oder einer + erziehungsberechtigten Person. +2. __Helfende benötigen keinen Zugriff auf das System in der Schule__ + Die Kommunikation mit Helfenden aus der Zivilgesellschaft soll über eine + bestimmte und sichere Schnittstelle erfolgen. Diese Bestimmtheit lässt sich + besser Überwachen und durch eine einzige Freigabe in Firewalls einrichten. +3. __Kommunikation erfolgt verschlüsselt und über erprobte Software__ + Die Kommunikation erfolgt über eine extern entwickelte Software, + welche gängige Sicherheitsstandards erfüllt und für die es + kommerziellen Support gibt. + +# Umsetzung + +Die genannten [Zielstellungen] grenzen die Auswahl der Software für +die Umsetzung des geplanten Ticketsystems ein. Weitere Auswahlkriterien +umfassen die Modularität des entstehenden Systems sowie existierende +Erfahrungen mit bestimmten Systemen seitens der Entwickelnden. + +Die Anfangsplanung sieht die Nutzung von [Nextcloud](https://nextcloud.com/de/) +als Platform und Oberfläche für die Anwendung vor. Nextcloud ist +eine modulbasierte Lösung für sogenannte "Cloud-Services". +Die Basisversion enthält bereits Funktionen wie eine Dateiablage, +Kalender und Kontaktverzeichnisse (siehe ähnliche Services großer Anbieter wie Google und Co.) +und deren Anbindung über generische Protokolle wie WebDAV oder CalDAV (welche auch von Thunderbird, Apple iPhones als Kalender-/Kontaktsynchronisation unterstützt werden). +Nextcloud wird außerdem bereits in manchen Schulen eingesetzt und dient dort +bspw. als Platform für eLearning. Die existierende Erfahrung von Schulen +mit Nextcloud als Platform und Systemadministrator\*innen der Schulen +mit dem System bestärkt die Entscheidung für Nextcloud. Der Datenschutz wird bei der +schuleigenen Nextcloud durch die Schule sichergestellt. + +Weitere Auswahl von Software für die Umsetzung ergibt sich durch +die Anforderungspunkte 2 und 3 der [Zielstellungen]. +Anforderung 2 schützt die Nextcloud (und Authentifikationssysteme) +der Schule und ließe zu diese Systeme mit Daten der Schüler\*innen +nur aus internen Netzen der Schule erreichbar zu machen. +Bedingt dadurch ist allerdings eine technische Kommunikationsschnittstelle +notwendig, welche den weiteren technischen Anforderungen genügt und +eine sichere Kommunikation zwischen Helfenden und Schüler\*innen zulässt. + diff --git a/doc/index.pdf b/doc/index.pdf new file mode 100644 index 0000000..a1bc97a Binary files /dev/null and b/doc/index.pdf differ