diff --git a/README.md b/README.md index 4dddceeda..08ade93a8 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,42 @@ $ nohup $HOME/ArduinoCreateAgent-1.1/Arduino_Create_Bridge & ``` or in the location selected during the installation +## Using multiple configurations + +The agent support multiple configuration files. When multiple configurations are found by the agent, the tray icon menu is expanded to contain the different configurations: + +![Agent multiple configuration tray ycon](https://raw.githubusercontent.com/arduino/arduino-create-agent/devel/images/linux/tray-icon-multiple-profiles.png) + +The default `config.ini` file contains common configurations, every other config file inherit from it. + +To create multiple configuration files: +- stop the agent: tray bar icon -> pause then tray bar icon -> kill +- find the `config.ini` file that is present in the `arduino-create-agent` installation folder +- copy `config.ini` or create a new ini file (e.g. `example.ini`) with content: + ```ini + name = your configuration nanem + ``` + add in this file other configuration options (you can override inherited values from `config.ini`) +- restart the agent +- click the tray bar icon and select the new configuration + +## When behind a proxy + +The agent support working behind a proxy, but manual configuration is required ( there is no support for automatic proxy discovery ). + +To add proxy configuration: +- stop the agent: tray bar icon -> pause then tray bar icon -> kill +- find the `config.ini` file that is present in the `arduino-create-agent` installation folder +- edit the `config.ini` file adding this lines under the `[env]` section ( create it if not present ): + ```ini + http_proxy=yourproxyhere + https_proxy=yourhttpsproxyhere + ``` +- restart the agent + +**Tip**: you can also use the multiple configurations feature to create a new configuration with the proxy settings. This way you can have multiple proxies configured and disable proxy configuration with ease. + + # Contributing Please use the current latest version: diff --git a/images/linux/tray-icon-multiple-profiles.png b/images/linux/tray-icon-multiple-profiles.png new file mode 100644 index 000000000..120bd9610 Binary files /dev/null and b/images/linux/tray-icon-multiple-profiles.png differ