Installation
General
At its basic format, XPLG installs as a single process. This process includes everything that is needed to run and use XPLG.
The system scales easily by running multiple processes that supports high daily volumes and data retention. See XPLG Architecture for more information.
This topic includes installation instructions for the following operating systems:
Windows
Linux
Mac OS X
Generic - Any JAVA supported OS (JAVA should be provided externally)
Downloading the XPLG Software
Navigate to the XPLG site http://www.xplg.com and go to the Download Center
On the XPLG download page, click the link or button for the product that you want to download.
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.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.
Installing XPLG Software
At any step during installation you can click cancel or press Ctrl+C to quit the installation.
Installing on Windows Server OS
After downloading is complete, you may see a "Download successful" dialog box.
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 XPLG, double click the “exe” file. Depending on what you are installing, you may see the Install Anywhere dialog box.
When the XPLG 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.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 XPLG 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.
Choose a name for the program group; the default is XpoLog. Then, click Next.
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.When you see the prompt telling you that installation is complete, click Done.
XPLG starts automatically unless you specified differently during the installation.
Installing on Linux OS
After downloading is complete, you may see a "Download successful" dialog box. If you see this dialog box, copy the installation file to your Linux machine.
Due to permissions you may have copied the file to the /tmp directory on the linux host. Change the permissions on the file using chmod to an appropriate user and group.
Create a user and group the software will install and run as. You may need to do this via your enterprise standard process if integrations are centralised to solutions such as LDAP / AD.
Create a target install folder inline with your enterprise standards and ensure that folder has the permissions for the user and group the software will be in stalled and run as
Open the folder that the new software was downloaded into on the linux host and copy the file to the target install directory
Change the owner and group of the file to the user group you wish to install and run the software as
Switch to the target user the software should install as to ensure correct permissions are retained
gunzip the file that you downloaded:
gunzip ./XpoLogCenterSetup-64.bin.gz ./ |
---|
After unzipping the file, execute the .bin file to start the install wizzard
When the following XpoLog Setup message appears, read the information and follow the installation process.
Read the instructions on each step.
Question | Documented Example Note | Documented Example |
---|---|---|
ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT | Enter the install path created in step 3. | /apps/xplg/ |
INSTALL FOLDER IS: /apps/xplg | Y | Y |
=============================================================================== Start XpoLog after the installation completes ->1- Yes ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 2 | No so we can see what has been done and / or add the control to an external service manager | 2 |
Confirm the install summary
When you see the prompt telling you that installation is complete and you will see the installed directories and files
XPLG will be started automatically unless you specified differently.
Installing on Mac OS X
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.
(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 unzip the file that you downloaded. For instance, if you downloaded XPLG , unzip the downloaded file (unzip XpoLogCenterSetup.zip).
After unzipping the file, ensure there are sufficient permissions to run the file:
Open a terminal and cd to the location where you extracted the file
Run: sudo chmod -R 755 XpoLogCenterSetup.app/
execute the installer - Right Click the XpoLogCenterSetup and select Open.
The installation wizard will start.When the XPLG Setup message appears, read the information and follow the installation process.
Read the instructions on each step.
When you see the prompt telling you that installation is complete, XPLG will be started automatically.
Installing on UNIX without bundles JVM
This XPLG 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 17 is required.
On the XPLG download page, click the link or button for the product that you want to download (without internal JVM).
Check the target machine you are installing XPLG on to ensure JAVA is available. Run the command
Confirm the output is JAVA 17.
If the java command does not return a result or the JAVA version is not 17 please download the java 17 jre and install inline with your enterprises approved software repository.
If installation has already started jump to step 5.
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 XPLG, gunzip the downloaded file
Execute the command to start the wizzard;
Note: As you have chosen the installer without Java built in the wizard looks for a local JAVA to be used using the JAVA_HOME environment variable. It is possible to specify the full JAVA path that should be used by executing the installation with a specified JAVA full path
When the XpoLog Setup message appears, read the information and follow the installation process.
Read the instructions on each step.
When you see the prompt telling you that installation is complete, XpoLog will be started automatically, unless you specified otherwise during installation.
Installing as a System Service
XpoLog starts automatically after installation unless you specified differently during the installation process
Windows Service
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:
Recommended: In the Windows Services panel, under the log on tab, type a username that XPLG service can use in order to connect and read logs over the Windows network authentication in your organization.
Linux Daemon
It is recommended to set up the xplg service as a system service inline with your enterprise standards.
MacOS Daemon
It is recommended to set up the xplg service as a system service inline with your enterprise standards.
Starting and Stopping XpolgCentre
XPLG starts automatically after installation unless you specified differently. There are several useful commands for starting, stopping, restarting, or finding out the status of the server:
cd to the installation directory of XPLG
XPLG should start automatically after installation. To control and verify, use these commands:
Starting XpologCentre
Stopping XpogLogCentre
Check XpologCentre Status
Open a browser with the following URL: http://MACHINE_NAME:30443
You will be redirected to the XPLG homepage.
Support
For further assistance please contact XpoLog Support.