zulip archive

Zulip-Archiv

In Haskell geschriebener Zulip-Archiv-Viewer unter Verwendung des statischen Rib-Site-Generators.

Demo

Voraussetzungen

Installieren Sie zunächst den Nix-Paketmanager:

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

Aktivieren Sie optional den Nix-Cache, wenn Sie lokale Builds beschleunigen möchten:

 # 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

Zulip-API-Schlüssel

Holen Sie sich Ihren API-Schlüssel für zulip (Anleitung hier). Hinweis: Sie suchen nach Ihrem API-Schlüssel und nicht nach dem API-Schlüssel eines Bots.

Läuft

Erstellen Sie zunächst eine Konfigurationsdatei und fügen Sie Ihre Zulip-Site-Einstellungen hinzu (einschließlich des API-Schlüssels):

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

HINWEIS: Sie können den Inhalt der Konfigurationsdatei auch in der Umgebungsvariablen ZULIP_ARCHIVE_CONFIG übergeben, die Vorrang vor der Konfigurationsdatei hat. Dies kann zum Einrichten des GitHub Pages-Workflows verwendet werden (siehe ./.github/workflows ).

So erstellen und betreiben Sie die Site:

bin/run

Gehen Sie zu http://localhost:7004, um Ihre generierte Site anzuzeigen.

Manuelles Update

Vom Benutzer hochgeladene Dateien sind über die API nicht verfügbar. Sie müssen manuell exportiert werden (Administratorrechte erforderlich) und nach ./site/user_uploads kopiert werden.