Skip to content

Setup Versio.io Managed

For all customers who want to run Versio.io in their own environment, Versio.io Managed is available.

Installation & Startup Package

Please carry out the installation by following the steps below:

  1. Check server prerequisites
  2. Download Versio.io installer (get a customer specific link from Versio.io)
  3. Download Versio.io docker images (get a authorization for Versio.io Docker repository)
  4. Customize configuration
  5. Startup Versio.io server
  6. Shutdown Versio.io server

After successful installation, we recommend that you perform the following activities as soon as possible:

  1. Login with the default user and password
  2. Configure SMTP server for e-mail notification (necessary for initial password set/reset!)
  3. Create new admin user (see Environment settings - User & rights)
  4. Deactivate default admin user
    • Change default password
    • Remove from default environment (see Environment settings - User & rights)
  5. Create a new environment (see Server settings - Environment settings)
  6. Invite new user to the new environment (see Environment settings - User & rights)
  7. Install an OneImporter (see Environment settings - OneImporter - Install)
  8. Configure OneImporter configuration (see Environment settings - OneImporter - Configurations)

Prerequisites

Supported operating systems

The following operating systems are supported:

  • Red Hat
  • Debian
  • Ubuntu

Software components

The installer assumes that the following software components are already installed:

  • TAR & GZip
  • OpenSSL
  • WGET
  • Docker & Docker Compose
    • Docker (>= version 19.0.0)
    • Docker-Compose (>= version 1.24.0)
    • see install script

Download Versio.io images

Before the first start or when updates are available, the Docker images must be download once. With the following script the Docker images can be download. Please note that you must register for this in advance.

bash docker login repository.versio.io // authentification is needed
bash docker-pull-images-from-versio.io-repository.sh

Command: Download Versio.io images

Customizing

Environment variable

The following environment variables can be set to accommodate customer specific wishes, when starting Versio.io:

Environment variable Purpose of use Description Default value
VERSIO_DOMAIN Web server config Define the URL domain address under which the Versio.io browser user interface can be accessed on the network. The domain address must match the domain specified in the SSL certificate, otherwise the browser will display an error message. Host name
VERSIO_PORT_HTTPS Web server config Define the port on which Versio.io can be accessed via HTTPS. 443
VERSIO_PORT_HTTP Web server config Define the port on which Versio.io should be accessible via HTTP. Please note that the HTTP has to be enabled in 'docker-compose.yml'. 80
VERSIO_VALIDITY_CERTIFICATE Self generated SSL certificates Validity of self-generated SSL certificates in days. 365
VERSIO_DATA Versio.io server and backup.sh Define the folder to store all Versio.io logging and database data. /home/versio.io
VERSIO_BACKUP_FOLDER backup.sh Define the folder to store Versio.io backup data. /home/versio.io/backup
VERSIO_ENVIRONMENT Versio.io server Define the logging behavior of Versio.io. The value can be development or production. production

Configuration: Environment variables with default values

SSL certificate

The Versio.io startup script automatically generates an SSL certificate for HTTPS support if no certificate authority is available in the ./ssl folder (ca-root.pem and ca-private-key.pem).

For productive systems we recommend to store company specific SSL certificates in the ./ssl/versio.reverse-proxy folder of the startup script with following file names: * cert-private-key.pem for the private key * cert-public-key.pem for the public key

Please note that for self generated SSL certificates the certification authority 'ssl/ca-root.pem' should or must be made known on the client side:

  • Browser: Import of the certification authority into the certificate memory of the browser. If this is not done, you will receive a browser warning where you can again indicate that you accept the risk.
  • API usage: Announcement of the certification authority to the operating system or manual specification when starting the corresponding client application.

Startup Versio.io server

If the installation is finished and the Docker images are available, the Versio.io instance can be started:

bash startup.sh

Command: Start Versio.io instance

The following steps are performed during the start up process:

  • Checking if operating system is supported.
  • Checking if docker and docker-compose is installed.
  • Checking if SSL certificate exists. If not a default one is generated.
  • Prepare the reverse proxy configuration file.
  • Checking if Versio.io docker network exists. If not one is created.
  • Checking if environment variables are set. If not the default value is set.
  • Starting all required Versio.io components.

Enclosed is a sample output for starting a Versio.io instance:

Versio.io Managed Installer

Image: Versio.io Managed installer

Shutdown Versio.io server

To shut down a Versio.io instance the corresponding command must be executed:

bash shutdown.sh

Command: Stop Versio.io instance

Then, for example, updates of Versio.io Docker images or other maintenance work can take place before Versio.io is started again.

Backup Versio.io server data

To backup a Versio.io server instance with all environment data the corresponding command must be executed (see environment varibale VERSIO_BACKUP_FOLDER):

bash backup.sh

Command: Backuup Versio.io instance includes all environment data

The backup script creates a physical backup with name versio.io-backup-<date>-<time>.tar.gz. Physical backups are performed by copying the individual data files or directories (see logical versus physical backups).

To ensure data integrity, the Versio.io Server instance is stopped, the backup is performed and the Versio.io Server instance is restarted. This means that during this time the Versio.io Server is not available. The downtime depends on the data volume to be backed up and is displayed at the end of the backup execution.

Please note that a repocessing of the full-text search for each environment must be performed when restoring backup data (see Environment Settings - Full-text search - Reprocess environment)!

It is recommended to run the backup continuously e.g. based on cron jobs:

40 0 * * * /opt/versio.io/install/backup.sh

Configuration: Cronjob configuration for daily backup