Page History
| Section | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
General information
AxxonData is is a local version of the 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 |
Docker installation
| Info | ||
|---|---|---|
| ||
This installation description is relevant for Ubuntu 20.04 and Debian 1112. Installation for other OS versions can be slightly different. |
To install the latest version of Docker from the official repository, do the following:
Update the current package list:
Code Block language bash sudo apt updateInstall the packages that allow APT to use HTTPS:
Code Block language bash sudo apt install apt-transport-https ca-certificates curl software-properties-commonAdd the CFG key of the official Docker repository to the system:
Code Block language bash curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -Info title Note When installing on Debian
1112, this command will look like this:
Code Block language bash curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg
apt--
keydearmor
add --o /usr/share/keyrings/docker-archive-keyring.gpgAdd the Docker repository to the list of the APT package sources:
Code Block language bash sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"Info title Note When installing on Debian
1112, this command will look like this:
Code Block sudo add-apt-repositorylanguage bash echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian
stretch stable"$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/nullUpdate the current package list including the Docker packages from the added repository:
Code Block language bash sudo apt updateMake sure the installation is performed from the Docker repository:
Response example:Code Block language bash apt-cache policy docker-ceCode Block docker.service - Docker Application Container Enginelanguage bash docker-ce:
LoadedInstalled:
loaded(/lib/systemd/system/docker.service; enabled; vendor preset: enabled)none) Candidate: 18.03.1~ce~3-0~ubuntu Version
Activetable:
active18.03.1~ce~3-0~ubuntu 500
Docs:500 https://
docsdownload.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/linux/ubuntu bionic/stable amd64 PackagesInstall the Docker:
Code Block language bash sudo apt install docker-ceInfo title Note When installing on Debian 12, this command will look like this:
Code Block language bash sudo apt install docker-ce docker-ce-cli containerd.io
Make sure the Docker is running:
The response must contain the active (running) status:Code Block language bash sudo systemctl status dockerCode Block language bash 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
Install the Docker:
AxxonData installation
To install AxxonData, do the following:
Download the distribution archive from the AxxonSoft website and unpack it into any folder.
The default access protocol is HTTPS that requires manual installation of certificates on client AxxonData computers. If it is necessary to switch to HTTP, run the following command:
Code Block language bash sudo ./http_https_switcher.sh HTTPHTTP is an insecure protocol that does not require a certificate to be installed. To switch back to HTTPS, run the following command:
Code Block language bash sudo ./http_https_switcher.sh HTTPSIn the terminal, run the command to grant the execution permissions to the scripts (load.sh, once.sh, run.sh, stop.sh).
Code Block language bash sudo chmod +x *.shRun the once.sh script.
Code Block language bash sudo ./once.shRun the load.sh script.
Code Block language bash sudo ./load.shCreate the Docker services.
Code Block language bash sudo ./run.shCheck the services status.
Code Block language bash sudo docker service lsIn the REPLICAS column, all values must be displayed as 1/1.
- Change the name of the vmscloud.local domain in the /etc/hosts file.
Install the root certificate. The certificate must be in PEM format with a .crt extension.
If you use Firefox, then you must addCode Block language bash sudo mkdir /usr/share/ca-certificates/extra sudo cp rootCA.pem /usr/share/ca-certificates/extra/rootCA.crt sudo dpkg-reconfigure ca-certificates the - the rootCA certificate to the Firefox Certificates yourself.
Change the AxxonData address in the Axxon One configuration:
- Stop the Server.
- In the infra.
dictionar- dictionary 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.
- Start the Server.
- dictionary 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.
- 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 is complete.
AxxonData will be available at:
| Connection protocol | Address |
|---|---|
| HTTPS | https://vmscloud.local |
| HTTP | http://vmscloud.local |
By default, two test users are available:
- USER NAME OR EMAIL—Admin1
- —Admin1, PASSWORD —admin1password
- —admin1password.
- USER NAME OR EMAIL—Admin2
- —Admin2, PASSWORD —admin2password
- —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:
- Stop AxxonData:
Code Block language bash sudo ./stop.sh - In the cloud.env file, specify the values of the variables:
- AXXONCLOUD_EMAIL_
TYPE—type - TYPE—type of the Server.
- AXXONCLOUD_SMTP_
SERVER—address - SERVER—address of the SMTP server for outgoing mail.
- AXXONCLOUD_SMTP_
PORT—port - PORT—port number used by the SMTP server for outgoing mail.
- AXXONCLOUD_SMTP_
USERNAME—full - USERNAME—full email of the account used to send messages on the SMTP server for outgoing mail.
- AXXONCLOUD_SMTP_
PASSWORD—16- PASSWORD—16-character code without spaces generated when configuring the SMTP server for outgoing mail.
- Load changes:
Code Block language bash sudo ./load.sh - Run AxxonData:
Code Block language bash 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 AxxonData, do the following:
Stop AxxonData:
Code Block language bash sudo ./stop.shChange the protocol:
Code Block language bash sudo ./http_https_switcher.sh HTTP - change https to http sudo ./http_https_switcher.sh HTTPS - change http to httpsLoad the changes:
Code Block language bash sudo ./load.shRun AxxonData:
Code Block language bash sudo ./run.shCheck the availability of AxxonData:
Code Block language bash sudo docker service ls
In the REPLICAS column, all values must be displayed as 1/1.
The data communication protocol on the previously installed AxxonData is updated.
Updating AxxonData
To update AxxonData, do the following:
- Stop AxxonData:
Code Block language bash sudo ./stop.sh - Move the uploads folder to the folder with the new version of AxxonData:
Note title 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.
- 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 language bash sudo chmod +x *.sh - Load changes:
Code Block language bash sudo ./load.sh - If you configured an SMTP server, you must update the variable data in the cloud.env file (see seeConfiguring the SMTP server).
- Update the data communication protocol (see Updating the data communication protocol on the previously installed AxxonData).
- Start AxxonData:
Code Block language bash sudo ./run.sh
AxxonData update is complete.
Removing AxxonData
To remove AxxonData, do the following:
- Remove all containers:
- Stop AxxonData:
Code Block language bash sudo ./stop.sh - Stop all Docker containers:
Code Block language bash sudo docker stop $(docker ps -qa) - Remove all Docker containers:
Code Block language bash sudo docker rm $(docker ps -qa) - Remove all images:
Code Block language bash sudo docker rmi -f $(docker images -qa) - Remove all volumes:
Code Block language bash sudo docker volume rm $(docker volume ls -q) - Remove all networks:
Code Block language bash sudo docker network rm $(docker network ls -q) - Press Y to confirm.
The following commands must not output any items:Code Block language bash sudo docker ps -aCode Block language bash sudo docker images -aCode Block language bash sudo docker volume ls - Remove all unused images:
Code Block language bash sudo docker system prune - Press Y to confirm.
- Stop AxxonData:
- Remove Docker. Enter the commands one by one:
Code Block language bash sudo dpkg -l | grep -i dockerCode Block language bash sudo apt-get purge -y docker-buildx-plugin docker-ce docker-ce-cli docker-ce-rootless-extras docker-compose-pluginCode Block language bash sudo apt-get autoremove -y --purge docker-buildx-plugin docker-ce docker-ce-cli docker-ce-rootless-extras docker-compose-pluginCode Block language bash sudo rm -rf /var/lib/docker /etc/dockerCode Block language bash sudo /etc/apparmor.d/dockerCode Block language bash sudo groupdel dockerCode Block language bash sudo -rf /var/run/docker.sock - Remove the uploads folder and the AxxonData folder:
Code Block language bash sudo rm -rf /opt/AxxonData/Note title 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.
