Installing Sanbox Runtime

What's Installing?

Lumisan Sanbox Runtime is extremely easy to install. Sanbox Runtime is one executable file that can run anywhere on the system. A typical installation however would have a runtime.json configuration file alongside it. The downloads for Sanbox Runtime that you find on our site include a default runtime.json configuration file for you.

Downloads for Sanbox Runtime can be found in the Customer Portal. To learn about what Linux and Windows systems are supported and minimal requirements - visit the Architecture & Requirements page.


Express Install

For quick and easy install, you can use our express script. This script is used for a bare metal or VM install. This script will download and install the latest Sanbox Runtime as a service, and will update the Sanbox Runtime executable while also restarting it whenever ran afterwards.

To use the script, insure curl is installed. If it is not, run the following command:

sudo apt-get install curl

With curl available, run the express script by running this command:

curl -sSo- | sudo bash

The script will first insure any dependencies are installed, then it will install Sanbox Runtime to /opt/lumisanSanboxRuntime/SanboxRuntime and register it as a service.

After Sanbox Runtime is installed, you should modify any configuration you wish to change by editing runtime.json located at /opt/lumisanSanboxRuntime/runtime.json.

Once Sanbox Runtime is configured, you may start it by running:

systemctl start sanboxRuntime

Manual Install

To manually install Sanbox Runtime on Linux, simply use our download link provided, and then copy the executable and configuration file over to the directory you wish to have Sanbox Runtime reside. You can then either run it in terminal, register your own service, run it behind Nginx, run it behind Apache, or more.


Currently, we do not offer an official Docker Hub image but are planning on having one available soon!

A simple docker file to create a Docker image for Sanbox Runtime may look like this.

COPY /sanbox/SanboxRuntime /usr/local/bin
EXPOSE 50155
ENTRYPOINT [ "/usr/local/bin/SanboxRuntime", "/usr/local/bin" ]
  • The image is built from a Ubuntu image with .Net Core dependent libraries installed.

  • Sanbox Runtime executable copied over.

  • Port 50155 is the default port used for the Designer.

  • Port 80 and 443 for http and https traffic.

  • An entry point to start Sanbox Runtime setting the working directory to the directory it was installed to.

You can either also copy the runtime.json file over for configuration while building the image or instead while running the image set the environment variable SANBOX_RUNTIME_CONFIG to a JSON string representing the contents of runtime.json. (This is the behavior on any OS)

Sanbox Runtime will always check the SANBOX_RUNTIME_CONFIG environment variable first and use it if exists instead of the runtime.json file.


To install Sanbox Runtime on Windows, download the Windows version on our site and extract the download contents to whatever directory where you wish Sanbox Runtime to run from.

The Windows download for Sanbox Runtime comes with the following files:

  • SanboxRuntime.exe - Sanbox Runtime itself.

  • runtime.json - Default configuration file for Sanbox Runtime.

  • StartRuntime.bat - Bat file that starts Sanbox Runtime with the current directory as the working directory.

  • InstallAsService.bat - Bat file that installs and starts Sanbox Runtime as a Windows Service with a bin path to the current directory. runtime.json must have RunAsWindowsService set to true.

  • UninstallAsService.bat - Bat file that uninstalls Sanbox Runtime when installed as a Windows Service.

After these files are copied to the chosen directory, modify runtime.json to the proper configuration.

You can either run Sanbox Runtime in a console by simply running StartRuntime.bat, or install it as a service by using InstallAsService.bat. Be sure to make the necessary configuration changes first in the runtime.json file before starting Sanbox Runtime.

Running Sanbox Runtime in IIS is not supported.

After Sanbox Runtime is installed, you can quickly verify that its listening and started by opening http://localhost in a browser while on the machine running Sanbox Runtime.