Export Documentation to PDF


Documentation for XpoLog 6.0.x
Documentation for the previous version of XpoLog is available too.

Skip to end of metadata
Go to start of metadata

General

This topic includes installation instructions for the following operating systems:

  • Windows
  • Linux
  • Solaris
  • WAR Deployment
  • Any JAVA supported OS (JAVA should be provided externally)

Installing on Windows

You may want to print these instructions. When you are ready to install, go to XpoLog site www.xpolog.com to the Download Center.

Part One: Downloading Your New Software

To download your new software:
  1. On the XpoLog download page, click the link or button for the product that you want to download.
  2. When you are done, click the Download link or the Download Now button.
    Note: Be sure to click the Download Now button for the product you want to install.
  3. Do one of the following:
  • If the software is downloaded automatically into a default folder, you see a download progress dialog box. Make a note of the directory (folder) and filename for the software that you are downloading.
  • If a "Save As" dialog box appears, choose a folder and filename for the software that you are downloading.

Part Two: Installing Your New Software

To install your new software:
  1. After downloading is complete, you may see a "Download successful" dialog box. If you see this dialog box, click Install and proceed to step 3. Otherwise, continue with step 2.
  2. (Skip this step if installation has already started.) Open the folder into which the new software was downloaded, copy it to the target machine, and double-click the file that you downloaded. For instance, if you downloaded XpoLog Center, doubleclick the file named "XpoLogCenterSetup.exe". Depending on what you are installing, you may see the Install Anywhere dialog box.
  3. When the XpoLog Setup Welcome screen appears, read the information and click Next.
    Note: Read the instructions on the following screens. The screens vary depending on what you are installing, but in general you are asked to do some or all of the instructions in the following steps.
  4. Choose a destination directory (folder). This is the location where the new software will be installed, normally C:\Program Files\XpoLogCenter. If you install your new software into the XpoLog folder that contains your current version of the software, your current version will be overwritten. If you wish to keep a copy of the old version as a backup, simply choose or create a new folder for the software that you are about to install.
  5. Choose a name for the program group; the default is XpoLog. Then, click Next.
  6. Verify all the details in the preview screen and click Install.
    Note: if you want to edit any of the details that are presented in the preview screen, click Previous to return to the desired location.
  7. When you see the prompt telling you that installation is complete, click Done
    XpoLog starts automatically.


Important: At any step, you can click cancel to quit the installation.


Silent Mode:

  1. Open the folder that the new software was downloaded into, copy it to the target machine.
  • In the folder that the new software was downloaded into create a file installer.properties, with the following contents:
    Mandatory Parameters:
    INSTALLER_UI=SILENT
    USER_INSTALL_DIR=<FULL_PATH_TO_INSTALLATION_DIRECTORY> (For example: C\:\\Program Files\\XpoLogCenter\\)
    Optional Parameters:
    USER_INPUT_AGENT_MODE="Agent Mode Active" (use "Agent Mode Not Active" for a regular installation)
    USER_INPUT_START_XPOLOG=1 (use 0 to prevent XpoLog from starting once the installation completes)
    USER_INPUT_SERVICE_NAME=XpoLogCenter (use a different service name if needed)

    - Note: ensure there are no spaces at the end of any of the lines in the file installer.properties

    - Note: ensure that you use backslash in the path before sings (For example, path: C:\Program Files\XpoLogCenter\ should be represented in the installer.properties file as C\:\\Program Files\\XpoLogCenter\\)

  1. Execute command: XpoLogCenterSetup.exe -f installer.properties
  2. XpoLog will be installed in the background and will be started automatically, unless you specified otherwise during installation.

Part Three: Running Your New Software

XpoLog starts automatically after installation. There is a single process - XpoLogCenter, which is presented in the Windows Services panel. It is highly recommended to configure a user on the XpoLogCenter service, which XpoLog can use while reading logs from machines in the environment.

To run your new software:
  1. Recommended: In the Windows Services panel, under the log on tab, type a username that XpoLog service can use in order to connect and read logs over the Windows network authentication in your organization.
  2. Open a browser with the following URL: http://MACHINE_NAME:30303 and you will be redirected to XpoLog Center homepage. 

Installing on Linux/Solaris

You may want to print these instructions. When you are ready to install, go to XpoLog site www.xplg.com to the Download Center.

Part One: Downloading Your New Software

To download your new software:
  1. On the XpoLog download page, click the link or button for the product that you want to download.
  2. When you are done, click the Download link or the Download Now button.
    Note: Be sure to click the Download Now button for the product that you want to install.
  3. Do one of the following:
  • If the software is downloaded automatically into a default folder, you see a download progress dialog box. Make a note of the directory (folder) and filename for the software that you are downloading.
  • If a "Save As" dialog box appears, choose a folder and filename for the software that you are downloading.

Part Two: Installing Your New Software

To install your new software:

After downloading is complete, you may see a "Download successful" dialog box. If you see this dialog box, click Install and go on to step 3. Otherwise, continue with step 2.

  1. (Skip this step if installation has already started.) Open the folder that the new software was downloaded into, copy it to the target machine, and gunzip the file that you downloaded. For instance, if you downloaded XpoLog Center, gunzip the downloaded file (gunzip XpoLogCenterSetup.bin.gz | for x64 gunzip XpoLogCenterSetup-64.bin.gz).
  2. After unzipping the file, execute the .bin file (sh XpoLogCenterSetup.bin | for x64 sh XpoLogCenterSetup-64.bin).
    The installation wizard will start.
  3. When the XpoLog Setup message appears, read the information and follow the installation process.
  4. Read the instructions on each step.
  5. When you see the prompt telling you that installation is complete, XpoLog will be started automatically.

Important: At any step, you can click cancel to quit the installation.


Silent Mode:

  1. Open the folder that the new software was downloaded into, copy it to the target machine, and gunzip the file that you downloaded. For instance, if you downloaded XpoLog Center, gunzip the downloaded file (gunzip XpoLogCenterSetup.bin.gz | for x64 gunzip XpoLogCenterSetup-64.bin.gz).
  2. In the folder that the new software was downloaded into create a file installer.properties, with the following contents:
    Mandatory Parameters:
    INSTALLER_UI=SILENT
    USER_INSTALL_DIR=<FULL_PATH_TO_INSTALLATION_DIRECTORY> (For example: /apps/XpoLogCenter/)
    Optional Parameters:
    USER_INPUT_AGENT_MODE="Agent Mode Active" (use "Agent Mode Not Active" for a regular installation)
    USER_INPUT_START_XPOLOG_CONSOLE="Yes" (use "No" to prevent XpoLog from starting once the installation is complete)

     
    - Note: ensure there are no spaces at the end of any of the lines in the file installer.properties

  3. Execute command: sh XpoLogCenterSetup.bin -f installer.properties.
  4. XpoLog will be installed in the background and will be started automatically, unless you specified otherwise during installation.

Part Three: Running Your New Software

XpoLog starts automatically after installation. There are several useful commands for starting, stopping, restarting, or finding out the status of the server:

  • cd to XPOLOG_HOME
  • Run: 'sh runXpoLog.sh start|stop|restart|stat'
    start = starting XpoLog 
    stop = stopping XpoLog
    restart = restarting XpoLog
    stat = finding out whether XpoLog is running or not

To run your new software:

  1. Go to the installation directory.
  2. XpoLog should start automatically after installation. To control and verify, use these commands:
    Start XpoLog – sh /…/XpoLogCenter/runXpoLog start
    Stop XpoLog – sh /…/XpoLogCenter/runXpoLog stop
    Check Status – sh /…/XpoLogCenter/runXpoLog stat
  3. Open a browser with the following URL: http://MACHINE_NAME:30303.
    You will be redirected to the XpoLog Center homepage. 

 

Installing on UNIX without internal JVM (JAVA Provided Externally)

You may want to print these instructions. When you are ready to install, go to XpoLog site www.xpolog.com to the Download Center.
This XpoLog Installer does not contain JAVA and uses an external JAVA which should already be available on the machine that you plan to run XpoLog on. Important: JAVA 1.6+ is required.

Part One: Downloading Your New Software

To download your new software:
  1. On the XpoLog download page, click the link or button for the product that you want to download (without internal JVM).
  2. Log in to the target machine with the same user you plan to run XpoLog with to ensure JAVA is available. Run the command 'java -version' and confirm the output is JAVA 1.6+
    If the java command does not return result or the JAVA version is prior to JAVA 1.6 please contact XpoLog Support for additional information.
  3. Do one of the following:
  • If the software is downloaded automatically into a default folder, you see a download progress dialog box. Make a note of the directory (folder) and filename for the software that you are downloading.
  • If a "Save As" dialog box appears, choose a folder and filename for the software that you are downloading.

Part Two: Installing Your New Software

To install your new software:

After downloading is complete, you may see a "Download successful" dialog box. If you see this dialog box, click Install and go on to step 3. Otherwise, continue with step 2.

  1. (Skip this step if installation has already started.) Open the folder that the new software was downloaded into, copy it to the target machine, and gunzip the file that you downloaded. For instance, if you downloaded XpoLog Center, gunzip the downloaded file (gunzip XpoLogCenterSetupNoJava.bin.gz).
  2. After unzipping the file, execute the .bin file (sh XpoLogCenterSetup.bin).
    The installation wizard will start.
    Note: the installation wizard looks for a local JAVA to be used, it is possible to specify the full JAVA path that should be used, by executing the installation with a specified JAVA full path (sh XpoLogCenterSetupNoJava.bin LAX_VM "/FULL/PATH/TO/JAVA/EXECUTABLE")
  3. When the XpoLog Setup message appears, read the information and follow the installation process.
  4. Read the instructions on each step.
  5. When you see the prompt telling you that installation is complete, XpoLog will be started automatically, unless you specified otherwise during installation.

Important: At any step, you can click cancel to quit the installation.


Silent Mode:

  1. Open the folder that the new software was downloaded into,copy it to the target machine, and gunzip the file that you downloaded. For instance, if you downloaded XpoLog Center, gunzip the downloaded file (gunzip XpoLogCenterSetupNoJava.bin.gz or in case of x64 gunzip XpoLogCenterSetupNoJava-64.bin.gz).
  2. In the folder that the new software was downloaded into create a file installer.properties, with the following contents:
    Mandatory Parameters:
    INSTALLER_UI=SILENT
    USER_INSTALL_DIR=<FULL_PATH_TO_INSTALLATION_DIRECTORY> (For example: /apps/XpoLogCenter/)
    Optional Parameters:
    USER_INPUT_AGENT_MODE="Agent Mode Active" (use "Agent Mode Not Active" for a regular installation)
    USER_INPUT_START_XPOLOG_CONSOLE="Yes" (use "No" to prevent XpoLog from starting once the installation is complete)

     
    - Note: ensure there are no spaces at the end of any of the lines in the file installer.properties

  3. Execute command: sh XpoLogCenterSetup.bin -f installer.properties
  4. XpoLog will be installed in the background and will be started automatically.

Part Three: Running Your New Software

XpoLog starts automatically after installation. There are several useful commands for starting, stopping, restarting, or finding out the status of the server:

  • cd to XPOLOG_HOME
  • Run: 'sh runXpolog.sh start|stop|restart|stat'
    start = starting XpoLog 
    stop = stopping XpoLog
    restart = restarting XpoLog
    stat = finding out whether XpoLog is running or not

To run your new software:

  1. Go to the installation directory.
  2. XpoLog should start automatically after installation. To control and verify, use these commands:
    Start XpoLog – sh /…/XpoLogCenter/runXpoLog start
    Stop XpoLog – sh /…/XpoLogCenter/runXpoLog stop
    Check Status – sh /…/XpoLogCenter/runXpoLog stat
  3. Open a browser with the following URL: http://MACHINE_NAME:30303.
    You will be redirected to the XpoLog Center homepage. 

Deploying XpoLog as a Web Application


Part One: Downloading Your New Software

To download your new software:
  1. On the XpoLog download page, click the link or button for the product that you want to download.
  2. When you are done, click the Download link or the Download Now button.
    Note: Be sure to click the Download Now button for the product that you want to install.

Part Two: Installing Your New Software

XpoLog can be deployed on most application servers. The deployment is standard, according to the application server that you are using.
For specific information on how to deploy XpoLog on Apache Tomcat, IBM WebSphere, Oracle WebLogic, JBoss, or any other, please contact XpoLog support team at support@xplg.com
Once XpoLog WAR has been deployed successfully, the context of XpoLog is ‘logeye’. 

Part Three: Running Your New Software

Start/stop/restart the application on the application server on which you deployed XpoLog.
Note: XpoLog default context is 'logeye'.


Thank you for installing XpoLog Center.

  • No labels