Packaging information

Here is a list of the various packages you have received as part of your installation. See also this version's compatibility information.

Note that these packages are encrypted when shipped; please refer to the instruction received in the email for how to decrypt them.

esReven

esReven's software is shipped as an archive containing, among other things, multiple Docker images, installable on any Linux amd64 using Docker Compose.

The provided installation material consists of an encrypted compressed archive of the type install-esReven-<date-version>-<tag>.tar.zst.gpg containing:

• An installation documentation as reference, README.md
• An upgrade documentation, UPGRADE_FROM_2.X.md to migrate previous versions's data
• Initialization and operation scripts, respectively init.sh and start_stop.sh
• Several Docker images to implement esReven:
  • esConnect - /esconnect - the user management framework
    • /blueprints folder, contains initial setup
    • /scripts folder, contains wizard installer for initial installation
    • A docker image (esconnect:x.img)
  • esDynamic-Meta - /metaenv - the main application framework
    • Two docker images esdmeta_web.img + esdmeta_api.img
    • A folder with a database structure dump docker-entrypoint.d/*
  • esReven - /reven - the Reven server software
    • A docker image reven2:x.y.z-xxx.img
  • esDynamic Hub - /esdynamic-hub/ - the Jupyter environment
    • Two docker images esDynamic Hub + esDynamic
    • A license file
    • A docker-compose .yml file
• A configuration file *.py in root/etc/esdynamic/ folder containing the JupyterHub settings

Knowledge modules

esReven also comes bundled with knowledge modules that contain interactive documentation in the form of Knowledge, Tutorial or Use-Case Jupyter notebooks.

Each module comes as a separate archive, and must be installed alongside the esReven software.

Here is an overview of one package's content:

• esReven-knowledge_base-<ModuleName>-<version>.tar.zst
  • README.md: installation procedure.
  • <ModuleName>: module's folder.
    • 00-Knowledge-What_is_inside.ipynb: summary of the module.
    • [...]: more notebooks & resources.

Axion AppImage

This shipment contains Axion's AppImage. It consists of a file named Axion-2.*.AppImage that can be used to run the Axion GUI locally on any Linux amd64 or Windows 10 with WSL.

Note that running this client is not required - it simply allows the user to install the GUI on its own machine. See the Installing the Reven clients page for more info.