Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.39 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.39 KB
Raw

zulip-archive

Zulip archive viewer written in Haskell, using the rib static site generator.

Demo

Prerequisites

First, install the Nix package manager:

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

Optionally, enable the Nix cache if you would like to speed up local builds:

# 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 Key

Get your API key for zulip (instructions here). Note: you are looking for your API key, and not a bot's API key.

Running

First, create a configuration file, adding your Zulip site settings (including the API key):

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

NOTE: You can also pass the contents of the config file in the environment variable ZULIP_ARCHIVE_CONFIG which takes precedence over the config file. This can be used to setup GitHub Pages workflow (see ./.github/workflows).

To build and run the site:

bin/run

Go to http://localhost:7004 to view your generated site.

Manual update

User uploaded files are unavailable via the API. They must be manually exported (needs admin rights), and copied to ./site/user_uploads.