zulip archive

zulip-archive

Visionneuse d'archives Zulip écrite en Haskell, utilisant le générateur de site statique rib.

Démo

Conditions préalables

Tout d'abord, installez le gestionnaire de packages Nix :

bash <( curl https://nixos.org/nix/install )

Eventuellement, activez le cache Nix si vous souhaitez accélérer les builds locaux :

 # If you do not already have cachix, install it:
nix-env -iA cachix -f https://cachix.org/api/v1/install
# Enable nix cache for rib
cachix use srid

Clé API Zulip

Obtenez votre clé API pour zulip (instructions ici). Remarque : vous recherchez votre clé API, et non la clé API d'un bot.

En cours d'exécution

Tout d'abord, créez un fichier de configuration, en ajoutant les paramètres de votre site Zulip (y compris la clé API) :

 cp config/config.example.dhall config/config.dhall
vim config/config.dhall

REMARQUE : Vous pouvez également transmettre le contenu du fichier de configuration dans la variable d'environnement ZULIP_ARCHIVE_CONFIG qui est prioritaire sur le fichier de configuration. Cela peut être utilisé pour configurer le workflow GitHub Pages (voir ./.github/workflows ).

Pour créer et gérer le site :

bin/run

Accédez à http://localhost:7004 pour afficher votre site généré.

Mise à jour manuelle

Les fichiers téléchargés par l'utilisateur ne sont pas disponibles via l'API. Ils doivent être exportés manuellement (nécessite des droits d'administrateur) et copiés dans ./site/user_uploads .