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

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:

Procedure

  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, mid.os.zip 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: ./installer.sh.
    If you prefer to manually configure the MID Server instead, skip to Step 9.
    The MID Server installer
    The system opens the MID Server installer.
  4. Use the installer to enter the following information.
    • URL to your instance
    • User credentials to run the MID Server
    • Proxy server connection details
    • MID Server name
    Note: The MID Server user must have the mid_server role.
  5. From the installer, click Start MID Server.
    The local host starts the MID Server.
  6. Click Mid Servers List Page.
    The installer opens the MID Server list from your instance.
  7. 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.
  8. From Related Links, click Validate.
    The MID Server Validated changes to Yes.
  9. 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="https://YOUR_INSTANCE.service-now.com" /> 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.host
      • mid.proxy.port
      • mid.proxy.username
      • mid.proxy.password
  10. If you configured the MID Server manually, finalize the configuration as follows:
    1. Execute the shell script start.sh.
      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.
  11. To configure the MID Server to restart automatically when the host is restarted, run ${base_install_dir}/agent/bin/mid.sh install as root to add the auto start scripts to the init.d directory.