Installation

Requirements

• Operating system: Windows or Linux (on Linux, the graphical CONFIG screen is not available: see the Linux section below).
• Java: 21 or later (a JRE is enough to run BroadSQL; a JDK is only needed to build it from source). See Technical requirements for the full runtime contract.

Install

1. Download the latest ZIP from the downloads page.
2. Unzip it to a location on your disk, e.g. C:\BroadSQL.

BroadSQL/
  BroadSQL.bat            Windows launcher
  BroadSQL.ps1            PowerShell launcher (Windows)
  broadsql.sh             Linux/Unix launcher
  connect.bat             Synonym for BroadSQL.bat (Windows)
  conf/                   Configuration files (BroadSQL.ini, the CDF, log settings)
  drivers/                Add JDBC drivers not included in the distribution here
  extensions/             Add JAR files with additional commands here
  lib/                    Required libraries, including broadsql.jar
  logs/                   Log files
  samples/                WorldDB.mv.db, the WORLD sample database (CONNECT WORLD;)
  jsscripts/              Folder of the experimental JS scripts (separate from the Scripts Library)
  scripts/                The Scripts Library: your reusable scripts (run with @name or LIB RUN name)

The launchers always start BroadSQL from this folder, so its relative paths (conf/, lib/, samples/) work whatever folder you start them from. Once started, CONNECT WORLD; opens the included sample database: see Getting started.

Windows

1. Edit conf/BroadSQL.ini if needed (the defaults work out of the box): see Application settings for every setting it supports.
2. Start BroadSQL with connect.bat (or BroadSQL.bat), optionally passing a connection ID as an argument, or right-click BroadSQL.ps1 and "Run with PowerShell".
3. Log in with the default password clipper8AD (change it later with SET MASTER PASSWORD;).
4. Add database connections with CONFIG;.

See Getting started for a full walkthrough of steps 3 and 4.

Linux

1. Install Java 21 or later. broadsql.sh uses JAVA_HOME/bin/java when JAVA_HOME is set, otherwise the java command found on the PATH. It checks the version and refuses to start with an older Java, naming the Java it found.

2. Start BroadSQL from the installation folder:

./broadsql.sh

or from any folder, with the full path of the script (for example /opt/broadsql/broadsql.sh, or a symbolic link to it): the script always runs from its own installation folder. Add a connection ID to open that connection instead of the CDF, for example ./broadsql.sh WORLD. If your unzip tool did not keep the file permissions and the script is not executable, type chmod +x broadsql.sh once.

3. Log in with the default password clipper8AD (change it later with SET MASTER PASSWORD;).

4. Review conf/broadsqlux.ini (see Application settings). A relative folder is relative to the installation folder. Set DefaultFolder, the folder DUMP writes to: the shipped value /home/myuser/broadsql/temp is an example to replace with an existing folder of your own. The activity log is written to the installation's logs folder, and extension JAR files are read from its extensions folder, as on Windows.

5. CONFIG is not available on Linux: add connections with ADD CONNECTION <id>; (see Getting started, Step 1).

See Getting started for what to do next.