Prequisites

Before you begin you should have:

Compatible hardware (or a virtual machine running on compatible hardware) with a supported operating system installed.
Be logged into a terminal, with a user account that can utilise sudo.

You do not need to use the Linux graphical interface for EVVR Docker and can perform all the following operations locally or via SSH.

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

Follow any appropriate guidance supplied to update to the latest version (this may include a reboot).

Step 1 - Install Docker Compose

In your terminal window enter one of the following commands:

Raspberry PiOs
sudo apt install docker.io docker-compose
Ubuntu / Other Operating Systems
sudo apt install docker-compose-v2

And accept the confirmation prompt.

Using Raspberry PiOs?

The syntax for the docker commands is slightly different! When you see a
"docker compose" command listed you must add a dash - commands become "docker-compose".

Step 2 - Generate the Docker Compose file

In your terminal window, enter the following:

mkdir evvr
cd evvr

nano compose.yml

This will open the nano text editor with an empty file that you can enter your desired configuration into.

You can either:

Option 1 - Use a quick-start minimal compose file
This will bring up a fully functioning container that you can use the web interface to set up and configure.
Option 2 - Use an extended compose file (Advanced)
You can install, set up and configure a container's EdgeVis settings - this reduces/eliminates the need to configure your container using the web interface.

Option 1 - Use a sample quick-start minimal compose file

Copy and paste the following into your text editor:

services:
    edgevis-encoder:
        image: digitalbarriers/evvr:9.1.0
        devices:
            - /dev/dri:/dev/dri
        tty: true
        container_name: edgevis-encoder
        ports:
            - "8443:443"
            - "8554:8554"
        volumes:
            - edgevis-config:/config
            - edgevis-recordings:/mnt/recordings
            - /dev:/dev
        environment:
            - EV_RTSP_PORT=8554
        device_cgroup_rules:
          - 'c 81:* rmw'
          - 'c 116:* rmw'
        restart: unless-stopped

volumes:
  edgevis-config:
    name: edgevis-config
  edgevis-recordings:
    name: edgevis-recordings

This will create a working container, with a recording volume that will use a quota limit of 16GB for recordings - you can increase this if necessary.

We've also attached a compose.yml file at the bottom of this page that you can either use directly or copy and paste from if your browser is modifying the text when you try copying the above.

Once you have copied the text into your editor, please move on to Step 3.

Option 2 - Set up your container's settings using a compose file

It is possible to configure almost every aspect of your EVVR Container using environment variables within your compose file (you can also use a separate seed file as well - please read this article to understand the differences).

For example, you can pre-configure the following:

For a complete reference of all available settings and an example of a fully populated compose file, please refer to this article.

You should enter the desired settings into your compose file in the text editor.

Step 3 - Start your EVVR Container encoder

If you haven't already, you need to save your compose file.

To save this file, hit CTRL + O (letter O), then hit Enter to confirm the filename.

To exit nano, hit CTRL + X.

Type the following into your terminal window:

sudo docker compose up -d

Your terminal will now show Docker downloading, installing and running your new instance of EVVR Container:

[+] Running 11/11
✔ edgevis-encoder 10 layers [⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿] Pulled. 17.3s 
✔ 6414378b6477 Pull complete 1.6s 
✔ 55170407c7f5 Pull complete 1.6s 
✔ ab47a14fcbf4 Pull complete 7.0s 
✔ 4f4fb700ef54 Pull complete 2.1s 
✔ cd209638f3af Pull complete 2.3s 
✔ 9b9d86ca0960 Pull complete 2.9s 
✔ 730bec03d197 Pull complete 3.0s 
✔ 46798118e232 Pull complete 3.8s 
✔ dc1ce2f6c4c6 Pull complete 3.5s 
✔ 2df2c232c4a7 Pull complete 6.4s 
[+] Running 1/1
✔ Container edgevis-encoder Created 0.3s

Unless you encounter any errors, your instance of EVVR Container is now running and will continue to run automatically after any machine reboot.

Next steps...

You should proceed to log in to your EVVR Container to configure it.

Minimal compose.yml file

This is a minimal compose file that will download and install a fully functional EVVR Container.

compose.yml

Installing EVVR Container using Docker and a compose file (standard method)