Setup

Axxon One Setup Checklist and Best Practices

Before you install Axxon One:

Make sure all Servers are connected to an uninterruptible power supply (UPS) and have unique IP addresses.
To prevent frequent system updates, which can cause system inoperability, we recommend using Windows 10 LTSB or Windows Server (see Operating system requirements).
Install all the latest Windows service/update packs.
Synchronize the system time with world time and specify the correct time zone.
For each Server, specify a unique Windows host name.
Specify a new password for the account of the local administrator.
Synchronize the time of all Servers and IP devices.
Create another administrator account for backup. Specify a password for it.

Hardware setup:

On each Server, install an additional SSD specifically designed for storing metadata. We highly recommend NOT storing the metadata either on the system drive or on the drive to which the archive is recorded.
If you are going to use any kind of video analytics (including motion detection for motion-based recording and other detectors), we recommend using an Nvidia GPU to increase system performance. For specific GPU requirements, see Hardware requirements.

Axxon One installation (see Installation, Update):

Recommendation on how to choose the installation type:

Server and Client: choose this type of installation if you have no more than 5 Servers in one location, which must operate within the same Axxon-domain.
Failover Server and Client: choose this type of installation if you have 5 to 30 Servers (minimum 3) in one location, which must operate within the same Axxon-domain.

If you have more than 30 Servers in one location, or if they are spread between different locations, but you need to have unified user management across all Servers, please contact your manager or technical support for consulting.

Server and Client

Use the port range 20111-20210 (see Network settings utility, Ports used by Axxon One).
Metadata database:
1. The path to the metadata storage folder can be specified only once during the installation process. If you decide to change it later, you will have to re-install Axxon One (without losing your configuration or video archive).
2. We highly recommend installing the database on SSD specifically designed for storing metadata.
  1. Do NOT install metadata on system drive because metadata size tends to grow over time, and if the system drive space is not sufficient it can cause system issues.
  2. Do NOT install metadata on the drive to which the archive is recorded because it affects recording performance.
3. Consider the disk space required for the database (see Disk storage subsystem requirements). For example, ≈1.5 TB is required to store metadata for 30 days for 50 cameras.

Failover Server and Client

The path to the metadata storage folder can be specified only once during the installation process. If you decide to change it later, you will have to re-install Axxon One (without losing your configuration or video archive). To specify the database path during installation, select Custom installation type and specify the path in the configuration window.
We highly recommend installing the database on SSD specifically designed for storing metadata.
1. Do NOT install metadata on system drive because metadata size tends to grow over time, and if the system drive space is not sufficient it can cause system issues.
2. Do NOT install metadata on the drive to which the archive is recorded because it affects recording performance.

Antivirus configuration (see Appendix 4. Using Axxon One with antivirus software):

Add the following processes to the exclusion list:
1. consul.exe
2. nomad.exe
3. apphost.exe
4. postgres.exe
Add the following folders to the exclusion list:
1. C:\ProgramData\AxxonSoft\Axxon One
2. C:\Program Files\AxxonSoft\Axxon One
3. C:\Program Files\Common Files\AxxonSoft
4. Postgres and metadata folders if their location is not default.
Add the following ports to the exclusion list:
1. 20109-20210
2. If Failover Server and Client installation type is selected, then also add ports 4000, 4646-4648, 8300-8302, 8500, 8600.

Initial setup:

Activate the licenses (see Creating an activation request, Activation by applying license file).
Change the password of the root user (see Users).
Create another administrator account for backup. Specify a password for it.
For Server only: configure Client auto-logout after 1 hour (see Configuring automatic logging out and locking of the Client).
Create the archive before adding cameras (see Creating archives).

Creating archives:

Create a local archive with object storage type (see Creating a local archive). This allows you to increase the reliability and speed of data recording, change the size of an archive volume without restarting the system, and encrypt an archive volume (see Encrypting a volume of an object archive).
Divide the archive into several volumes located on different devices.

Camera configuration (see Camera):

Connect cameras to the Servers.
Synchronize the time of all Servers and cameras with a single NTP Server.
Add cameras to the system (see Searching, adding, configuring and removing IP devices, Bulk creation of IP devices). Preferred protocol: ONVIF generic.
Multistreaming:
1. Set different high and low quality streams for each camera.
2. Low quality stream settings must be lower than the High quality stream.
3. Enable GreenStream in the camera context menu on the layout (see Selecting video stream quality in a Surveillance window (GreenStream)) or in the layout settings (see Selecting the default video stream for all cameras on the layout).
Codec type (сan differ for different camera models): H.265 or H.264 is recommended.
FPS: the Low quality stream frame rate must be at least 6 to ensure the correct operation of the detectors.
Resolution:
1. Aspect ratio must be the same for Low and High quality streams*.
2. The Low quality stream resolution must be no less than 640x360 and no more than 1280x720 to ensure the correct operation of the detectors.
Bitrate:
1. Recommended type*: VBR.
2. Set maximum bitrate/bandwidth values.
3. Recommended bitrate: 1 Mbps per 1 MP.
GOV (also known as GOP, I Frame, etc.): it is recommended to have at least one keyframe per 2 seconds.

Archive recording configuration (see Configuring recording to an archive):

Link each camera to at least one archive.
Configure recording to the archive (permanent or started by events from detectors) for each camera.
Make sure pre-recording is enabled (> 1 sec).
Note that after you re-create the archive, you must re-create all recording rules in the detector settings or on the Programming tab.

Detector configuration (see Detectors):

The motion detector must operate on a low quality stream (see Configuring the Motion detector).
To mask, exclude areas of the frame that constantly have motion (for example, on-screen display (OSD) or TV).
Create automatic rules for recording to the archive (see Automatic rules).
Use an Nvidia GPU for the detectors operation.

Automatic notifications (see Programming):

Create and configure an email notification (see E-mail notification).
Configure a cycle macro (once a day) to check if all cameras are recording (see Check that archive record exists, Examples of Cycle rules macros).
Configure event macros based on statistical data (CPU load, free disk space, see Starting the Event rules macros based on statistical data).

Users and roles (see General information about users):

Create and configure the roles (see Roles).
Create the users (see Configuring local users, Configuring LDAP users).
Create the required layouts for each user (see Configuring layouts).
Check your setup by logging in under different user accounts and verifying the interface and permissions.

Backups (see Backup and restore utility):

Create a new backup:
1. After you complete the system configuration.
2. Before you update to a new version.
3. After you update to a new version.
4. Periodically (recommended period is once a month).
To restore the configuration, use the backup created on the same version of software (see Backup and restore utility). Example: if backup was created on v. 1.0 then restore it only on v. 1.0.

Web-Client (see Working with Axxon One through the Web-Client):

Change the HTTP port from 80 to a custom port (see Configuring the Web-Server).

System check:

Monitor the CPU load (<= 60%).
Monitor the RAM load (<= 60%).
Monitor the disk load:
1. Active time is lower than 50%.
2. Average response time is lower than 1 sec.
Monitor free disk space: system drive has not less than 20 GB.
Use the statistics panel in the Web-Client (see Viewing Camera and Archive Statistics).

What are the Axxon One limitations?

Complete guide Limitations of Axxon One

What graphics card do I need to run Axxon One?

Axxon One requires a GPU with OpenGL 2.0 or higher version and the following extensions:
ARB_vertex_program;
GL_EXT_blend_func_separate;
GL_ARB_framebuffer_object for OpenGL.
You can run OpenGL Extension Viewer (download) to check the extensions.
Axxon One is guaranteed to work with:
discrete GPU NVIDIA GeForce 7300LE/GeForce 200 or higher (512 MB);
integrated Intel HD Graphics 530 or higher.
Complete guide Hardware requirements

How do I check if my camera is integrated with Axxon One?

Please refer to the Drivers Pack documentation page.
Download the list of supported devices from the latest release in xls.
Open the file and go to the Axxon One tab.
If your device is listed, it is integrated via the vendor protocol. When adding a device, select the model.
Complete guide Searching, adding, configuring and removing IP devices
If your device is not listed, you can still use it in Axxon One in one of the following ways:
Via General Device. General Device is a universal driver that enables AxxonSoft products to work with almost all devices from the relevant manufacturer. General Device is a generic driver that supports nearly all devices from a particular camera vendor.
Complete guide Generic Drivers (General device, generic)
Via ONVIF.
Complete guide Notes on configuring video cameras connected via ONVIF
Via RTSP.
Complete guide Configuring connection of single-channel devices

How to install Axxon One?

Complete guide Installation

How to install Axxon One in Linux OS?

Complete guide Linux OS Administrator's guide

You can install Axxon One on all 64-bit distribution packages of Linux OS:

Debian: 12, 11, 10, 9;
Ubuntu: 22, 20, 19, 18.
Server in Docker container (see the current list of supported distributions);
Client as Flatpak (supported starting with Axxon One 2.0.10, see the current list of supported distributions).

To install the Axxon One server in Linux OS, see Installing the Axxon One Server in Linux OS. To install the Axxon One client in Linux OS, see Installing the Axxon One Client in Linux OS.

For more information on installing and configuring Axxon One in Linux OS, see Features and potential problems with Linux OS.

How do I bulk create devices?

To create several IP devices at once in Axxon One, do the following:
Create a CSV file containing the parameters of the devices to be added.
Drag & drop the created file to the field in IP Device Discovery Wizard in Axxon One.
Complete guide Bulk creation of IP devices

How do I add and remove a Server from an Axxon-domain?

A distributed system based on the Axxon One VMS is created within an Axxon-domain, i.e., a selected group of Axxon One Servers.
A new Axxon-domain can be created in one of two ways:
During installation of the Axxon One software package with the Server and Client configuration.
When attempting to connect to a Server which does not belong to an Axxon-domain.

Creating a new domain
Full article

A Server can be added to an existing Axxon-domain from any Server within that Axxon-domain.

Adding a Server to an existing Axxon-domain
Full article

You can remove a Server from an Axxon-domain on any Server within the domain.

Removing a Server from an Axxon-domain
Full article

In the program activation utility, you can also exclude a Server from the Axxon-domain.

Excluding the Current Server from an domain
Full article

Which ports are required for Axxon One operation?

There are default ports used for Axxon One operation. You can change the default ports.

Complete guides

Ports used by Axxon One

Configuring the Server ports

License

How is Axxon One licensed?

There are 6 types of Axxon One licenses:

Axxon One Demo. Upon installation, the software will be launched in Axxon One Demo mode. You can use the system with some features from 8:00 to 18:00.
Axxon One Free.
1. 1 Server, 4 video channels;
2. Basic features.
$ Axxon One Start.
1. Maximum number of Servers—1, maximum number of channels—64.
2. Some features.
$ Axxon One Professional.
1. Maximum number of Servers—30, unlimited number of channels.
2. Some features.
$ Axxon One Enterprise.
1. Maximum number of Servers—30, unlimited number of channels.
2. Some features.
$ Axxon One Unified.
1. Unlimited number of Servers and channels.
2. All features.

Complete guide Axxon One license types

How to activate a license in Axxon One?

You can launch the product activation utility from the Windows Start menu: Start → Programs → Axxon One → Utilities → Activation utility.

Complete guide Activation utility

To activate Axxon One, do as follows:

In the activation utility, create an activation request.
Complete guide Creating an activation request
Submit the received activation request to the AxxonSoft manager.
Upload the received license file to the system.
Complete guide Activation by applying license file

How do I see features available under the activated license?

Run the activation utility Start → All Programs → Axxon One→ Utilities → Program Activation.
Complete guide Activation utility
Save the license file.
Complete guide Saving the license file
Decode the license file on the website https://sale.axxonsoft.com/sale/.
Complete guide Decoding the activated license

Other

How to uninstall Axxon One?

To remove Axxon One and prerequisites, do as follows:

Remove Axxon One and delete the configuration.
Complete guide Removal
Go to Control Panel → Programs.
Uninstall the Postgres NGP, DetectorPack, Axxon Drivers Pack, Guardant Drivers.
Clear the folder: C:\Program Files\AxxonSoft.
Clear the folder: C:\Program Files\Common Files\AxxonSoft.
Clear the hidden folder: C:\ProgramData\AxxonSoft.
Remove the registry entry through the Registry Editor: \HKEY_LOCAL_MACHINE\SOFTWARE\AxxonSoft.

How do I connect to Axxon One from a smart-phone or tablet PC?

You can use a mobile app to connect to Axxon One from a mobile device (smartphone or tablet). Mobile apps are available for iOS and Android platforms.

Example URL with standard Server settings for Axxon One:

192.168.0.10:80

Complete guides about Server connection

Direct Server connection in the AxxonNet iOS mobile client

Direct Server connection in AxxonNet client on Android OS

Complete guides about mobile apps

General information about the AxxonNet iOS mobile client

General information about the AxxonNet mobile client on Android OS

Can I change the NetBiosName on the computer that has the Axxon One Server installed?

Yes, the Axxon One Server will be available under the new NetBiosName or IP address from the external network or under the Server name in the Axxon One configuration from the internal network.

Note

The NetBiosName of the computer can contain up to 15 characters.

By default, the Server name in the Axxon One configuration corresponds to the NetBiosName of the computer on which it is installed. You can change the Server name from the Backup and restore utility.

Complete guide Backup and restore utility

I don't have video from the camera in Axxon One. What should I do?

Ping the camera.
Check that the camera is available in the Web-Interface.
Check the connection settings (port, login, password) in Axxon One.
If the camera's integration with Axxon One is via vendor protocol, verify that the model and version of the firmware in the documentation and on the camera are the same.
How do I check if my camera is integrated with Axxon One?
If the camera is connected via ONVIF:
1. Check the connection in the ONVIF Device Manager.
2. Synchronize time between camera and Server.
3. Enable the ONVIF option on the camera, if there is one.
If the camera is connected through the RTSP protocol, check the connection in the VLC Media Player.
Check the network. The firewall, antivirus, SmartScreen, UAC and other software can use the port you want for connecting to the camera.
Make sure that Axxon One license file allows the sufficient number of video channels. If channels are not enough, please contact your AxxonSoft manager to request the new license file.
How can I see features available under the activated license?

How do I configure multi-domain monitoring (Cross-System Client)?

Cross-System Client empowers users to connect to multiple servers on various domains and in different systems from a single client workstation.

Complete guide Cross-System client

For this to take place, the following conditions must be true:

The Professional or Enterprise or Unified license is enabled on each server to which the client connects.
How is Axxon One licensed?
How to activate a license in Axxon One?
Connection to all Servers made via with the same user name/password combination on each Axxon domain.

To configure connection to servers from different domains, go to Settings → Options → Automatic connection.

Complete guide Automatic connection

How do I set up e-mail sending in case if camera recording stops?

If a specific video camera or a group of cameras does not record to the archive for some time, you can set up e-mail notifications about this. To do this, it is necessary to create a macro that checks if there is a record in the archive, and set up sending an e-mail notification when it is initiated. Do the following:

On the Programming tab, create a macro for the Check archive record events.
In the macro settings:
1. select a camera or a group of cameras for which you want to check the presence of a record in the archive;
2. select an archive to check;
3. specify the depth of the check.
Select the action to be performed if there is no record in the archive for the specified period. To do this, in the Execute if no video in archive field of the created macro, select the Notification: Send E-mail action. In the action settings:
1. select the used E-mail message object;
2. set the e-mail addresses to which the notification will be sent;
3. write the subject of the email and the message itself.

Complete guides

Check that archive record exists

E-mail notification

How to reduce the CPU load?

To reduce the CPU load, it is necessary to configure hardware decoding of displayed video. Besides, the detection tool settings can affect the CPU load—for example, decimation, fps, etc.

Complete guides

Configuring hardware video decoding for display on the Client

Detectors

Note

The number of detection tools must match the CPU capabilities. You can check it in the platform calculator, and the calculation algorithm is described in Recommended platform calculation.

How to restore the configuration?

To restore a configuration, use the Restore mode in the Backup and restore utility.

Complete guide Backup and restore utility

Attention!

We can guarantee that your configuration will be fully restored if:

the backup was created on the same software version (including the build number);
the backup was created on the same PC (for licensing without the Guardant key).

How to configure Axxon One with NAT?

You can consolidate the Servers from different networks separated by routers into the Axxon-domain, as well as connect the Clients to the Server behind NAT.

Complete guide Using Axxon One with NAT

Content

Page tree

Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.

Setup

Axxon One Setup Checklist and Best Practices

Before you install Axxon One:

Hardware setup:

Axxon One installation (see Installation, Update):

Server and Client

Failover Server and Client

Antivirus configuration (see Appendix 4. Using Axxon One with antivirus software):

Initial setup:

Creating archives:

Camera configuration (see Camera):

Archive recording configuration (see Configuring recording to an archive):

Detector configuration (see Detectors):

Automatic notifications (see Programming):

Users and roles (see General information about users):

Backups (see Backup and restore utility):

Web-Client (see Working with Axxon One through the Web-Client):

System check:

What are the Axxon One limitations?

What graphics card do I need to run Axxon One?

How do I check if my camera is integrated with Axxon One?

How to install Axxon One?

How to install Axxon One in Linux OS?

How do I bulk create devices?

How do I add and remove a Server from an Axxon-domain?

Creating a new domain

Adding a Server to an existing Axxon-domain

Removing a Server from an Axxon-domain

Excluding the Current Server from an domain

Which ports are required for Axxon One operation?

License

How is Axxon One licensed?

How to activate a license in Axxon One?

How do I see features available under the activated license?

Archive

How to configure an archive?

How do I set up an archive in the network storage?

How can I replicate data from one archive to another?

Other

How to uninstall Axxon One?

How do I connect to Axxon One from a smart-phone or tablet PC?

Can I change the NetBiosName on the computer that has the Axxon One Server installed?

I don't have video from the camera in Axxon One. What should I do?

How do I configure multi-domain monitoring (Cross-System Client)?

How do I set up e-mail sending in case if camera recording stops?

How to reduce the CPU load?

How to restore the configuration?

How to configure Axxon One with NAT?