Go to documentation repository
Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.
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:
- 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).
- We highly recommend installing the database on SSD specifically designed for storing metadata.
- 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.
- Do NOT install metadata on the drive to which the archive is recorded because it affects recording performance.
- 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.
- 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.
- 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:
- consul.exe
- nomad.exe
- apphost.exe
- postgres.exe
- Add the following folders to the exclusion list:
- C:\ProgramData\AxxonSoft\Axxon One
- C:\Program Files\AxxonSoft\Axxon One
- C:\Program Files\Common Files\AxxonSoft
- Postgres and metadata folders if their location is not default.
- C:\ProgramData\AxxonSoft\Axxon One
- Add the following ports to the exclusion list:
- 20109-20210
- 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:
Set different high and low quality streams for each camera.
- Low quality stream settings must be lower than the High quality stream.
- 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:
- Aspect ratio must be the same for Low and High quality streams*.
- 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:
Recommended type*: VBR.
Set maximum bitrate/bandwidth values.
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:
- After you complete the system configuration.
- Before you update to a new version.
- After you update to a new version.
- 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:
- Active time is lower than 50%.
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).