Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Install a MID Server on Linux

Log in to subscribe to topics and get notified when content changes.

Install a MID Server on Linux

This MID Server installer automates the installation of a MID Server on a Linux computer.

Before you begin

Role required: admin, mid_server
Important: Verify that the computer meets the MID Server system requirements.

About this task

You can install a MID Server on a 32-bit or 64-bit Linux computer. Click this link to view the installation video:


  1. From the Linux command line, type mkdir -p /servicenow/mid server name to create the installation directory. You need to have read/write/execute permissions on this folder.
  2. Extract the downloaded MID Server archive file, into the servicenow/mid server name/ directory. Use the MID Server name created in the instance or create a new name that you will use for this MID Server moving forward.
    The resulting directory structure is /servicenow/<mid server name>/agent.
  3. Change to the servicenow/mid server name /agent directory, and enter the following command to start the MID Server installer: ./
    If you prefer to manually configure the MID Server instead, skip to this step.
  4. Use the installer to enter the following information.

    An example MID Server installation

    Field Description
    ServiceNow instance URL Enter the full URL of your instance, for example:

    ServiceNow MID Server username Enter the user name of the MID Server user that you already created. The MID Server user must have the mid_server role.
    ServiceNow MID Server password Enter the password for the user in the ServiceNow MID Server username.
    Use proxy Select this check box if your MID Server communicates through a proxy to connect to the instance.
    Note: Your proxy server must use Basic Authentication for the MID server to connect to the instance.
    Proxy host Enter the proxy server host name or IP address. Do not include the protocol in the host name. For example, enter, not
    Proxy port Enter the port through which the proxy server communicates. If you leave this field blank, it should use the proxy server's default port number.
    Proxy username Enter the user name that has administrator rights to the proxy server.
    Proxy password Enter the password for the user name.
  5. Click Test your connection to validate the credentials and instance information. If you encounter any errors, verify the information that you input.
  6. Click Next.
  7. Configure the MID name parameters (see table).

    Table 1.
    Field Description
    MID Server name Enter any MID Server name.
    MID Service wrapper name Modify this field if necessary. It is populated automatically by prefixing snc_mid_ to the MID Server name. In most cases, you do not need to modify this.
    MID Server wrapper display name Modify this field if necessary. It is populated automatically by prefixing ServiceNow MID Server_ to the MID Server name. In most cases, you do not need to modify this.
  8. Click Next to view the summary.
  9. Click Start MID Server.
    The local host starts the MID Server.
  10. Click Mid Servers List Page.
    The installer opens the MID Server list from your instance.
  11. Select the MID Server name from the list.
    Note: It may take a few seconds for the MID Server time to establish a connection with your instance.
    The system displays the MID Server record.
  12. From Related Links, click Validate.
    The MID Server Validated changes to Yes.
  13. To configure the MID Server manually, change to the servicenow/mid server name /agent directory, and then edit the config.xml file as follows:
    1. Find the element <parameter name="url" value="" /> and change the value to the URL of your instance.
    2. Enter the MID user credentials in the mid.instance.username and mid.instance.password parameters.
      By default, the MID Server, uses basic authentication for SOAP messages. The password value is also encrypted authentication.
    3. Find the <parameter name="name" value="YOUR_MIDSERVER_NAME_GOES_HERE" /> element and change the value for the MID Server name.
    4. (Optional) Enter connection information for the proxy server. Remove the appropriate comment tags from the proxy configuration information.
      For example, you can configure these parameters:
      • mid.proxy.use_proxy
      • mid.proxy.port
      • mid.proxy.username
      • mid.proxy.password
  14. If you configured the MID Server manually, finalize the configuration as follows:
    1. Execute the shell script
      The system starts the new MID Server.
    2. Log into the instance.
    3. Navigate to MID Servers > Servers.
      The system displays a list of MID Server records.
    4. Select the record matching your new MID Server and verify that the Status is listed as Up.
  15. To configure the MID Server to restart automatically when the host is restarted, run ${base_install_dir}/agent/bin/ install as root.
    This command installs the MID Server as a daemon service and adds the auto start scripts to the init.d directory.
    Note: You cannot install more than one MID Server service as a daemon on a Linux host. This is a limitation of the Tanuki wrapper service.

What to do next

Configure MID Server parameters, which control several aspects of MID Server functionality, including proxy servers, debugging, and upgrade.