esReven installation instructions

This section will guide you through the process of installing esReven. This is also necessary when upgrading from previous Reven <= 2.11 installation, in which case please read the "Upgrading Reven" section in the release notes first.

By the end of this section, you will have a running esReven server with its license setup.

Getting the packages

You can find the download links for the available esReven packages in the message you received from eShard containing your esReven license information.

Decrypt the packages

These packages are shipped encrypted, you need to decrypt them using the GPG command, then extract the unencrypted archive with tar and zstd.

To install GPG and zstd, you can run:

  1. Install the dependencies
  • For Debian based systems:
    • sudo apt install zstd gpg
  • For RPM based systems:
    • sudo dnf install zstd gpg
  1. Decrypt the archive:
  • gpg --output /path/to/archive/install-<xxx>.tar.zst -d /path/to/archive/install-<xxx>.tar.zst.gpg
  • You will be prompted for the password provided by eShard by e-mail.

Note: In some cases, if the above command fail, you may need to tell GPG you are in a TTY by using: export GPG_TTY=$(tty)

  1. Uncompress and extract the archive:
  • tar xvf /path/to/archive/install-<xxx>.tar.zst

Installation steps

esReven consists of a server and several clients. Everything can be accessed through the main web interface. As part of the installation process, you will create a first user account to access this interface.

Please follow the steps below to install esReven:

  1. Before installing, please review the pre-requisites.
  2. Installing the server part of the software is mandatory.
  3. After the server installation, it is mandatory to install a license to finalize the setup.
  4. You can now access your esReven installation entirely from the web interface.

Optionally, the client part can be installed locally.

Open source software license information

esReven implements programs governed by a free or open source license. The corresponding list of programs, their license(s) and source code are available at https://github.com/tetrane/tetrane-oss. These programs come with ABSOLUTELY NO WARRANTY; before using, modifying or distributing them, please make sure to read their license and accept the attached terms and conditions; you are welcome to redistribute free or open source software under certain conditions.

©2019-2023 eShard