From f71d4a05626a3a7c9232097746d66c56d9bb3aac Mon Sep 17 00:00:00 2001
From: schiwagoa <webmaster@retronerd.at>
Date: Sat, 23 Mar 2024 23:33:46 +0100
Subject: [PATCH] =?UTF-8?q?readme=20angeh=C3=A4ngt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md        | 38 +++++++++++++++++++++++++++++++++++++-
 asciinema-client |  2 +-
 2 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4e75c36..710b6e2 100644
--- a/README.md
+++ b/README.md
@@ -5,4 +5,40 @@ Client zum Ausfzeichnen in der Terminal/Bash.
 Dies ist ein FORK von https://git.media-techport.de/scriptos/asciinema
 
 Mit freundlicher Genehmigung von <br>
-## scriptOS
\ No newline at end of file
+## scriptOS
+
+asciinema
+
+Ich biete hier eine Docker-Server installation und ein Script für eine Clientseitige Installation an
+asciinema Server
+
+Zur komfortablen Bereitstellung des asciinema Servers stelle ich euch eine speziell vorbereitete Docker-Kompositionsdatei zur Verfügung. Diese docker-compose.yaml beinhaltet präzise definierte Einstellungen und Umgebungsvariablen, um den asciinema Server als Container-Dienst einzurichten.
+
+    Download und Vorbereitung: Ladet die docker-compose.yaml-Datei herunter und speichert sie in einem passenden Verzeichnis auf eurem Server.
+
+    Erzeugung eines Secret-Keys: Generiert einen sicheren Schlüssel für eure Installation mit folgendem Befehl: tr -dc A-Za-z0-9 </dev/urandom | head -c 64; echo
+
+    Anpassung der Konfigurationsdatei: Öffnet die docker-compose.yaml und ersetzt den Platzhalter bei SECRET_KEY_BASE mit dem erzeugten Schlüssel. Passt die weiteren Umgebungsvariablen wie URL_HOST, SMTP_HOST und so weiter gemäß eurer Infrastruktur an.
+
+    Deployment: Startet euren asciinema Server mit dem Kommando: docker-compose up -d Dadurch werden die Docker Container im Hintergrund hochgefahren.
+
+Hinweise zur Konfiguration:
+
+    Der Dienst asciinema-app wird als Webapplikation konfiguriert, die auf Port 80 eures Hosts und intern auf Port 4000 des Containers lauscht.
+    Die Datenbankverbindung für asciinema-app erfolgt über einen separaten Postgres-Container, genannt asciinema-db.
+    Netzwerkeinstellungen innerhalb des dockernet sorgen für eine abgeschottete und sichere Kommunikation zwischen den Services.
+    Ich verwende Diesen Docker hinter einem eigenen ReverseProxy. Das bedeutet, diese Konfiguration ist für den Betrieb hinter einem ReverseProxy konfiguriert
+
+asciinema Client
+
+Der Client Installer ist relativ einfach gehalten. Das Script wird mit bash asciinema-client-installer.v1.sh ausgeführt und dann passiert folgendes:
+
+    Installation von asciinema: Das Skript aktualisiert zuerst die Paketlisten des Systems mit sudo apt update und installiert dann asciinema über sudo apt install asciinema -y.
+
+    Erkennung der Shell-Konfigurationsdatei: Es wird geprüft, ob eine .zshrc-Datei (für oh-my-zsh) im Root-Verzeichnis existiert. Falls ja, wird diese als Konfigurationsdatei (CONFIG_FILE) verwendet, ansonsten wird .bashrc verwendet.
+
+    Konfiguration der Umgebungsvariablen: Das Skript fügt der erkannten Konfigurationsdatei die Umgebungsvariable ASCIINEMA_API_URL hinzu, wobei die URL standardmäßig auf https://asciinema.media-techport.de gesetzt wird. Diese Einstellung ist spezifisch für eure API.
+
+    Informationen für den Benutzer: Nach der Konfiguration zeigt das Skript eine Nachricht an, die den Benutzer auffordert, das Terminal neu zu starten, um die Änderungen zu übernehmen.
+
+    Nützliche asciinema-Befehle: Zum Abschluss listet das Skript verschiedene asciinema-Befehle auf, die nach der Installation verwendet werden können, wie asciinema auth, asciinema rec, asciinema upload und weitere, zur Aufnahme, Bearbeitung, Wiedergabe und Verwaltung von Terminal-Sitzungen.
diff --git a/asciinema-client b/asciinema-client
index 482da05..14d0431 100644
--- a/asciinema-client
+++ b/asciinema-client
@@ -8,7 +8,7 @@
 # Git-Reposit.: https://git.retronerd.at/schiwagoa/asciinema.git
 # Version:      1.0.2
 # Datum:        23.03.2024
-# Modifikation: readme, FORK und Quelle angepasst
+# Modifikation: readme angehängt
 #####################################################
 
 ASCIINEMA_API_URL="https://asciinema.retronerd.at"