Local AxxonData Reports subsystem in Linux OS

General information

AxxonData is a local version of the AxxonNet cloud service and it is used to work in local networks only. AxxonData is compatible with Axxon One version 1.0.4 and with the Axxon Next archive product.

List of supported Linux OS

AxxonData is available in Linux Ubuntu 20.04 and Debian 11.

Minimum requirements for installing and running AxxonData in Linux OS

To run AxxonData, we recommend using a computer with a 1.0 GHz processor with two or more cores and 2 GB RAM.

Disk subsystem requirements: 4 GB to install AxxonData and at a rate of 1 MB = 1000 events to store the events from the detection tools in the database.

You can use the following formulas to calculate the required space for storing events in the database:

T = E × 60 × 24 × 0.5 ÷ 1024²

where

• T is a total number of events in GB per day per camera;
• E is an average number of events per camera per minute;
• 60—minutes;
• 24—hours in a day;
• 0.5—coefficient;
• 1024²—GB.

Required space for D days in GB = C × T × D

where

• С is a total number of cameras;
• T is a total number of events in GB per day per camera;
• D is days of data storage.

Docker installation

To install the latest version of Docker from the official repository, do the following:

1. Update the current package list:

   sudo apt update

2. Install the packages that allow APT to use HTTPS:

   sudo apt install apt-transport-https ca-certificates curl software-properties-common

3. Add the CFG key of the official Docker repository to the system:

   curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

   Note

   When installing on Debian 11, this command will look like this:

   curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -

4. Add the Docker repository to the list of the APT package sources:
   

   sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"

   Note

   When installing on Debian 11, this command will look like this:

   sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian stretch stable"

5. Update the current package list including the Docker packages from the added repository:
   

   sudo apt update

6. Make sure the installation is performed from the Docker repository:
   

   apt-cache policy docker-ce

   Response example:
   

   docker.service - Docker Application Container Engine
      Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
      Active: active (running) since Thu 2018-07-05 15:08:39 UTC; 2min 55s ago
        Docs: https://docs.docker.com
    Main PID: 10096 (dockerd)
       Tasks: 16
      CGroup: /system.slice/docker.service
              ├─10096 /usr/bin/dockerd -H fd://
              └─10113 docker-containerd --config /var/run/docker/containerd/containerd.toml

7. Install the Docker:
   

   sudo apt install docker-ce

8. Make sure the Docker is running:
   

   sudo systemctl status docker

   The response must contain the active (running) status:
   

   docker.service - Docker Application Container Engine
      Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
      Active: active (running) since Thu 2018-07-05 15:08:39 UTC; 2min 55s ago
        Docs: https://docs.docker.com
    Main PID: 10096 (dockerd)
       Tasks: 16
      CGroup: /system.slice/docker.service
              ├─10096 /usr/bin/dockerd -H fd://
              └─10113 docker-containerd --config /var/run/docker/containerd/containerd.toml

AxxonData installation

To install AxxonData, do the following:

1. Download the distribution archive from the AxxonSoft website and unpack it into any folder.

2. The default access protocol is HTTPS, which requires manual installation of certificates on client AxxonData computers. If it is necessary to switch to HTTP, run the following command:
   

   sudo ./http_https_switcher.sh HTTP

   HTTP is an insecure protocol that does not require a certificate to be installed. To switch back to HTTPS, run the following command:
   

   sudo ./http_https_switcher.sh HTTPS

3. In the terminal, run the command to grant the execution permissions to the scripts (load.sh, once.sh, run.sh, stop.sh).

   sudo chmod +x *.sh

4. Run the once.sh script.

   sudo ./once.sh

5. Run the load.sh script.

   sudo ./load.sh

6. Create the Docker services.

   sudo ./run.sh

7. Check the services status.

   sudo docker service ls

   In the REPLICAS column, all values must be displayed as 1/1.
   

8. Change the name of the vmscloud.local domain in the /etc/hosts file.

9. Install the root certificate. The certificate must be in PEM format with a .crt extension.
   

   sudo mkdir /usr/share/ca-certificates/extra
   sudo cp rootCA.pem /usr/share/ca-certificates/extra/rootCA.crt
   sudo dpkg-reconfigure ca-certificates

   If you use Firefox, then you must add the rootCA certificate to the Firefox Certificates yourself.

10. Change the AxxonData address in the Axxon One configuration:

    1. Stop the Server.
    2. In the infra.dictionar file, replace the address of the CLOUD_URL parameter with vmscloud.local. If the Axxon One Server is installed in Linux OS, the file will be located in the /opt/AxxonSoft/AxxonOne/Dictionary.local directory. If Axxon One Server is installed in Windows OS, the file will be located in the C:\Program Files\AxxonSoft\AxxonOne\Dictionary.local directory. 
       
    3. Start the Server.
11. On the Axxon One Server, enter the address of the computer on which AxxonData is installed in the hosts file (C:\Windows\System32\drivers\etc or /etc/hosts). For example, 192.168.11.12 vmscloud.local. If AxxonData is installed on the same computer with the Axxon One Server, you can skip this step.

AxxonData will be available at vmscloud.local. By default, two test users are available:

1. Admin1, the password is admin1password.
2. Admin2, the password is admin2password.

These users can create other users, including the administrators. Names of users are case insensitive.

Updating the data communication protocol on the previously installed AxxonData

To change the data communication protocol on a previously installed AxxonData, do the following:

1. Stop AxxonData:
   

   sudo  ./stop.sh

2. Change the protocol:
   

   sudo ./http_https_switcher.sh HTTP - change https to http
   sudo ./http_https_switcher.sh HTTPS - change http to https

3. Load the changes:
   

   sudo  ./load.sh

4. Run AxxonData:
   

   sudo  ./run.sh

5. Check the availability of AxxonData:
   

   sudo docker service ls

In the REPLICAS column, all values must be displayed as 1/1.

Updating AxxonData

To update AxxonData, do the following:

1. Stop AxxonData:
   

   sudo  ./stop.sh

2. Move the uploads folder to the folder with the new version of AxxonData:
   

   Attention!

   The uploads folder is located in the /opt/AxxonData/uploads/ folder. In AxxonData 3.9 and earlier, the folder is located in the root directory.

3. In the terminal, run the command to grant the execution permissions to the scripts (load.sh, once.sh, run.sh, stop.sh) in the folder with the new AxxonData version:
   

   sudo chmod +x *.sh

4. Load changes:
   

   sudo  ./load.sh

5. Start AxxonData:
   

   sudo  ./run.sh

AxxonData update is complete.

Removing AxxonData 

To remove AxxonData, do the following:

1. Remove all containers:
   1. Stop AxxonData:
      

      sudo  ./stop.sh

   2. Stop all Docker containers:
      

      sudo docker stop $(docker ps -qa)

   3. Remove all Docker containers:
      

      sudo docker rm $(docker ps -qa)

   4. Remove all images:
      

      sudo docker rmi -f $(docker images -qa)

   5. Remove all volumes:
      

      sudo docker volume rm $(docker volume ls -q)

   6. Remove all networks:
      

      sudo docker network rm $(docker network ls -q)

   7. Press Y to confirm.
      The following commands must not output any items:
      

      sudo docker ps -a

      sudo docker images -a

      sudo docker volume ls

   8. Remove all unused images:
      

      sudo docker system prune

   9. Press Y to confirm.
2. Remove Docker. Enter the commands one by one:
   

   sudo dpkg -l | grep -i docker

   sudo apt-get purge -y docker-buildx-plugin docker-ce docker-ce-cli docker-ce-rootless-extras docker-compose-plugin

   sudo apt-get autoremove -y --purge docker-buildx-plugin docker-ce docker-ce-cli docker-ce-rootless-extras docker-compose-plugin

   
   

   sudo rm -rf /var/lib/docker /etc/docker

   sudo /etc/apparmor.d/docker

   
   

   sudo groupdel docker

   
   

   sudo -rf /var/run/docker.sock

3. Remove the uploads folder and the AxxonData folder:
   

   sudo rm -rf /opt/AxxonData/

   Attention!

   The uploads folder is located in the /opt/AxxonData/uploads/ folder. In AxxonData 3.9 and earlier, the folder is located in the root directory.

Removing AxxonData is complete.