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

For the installation and start up of Versio.io the following packages are required:

  • Scripts for IT operations
    • Import Versio.io docker images
    • Start up Versio.io server
    • Shut down Versio.io server
    • Back Versio.io databases
  • Docker images
    • Reverse proxy
    • Microservices
    • Database management system
  • Default database content
    • Demo environment with example data
    • Admin user
    • Management

Operating systems

Supported OS types

The following operating systems are supported:

  • Ubuntu
  • Red Hat
  • CentOS

Prerequisites

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

  • TAR
  • GZip
  • OpenSSL
  • Curl
  • Docker
  • Docker-Compose

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 Define the folder to store all Versio.io logging and database data. /home/versio.io
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

Docker & Docker-Compose Version

The Versio.io startup script will automatically install the latest version of Docker and Docker-Compose if they are not already installed. If you want to use a specific version, you only need to install Docker and Docker-Compose before running the startup script.

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-private-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.

Starting up Versio.io

Before the first start or when updates are available, the Docker images must be imported once. The Docker images must be located in the '/images' directory. With the following script the Docker images can be imported:

bash versio.io-docker-images_import.sh

Command: Import Versio.io images

If 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 exist. If not it is installed.
  • Checking if SSL certificate exists. If not a default one is generated.
  • Prepare the reverse proxy configuration file.
  • Checking if specific 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

Shutting down Versio.io

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.