Improve this doc

Service variables

Service variables allow you to provide runtime configuration to a running service without having to modify your source code. You can use them to keep secrets and other sensitive values out of your codebase.

Note: Adding or modifying a service variable will cause the service to restart on any devices where the new setting is applied. allows you to set service variables at both the fleet and device level.

Note: Service variables defined in the dashboard will not apply to devices in local mode. You will need to define them in your resin-sync.yml.

Fleet service variables

Service variables defined on the fleet level are available to the specified service on all devices in that fleet, unless they are redefined with a device service variable of the same name.

The application dashboard has a Service Variables tab containing a list of all fleet service variables.

To define a new fleet service variable, make sure you are in the Service Variables tab, then click the Add variable button in the upper-left corner:

A new dialog will pop up, asking you to select a service from the drop down menu. Once you have selected the service, you can define the name and value for your service variable. Click Add to apply to all devices in your fleet that do not already have an identical device service variable defined:

Your new service variable will show up in the list, where it can easily be edited or removed:

Note: Deleting a fleet service variable will not delete a device service variable of the same name.

If you have already defined service variables at the device level, they will appear in a list below your fleet service variables. You can easily apply a device value to the entire fleet by clicking Define fleet-wide:

Device service variables

Device service variables are available to the service running on that particular device. If both the fleet and the device have a service variable of the same name, the code on the device will use the value of the device service variable. In other words, device service variables redefine (or override) fleet service variables.

Adding a device service variable is very similar to adding a fleet service variable. From the device summary page, select the Device Service Variables tab, click Add variable, select the appropriate service from the drop down, add a name and value, and click Add.

The service variable list will include both values defined for that specific device, as well as any fleet service variables:

You can override the value of a fleet variable by clicking override in the far-right column. This will pop up the variable editing dialog, where you can change the value:

Managing with the CLI & SDK

The CLI and SDKs all include methods to easily read, add or update service variables. Consult the appropriate reference for code examples.