Installing distribution-specific packages

Use our packages for your distribution to install VidiCore.

Install the packages

You can either install the packages from our repository, or download and install the packages from our download page.

Note

VidiCore requires Java 17 which may not be available in the official repositories of older distributions. Install a third party repository providing Java 17 or upgrade to a newer distribution.

Install from official repository

To install VidiCore directly from our repository, head over to the repository page and follow the instructions.

Initialize the database

1. Create and give VidiCore access to an empty database:

   $ psql -c "CREATE USER vidispine PASSWORD 'vidispine'";
   $ psql -c "CREATE DATABASE vidispine OWNER vidispine";
   

   Ensure that TCP/IP is enabled for your server.

2. Ensure that PostgreSQL vacuuming is in place. For more details please refer to the knowledge base.

3. Modify the configuration file accordingly:

   $ vi /etc/vidispine/server.yaml
   

   database:
     driverClass: org.postgresql.Driver
     url: jdbc:postgresql://localhost/vidispine
     user: vidispine
     password: vidispine
     maxSize: 100
   

   Please align database.maxSize with your PostgreSQL server settings.

4. Initialize and migrate the database:

   $ vidispine db ping # verify connection
   $ vidispine db check # verify if tables exists (they shouldn't)
   $ vidispine db migrate
   $ vidispine db check # should succeed
   

Note

The /usr/bin/vidispine command is simply an alias to java -jar /usr/share/vidispine/server/vidispine-server.jar that is provided by the vidispine-server package.

Initialize the search index

1. Modify the configuration file accordingly:

   $ vi /etc/vidispine/server.yaml
   

   search:
     backend: opensearch
     url: http://localhost:9200/
   

2. Adust OpenSearch cluster defaults to match your cluster setup:

   When VidiCore creates the index via vidispine opensearch init (see below) the number of primary and replica shards are taken from the cluster default configuration. As this may not be the best choice for your cluster layout, we recommend applying a index template with values for index.number_of_shards and index.number_of_replicas matching your cluster layout. As a rule-of-thumb, the number of shards should be set to the number of cluster nodes and the number of replicas should be one.

   PUT _index_template/vidispine
   {
     "index_patterns": ["vidispine*"],
     "template": {
     "settings": {
             "index.number_of_shards": 5,
             "index.number_of_replicas": 1
       }
     }
   }
   

3. Initialize the search index:

   $ vidispine opensearch check # verify if the search index exists (it shouldn't)
   $ vidispine opensearch init
   $ vidispine opensearch check # should succeed
   

Note

The /usr/bin/vidispine command is simply an alias to java -jar /usr/share/vidispine/server/vidispine-server.jar that is provided by the vidispine-server package.

Start the services

1. Use systemd to start the services:

   $ systemctl start opensearch transcoder vidispine
   

2. Wait for VidiCore to start and then run APIinit to create the system metadata fields and the admin user.

   $ # wait for 8080 to become available, and then
   $ curl -X POST localhost:8080/APIinit
   

   Note

   APIinit is a migration step that must be run manually. It will be made part of the migration command in the future.

3. To verify that VidiCore is running, access http://localhost:8080/API/version using curl or HTTPie, or directly in your browser. The default admin password is admin.

   $ curl -X GET "localhost:8080/API/version" -uadmin:admin
   

Troubleshooting

• If the VidiCore service fails, then check the syslog or journal for errors:

  $ less /var/log/syslog
  

  $ journalctl -xn
  

• If the service dies, or never becomes available for some reason, then check the server log:

  $ less /var/log/vidispine/server.log
  

• If the service fails to start with a “UnsupportedClassVersionError: Unsupported major.minor version 51.0”, then make sure that the default system Java version is 7+ and not 6 or lower.

  $ sudo update-alternatives --config java
  

Configure VidiCore

Finally, you will need to configure VidiCore.