diff --git a/README.md b/README.md index 9c669f6..db59bec 100644 --- a/README.md +++ b/README.md @@ -1,140 +1,141 @@ -# **opensimMULTITOOL II V25.4 – Skript-Dokumentation** -Ein Bash-Skript zum Verwalten von OpenSim-Grids (Starten, Stoppen, Bereinigen, Installation). - -**Benutzung ausschließlich auf eigene Gefahr** -*Dieses Skript ist im Entwicklungsstadium und kann unbeabsichtigte Datenverluste verursachen.* - -```diff -- WICHTIGE WARNUNGEN: -1. Dies ist ein ALPHA-Skript - Im Produktivbetrieb nur nach ausführlichem Testing verwenden -2. Immer Backups erstellen VOR jeder Ausführung -3. Keine Haftung für Datenverlust oder Grid-Ausfälle -``` - -### 📜 **Nutzungsbedingungen** -> Durch die Ausführung dieses Skripts bestätigen Sie: -> - Die Risiken vollständig zu verstehen -> - Ausreichende Backups erstellt zu haben -> - Dass der Autor nicht für Schäden haftet - ---- - -## **📋 Inhaltsverzeichnis** -1. [OpenSim starten/stoppen](#-opensim-starten-stoppen-und-neustarten) -2. [OpenSim-Grid erstellen/aktualisieren](#-opensim-grid-erstellen-oder-aktualisieren) -3. [OpenSim bereinigen](#-opensim-grid-bereinigen) - ---- - -## **🔄 OpenSim starten, stoppen und neustarten** -| Befehl | Beschreibung | -|--------|-------------| -| `opensimstart` | Startet den OpenSim-Server. | -| `opensimstop` | Stoppt den OpenSim-Server. | -| `opensimrestart` | Startet OpenSim neu. | -| `check_screens` | Überprüft laufende OpenSim-Prozesse und startet sie bei Bedarf neu. | - -*(Optional implementiert, aber nicht aktiv genutzt:)* -| `standalonestart` | Startet OpenSim im Standalone-Modus. | -| `standalonestop` | Stoppt OpenSim im Standalone-Modus. | -| `standalonerestart` | Startet OpenSim Standalone neu. | - ---- - -## **🛠️ OpenSim-Grid erstellen oder aktualisieren** -### **Schritt 1: Vorbereitung** -| Befehl | Beschreibung | -|--------|-------------| -| `servercheck` | Prüft, ob der Server für OpenSim bereit ist. | -| `createdirectory` | Erstellt die benötigten Verzeichnisse. | -| `mariasetup` | Erstellt und richtet die MariaDB-Datenbanken ein. | -| `sqlsetup` | Erstellt und richtet die SQL-Datenbanken ein. | -| `setcrontab` | Konfiguriert crontab Automatisierungen. | - -### **Schritt 2: OpenSim herunterladen & kompilieren** -| Befehl | Beschreibung | -|--------|-------------| -| `opensimgitcopy` | Lädt OpenSim aus dem Git-Repository herunter. | -| `moneygitcopy` | Lädt den MoneyServer aus dem Git-Repository herunter. | -| `ruthrothgit` | Ruth/Roth IAR-Dateien aus Git herunterladen. ⚡ *Vorsicht* | -| `avatarassetsgit` | Ruth/Roth Assets aus Git herunterladen. ⚡ *Vorsicht* | -| `osslscriptsgit` | OSSL-Skripte aus Git herunterladen. ⚡ *Vorsicht* | -| `opensimbuild` | Kompiliert OpenSim. | - -### **Schritt 3: Konfiguration & Deployment** *(In Arbeit)* -| Befehl | Beschreibung | -|--------|-------------| -| `configall` | Vorkonfiguriert ein komplettes Test-Grid automatisch. ⚡ *Vorsicht* | -| `opensimcopy` | Kopiert OpenSim in alle Zielverzeichnisse. | -| *(Geplant)* `opensimconfig` | Konfiguriert OpenSim-Einstellungen. | -| `regionsconfig` | Konfiguriert automatisch OpenSim-Regionen. | - ---- - -## **🧹 OpenSim-Grid bereinigen** -⚠ **Warnung:** Einige Befehle erfordern eine **Neuinstallation** von OpenSim! - -| Befehl | Beschreibung | -|--------|-------------| -| `dataclean` | Entfernt alle alten Dateien von Robust & Sim. ⚡ | -| `pathclean` | Entfernt alle alten Verzeichnisse von Robust & Sim. ⚡ | -| `cacheclean` | Bereinigt den Cache von Robust & Sim. | -| `logclean` | Löscht alte Log-Dateien. | -| `mapclean` | Löscht alte Maptile-Karten. | -| `autoallclean` | Führt alle Cleaner aus. ⚡ *Neuinstallation erforderlich!* | -| `regionsclean` | Entfernt alle konfigurierten Regionen aus allen Simulatoren. | - -➜ **Das Grid läuft sofort nach einem Upgrade mit:** -- Behaltenen Regionen -- Gleichen Benutzerkonten -- Intakten Einstellungen - -⚠ **Warnung:** Dies ist eine gefährliche Aktion, bitte prüfen und vergleichen Sie die alten Konfigurationen mit den neuen Example-Konfigurationen. - ---- - -## **⚠️ Wichtige Hinweise** -- **`autoallclean` ist irreversibel!** → OpenSim muss danach neu installiert werden. -- **Backups erstellen**, bevor Bereinigungsbefehle ausgeführt werden. -- Auch wenn keine Konfigurationsdateien gelöscht werden, empfehle ich eine manuelle Sicherung. -- Einige Funktionen sind noch in Arbeit (`opensimconfig`, `regionsconfig`). - ---- - -## **🔄 OpenSimulator auto- start stop restart Beispiel** - -### List crontabs: - crontab -l - -### Edit crontabs: - crontab -e -``` -# Minute Hour Day Month Year Command -# -# Restart at 5 AM, and on the 1st of each month, restart the entire server. -# - -# Restart server on the first of each month to clear cache data debris. -40 4 1 * * bash /opt/osmtool.sh cacheclean -45 4 1 * * bash /opt/osmtool.sh reboot - -# Restart the grid every morning at 5 AM. -55 4 * * * bash /opt/osmtool.sh logclean -0 5 * * * bash /opt/osmtool.sh autorestart - -# If Robust or the Welcome region fails, restart the grid. -*/30 * * * * bash /opt/osmtool.sh check_screens -``` -### Save crontabs - ctrl O - Enter -### Exit editor - ctrl X - ---- - -## **📜 Lizenz & Nutzung** -- **Skriptname**: `osmtool.sh` -- **Version**: *V25.4.45.121* -- **Autor**: *Manfred Aabye* -- **Lizenz**: *MIT* +# **opensimMULTITOOL II V25.4 – Skript-Dokumentation** +Ein Bash-Skript zum Verwalten von OpenSim-Grids (Starten, Stoppen, Bereinigen, Installation). + +**Benutzung ausschließlich auf eigene Gefahr** +*Dieses Skript ist im Entwicklungsstadium und kann unbeabsichtigte Datenverluste verursachen.* + +```diff +- WICHTIGE WARNUNGEN: +1. Dies ist ein ALPHA-Skript - Im Produktivbetrieb nur nach ausführlichem Testing verwenden +2. Immer Backups erstellen VOR jeder Ausführung +3. Keine Haftung für Datenverlust oder Grid-Ausfälle +``` + +### 📜 **Nutzungsbedingungen** +> Durch die Ausführung dieses Skripts bestätigen Sie: +> - Die Risiken vollständig zu verstehen +> - Ausreichende Backups erstellt zu haben +> - Dass der Autor nicht für Schäden haftet + +--- + +## **📋 Inhaltsverzeichnis** +1. [OpenSim starten/stoppen](#-opensim-starten-stoppen-und-neustarten) +2. [OpenSim-Grid erstellen/aktualisieren](#-opensim-grid-erstellen-oder-aktualisieren) +3. [OpenSim bereinigen](#-opensim-grid-bereinigen) + +--- + +## **🔄 OpenSim starten, stoppen und neustarten** +| Befehl | Beschreibung | +|--------|-------------| +| `opensimstart` | Startet den OpenSim-Server. | +| `opensimstop` | Stoppt den OpenSim-Server. | +| `opensimrestart` | Startet OpenSim neu. | +| `check_screens` | Überprüft laufende OpenSim-Prozesse und startet sie bei Bedarf neu. | + +*(Optional implementiert, aber nicht aktiv genutzt:)* + +| `standalonestart` | Startet OpenSim im Standalone-Modus. | +| `standalonestop` | Stoppt OpenSim im Standalone-Modus. | +| `standalonerestart` | Startet OpenSim Standalone neu. | + +--- + +## **🛠️ OpenSim-Grid erstellen oder aktualisieren** +### **Schritt 1: Vorbereitung** +| Befehl | Beschreibung | +|--------|-------------| +| `servercheck` | Prüft, ob der Server für OpenSim bereit ist. | +| `createdirectory` | Erstellt die benötigten Verzeichnisse. | +| `mariasetup` | Erstellt und richtet die MariaDB-Datenbanken ein. | +| `sqlsetup` | Erstellt und richtet die SQL-Datenbanken ein. | +| `setcrontab` | Konfiguriert crontab Automatisierungen. | + +### **Schritt 2: OpenSim herunterladen & kompilieren** +| Befehl | Beschreibung | +|--------|-------------| +| `opensimgitcopy` | Lädt OpenSim aus dem Git-Repository herunter. | +| `moneygitcopy` | Lädt den MoneyServer aus dem Git-Repository herunter. | +| `ruthrothgit` | Ruth/Roth IAR-Dateien aus Git herunterladen. ⚡ *Vorsicht* | +| `avatarassetsgit` | Ruth/Roth Assets aus Git herunterladen. ⚡ *Vorsicht* | +| `osslscriptsgit` | OSSL-Skripte aus Git herunterladen. ⚡ *Vorsicht* | +| `opensimbuild` | Kompiliert OpenSim. | + +### **Schritt 3: Konfiguration & Deployment** *(In Arbeit)* +| Befehl | Beschreibung | +|--------|-------------| +| `configall` | Vorkonfiguriert ein komplettes Test-Grid automatisch. ⚡ *Vorsicht* | +| `opensimcopy` | Kopiert OpenSim in alle Zielverzeichnisse. | +| *(Geplant)* `opensimconfig` | Konfiguriert OpenSim-Einstellungen. | +| `regionsconfig` | Konfiguriert automatisch OpenSim-Regionen. | + +--- + +## **🧹 OpenSim-Grid bereinigen** +⚠ **Warnung:** Einige Befehle erfordern eine **Neuinstallation** von OpenSim! + +| Befehl | Beschreibung | +|--------|-------------| +| `dataclean` | Entfernt alle alten Dateien von Robust & Sim. ⚡ *Neuinstallation erforderlich!* | +| `pathclean` | Entfernt alle alten Verzeichnisse von Robust & Sim. ⚡ *Neuinstallation erforderlich!* | +| `cacheclean` | Bereinigt den Cache von Robust & Sim. | +| `logclean` | Löscht alte Log-Dateien. | +| `mapclean` | Löscht alte Maptile-Karten. | +| `autoallclean` | Führt alle Cleaner aus. ⚡ *Neuinstallation erforderlich!* | +| `regionsclean` | Entfernt alle konfigurierten Regionen aus allen Simulatoren. | + +➜ **Das Grid läuft sofort nach einem Upgrade mit:** +- Behaltenen Regionen +- Gleichen Benutzerkonten +- Intakten Einstellungen + +⚠ **Warnung:** Dies ist eine gefährliche Aktion, bitte prüfen und vergleichen Sie die alten Konfigurationen mit den neuen Example-Konfigurationen. + +--- + +## **⚠️ Wichtige Hinweise** +- **`autoallclean` ist irreversibel!** → OpenSim muss danach neu installiert werden. +- **Backups erstellen**, bevor Bereinigungsbefehle ausgeführt werden. +- Auch wenn keine Konfigurationsdateien gelöscht werden, empfehle ich eine manuelle Sicherung. +- Einige Funktionen sind noch in Arbeit (`opensimconfig`, `regionsconfig`). + +--- + +## **🔄 OpenSimulator auto- start stop restart Beispiel** + +### List crontabs: + crontab -l + +### Edit crontabs: + crontab -e +``` +# Minute Hour Day Month Year Command +# +# Restart at 5 AM, and on the 1st of each month, restart the entire server. +# + +# Restart server on the first of each month to clear cache data debris. +40 4 1 * * bash /opt/osmtool.sh cacheclean +45 4 1 * * bash /opt/osmtool.sh reboot + +# Restart the grid every morning at 5 AM. +55 4 * * * bash /opt/osmtool.sh logclean +0 5 * * * bash /opt/osmtool.sh autorestart + +# If Robust or the Welcome region fails, restart the grid. +*/30 * * * * bash /opt/osmtool.sh check_screens +``` +### Save crontabs + ctrl O + Enter +### Exit editor + ctrl X + +--- + +## **📜 Lizenz & Nutzung** +- **Skriptname**: `osmtool.sh` +- **Version**: *V25.4.45.121* +- **Autor**: *Manfred Aabye* +- **Lizenz**: *MIT*