This article provides a basic overview of .ini files in the context of Nx Witness.

How does Nx Witness use .ini files?

An .ini file is a configuration file that contains attributes and configurations. Nx Witness can use .ini files to specify certain settings in the application. When .ini files are detected, Nx Witness applies the files’ configurations to its runtime automatically. Otherwise, Nx Witness uses default settings when the .ini files are either missing or empty.

Note: .ini files should be mainly used for testing or troubleshooting. Please consult Nx Support before making any changes to the settings.

Where should I create the nx_ini directory?

By default, the nx_ini directory is absent and should be created at the default location. The default location of the directory depends on your OS and Nx software component.

• Nx Server
  • Windows:

    C:\Windows\System32\config\systemprofile\AppData\Local\nx_ini\ 

  • Linux:

    /home/networkoptix/.config/nx_ini

  • ARM:

    /etc/nx_ini/

• Nx Desktop
  • Windows:

    C:\Users\%USERNAME%\AppData\Local\nx_ini

  • Linux and macOS:

    $HOME/.config/nx_ini

Alternatively, you can use the API to locate the nx_ini directory for Nx Server. Simply perform the REST API call below and input your server authentication details when prompted:

https://<server IP>:7001/api/iniConfig

For more details, refer to Configuring via .ini files – IniConfig.

How can I create .ini files for Nx Witness?

Take the following steps to generate an .ini file with default values and comments describing each setting:

1. Determine which directory your .ini file belongs in (e.g., nx_vms_server.ini belongs in the Nx Server .ini directory).
2. Create an empty file with the proper name. The following are the most common:
   1. nx_vms_server.ini — for changing settings in Nx Server
   2. desktop_client.ini — for changing settings in Nx Desktop
   3. analytics_logging.ini — for changing settings in analytics metadata or for frame logs. Refer to Troubleshooting Analytics Issues for Cameras and Plugins for more info.

Note: On Linux and Android ADB shell, use the touch <filename> command to create the .ini files.

1. Restart the application.
2. Confirm that the .ini file is in the directory and was filled with default values and comments.