Skip to Content

Install Vinyl on Linux

Introduction

This page shows you how to install and run Vinyl on Debian or Red Hat Linux.

To install Vinyl on Linux, you must get software dependencies installed and configured, download and unpack a .tar.gz file, create a configuration file, then start Vinyl on the command line.

Tip

It is easier and recommended to run Vinyl as a Docker container.

Prerequisites

You must have the following:

  • A host that meets the system requirements.
  • A host account with root or sudo privileges. Use it for all actions on this page.
  • These packages installed and configured:

    The following examples show how to install these on two supported Linux distributions:

    # Install dotnet 6.0
    wget https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
    sudo dpkg -i packages-microsoft-prod.deb
    rm packages-microsoft-prod.deb
    
    # Install other dependencies
    apt-get install -y --no-install-recommends ca-certificates libc6 libgcc1 libgssapi-krb5-2 libicu67 libssl1.1 libstdc++6 zlib1g
    
    # Install dotnet 6.0 (package provider's version)
    yum install aspnetcore-runtime-6.0
    
    # Install other dependencies
    yum install ca-certificates glibc libgcc  sssd-krb5-common libicu openssl-libs libstdc++ zlib
    

Download and unpack

To unpack the downloaded .tar.gz file, follow these steps:

  1. Go to the Harmony portal Downloads page and click Linux tar in the Jitterbit Vinyl section to download the Vinyl .tar.gz installation package.

  2. In a terminal, run the following commands to create an installation directory and unpack the downloaded file:

    1
    2
    mkdir /app && cd $_
    tar -C /app -xvfz PATH_TO/vinyl-*-lin.tar.gz
    

    Notes

    • Line 1: The choice of /app is arbitrary, as Vinyl can run from any location where you have read/write access.
    • Line 2: If there is more than one Vinyl .tar.gz file in PATH_TO, specify the exact filename.

Configure

Vinyl reads its startup configuration from an appsettings.json file (used in this example) or from environment variables.

To configure Vinyl on startup, create an /app/appsettings.json file containing the following, with values substituted according to the table below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "ConnectionInfo": {
        "DatabaseType": "DB_TYPE",
        "HostName": "DB_HOSTNAME",
        "DatabaseName": "DB_NAME",
        "UserName": "DB_USERNAME",
        "Password": "DB_PASSWORD"
    },
    "License": {
        "LicenseKey": "LICENSE_KEY"
  }
}
Line Value Replace with
3 DB_TYPE Vinyl backend database type: SQLServer, MySQL, or PostgreSql
4 DB_HOSTNAME Vinyl backend database server name or IP address.
5 DB_NAME Vinyl (Recommended)
6 DB_USERNAME Vinyl backend database username.
7 DB_PASSWORD Vinyl backend database password.
10 LICENSE_KEY (Optional) Base64 encoded version of your Vinyl license file. If omitted, Vinyl prompts for it on first login.

Run

To start the Vinyl server and log into the Vinyl application, follow these steps:

  1. Run this command to set the default Vinyl server port number:

    export ASPNETCORE_URLS=http://+:80
    
  2. Run this command to start Vinyl:

    dotnet vinyl.dll
    
  3. In a browser, open http://VINYL_HOST (where VINYL_HOST is the hostname or IP address of the host) and wait for the Vinyl login page to appear.

    Tip

    Add the port number to the address if you changed it from the default :80 in step 1.