Skip to main content

3. Install Xerolite

Follow these steps to download, install, and launch XeroLite on your computer or VPS.


3.1: Download Xerolite

What this does: You're getting the XeroLite software package so you can run it on your machine or VPS.

Why it matters: Without the correct package for your OS (Windows or Linux), XeroLite won't run. Mac is not supported.

Download Location

Download the latest version of XeroLite from the official download page: XeroLite Downloads & Resources

Make sure you have completed the Preparation steps before downloading.

Download Steps

  1. Visit the XeroLite Downloads & Resources page
  2. Select the appropriate version for your operating system:
    • Windows: Download win v1.2.0 (or latest version)
    • Linux: Download lin v1.2.0 (or latest version)
  3. Click the Download button for your platform
  4. Save the xerolite-xxxx.zip file to your preferred location

Verify Download

After downloading, verify that you have the complete package:

  • The zip file should be named xerolite-xxxx.zip (where xxxx is the version number)
  • Ensure the download completed successfully

You'll know it worked when: You have a single zip file (e.g. xerolite-1.2.0.zip) with no errors.


3.2: Install Xerolite

What this does: You're unpacking the XeroLite files so the run script and config can be used.

Why it matters: XeroLite runs from these extracted files. Don't run it from inside the zip.

Extract the Package

  1. Extract xerolite-xxxx.zip to your preferred location
  2. Verify required files are present:
    • win-run.bat (Windows) or linux-run.sh (Linux) or mac-run.sh (Mac)
    • config/ folder
    • bin/ folder

Installation Location

Choose an appropriate location for installation:

  • Windows: C:\xerolite or C:\Program Files\xerolite
  • Linux: /opt/xerolite or ~/xerolite
  • Mac: /Applications/xerolite or ~/xerolite

Verify Installation

After extraction, verify the following files and folders exist:

  • Run script for your platform (win-run.bat, linux-run.sh, or mac-run.sh)
  • config/ directory
  • bin/ directory
  • jre/ directory (Java Runtime Environment)

You'll know it worked when: You see the run script and config/, bin/, jre/ folders in your install directory.


3.3: Launch Xerolite

What this does: You're starting XeroLite so its webhook is listening and you can log in in the browser.

Why it matters: Until XeroLite is running, TradingView alerts can't reach it and you can't configure TWS connection or license.

Windows

  1. Open Terminal: Press Win + R, type cmd, and press Enter

  2. Navigate: Change to the XeroLite directory:

    cd C:\path\to\xerolite

    Replace C:\path\to\xerolite with the actual folder path where you extracted XeroLite.

    Example: If you extracted it to Downloads:

    cd C:\Users\YourName\Downloads\xerolite-xxxx
  3. Run Program: Execute the run script:

    win-run.bat

Linux

  1. Open Terminal: Press Ctrl + Alt + T

  2. Navigate: Change to the XeroLite directory:

    cd /path/to/xerolite

    Replace /path/to/xerolite with your actual path.

    Example:

    cd ~/Downloads/xerolite-xxxx
  3. Make Executable: Make the run script executable:

    chmod +x linux-run.sh
  4. Run Program: Execute the run script:

    ./linux-run.sh

Mac

  1. Open Terminal: Press Command + Space, type "Terminal", and press Enter

  2. Navigate: Change to the XeroLite directory:

    cd /path/to/xerolite

    Replace /path/to/xerolite with your actual location.

    Example:

    cd ~/Downloads/xerolite-xxxx
  3. Make Executable: Make the run script executable:

    chmod +x mac-run.sh
  4. Run Program: Execute the run script:

    ./mac-run.sh

Mac Users: First-time Java Execution

If you encounter a security warning:

  1. Navigate to /jre/bin in the XeroLite directory
  2. Right-click java → Open
  3. Click "Open" on the security warning
  4. Close terminal and rerun ./mac-run.sh

Verify Launch

After launching XeroLite:

  1. Check Console Output: The console should display startup messages
  2. Check Generated Credentials: Default login credentials will be printed in the console
  3. Verify Port 80: Ensure no errors related to port 80 are displayed

Access the Login Page

Once XeroLite is running:

  1. Open your web browser
  2. Navigate to one of the following:
    • localhost
    • http://localhost
    • http://127.0.0.1
  3. You should see the XeroLite login page

Important: Port 80 Access

For TradingView webhook access, ensure:

  • Port 80 is not blocked by firewall
  • No other application uses port 80
  • Cloud service allows port 80 traffic

Test accessibility from another device by entering your server's IP address in a browser.

You'll know it worked when: You see the XeroLite login page at http://localhost or your server's IP address, and the console shows no errors about port 80.

Check Generated Login Credentials

Default credentials are generated and saved in config/login-credentials.properties

First time startup, the generated credentials will be printed out in the console.

Console output showing generated credentials

Security Note: Change default credentials after first login by editing config/login-credentials.properties. You can open this file with Notepad (or any text editor) to view your current username and password and update them as needed.

Next Steps

After successfully launching XeroLite, proceed to:


Need more help? Contact support at [email protected]

See also: