Installing MID Server on Linux

  • Release version: Australia
  • Updated March 12, 2026
  • 14 minutes to read

    • Using the ITOM Infra Services Workspace, MID Servers can be deployed to Linux with a variety of authentication and installation methods. For authentication, choose between intertrust public key infrastructure (iPKI), basic authentication, or mutual authentication.

    Set up indicator for installation phaseEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server securityEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server security

    To install Linux on MID Server, the RedHat/CentOS systems require RPM while Debian (Ubuntu) systems require DEB. The default installation location is /opt/servicenow/mid. Installing DEB in user defined directories is not supported.

    To improve security, this procedure installs and run the MID Server service as a non-root user. Root privilege is required to deploy and configure a MID Server on a Linux server. A non-root user can manage a service only if they have the required permissions. For more details, see PolicyKit issues with Linux MID Servers using non-admin accounts [KB0815542].

    Note:
    ServiceNow no longer supports new installations of 32-bit MID Servers or upgrades to version Rome. New MID Server installation are blocked through RPM and MSI installer on the following operating systems:
    • CentOS 7
    • Windows server 2008
    • Windows server 2008 R2
    • Windows 8
    • Windows 10
    MID Servers can be manually installed to any operating system with the ZIP file, however Windows 10 is unsupported. Unsupported MID Servers auto-upgrading to Rome create an issue record in MID Server Issues (ecc_agent_issue). For more information, see Supported platform changes for MID Server [KB0863694].

    Java 21.0.7 is bundled with the MID Server installer package and is installed on the host for all new MID Servers. The installer automatically configures Java 21.0.7 to run in your environment. No additional configuration is required. This version supports both 64-bit Windows MID Servers and 64-bit Linux MID Servers. The MID Server requires a minimum JRE version 17.0.10, and recommended version 21.0.7. If you are using a lower version than 17.0.10, you may see encryption related issues.

    Note:
    Linux MID Servers require glibC version 2.17. The library must be updated for JRE 11. On 64-bit Linux systems, you must install the 32-bit GNU C library (glibc). The installation command for CentOS is: yum install glibc.i686

    Testing showed that the MID Server works as expected with Oracle Java 11 version 17.0.10. If you need to upgrade the JRE to a different version, then coordinate with the appropriate account representative for support.

    Install MID Server on Linux using ZIP

    Using the ITOM Infra Services Workspace, MID Servers can be deployed and configured manually with a ZIP file.

    Before you begin

    Role required: admin

    Procedure

    1. On the instance, navigate to ITOM Infra Services Workspace.
    2. In the Set up a MID panel, select Download a MID Server.
    3. In the Download and set up a MID Server panel, select Set up a MID Server.
    4. To begin the installation process, provide the following information.
      • Authentication type: ServiceNow certificate
      • I'm installing the MID Server on: Linux
      • I want to install using a: Manual configuration via zip file
      Note:
      If this is your first time installing a MID Server, use the command line installer instead of installing manually. See Install MID Server with the command line installer for more information.
    5. To proceed, select Next: Configuration.
    6. Configure a Non-Root User by creating a dedicated non-root account for the MID Server.
    7. Navigate to mid.shconf_override and edit the following:
      Parameter Action
      APP_NAME Set to a unique MID Server Name (mid_centos_1)
      APP_LONG_NAME Set to a unique MID Server Name (ServiceNow MID Server Centos 1)
      RUN_AS_USER Set to non-root username (DOMAIN\svc_mid_uswest1)
      GROUP_NAME Optional: Add name of group directory to own MID Server folder
      PROMPT_BEFORE_OWNERSHIP_CHANGE Set to true
    8. Download the Linux ZIP file from the installation plan.
    9. On the Linux host machine, extract the ZIP file into the intended install directory for the MID Server.
    10. Go to the installation plan and generate a token to register your ServiceNow-provided certificate.

      This token allows a new MID Server to authenticate to this instance for the first time. It is single-use and expires in 24 hours. You can regenerate this key if needed.

    11. Paste the code block into the config.xml file.
      Note:
      This token is generated with a default MID Server user. If you want to use a specific MID Server user, select Specify MID Server user to generate the token.
    12. To configure your MID Server, navigate to the agent folder and configure the following properties in config.xml with a text editor:
      Parameter Action
      url Set to your instance URL (https://YOUR_INSTANCE.service-now.com/)
      name Set to your MID Server name. This name must be unique and cannot contain spaces or special characters. (mid-uswest-01)

      If your MID Server connects to the instance through a proxy, uncomment and configure the following properties as well:

      Parameter Action
      mid.proxy.use_proxy Set to true
      mid.proxy.host Set to your proxy value (proxy.example.com)
      mid.proxy.port Set to your proxy port (defaults to 8080)
      mid.proxy.password Optional, set to your proxy password
    13. Start your MID Server by opening a command prompt, navigating to the agent folder, and running start.bat.

      If a service account was configured, enter the password when prompted. The MID Server then starts and connects to the instance.

    14. Set up your MID Server applications and capabilities by selecting the MID Server record and navigating to the related lists.

      By default, the MID Server is not be able to run any applications or capabilities.

    What to do next

    To optimize your MID Server, consider configuring it to be part of a cluster or set IP ranges. For more information, see Configure a MID Server cluster, Configure MID Server capabilities, Using MID Server IP range auto-assignment.

    Install MID Server on Linux with basic authentication

    Using the ITOM Infra Services Workspace, MID Servers can be deployed with the Linux installer. Basic authentication is less secure than other authentication types.

    Before you begin

    Role required: admin

    Procedure

    1. On the instance, navigate to ITOM Infra Services Workspace.
    2. In the Set up a MID panel, select Download a MID Server.
    3. In the Download and set up a MID Server panel, select Set up a MID Server.
    4. To begin the installation process, provide the following information.
      • Authentication type: Basic authentication
      • I'm installing the MID Server on: Linux
      • I want to install using a: Linux (RPM, DBM, or Docker)
      Note:
      If this is your first time installing a MID Server, use the command line installer instead of installing manually. See Install MID Server with the command line installer for more information.
    5. To proceed, select Next: Download and Install.
    6. Create a ServiceNow user for this MID Server and grant it mid_server role.

      For more information on creating users, see Create the MID Server user and grant the role.

      Note:
      This user should be unique for each MID Server using basic authentication.
    7. Download either the MID Server installer RPM file for RedHat/CentOS or the DEB file for Debian (Ubuntu) systems.

      For more information, see Install a MID Server on Linux.

    8. Place the installer file on the MID Server host.
    9. Install the package for the appropriate system with the following commands:
      1. Install the RPM package for RedHat systems with the command: sudo rpm -ivh --nodeps package_name.rpm.
      2. Install the DEB package for Debian systems with the following command: sudo dpkg -i package_name.deb.
    10. To configure the MID Server service, run the command ./installer.sh from the agent folder as a user with root privilege, and provide the required inputs.
    11. Verify that the MID Server is running.

      The MID Server record appears in the installer step once it is detected. If the MID Server does not appear within 5 minutes of running the installation command, check your logs in agent\logs to identify the issue.

    12. Use the Validate MID Server action and select the clusters, applications, capabilities, and IP ranges for this server.
      For more information, see Configure a MID Server cluster, Configure MID Server capabilities, Using MID Server IP range auto-assignment respectively.

    Install MID Server on Linux with basic authentication using ZIP

    Using the ITOM Infra Services Workspace, MID Servers can be deployed and configured manually with a ZIP file. Basic authentication is less secure than other authentication types.

    Before you begin

    Role required: admin

    Procedure

    1. On the instance, navigate to ITOM Infra Services Workspace.
    2. In the Set up a MID panel, select Download a MID Server.
    3. In the Download and set up a MID Server panel, select Set up a MID Server.
    4. To begin the installation process, provide the following information.
      • Authentication type: Basic authentication
      • I'm installing the MID Server on: Linux
      • I want to install using a: Manual configuration via zip file
      Note:
      If this is your first time installing a MID Server, use the command line installer instead of installing manually. See Install MID Server with the command line installer for more information.
    5. To proceed, select Next: Download and Install.
    6. Download the Linux ZIP file from the installation plan.
    7. On the Linux host machine, extract the ZIP file into the intended install directory for the MID Server.
    8. Configure a Non-Root User by creating a dedicated non-root account for the MID Server, then navigate to the mid.shconf_override and edit the following:
      Parameter Action
      APP_NAME Set to a unique MID Server Name (mid_centos_1)
      APP_LONG_NAME Set to a unique MID Server Name (ServiceNow MID Server Centos 1)
      RUN_AS_USER Set to non-root username (DOMAIN\svc_mid_uswest1)
      GROUP_NAME Optional: Add name of group directory to own MID Server folder
      PROMPT_BEFORE_OWNERSHIP_CHANGE Set to true
    9. To configure your MID Server, navigate to the agent folder and configure the following properties in config.xml with a text editor:
      Parameter Action
      url Set to your instance URL (https://YOUR_INSTANCE.service-now.com/)
      mid.instance.username Enter the name of the MID Server user that you already created. The MID Server user must have the mid_server role.
      mid.instance.password Enter the password for the user in the ServiceNow MID Server username.
      name Set to your MID Server name. This name must be unique and cannot contain spaces or special characters. (mid-uswest-01)

      If your MID Server connects to the instance through a proxy, uncomment and configure the following properties as well:

      Parameter Action
      mid.proxy.use_proxy Set to true
      mid.proxy.host Set to your proxy value (proxy.example.com)
      mid.proxy.port Set to your proxy port (defaults to 8080)
      mid.proxy.password Optional, set to your proxy password
    10. Start your MID Server by opening a command prompt, navigating to the agent folder, and running start.bat.

      If a service account was configured, enter the password when prompted. The MID Server then starts and connects to the instance.

      The MID Server appears in the record table once it is detected. If the MID Server does not appear within 5 minutes of running the installation command, check your logs in agent\logs to identify the issue.

    11. Set up your MID Server applications and capabilities by selecting the MID Server record and navigating to the related lists.

      By default, the MID Server is not be able to run any applications or capabilities.

    12. Use the Validate MID Server action and select the clusters, applications, capabilities, and IP ranges for this server.
      For more information, see Configure a MID Server cluster, Configure MID Server capabilities, Using MID Server IP range auto-assignment respectively.

    Install MID Server on Linux with mutual authentication

    Using the ITOM Infra Services Workspace, MID Servers can be deployed for mutual authentication. Mutually authentication must be authorized and prepared on the instance by ServiceNow support.

    Before you begin

    Role required: admin

    Procedure

    1. To enable Mutual Authentication, the instance must be authorized and prepared by ServiceNow support.
      For more information, see Enable MID Server mutual authentication.
    2. On the instance, navigate to ITOM Infra Services Workspace.
    3. In the Set up a MID panel, select Download a MID Server.
    4. In the Download and set up a MID Server panel, select Set up a MID Server.
    5. To begin the installation process, provide the following information.
      • Authentication type: Custom certificate (mutual TLS)
      • I'm installing the MID Server on: Linux
      • I want to install using a: Linux (RPM, DBM, or Docker)
      Note:
      If this is your first time installing a MID Server, use the command line installer instead of installing manually. See Install MID Server with the command line installer for more information.
    6. To proceed, select Next: Download and Install.
    7. Create a ServiceNow user for this MID Server and grant it mid_server role.

      For more information on creating users, see Create the MID Server user and grant the role.

      Note:
      This user should be unique for each MID Server using basic authentication.
    8. Download either the MID Server installer RPM file for RedHat/CentOS or the DEB file for Debian (Ubuntu) systems.

      For more information, see Install a MID Server on Linux.

    9. Place the installer file on the MID Server host.
    10. Install the package for the appropriate system with the following commands:
      1. Install the RPM package for RedHat systems with the command: sudo rpm -ivh --nodeps package_name.rpm.
      2. Install the DEB package for Debian systems with the following command: sudo dpkg -i package_name.deb.
    11. To configure the MID Server service, run the command ./installer.sh from the agent folder as a user with root privilege, and provide the required inputs.
    12. Verify that the MID Server is running.

      The MID Server record appears in the installer step once it is detected. If the MID Server does not appear within 5 minutes of running the installation command, check your logs in agent\logs to identify the issue.

    13. Use the Validate MID Server action and select the clusters, applications, capabilities, and IP ranges for this server.
      For more information, see Configure a MID Server cluster, Configure MID Server capabilities, Using MID Server IP range auto-assignment respectively.

    Install MID Server on Linux with mutual authentication using ZIP

    Using the ITOM Infra Services Workspace, MID Servers can be deployed using ZIP for mutual authentication. Mutually authentication must be authorized and prepared on the instance by ServiceNow support.

    Before you begin

    Role required: admin

    Procedure

    1. To enable Mutual Authentication, the instance must be authorized and prepared by ServiceNow support.
      For more information, see Enable MID Server mutual authentication.
    2. On the instance, navigate to ITOM Infra Services Workspace.
    3. In the Set up a MID panel, select Download a MID Server.
    4. In the Download and set up a MID Server panel, select Set up a MID Server.
    5. To begin the installation process, provide the following information.
      • Authentication type: Custom certificate (mutual TLS)
      • I'm installing the MID Server on: Linux
      • I want to install using a: Linux (RPM, DBM, or Docker)
      Note:
      If this is your first time installing a MID Server, use the command line installer instead of installing manually. See Install MID Server with the command line installer for more information.
    6. To proceed, select Next: Download and Install.
    7. Create a ServiceNow user for this MID Server and grant it mid_server role.

      For more information on creating users, see Create the MID Server user and grant the role.

      Note:
      This user should be unique for each MID Server using basic authentication.
    8. Download the Linux ZIP file from the installation plan.
    9. On the Linux host machine, extract the ZIP file into the intended install directory for the MID Server.
    10. Configure a Non-Root User by creating a dedicated non-root account for the MID Server, then navigate to the mid.shconf_override and edit the following:
      Parameter Action
      APP_NAME Set to a unique MID Server Name (mid_centos_1)
      APP_LONG_NAME Set to a unique MID Server Name (ServiceNow MID Server Centos 1)
      RUN_AS_USER Set to non-root username (DOMAIN\svc_mid_uswest1)
      GROUP_NAME Optional: Add name of group directory to own MID Server folder
      PROMPT_BEFORE_OWNERSHIP_CHANGE Set to true
    11. To configure your MID Server, navigate to the agent folder and configure the following properties in config.xml with a text editor:
      Parameter Action
      url Set to your instance URL (https://YOUR_INSTANCE.service-now.com/)
      mid.instance.username Enter the name of the MID Server user that you already created. The MID Server user must have the mid_server role.
      mid.instance.password Enter the password for the user in the ServiceNow MID Server username.
      name Set to your MID Server name. This name must be unique and cannot contain spaces or special characters. (mid-uswest-01)

      If your MID Server connects to the instance through a proxy, uncomment and configure the following properties as well:

      Parameter Action
      mid.proxy.use_proxy Set to true
      mid.proxy.host Set to your proxy value (proxy.example.com)
      mid.proxy.port Set to your proxy port (defaults to 8080)
      mid.proxy.password Optional, set to your proxy password
    12. Start your MID Server by opening a command prompt, navigating to the agent folder, and running start.bat.

      If a service account was configured, enter the password when prompted. The MID Server then starts and connects to the instance.

      The MID Server appears in the record table once it is detected. If the MID Server does not appear within 5 minutes of running the installation command, check your logs in \agent\logs to identify the issue.

    13. Set up your MID Server applications and capabilities by selecting the MID Server record and navigating to the related lists.

      By default, the MID Server is not be able to run any applications or capabilities.

    14. Use the Validate MID Server action and select the clusters, applications, capabilities, and IP ranges for this server.
      For more information, see Configure a MID Server cluster, Configure MID Server capabilities, Using MID Server IP range auto-assignment respectively.