On-Premise Administrator Overview

Help with technical tasks required to install and manage your on-premise NetX environment.


Though it's common for NetX staff to perform the initial installation of your on-premise NetX site during onboarding, we offer comprehensive guides on how to install your on-premise site, system requirements, and information on various components needed to run NetX.


  • Since NetX relies on the Java Virtual Machine (JVM) for its resources, you'll need to configure Java's heap size parameters to control how much memory the application uses on your server. Setting these parameters too low or high could result in performance degradation or application crashes due to Out Of Memory errors. For details on how to change heap size and rough guidelines on the amount of memory to allocate, see Java Memory Heap.
  • Proper configuration of storage paths is necessary for the successful operation of your NetX site. For a detailed list of paths used in the application, see Managing File Paths.

Transcoding Engines

NetX requires third-party software known as Transcoding Engines in order to process media files such as images, videos, and documents. Engines are used to generate thumbnails, previews, zooms, and repurposed derivatives.

  • See Supported Transcoding Engines for links on how to install and configure the minimum set of required engines.
  • Supported engine versions are tied to specific NetX releases, so make sure to stay up to date with new versions as you upgrade NetX.


  • Advanced NetX settings are configured with the use of properties.
  • NetX requires connection to a valid SMTP server to send email. To learn how to configure this connection and other important email settings, see NetX Global Email Settings.
  • Need to configure or troubleshoot SSO? Check out NetX SAML Services for help.


  • NetX logs are the best resource for monitoring and troubleshooting issues with your installation. To learn about which log files are available, see Log Files.
  • When troubleshooting, it's best to temporarily set your log level to DEBUG to capture the necessary information.
  • Third-party monitoring software can alert you to critical issues in your environment before they affect users.
  • Insights into storage, usage, and application performance can be found in Statistics.


  • Establishing a robust backup and disaster recovery strategy is the most important thing you can do.
  • Learn how to stop and start a NetX instance when you need to bring your server down for maintenance or upgrade.
  • If you are using SSL or a custom hostname, make sure you keep your security certificates up to date.
  • Set up up a log archival/deletion routine to prevent disk space from filling up.
  • Periodically review your authentication (SSO or LDAP) settings to make sure they are aligned with evolving requirements.
  • We recommend disabling automatic updates on your server operating system.
  • Certain upgrades and feature changes may require a rebuild of the search index.

Upgrading NetX

  • Read Release Notes and upgrade guides first: Upgrading NetX on Windows and Upgrading NetX on Linux.
  • Follow Upgrade Best Practices to ensure a successful upgrade.
  • We strongly recommend practicing upgrades on a test environment before attempting your production upgrade.
  • If your system runs components such as Solr and database on separate servers, start those services first before NetX.
  • Starting in version 9, Solr upgrades must be done separately from NetX. Follow the instructions in your upgrade guide.
  • If you've changed license coverage, read Updating a NetX License File to learn how to install your new license.
  • Check out our Release Policy.

Multiple Server Instances

NetX can be installed in a distributed architecture, with multiple application server nodes connected to a shared database. Additional licensing is required.

  • There are special considerations to be aware of when running multiple server instances. Please contact your account manager for advice and information before attempting to run this configuration.
  • Solr must also be upgraded when upgrading NetX. Both the database and Solr and must be running before starting NetX application nodes.
  • Most storage paths are shared, but some may be configured per node. See properties for details.
  • Properties are configured per node and must be updated on each.
  • AutoTasks are configured per node, with the exception of periodic AutoTasks.









Was this article helpful?
0 out of 0 found this helpful