diegesis-monorepo

Monorepo containing Diegesis server and clients.

Overview

Diegesis server is a node express-based web server that can pull content from a number of open-access Bible archives, making them available in various formats via a GraphQL interface.

It can also serve static content, including multiple static websites. The monorepo includes several such clients, but others may be added at any URL via the config file. It is also possible to set up client-side routing redirection for one-page app frameworks such as React.

How to run (using Docker)

Running a Docker container is the easiest way to get started.

A quick test run
docker run -d -p 3060:2468 mvhs/diegesis-server
This will give you a full-blown instance of Diegesis Server to play with, accessible at http://localhost:3060. Mind you, though, that all data is ephemeral when starting this way. When the container is destroyed, all data is gone as well.

For production
docker run -d -p 3060:2468 -v /path/to/local/data:/app/data -v /path/to/local/config:/app/config mvhs/diegesis-server
This mounts both the data and config directory, giving you persistent storage and full control over the configuration respectively.
Diegesis expects a config.json in the config directory. A good start is the one used by the Docker image itself, which you can find here

Mountable directories
The following is a list of all paths that can be externally mounted

Path	Purpose
/app/config/	Diegesis configuration
/app/data/	Data storage
/app/ui_config/	UI configuration
/app/resources/	?
/app/default_structure/	Site configuration

Docker images
All our Docker images can be found on Docker Hub at mvhs/diegesis-server. The most important tags are latest, staging and dev.

How to run (manual install)

You want to do everything yourself, eh?

This assumes a fairly standard setup including the monorepo's public and admin React clients.

Ensure Node Version

If you are MacOS or Linux and have NVM, in the repository root run:

nvm install 18
nvm use 18

It will get the node version from the repository .nvmrc file.

If you are on Windows, get the node version from the .nvmrc file, e.g.:

nvm install 18.14.2
nvm use 18.14.2

If you don't use NVM, then ensure you have the node version in the .nvmrc file.

Use the script

go into the folder scripts and launch cleanInstall.sh!

cd scripts/
./cleanInstall.sh

After that you can skip the "Compile the clients" part and go directly to the "Make your own config file" section.

Compile the clients

First install the packages

cd diegesis-monorepo
npm install

then compile

cd apps/diegesis-user-client
npm run build
cd ../diegesis-upload-client
npm run build

Make your own config file

Start by copying config/debug_config.json. You may want to create a local directory for this. (That directory is gitignore'd.)

cd apps/diegesis-server
mkdir local
cp config/debug_config.json local/

Choose a server name

This is the identifier used for peer to peer transactions. Pick something short and meaningful in upper-case letters and digits.

Add a superuser

There is a command-line utility to do this. Note that it will currently store your plain text password in the bash log. The password hash is portable so, for production, one solution is to make the hash locally and then copy it into the production config file.

cd utils
node add_admin_user.js ../local/debug_config.json auser aGreatPassword admin archivist

You should then see a superuser record in your config file.

Run the server

# In diegesis-server directory
node src/index.js local/debug_config.json

If all goes well you should see the startup process in the console. If there's an issue (most likely with the config file) you should get a meaningful error.

Get some content

• Go to /admin, follow the login trail
• You can download content from four archives, which you select from the (slightly obscure) menu top left.
• Click on an entry, wait for the download icon to go grey, rinse and repeat

Note that a server cron will attempt to process new downloads using worker threads. You can configure the number of cores to give to this.

Visit the main site

Open your browser, go to localhost / and enjoy!