Prerequisites

• Nx Witness Server (version 5.1.4.38717+)
• Administrator/root privileges on the target server
• Network access to the Nx server
• Valid Nx Powertoys license (purchased through Nx distribution channels)
• Nx Administrator user with Digest Authentication enabled (required for API functionality)

System Requirements

• Operating System: Windows 10/11 or Linux (Ubuntu 18.04+, Debian 11+)
• Architecture: x86_64 (64-bit)
• Memory: Minimum 2GB RAM
• Storage: 100MB free disk space
• Network: Local network access to Nx server

Windows Installation

1. Download the installer
   • Download nxpowertoys_x.x.x.zip from the official Nx Powertoys distribution
   • Extract the zip file in a directory of your choice
2. Open Command Prompt as Administrator
   • Press Windows + X and select "Windows PowerShell (Admin)" or "Command Prompt (Admin)"
   • Navigate to the directory containing the installer
3. Run the installation
   • nxpt.exe --install
   • The Nx Powertoys service should start automatically
   • Default port: 8080
   • Access the web interface at: http://127.0.0.1:8080

Windows CLI Options

• nxpt.exe --help - Show help message
• nxpt.exe --version - Show version information
• nxpt.exe --install --port 8080 - Install with custom port
• nxpt.exe --start - Start the Windows service
• nxpt.exe --stop - Stop the Windows service
• nxpt.exe --restart - Restart the Windows service
• nxpt.exe --uninstall - Uninstall the Windows service

Linux Installation

1. Download the installer
   • Download the appropriate .deb package for your Ubuntu/Debian version
   • Example: nxpowertoys_[version]_amd64.deb
2. Install the package
   • sudo apt install ./nxpowertoys_*.deb
3. Verify installation
   • sudo systemctl status nxpt
4. Access the web interface
   • Default URL: http://127.0.0.1:8080
   • Automatic port detection: If port 8080 is in use, the application automatically finds the next available port by incrementing by 10 (8090, 8100, 8110, etc.)

Linux Service Management

• sudo systemctl start nxpt - Start service
• sudo systemctl stop nxpt - Stop service
• sudo systemctl restart nxpt - Restart service
• sudo systemctl status nxpt - Check status
• sudo journalctl -u nxpt -f - View logs
• sudo systemctl enable nxpt - Enable auto-start
• sudo systemctl disable nxpt - Disable auto-start

Linux Configuration

To change the default port on Linux:

1. Edit the configuration file
   • sudo nano /opt/nxpt/etc/config.json
2. Modify the port setting
   • Change the port value in the JSON configuration
3. Restart the service
   • sudo systemctl restart nxpt

Post-Installation Setup

1. Access the Web Interface
   • Open your web browser
   • Navigate to: http://127.0.0.1:8080
   • Note: Nx Powertoys only responds to localhost calls (127.0.0.1)
   • Port detection: If the default port 8080 is in use, check the application logs or try http://127.0.0.1:8090, http://127.0.0.1:8100, etc.
2. Connect to Nx Server
   • Click the "Connect" button on the Status page
   • Enter Nx credentials:
     • Username: Your Nx Administrator username
     • Password: Your Nx Administrator password
     • Critical: The Nx Administrator user MUST have Digest Authentication enabled
     • Why: Many API calls will fail without digest authentication enabled
3. License Activation
   • Copy the NX Hardware ID from the Nx Powertoys server
   • Visit the Nx Activation form with your license key
   • Enter the Hardware ID and license key (include the "-" in the license key)
   • Copy the activation confirmation and license key
   • Paste into Nx Powertoys server and click Submit
4. Integration with Nx Client (Recommended)
   • Open Nx Client
   • Create a new "Proxied Webpage" pointing to the Nx Powertoys server
   • URL: http://127.0.0.1:8080 (or the port found by automatic detection)
   • This provides seamless integration within the Nx Client interface

Important: Digest Authentication Requirement

CRITICAL: The Nx Administrator user account used with Nx Powertoys MUST have Digest Authentication enabled in the Nx Witness Server settings. Without this:

• Many API calls will fail
• Rule management features may not work
• Password retrieval may be unavailable
• Other core functionality may be limited

To enable Digest Authentication:

1. Log into Nx Witness Client
2. Go to System Administration → Users
3. Select your Administrator user
4. Enable "Digest Authentication" in the user settings
5. Save the changes

This is a fundamental requirement for Nx Powertoys to function properly.

Troubleshooting

Common Issues

• Service Won't Start
  • Windows: Check Windows Event Viewer for error messages
  • Linux: Check logs with sudo journalctl -u nxpt -f
  • Verify port availability: Ensure port 8080 (or your custom port) is not in use
• Connection Issues
  • Verify Nx server is running and accessible
  • Check credentials: Ensure you're using Administrator privileges
  • Digest Authentication: CRITICAL - Ensure the Nx Administrator user has Digest Authentication enabled
  • Network connectivity: Confirm localhost access to port 8080
• Port Conflicts
  • Windows: You can also use the --port parameter during installation to specify a custom port
  • Linux: Edit the configuration file at /opt/nxpt/etc/config.json to specify a custom port

1. Using the Nx Client rules editor, comment all the rules you would like Nx Powertoys to list
2. Browse to the Nx Powertoys server > Rule Groups > Add / Edit Rule Group
3. Select the commented rules you would like Nx Powertoys to enable or disable for that group
   ("Include" selects the rule to be part of the group, the "State" checkbox sets the state for that rule).
   Using only commented rules limits the list & allows you to create your own comment syntax for rule sorting
4. Apply the Rule Group directly, or Nx Powertoys can create the Nx "Soft Trigger" & "Generic" events to action the Rule Group

• Other "Powered by Nx" products share the same API, so yes.
  Nx Meta, DW Spectrum, Hanwha Wave etc.
  Application supports version 5.1.4.38717 +