Redis

​

Activer l’authentification par mot de passe

Si vous utilisez un service Redis externe et devez fournir un mot de passe, définissez les variables d’environnement OVERLEAF_REDIS_PASS et REDIS_PASSWORD dans le fichier config/variables.env, puis exécutez la commande bin/up -d pour recréer le conteneur sharelatex.

Si vous exécutez une instance locale de Redis, vous devrez configurer le service redis pour qu’il démarre avec l’authentification par mot de passe. Après avoir défini les variables d’environnement ci-dessus, vous devrez également effectuer les étapes supplémentaires suivantes :

Créez un fichier docker-compose.override.yml dans le répertoire config/ avec le contenu suivant :

config/docker-compose.override.yml

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

Si la persistance AOF est activée, vous devrez ajouter --appendonly yes à la command.

Exécutez bin/up -d pour recréer les conteneurs.

​

Activer la persistance Append-Only File

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

La persistance AOF (Append-Only File) de Redis offre un moyen robuste de garantir la durabilité des données en journalisant chaque opération d’écriture reçue par le serveur. Contrairement aux instantanés RDB, qui capturent votre jeu de données à un instant donné, l’AOF conserve un historique complet de toutes les modifications apportées à vos données.

La désactivation de RDB est facultative. Il est généralement recommandé d’utiliser les deux méthodes de persistance conjointement. Avant toute modification en production, examinez les avantages et les inconvénients de l’utilisation simultanée d’AOF et de RDB.

Pour en savoir plus sur l’activation de la persistance AOF dans Redis, consultez : 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. Planifiez une fenêtre de maintenance pour la mise à niveau.
2. Arrêtez l’instance avec bin/stop et faites une sauvegarde des dossiers config/ et data/.
3. Exécutez bin/up pour démarrer l’instance
4. Exécutez la commande docker exec -it redis sh
5. Exécutez la commande redis-cli pour ouvrir l’interface en ligne de commande de Redis
6. Dans redis-cli, exécutez la commande config set appendonly yes
7. Vous devez maintenant attendre que la réécriture AOF ait fini de persister les données. Pour cela, saisissez INFO persistence dans redis-cli et attendez que aof_rewrite_in_progress et aof_rewrite_scheduled valent 0, puis vérifiez que aof_last_bgrewrite_status vaut ok.
8. Quittez redis-cli en tapant exit puis en appuyant sur la touche Entrée
9. Quittez le conteneur redis en tapant exit puis en appuyant sur la touche Entrée
10. Exécutez la commande ls ./data/redis et vérifiez que le fichier appendonly.aof est bien présent
11. Modifiez le fichier config/overleaf.rc et passez la variable d’environnement REDIS_AOF_PERSISTENCE de false à true
12. Exécutez bin/up -d et assurez-vous que l’application fonctionne (l’éditeur de projet et le panneau d’historique sont opérationnels).