Automatic configuration download
Ruuvi Gateway can automatically download its configuration from a remote server, you can enable this feature on this page:
You need to specify the base URL from where gw_cfg.json with the Gateway settings can be downloaded.
If you specify a folder name as the base URL (any URL that does not end with '.json'), it will first attempt to read the configuration file for the Gateway from <GW_MAC>.json (e.g. AABBCCDDEEFF.json). If this file fails, it will attempt to read the overall configuration from gw_cfg.json.
The configuration file can also be generated dynamically by the server, which requires the server to analyse the HTTP header 'ruuvi_gw_mac', which contains the MAC address in the format XX:XX:XX:XX:XX:XX.
After entering the base URL, press the Check button to validate the URL and check that the configuration file exists. Next, after pressing the Download button, the new configuration will be downloaded, which completes the configuration process. After that, Ruuvi Gateway will periodically check for configuration updates and download them. The polling period is set in the configuration file (Gateway configuration), which is downloaded from the server.
The gateway configuration file on the remote server must contain at least the following attributes:
- remote_cfg_use: true
- remote_cfg_url: URL
- remote_cfg_refresh_interval_minutes: a period of checking for an updated configuration (in minutes)
- remote_cfg_auth_type: authentication type ('no' if authentication is not required)
Example of minimal gw_cfg.json:
{
"remote_cfg_use": true,
"remote_cfg_url": "http://192.168.1.101:7000/",
"remote_cfg_refresh_interval_minutes": 10,
"remote_cfg_auth_type": "no"
}
All configuration attributes not specified in the configuration file will retain their previous value after the new configuration is loaded from the remote server.
Configuration downloads with basic HTTP authentication are also supported:
Example of corresponding minimal gw_cfg.json:
{
"remote_cfg_use": true,
"remote_cfg_url": "http://192.168.1.101:7000/",
"remote_cfg_refresh_interval_minutes": 10,
"remote_cfg_auth_type": "basic",
"remote_cfg_auth_basic_user": "user1",
"remote_cfg_auth_basic_pass": "password1"
}
Or Bearer authentication (using a token):
Example of corresponding minimal gw_cfg.json:
{
"remote_cfg_use": true,
"remote_cfg_url": "http://192.168.1.101:7000/",
"remote_cfg_refresh_interval_minutes": 10,
"remote_cfg_auth_type": "bearer",
"remote_cfg_auth_bearer_token": "my_secret_token_123"
}
You can also trigger a forced configuration download via API: Configuration download from a remote server via API
Last modified 1mo ago