From 724e05e4b14623a6d8fe92456e39cd8ff3e0ca2a Mon Sep 17 00:00:00 2001
From: Jan Hartig <jan.hartig@ptb.de>
Date: Tue, 15 Aug 2023 11:59:25 +0200
Subject: [PATCH] Add architecture overview

---
 architecture.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 architecture.md

diff --git a/architecture.md b/architecture.md
new file mode 100644
index 0000000..47df7d8
--- /dev/null
+++ b/architecture.md
@@ -0,0 +1,15 @@
+# Architecture overview
+
+1. Webserver takes and validates user submitted files
+2. Cron job scans files and enqueues new jobs on cluster
+3. Job gets processed on the cluster using [whisper-webvtt-transcriber](https://gitlab1.ptb.de/janhartig/whisper-webvtt-transcriber)
+4. Mailservice scans job folders for completed jobs and:
+   - Sends processed files to users
+   - Optional: Notifies admins on processing errors
+   - Optional: Sends monitoring data to webserver 
+
+
+State is tracked through the following files in the jobs folder:
+   - new: Job has been submitted by user
+   - done: Job has been processed without errors
+   - error: Job has been processed with errors
\ No newline at end of file
-- 
GitLab