Redis

​

Passwortauthentifizierung aktivieren

Wenn Sie einen externen Redis-Dienst verwenden und ein Passwort angeben müssen, setzen Sie dazu die Umgebungsvariablen OVERLEAF_REDIS_PASS und REDIS_PASSWORD in der Datei config/variables.env und führen Sie den Befehl bin/up -d aus, um den sharelatex-Container neu zu erstellen.

Wenn Sie eine lokale Redis-Instanz betreiben, müssen Sie den redis-Dienst so konfigurieren, dass er mit Passwortauthentifizierung startet. Nachdem Sie die oben genannten Umgebungsvariablen gesetzt haben, müssen Sie außerdem die folgenden zusätzlichen Schritte ausführen:

Erstellen Sie im Verzeichnis config/ eine Datei docker-compose.override.yml mit folgendem Inhalt:

config/docker-compose.override.yml

services:
    redis:
        command: "redis-server --requirepass <YOUR-PASSWORD>"

Wenn Sie die AOF-Persistenz aktiviert haben, müssen Sie --appendonly yes zum command hinzufügen.

Führen Sie bin/up -d aus, um die Container neu zu erstellen.

​

Append-Only-File-Persistenz aktivieren

(Original: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/redis#enabling-append-only-file-persistence)

Die Redis-AOF-Persistenz (Append-Only File) bietet eine robuste Möglichkeit, die Dauerhaftigkeit von Daten sicherzustellen, indem jede vom Server empfangene Schreiboperation protokolliert wird. Im Gegensatz zu RDB-Snapshots, die zeitpunktbezogene Kopien Ihres Datenbestands erstellen, führt AOF eine vollständige Aufzeichnung aller Änderungen an Ihren Daten.

Das Deaktivieren von RDB ist optional. Im Allgemeinen wird empfohlen, beide Persistenzmethoden gemeinsam zu verwenden. Bevor Sie Änderungen in der Produktion vornehmen, sollten Sie die Vor- und Nachteile des gemeinsamen Betriebs von AOF und RDB abwägen.

Weitere Informationen zum Aktivieren der AOF-Persistenz in Redis finden Sie hier: https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#how-i-can-switch-to-aof-if-im-currently-using-dumprdb-snapshotsarrow-up-right

1. Planen Sie ein Wartungsfenster für das Upgrade ein.
2. Stoppen Sie die Instanz mit bin/stop und erstellen Sie eine Sicherung der Ordner config/ und data/.
3. Führen Sie bin/up aus, um die Instanz zu starten
4. Führen Sie den Befehl docker exec -it redis sh aus
5. Führen Sie den Befehl redis-cli aus, um die Redis-Kommandozeile zu öffnen
6. Führen Sie in der redis-cli den Befehl config set appendonly yes aus
7. Nun müssen Sie warten, bis das AOF-Rewrite die Daten vollständig persistiert hat. Geben Sie dazu INFO persistence in die redis-cli ein, warten Sie, bis aof_rewrite_in_progress und aof_rewrite_scheduled den Wert 0 haben, und prüfen Sie, ob aof_last_bgrewrite_status den Wert ok hat.
8. Verlassen Sie die redis-cli, indem Sie exit eingeben und die Eingabetaste drücken
9. Verlassen Sie den redis-Container, indem Sie exit eingeben und die Eingabetaste drücken
10. ​Führen Sie den Befehl ls ./data/redis aus und vergewissern Sie sich, dass die Datei appendonly.aof vorhanden ist
11. Bearbeiten Sie die Datei config/overleaf.rc und ändern Sie die Umgebungsvariable REDIS_AOF_PERSISTENCE von false auf true
12. Führen Sie bin/up -d aus und stellen Sie sicher, dass die Anwendung funktioniert (der Projekteditor und der Verlaufsbereich sind funktionsfähig).