Config Files

PRODUCT_NAME is "idgard Sync". USER_NAME is the Windows username of the current user.

We have a special config folder C:\Users\USER_NAME\AppData\Local\PRODUCT_NAME\config, copy configuration file(s) (for example: .json, .config, .xml, .ini) to config folder restart app.

Config files are part of the Deployment Guide.

Common usage of config files:

1. In Windows Explorer navigate to %LocalAppData%/PRODUCT_NAME/.
2. Create a folder config if it does not exist.
3. Create a new json file with the name of the configuration, e.g. my-config.json.

Behavior (_behavior property)

All JSON config files require a _behavior setting that controls how the configuration is applied on startup. Not every setting supports all _behavior variants.

If _behavior is not set or the value is not recognized, once is used.

Value	Description
once (default)	Reads the config file, imports the values, then deletes the file. The user can change the values later in the app settings.
always	Reads the config file, imports the values, and keeps the file. The values will always overwrite user settings on every startup.
OnceIfNotSet	Like once, but only imports a value if no existing app setting is found for it.

Web Proxy

Configure a web proxy via config-file.

• Config filename: proxy.json
• Supported _behavior: once, always and OnceIfNotSet.

Example of proxy.json.

{
    "_behavior": "once",
    "ProxyAddress": "my.proxy-server.tld",
    "ProxyPort": 8080
}

Configure ProxyAddress (can be an IP or an URL) and ProxyPort to your needs.

The usage of the proxy will also be seen in the log-files

[YYYY-mm-dd HH:MMM:ss.fff INF] Parsing the proxy config file 'C:\Users\USER_NAME\AppData\Local\PRODUCT_NAME\config\proxy.json' was successful. Address: my.proxy-server.tld, Port: 8080