Configuring Stump

Default Options

Stump will use default options if you don't manually configure them. When following this guide, keep in mind you only need to provide values for things you wish to override.

Stump uses something called environment variables to set all of the various configuration properties. These environment variables are controlled has a custom TOML-based configuration, which is located by default at $STUMP_CONFIG_DIR/Stump.toml. STUMP_CONFIG_DIR itself is an environment variable that defaults to .stump your home directory, e.g. /Users/oromei/.stump.

If you're using Stump with Docker, you'll want to specify environment variables in either the docker run or docker-compose.yml file to override the default configuration. See the Docker guide for more information.

There are a number of configuration options that you can set to customize Stump's behavior. You will be setting these options in the Stomp.toml file, but you can also set them as environment variables.

The following is a list of all the environment variables that Stump uses to configure itself:

The version of the Stump API to use. This should really be left alone and not manually set.

TypeDefault Value

This corresponds to the api_version configuration option in the Stump.toml file.

The allowed origins for the Stump API. If you're trying to access the API from a different domain, you'll need to add it to this list. By default, origins corresponding to the Tauri desktop application are allowed, and the host machine's IP address with the configured port is allowed for both HTTP and HTTPS.

TypeDefault Value
String[]["tauri://localhost", "https://tauri.localhost", "http(s):{machine_ip}:{configured_port}"]

This corresponds to the allowed_origins configuration option in the Stump.toml file.

Whether or not Stump is running in a Docker container.

TypeDefault Value

The directory where Stump will look for its configuration file.

TypeDefault Value

The directory the contains the web bundle for the web UI

TypeDefault Value

The profile to use when running Stump. This should really be left alone and not manually set.

TypeDefault Value

The port for the Stump server.

TypeDefault Value

The verbosity level for Stump logs. Verbosity levels are integers that correspond to a list of log levels that will be visible, and are inclusive of all the levels below them.

For example, if you set the verbosity level to 1, you will see INFO, WARN, and ERROR messages. If you set the verbosity level to 2, you will see DEBUG, INFO, WARN, and ERROR messages, and so on. The default verbosity level is 1.

You may turn off logging entirely by setting the verbosity level to 0. However, this is not recommended, as it will make it difficult to debug issues with Stump if they arise.

The available verbosity levels are:

OptionVisible Log Levels

Whether or not to enable Swagger UI. To learn more about what Swagger UI is, visit

TypeDefault Value