Redis

​

Wachtwoordauthenticatie inschakelen

Als je een externe Redis-service gebruikt en een wachtwoord moet opgeven, kun je dat doen door de omgevingsvariabelen OVERLEAF_REDIS_PASS en REDIS_PASSWORD in te stellen in het bestand config/variables.env en vervolgens het commando bin/up -d uit te voeren om de sharelatex-container opnieuw aan te maken.

Als je een lokale Redis-instantie draait, moet je de redis-service zo configureren dat deze met wachtwoordauthenticatie start. Nadat je de bovenstaande omgevingsvariabelen hebt ingesteld, moet je ook de volgende extra stappen uitvoeren:

Maak een bestand docker-compose.override.yml aan in de map config/ met de volgende inhoud:

config/docker-compose.override.yml

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

Als je AOF-persistentie hebt ingeschakeld, moet je --appendonly yes toevoegen aan het command.

Voer bin/up -d uit om de containers opnieuw aan te maken.

​

Append-Only File-persistentie inschakelen

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

Redis AOF-persistentie (Append-Only File) biedt een robuuste manier om de duurzaamheid van gegevens te garanderen door elke schrijfoperatie die de server ontvangt te loggen. In tegenstelling tot RDB-snapshots, die momentopnamen van je dataset maken, houdt AOF een volledig overzicht bij van alle wijzigingen in je gegevens.

Het uitschakelen van RDB is optioneel. Over het algemeen wordt aanbevolen om beide persistentiemethoden samen te gebruiken. Bekijk de voor- en nadelen van het gecombineerd gebruiken van AOF en RDB voordat je wijzigingen in productie aanbrengt.

Meer informatie over het inschakelen van AOF-persistentie in Redis vind je 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. Plan een onderhoudsvenster voor de upgrade.
2. Stop de instantie met bin/stop en maak een back-up van de mappen config/ en data/.
3. Voer bin/up uit om de instantie te starten
4. Voer het commando docker exec -it redis sh uit
5. Voer het commando redis-cli uit om de Redis-opdrachtregelinterface te openen
6. Voer in de redis-cli het commando config set appendonly yes uit
7. Nu moet je wachten tot de AOF-rewrite klaar is met het persistent maken van de gegevens. Dat doe je door INFO persistence in de redis-cli te typen en te wachten tot aof_rewrite_in_progress en aof_rewrite_scheduled op 0 staan, en te controleren dat aof_last_bgrewrite_status gelijk is aan ok.
8. Verlaat de redis-cli door exit te typen en op Enter te drukken
9. Verlaat de redis-container door exit te typen en op Enter te drukken
10. ​Voer het commando ls ./data/redis uit en controleer of je het bestand appendonly.aof ziet
11. Bewerk het bestand config/overleaf.rc en wijzig de omgevingsvariabele REDIS_AOF_PERSISTENCE van false in true
12. Voer bin/up -d uit en controleer of de applicatie werkt (de projecteditor en het geschiedenispaneel functioneren).