Skip to content

Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

Application Properties

Many applications intentionally expose certain configuration files to their users so that they may tweak and dictate the behavior of the application during runtime. In TORO Integrate, the <toro-integrate-home>/conf/toro-integrate.properties file is one such file. In this file, we define what we call application properties (sometimes called instance properties) whose values are taken in by TORO Integrate, during start-up or runtime, to instruct how TORO Integrate should set itself up or to direct how its components should operate.

For example, you can indicate the location of your Solr cores

Take the solr.mode and solr.url instance properties for example; the value of these properties help TORO Integrate determine whether to fetch linked Solr cores from a local, remote, or cloud instance of Solr and specifically which Solr instance (by providing the Solr instance's URL).

Package-local properties

Aside from properties that are global to the instance, we also have properties that are local to a package. These properties work very much like TORO Integrate's properties, except their scope is limited to a package.

Application properties are especially handy because they also help externalize TORO Integrate's configuration properties, allowing you to run TORO Integrate in different modes or environments without having to do much except for modify the
<toro-integrate-home>/conf/toro-integrate.properties file.

You can choose whether to use development or production environment-specific package properties

Packages allow you to have multiple .properties files. For testing purposes, you can have one .properties file specifically for development environments and another for production environments in each of your packages. You can tell TORO Integrate which one to use via the package.prefix instance property.

To help you easily go back to using the original configured application properties, TORO Integrate allows you to leave the standard toro-integrate.properties file untouched and define values you want to change in an override file. If you want to restore properties back to their original state, simply remove them from the override file.

By default, the override file is named <toro-integrate-home>/conf/override.properties. If you want to use an override file with a different name or location, you must specify the new file via a system property called integrate.override.properties. Simply add a property to the override file with the same key as the property in the main .properties file to have TORO Integrate use the overridden value instead.

Creating a system property...

To create a system property, look at the toro-integrate (if you're using OSX or *NIX) or toro-integrate.bat (for Windows users) file. There are placeholders there and comments that tell you where to add the configuration parameters. These files are in the <toro-integrate-home>/bin/ directory.

Restarts may be required

Changes you make in the application .properties file may not reflect immediately unless you restart TORO Integrate or reload the properties via the UI. However, some properties (like HTTP/S port numbers, local/remote broker settings, and others) will not take effect at all until TORO Integrate is restarted.

Editing Application Properties

There are plenty of ways to modify an instance's application properties:

  • Directly editing the application .properties file via the file system
  • Using the CLI tool
  • Using the REST API
  • Via Coder or the Server Admin UI

Editing via the UI

If you're going to use the UI editors to change the values of properties, note that changes will be automatically written to theunderlying override.properties file. If the value has not changed from what is set in the default, its entry will still be removed in the override.properties file.

Via Coder

To modify the application properties in Coder Studio, you must right click the instance whose application properties you want to modify and then click on Edit Integrate Properties from the appearing context menu. The process should be the same for Coder Cloud, except you must click on any empty space in the Coder Navigator view. The <toro-integrate-home>/conf/toro-integrate.properties file should open up in the editor.

How to access the application .properties file

How to access the application .properties file

Another way to access the toro-integrate.properties file is to locate the conf directory in the core package in the Coder Navigator, then double-click on the .properties file you wish to edit.

Navigating to the application .properties file

Navigating to the application .properties file

Via the Server Admin UI

To open up the application .properties file in the Server Admin UI, simply hover your cursor over the configuration menu item and then select Integrate Properties. From can then edit the file in the editor.

How to access the application .properties file

Via the REST API

TORO Integrate also provides REST endpoints for maintaining application properties. This API allows you to remotely do things such as:

  • Retrieve application properties
  • Add, remove, or update application properties
  • Reload application properties