Running s-Dashboard

By default, when you install s-Server as a sudo or root user, the installer sets up a service called s-dashboardd.

To start the service:

[sudo] service s-dashboardd start

To stop the service:

[sudo] service s-dashboardd stop

If you installed as a regular user or chose not to create the s-Dashboard service, you can run s-Dashboard manually by taking the following steps.

To run s-Dashboard in the foreground:

  • Open a terminal and navigate to the s-Dashboard directory. By default, this directory is /opt/sqlstream//s-Dashboard.
  • Type ./ You can specify any of the command-line arguments below.
Command-line argument Definition Default
-d Store dashboards in (overrides $SDASHBOARD_DIR) …/s-Dashboard/dashboards/
-p Specify port (overrides $SDASHBOARD_PORT) 5595
-s Server mode, restarts server if it exits No
-h -? Show this help message No
-w WebAgent port or URL. For example: http://yourhost:5580 where “yourhost” is the name of the server running s-Server. If not specified, s-Dashboard looks for WebAgent on port 5580 of the same server running s-Server.

To stop s-Dashboard foreground process:

Use the …/s-Dashboard/ script.

Using the SDASHBOARD_DIR Environment Variable

By default you will see a few demo dashboards that are stored in the …/s-Dashboard/dashboards directory.

When you are developing your own applications, you will want to save your dashboards somewhere else, as part of your application directory structure. This is achieved using the SDASHBOARD_DIR environment variable.

For the foreground process, SDASHBOARD_DIR is set using the -d command line switch.

If you are using the s-Dashboard service, you can set SDASHBOARD_DIR by editing the file /etc/default/s-dashboardd.

Running Multiple Instances of s-Dashboard

By using multiple ports, you can run multiple instances of s-Dashboard. The default port is 5595. You can specify any available port by using the -p command line argument, as in:

./s-dashboard -p 5596

You may also need to specify a dashboard directory for the additional instance by using the -d argument, as in:

./s-dashboard -p 5596 -d /my/other/project/dashboards

Starting s-Dashboard in the browser

To launch s-Dashboard in your browser, open a browser and enter http://<>:<port> (often you will be using http://localhost:5595).
This will redirect to http://<>:<port>/dashboards where you will see a list of all the dashboards in the directory designated by SDASHBOARD_DIR.