Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Tip

Minimum requirements for installing and running AxxonData

...

Selecting an operating system for AxxonData installation

Ports used for AxxonData operation

...

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;
  • is an average number of events per camera per minute;
  • 60minutes;
  • 24hours in a day;
  • 0.5coefficient;
  • 1024²—GB.

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

where

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

Docker installation

Info
titleNote

This installation description is relevant for Ubuntu 20.04 and Debian 11. Installation for other OS versions can be slightly different.

...

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

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

    Code Block
    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:

    Code Block
    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).

    Code Block
    sudo chmod +x *.sh


  4. Run the once.sh script.

    Code Block
    sudo ./once.sh


  5. Run the load.sh script.

    Code Block
    sudo ./load.sh


  6. Create the Docker services.

    Code Block
    sudo ./run.sh


  7. Check the services status.

    Code Block
    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.

    Code Block
    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.

Installation of AxxonData is complete.

AxxonData will be available at:

Connection protocolAddress
HTTPShttps://vmscloud.local
HTTPhttp://vmscloud.local

By default, two test users are available:

  1. USER NAME OR EMAILAdmin1, the password is PASSWORDadmin1password.
  2. USER NAME OR EMAILAdmin2, the password is PASSWORDadmin2password. 

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

Configuring the SMTP server

To send email notifications, you must specify the parameters of the SMTP server. If you don't want to send notifications, you can skip this step. To set up an SMTP server, do the following:

  1. Stop AxxonData:
    Code Block
    sudo  ./stop.sh
  2. In the cloud.env file, specify the values of the variables:
    1. AXXONCLOUD_EMAIL_TYPE—type of the Server.
    2. AXXONCLOUD_SMTP_SERVER—address of the SMTP server for outgoing mail.
    3. AXXONCLOUD_SMTP_PORT—port number used by the SMTP server for outgoing mail.
    4. AXXONCLOUD_SMTP_USERNAME—full email of the account used to send messages on the SMTP server for outgoing mail.
    5. AXXONCLOUD_SMTP_PASSWORD—16-character code without spaces generated when configuring the SMTP server for outgoing mail.
  3. Load changes:
    Code Block
    sudo  ./load.sh
  4. Run AxxonData:
    Code Block
    sudo  ./run.sh

Configuration of the SMTP server is complete.

Updating the data communication protocol on the previously installed AxxonData

...

  1. Stop AxxonData:
    Code Block
    sudo  ./stop.sh
  2. Move the uploads folder to the folder with the new version of AxxonData:
    Note
    titleAttention!

    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:
    Code Block
    sudo chmod +x *.sh
  4. Load changes:
    Code Block
    sudo  ./load.sh
  5. If you configured an SMTP server, you must update the variable data in the cloud.env file (see Configuring the SMTP server).
  6. Update the data communication protocol (see Updating the data communication protocol on the previously installed AxxonData). 
  7. Start AxxonData:
    Code Block
    sudo  ./run.sh

...

  1. Remove all containers:
    1. Stop AxxonData:
      Code Block
      sudo  ./stop.sh
    2. Stop all Docker containers:
      Code Block
      sudo docker stop $(docker ps -qa)
    3. Remove all Docker containers:
      Code Block
      sudo docker rm $(docker ps -qa)
    4. Remove all images:
      Code Block
      sudo docker rmi -f $(docker images -qa)
    5. Remove all volumes:
      Code Block
      sudo docker volume rm $(docker volume ls -q)
    6. Remove all networks:
      Code Block
      sudo docker network rm $(docker network ls -q)
    7. Press Y to confirm.
      The following commands must not output any items:
      Code Block
      sudo docker ps -a
      Code Block
      sudo docker images -a
      Code Block
      sudo docker volume ls
    8. Remove all unused images:
      Code Block
      sudo docker system prune
    9. Press Y to confirm.
  2. Remove Docker. Enter the commands one by one:
    Code Block
    sudo dpkg -l | grep -i docker
    Code Block
    sudo apt-get purge -y docker-buildx-plugin docker-ce docker-ce-cli docker-ce-rootless-extras docker-compose-plugin
    Code Block
    sudo apt-get autoremove -y --purge docker-buildx-plugin docker-ce docker-ce-cli docker-ce-rootless-extras docker-compose-plugin

    Code Block
    sudo rm -rf /var/lib/docker /etc/docker
    Code Block
    sudo /etc/apparmor.d/docker

    Code Block
    sudo groupdel docker

    Code Block
    sudo -rf /var/run/docker.sock
  3. Remove the uploads folder and the AxxonData folder:
    Code Block
    sudo rm -rf /opt/AxxonData/
    Note
    titleAttention!

    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.

...