Linux

This software was built and tested on Ubuntu 22.04 LTS. Although other UNIX derivatives may be supported, this is not guaranteed.

System Requirements

Use the dependencies.sh file within the installation folder (vcpublisher_linux_version/vcPUBLISHER/) to install all required dependencies. Please use following command within the folder containing that bash file:

sudo bash dependencies.sh

Update

Skip this step if you are installing the VC Publisher for the first time!

This section is intended for users who wish to upgrade an existing 5.3 installation of the VC Publisher to version 6.

  • Open the old VC Publisher administration panel and navigate to configuration. Check the currently used settings for PUBLIC_DATA_PATH (path to public data folder), PRIVATE_DATA_PATH (path to private data folder) and cross origin header. Make a note of these values to use them in the new installation.

  • Do a backup of your data!: Backup the database and other relevant files, see chapter Backup data below.

  • Update: If you want to upgrade from a version older than v5.3, please contact <support@vc.systems>. For all upgrade paths do a backup of your data first and then install the newer VC Publisher:

  1. Unzip the downloaded zip file from the download page.

  2. Ensure all required dependencies are installed by running the dependencies.sh script in the installation folder. See chapter System Requirements for details.

  3. Update /etc/vcpublisher.conf to include all required environment variables. Especially check the variables PUBLIC_DATA_PATH and PRIVATE_DATA_PATH, which have been added with version 6.

  4. To complete VC Publisher setup run install.sh:

    sudo bash install.sh

Now the VC Publisher can be accessed on the configured HOST and PORT (default is http://localhost:3003).

If the VC Publisher seems to be unavailable after installation, please refer to chapter Troubleshooting at the end of this readme.

Installation

  1. Unzip the downloaded zip file from the download page.

  2. Ensure all required dependencies are installed by running the dependencies.sh script in the installation folder. See chapter System Requirements for details.

  3. Update setup.conf. in the installation folder with the required environment variables.

  4. Setup the VC Publisher by running install.sh after dependencies have been installed:

    sudo bash install.sh

Now the VC Publisher can be accessed on the configured HOST and PORT (default is http://localhost:3003).

If the VC Publisher seems to be unavailable after installation, please refer to chapter Troubleshooting at the end of this readme.

Backup

  1. Backup the database using the built-in program mongodump].

    1. Ensure the MongoDB service is active:

      sudo systemctl start mongodb.service

    2. Create and/or define a folder where the dump should be stored and do the DB backup:

      cd /to/dump/folder && mongodump

  2. If you wish to have a complete backup of the VC Publisher data, it is advisable to make a security copy of both the public and private folders (see environment variable PRIVATE_DATA_PATH and PUBLIC_DATA_PATH).

Depending on the streaming data, datasets in the projects can be very large (up to several hundred gigabytes).

Uninstall

To uninstall the VC Publisher you need to run the 'uninstall.sh' in /var/vcpublisher/:

sudo bash uninstall.sh

Only the VC Publisher software itself gets removed, the public and private data folders as well as the MongoDB data folder will not be deleted during this process. These folders can be used again with a new VC Publisher installation.