These instructions are not suitable for Raspberry Pi OS users.
Pi OS users must install using Docker.
Introduction
We have made a simple, all-in-one installer for EVVR Containers for Intel/AMD or ARM64 machines running Ubuntu/Debian-style Linux.
This makes it simple to install and test EVVR Container, and allows you to install a container without an internet connection (if you have the right dependencies installed).
However, for larger or automated type installs, we recommend using a Docker-type install as this provides more flexibility and the ability to download updates directly from Docker..
Prerequisites
Before you begin you should have:
Compatible hardware (or a virtual machine running on compatible hardware) with Ubuntu installed.
Be logged into a terminal, with a user account that can utilise sudo.
(The user account created during the installation of Ubuntu qualifies)
You do not need to use the Linux graphical interface for EVVR Container and can perform all the following operations locally or via SSH.
If you are using an older Linux installation it is recommended to bring your machine up to date before installation by performing these commands in your Terminal:
sudo apt update
sudo apt upgrade
And follow any appropriate guidance supplied to update to the latest version (this may include a reboot).
Offline installation
In theory you can use the .DEB installation method without an internet connection, however in practice you must ensure the following packages are installed before going offline:
docker.io, docker-compose-v2, jc, jq, iproute2
Step 1 - Download the appropriate .DEB file
Visit our Downloads site to download the .DEB that corresponds to your host platform.
You should now make sure to copy/move this file to the home folder of the user account you are using to install EVVR Container.
Step 2 - Install the .DEB file
In your terminal window enter the following:
sudo apt install ./edgevis-encoder_XXX.deb
where XXX matches the file you downloaded in Step 1, and accept the confirmation prompt.
Unless you encounter any errors, your instance of EVVR Container is now running and will continue to run automatically after any machine reboot.
Step 3 - (Optional) Set your EdgeVis settings using a config file
Familiar with EdgeVis?
This is an advanced topic, and is only recommended to users who are familiar with EdgeVis and the operation of containers. First-time users are recommended to skip this step and utilise your EVVR container's web interface to perform initial configuration.
You usually configure a standard hardware EdgeVis encoder using a simple local web interface. However, EVVR Containers are designed to be easily deployed, using standard Linux/Docker command line operations, so there are new additional options available to avoid the need to use a web interface to perform initial configuration of your container.
For example, by default the .DEB install sets a default recording volume quota of 16GB (to avoid filling your disk). If you would like to change this to a larger size you can do using a settings in a configuration file. Nearly every setting you can set in the web interface can be set in a configuration file:
For a complete reference of all available settings and an example of a fully populated compose file, please refer to this article.
Special instructions for .DEB users
The .DEB install will place your Docker compose file in a different location to the standard Docker instructions. The above links assume you are using a Docker installation - you should review the following guidance on how to edit a compose file for a .DEB install:
Next steps...
You should proceed to log in to your EVVR Container to configure it.