If you are running Guavus SQLstream in a Docker container, an Amazon Marketplace AMI, Microsoft Azure MI or other virtual machine >, Guavus StreamLab is installed alongside Guavus s-Server. If you are running Guavus SQLstream on Linux, you need to install StreamLab on its own.
This page contains the following topics:
You can install SQLstream StreamLab using an X-windows wizard. The easiest way to launch the installer is by initiating the installation file from the command line.
The StreamLab installer ships as a binary file named SQLstream-StreamLab-<VERSION> that you acquired by downloading from https://www.sqlstream.com/downloads.
If you have previously installed StreamLab, we recommend exporting any existing projects before proceeding.
You can also install StreamLab from the command line.
To install StreamLab:
If there is a StreamLab server already running on your computer, the installer will warn you. In this case, you can proceed with the install, but you should export any previously created StreamApps before you continue installing. The installer will automatically stop the StreamLab server before installing.
For more details on exporting projects, see Exporting Projects from the Projects Home Page.
Note: If you attempt to install into a directory that already contains StreamLab, the installer will overwrite any existing work.
To use maps, you need to obtain and install either a Google Maps or MapBox api key before maps can be used.
If you are using the the Pan and Zoom map visualization, StreamLab and s-Dashboard require a Google Maps API key.
To retrieve an API key, please visit the following link:
Once you have a Google Maps API key, you need to restart StreamLab to incorporate it. To do so when launching StreamLab from the command line, use a -m flag, as in:
To do so when launching StreamLab using the 'Start Streamlab Server' icon, right-click on the desktop 'Start Streamlab Server' icon, select Properties, and add the -m option to the end of the command.
You can now use the Pan and Zoom map visualization with full functionality.
To use OpenStreetMaps tiles, you need a Mapbox id. To design a map, go to
and sign up and design the map they want.
Each map has a map id. This gets used in the -m option preceded by 'mapbox:', as in:
All StreamLab maps will use the same tile set. In order to use a different tile set, you need to restart StreamLab with a different Mapbox id.
You can also set the map service in /etc/default/streamlabd, by setting STREAMLABMAPSERVICE to 'google:
You can also install in text mode, which does not display the graphical installation wizard. To do so, enter
sudo ./StreamLab-X.Y.Z-x64.run --mode text
where X.Y.Z represent the release and version numbers, as in SQLstream-StreamLab-2.3.0.run.
if you are logged in as a super user, you do not need to include "sudo".
The text-mode installer performs the same steps as the graphical one, but displays its prompts and messages in the console window. By default, the installer will run in graphical mode, GTK. If this is not possible, it will run in xwindow mode. If there is no graphical environment available it will fall back to text mode.
There are command-line options to perform all of the functions available in the GUI version. For a list of the command-line options and their meanings, type
|--help||Display this list of options.||None|
|--optionfile <optionfile>||Installation option file||None|
|--mode <mode>||Installation mode.||Default: gtk Allowed: gtk xwindow text unattended|
|--prefix <prefix>||Installation Directory||/opt/sqlstream/<version>|
|--startStreamlabService <startStreamlabService>||Start the streamlabd service. 1 for yes, 0 for no.||1|
|--startStreamLabServer <startStreamLabServer>||Start the StreamLab server after installing||True|
|--installer-language <installer-language>||Language selection||Default: en
Allowed: sq ar es_AR pt_BR bg ca hr cs da nl en et fi fr de el he hu it ja ko lv lt no pl pt ro ru sr zh_CN sk sl es sv th zh_TW tr va cy
|--overwrite||If set to 1, enables forced overwrite for non-interactive installs.||0|
By default, StreamLab is installed as a service, and will start automatically upon reboot. (It also starts by default after installation.) To access StreamLab, do one of the following:
Before you start StreamLab, you need to have both s-Server and WebAgent running. This version of StreamLab checks to see if WebAgent is running before starting.
For information on running WebAgent, see the topic WebAgent.
Note: WebAgent must be running with write enabled (-w).
To start StreamLab in other cases, open the StreamLab folder on your desktop and double-click the Start StreamLab Server icon.
Alternately, run the following script, located in the /opt/sqlstream/.xxxx directory:
To start the service as root, enter
sudo service streamlabd start
You can specify the following arguments when starting StreamLab from the command line.
||Specify port (overrides $STREAMLAB_PORT)||5590|
|-s||Server mode, restarts server if it exits||No|
|-h -?||Show this help message|
|-w||WebAgent port or URL. If not specified, StreamLab looks for WebAgent on port 5580 of the same server running s-Server.||http://yourhost:5580 where "yourhost" is the name of the server running s-Server.|
To stop StreamLab, take one of the following steps: