Skip to content

Commit ad6e75a

Browse files
committed
Updated readme about proxy
1 parent 47eaa10 commit ad6e75a

File tree

1 file changed

+45
-36
lines changed

1 file changed

+45
-36
lines changed

README.md

+45-36
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,51 @@ arduino-create-agent is a fork of @johnlauer's serial-port-json-server (which we
2222

2323
The history has been rewritten to keep the repo small (thus removing all binaries committed in the past)
2424

25+
26+
27+
## Using multiple configurations
28+
29+
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:
30+
31+
![Agent multiple configuration tray ycon](https://raw.githubusercontent.com/arduino/arduino-create-agent/devel/images/linux/tray-icon-multiple-profiles.png)
32+
33+
The default `config.ini` file contains common configurations, every other config file inherit from it.
34+
35+
To create multiple configuration files:
36+
- stop the agent: tray bar icon -> pause then tray bar icon -> kill
37+
- find the `config.ini` file that is present in the `arduino-create-agent` installation folder
38+
- copy `config.ini` or create a new ini file (e.g. `example.ini`) with content:
39+
```ini
40+
name = your configuration name
41+
```
42+
add in this file other configuration options (you can override inherited values from `config.ini`)
43+
- restart the agent
44+
- click the tray bar icon and select the new configuration
45+
46+
## When behind a proxy
47+
48+
The agent support working behind a proxy, but manual configuration is required ( there is no support for automatic proxy discovery ).
49+
50+
To add proxy configuration:
51+
- stop the agent: tray bar icon -> pause then tray bar icon -> kill
52+
- find the `config.ini` file that is present in the `arduino-create-agent` installation folder
53+
- copy `config.ini` or create a new ini file (e.g. `proxy.ini`) with content:
54+
```ini
55+
name = Proxy profile
56+
[env]
57+
http_proxy=your.proxy.here
58+
https_proxy=your.https.proxyhere
59+
```
60+
- please note spaces are not allowed before and after the string `http_proxy`
61+
- restart the agent
62+
- select the proper Proxy profile as in the image
63+
- your agent will now work behind a proxy
64+
65+
![Agent multiple configuration tray ycon](https://raw.githubusercontent.com/arduino/arduino-create-agent/devel/images/linux/tray-icon-multiple-profiles.png)
66+
67+
**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.
68+
69+
2570
## Disable Autostart
2671

2772
### Windows
@@ -85,42 +130,6 @@ $ nohup $HOME/ArduinoCreateAgent-1.1/Arduino_Create_Bridge &
85130
```
86131
or in the location selected during the installation
87132
88-
## Using multiple configurations
89-
90-
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:
91-
92-
![Agent multiple configuration tray ycon](https://raw.githubusercontent.com/arduino/arduino-create-agent/devel/images/linux/tray-icon-multiple-profiles.png)
93-
94-
The default `config.ini` file contains common configurations, every other config file inherit from it.
95-
96-
To create multiple configuration files:
97-
- stop the agent: tray bar icon -> pause then tray bar icon -> kill
98-
- find the `config.ini` file that is present in the `arduino-create-agent` installation folder
99-
- copy `config.ini` or create a new ini file (e.g. `example.ini`) with content:
100-
```ini
101-
name = your configuration nanem
102-
```
103-
add in this file other configuration options (you can override inherited values from `config.ini`)
104-
- restart the agent
105-
- click the tray bar icon and select the new configuration
106-
107-
## When behind a proxy
108-
109-
The agent support working behind a proxy, but manual configuration is required ( there is no support for automatic proxy discovery ).
110-
111-
To add proxy configuration:
112-
- stop the agent: tray bar icon -> pause then tray bar icon -> kill
113-
- find the `config.ini` file that is present in the `arduino-create-agent` installation folder
114-
- edit the `config.ini` file adding this lines under the `[env]` section ( create it if not present ):
115-
```ini
116-
http_proxy=yourproxyhere
117-
https_proxy=yourhttpsproxyhere
118-
```
119-
- restart the agent
120-
121-
**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.
122-
123-
124133
# Contributing
125134
126135
Please use the current latest version:

0 commit comments

Comments
 (0)