Versions Compared

Key

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


Column
width50%


Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleOn this the page:
Table of Contents


Column


General information

AxxonData is  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.

Tip

Minimum requirements for installing and running AxxonData

To run AxxonData, it is recommended to use a computer with a 1.0 GHz processor with two or more cores and 2 GB RAM.

...

Selecting an operating system for AxxonData installation

Ports used for AxxonData operation

Docker installation

Info
titleNote

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

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

  1. Update the current package list

  2. .
  3. :

    Code Block
    languagebash
    sudo apt update
  4. Install the packages that allow APT to use HTTPS

  5. .
  6. :

    Code Block
    languagebash
    sudo apt install apt-transport-https ca-certificates curl software-properties-common
  7. Add the CFG key of the official Docker repository to the system

  8. .
  9. :

    Code Block
    languagebash
    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
    Info
    titleNote

    When installing on Debian

  10. 11
  11. 12, this command will look like this:

    Code Block
    languagebash
    curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg 
  12. apt
  13. --
  14. key
  15. dearmor 
  16. add -
  17. -o /usr/share/keyrings/docker-archive-keyring.gpg
  18. Add the Docker repository to the list of the APT package sources

  19. list.
  20. :

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

    When installing on Debian

  21. 11
  22. 12, this command will look like this:

    Code Block
  23. sudo add-apt-repository
  24. languagebash
    echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian
  25. stretch stable"
  26.  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
  27. Update the current package list including the Docker packages from the added repository

  28. .
  29. :

    Code Block
    languagebash
    sudo apt update
  30. Make sure the installation is performed from the Docker repository

  31. .
  32. :

    Code Block
    languagebash
    apt-cache policy docker-ce
    Response example:
    Code Block
    languagebash
    docker-ce:
      Installed: (none)
      Candidate: 18.03.1~ce~3-0~ubuntu
      Version table:
         18.03.1~ce~3-0~ubuntu 500
            500 https://download.docker.com/linux/ubuntu bionic/stable amd64 Packages
  33. Install the Docker

  34. .
    code
  35. :

    Code Block
    languagebash
    sudo apt install docker-ce

    Info
    titleNote

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

    Code Block
    languagebash
    sudo apt install docker-ce docker-ce-cli containerd.io
  36. Make sure the Docker is running

  37. .
  38. :

    Code Block
    languagebash
    sudo systemctl status docker
    The response
  39. should
  40. must contain the active (running) status:
    Code Block
    languagebash
    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

  3. , which
  4. that requires manual installation of certificates on client AxxonData computers

  5. in local cloud
  6. . If it is necessary to switch to HTTP, run the following command:

    Code Block
    languagebash
    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
    languagebash
    sudo ./http_https_switcher.sh HTTPS
  7. NotetitleAttention!
  8. If you install AxxonData using the HTTPS access protocol, then it will not be possible to upgrade it to HTTP later.

    HTTP protocol is available starting from Axxon One 1.9.

  9. In the terminal,

  10. execute
  11. run the

  12. command to
  13. command to grant the execution

  14. rights
  15. permissions to the scripts (load.sh, once.sh, run.sh, stop.sh).

    Code Block
    languagebash
    sudo chmod +x *.sh
  16. Run the once.sh script.

    Code Block
    languagebash
    sudo ./once.sh
  17. Run the load.sh script.

    Code Block
    languagebash
    sudo ./load.sh
  18. Create the Docker services.

    Code Block
    languagebash
    sudo ./run.sh
  19. Check the services status.

    Code Block
    languagebash
    sudo docker service ls

    In the REPLICAS column, all values

  20. should
  21. must be displayed as 1/1.

  22. Image RemovedAdd the vmscloud
  23. Change the name of the vmscloud.local domain
  24. to
  25. in the
  26.  
  27. /etc/hosts file.
  28. Install the root certificate. The certificate

  29. should
  30. must be in PEM format with a .crt extension.

    Code Block
    language
  31. $
  32. bash
    sudo mkdir /usr/share/ca-certificates/extra
    
  33. $
  34. sudo cp rootCA.pem /usr/share/ca-certificates/extra/rootCA.crt
    
  35. $
  36. sudo dpkg-reconfigure ca-certificates
    If you use Firefox, then you
  37. should
  38. must add
  39. the
  40. the rootCA certificate to the Firefox Certificates yourself.
  41. Change the AxxonData address in the Axxon One configuration:

    1. Stop the Server.
    2. In the infra.
  42. dictionar
    1. dictionary file, replace the address of the CLOUD_URL parameter with vmscloud.local. If the Axxon One Server is installed
  43. on
    1. in Linux OS, the file will be located in the /opt/AxxonSoft/AxxonOne/Dictionary.local directory.
  44. If
    1. If Axxon One Server is installed
  45. on
    1. in Windows OS, the file will be located in the C:\Program Files\AxxonSoft\AxxonOne\Dictionary.local directory. 
    2. Start the Server.
  46. 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, 2 two test users are available:

...

  1. USER NAME—Admin1, PASSWORD—admin1password.
  2. USER NAME—Admin2, PASSWORD—admin2password. 

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
    languagebash
    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
    languagebash
    sudo  ./load.sh
  4. Run AxxonData:
    Code Block
    languagebash
    sudo  ./run.sh

Configuration of the SMTP server is complete

...

.

Updating the data communication protocol on the previously installed AxxonData

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

  1. Stop

  2. the local cloud
  3. AxxonData:

    Code Block
    languagebash
    sudo  ./stop.sh
  4. Change the protocol:

    Code Block
    languagebash
    sudo ./http_https_switcher.sh HTTP 
  5. #
  6. - change https to http
    sudo ./http_https_switcher.sh HTTPS 
  7. #
  8. - change http to https
  9. Load the changes:

    Code Block
    languagebash
    sudo  ./load.sh
  10. Run

  11. the local cloud
  12. AxxonData:

    Code Block
    languagebash
    sudo  ./run.sh
  13. Check the availability of

  14. the cloud
  15. AxxonData:

    Code Block
    languagebash
    sudo docker service ls

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

The data communication protocol on the previously installed AxxonData is updated.

Updating AxxonData

To update AxxonDatado the following:

  1. Stop AxxonData:
    Code Block
    languagebash
    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
    languagebash
    sudo chmod +x *.sh
  4. Load changes:
    Code Block
    languagebash
    sudo  ./load.sh
  5. If you configured an SMTP server, you must update the variable data in the cloud.env file (seeConfiguring 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
    languagebash
    sudo  ./run.sh

AxxonData update is complete.

Removing AxxonData 

To remove AxxonData, do the following:

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

Removing AxxonData is complete.