Web Console Configuration Reference

This page documents all configuration options for the NetXMS web management console (nxmc).

Configuration Sources

The web console reads its configuration from the following sources, in priority order (first match wins):

  1. JNDI — entries bound in the servlet container under java:comp/env/nxmc/*

  2. nxmc.properties file — loaded from the classpath, or, failing that, from the web application root (/nxmc.properties via the servlet context)

  3. JVM system properties — e.g. -Dnxmc.server=10.0.0.1

  4. Environment variables — the property name uppercased with an NXMC_ prefix, e.g. NXMC_SERVER=10.0.0.1

JNDI (Jetty Example)

Create a context XML file alongside your WAR deployment (e.g., /opt/jetty-base/webapps/root.xml alongside root.war):

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN"
  "https://www.eclipse.org/jetty/configure_10_0.dtd">
<Configure class="org.eclipse.jetty.ee10.webapp.WebAppContext">
  <Call name="setAttribute">
    <Arg>org.eclipse.jetty.server.webapp.WebInfIncludeJarPattern</Arg>
    <Arg>.*/.*\.jar$</Arg>
  </Call>
  <New id="nxmc/server" class="org.eclipse.jetty.plus.jndi.EnvEntry">
    <Arg></Arg>
    <Arg>nxmc/server</Arg>
    <Arg type="java.lang.String">10.0.0.1</Arg>
    <Arg type="boolean">true</Arg>
  </New>
</Configure>

Replace 10.0.0.1 with your NetXMS server address.

nxmc.properties File

Place nxmc.properties on the servlet container’s classpath.

  • Tomcat (Linux): copy to /usr/share/tomcat11/lib/

  • Tomcat (Windows): copy to C:\Program Files\Apache Software Foundation\Tomcat 11\lib\

  • Jetty: place the file in $JETTY_BASE/resources/ (that directory is on the server classpath automatically)

server=10.0.0.1

JVM System Properties

Pass properties on the Java command line or in the container’s JVM options file:

-Dnxmc.server=10.0.0.1

For Tomcat on Linux, add the option to JAVA_OPTS in /etc/default/tomcat11 or /etc/sysconfig/tomcat. For Tomcat on Windows, add the option to the Java options in the Tomcat service configuration.

Environment Variables

Set environment variables before starting the servlet container:

export NXMC_SERVER=10.0.0.1

For systemd-managed services, add Environment=NXMC_SERVER=10.0.0.1 to the service unit’s [Service] section.

On Windows, set the environment variable in the Windows system environment or in the Tomcat service wrapper configuration.

Configuration Properties

Property Env var / JVM property Description

server

NXMC_SERVER / -Dnxmc.server

NetXMS server address (IP or hostname). Required.

loginFormImage

NXMC_LOGINFORMIMAGE / -Dnxmc.loginFormImage

Path to a custom image on the login page (looked up on the classpath, then in the web application root). For example: /logo.jpg.

loginFormImageBackground

NXMC_LOGINFORMIMAGEBACKGROUND / -Dnxmc.loginFormImageBackground

Background color around the custom login image. Use CSS color values (e.g., #ffffff).

loginFormImageMargins

NXMC_LOGINFORMIMAGEMARGINS / -Dnxmc.loginFormImageMargins

Margins in pixels around the custom login image. Default: 10.

loginFormMessage

NXMC_LOGINFORMMESSAGE / -Dnxmc.loginFormMessage

Custom message displayed on the login form.

loginFormNoVersion

NXMC_LOGINFORMNOVERSION / -Dnxmc.loginFormNoVersion

Hide the product version on the login form. Default: false.

enableCompression

NXMC_ENABLECOMPRESSION / -Dnxmc.enableCompression

Enable protocol compression for the server connection. Default: true.

autoLoginOnReload

NXMC_AUTOLOGINONRELOAD / -Dnxmc.autoLoginOnReload

Automatically re-authenticate when the browser page is reloaded. Default: true.

ignoreProtocolVersion

NXMC_IGNOREPROTOCOLVERSION / -Dnxmc.ignoreProtocolVersion

Skip client/server protocol version compatibility check. Default: false.
Environment variable names are simply the property name uppercased with the NXMC_ prefix — no underscores are inserted at word boundaries.

Server Address Resolution Order

If no explicit server address is configured through any of the methods above, the web console uses the following fallback logic:

  1. Resolve the DNS name NETXMS_SERVER — if it resolves, use that address

  2. Fall back to 127.0.0.1 (localhost)

This allows zero-configuration deployments by creating a DNS A record named NETXMS_SERVER pointing to the NetXMS server address.