Skip to content

Commit f82c90b

Browse files
Merge pull request #216803 from bishal41/Minor-doc-update-for-http_proxy
added agent.config
2 parents 5f9f873 + 87dd670 commit f82c90b

File tree

1 file changed

+65
-16
lines changed

1 file changed

+65
-16
lines changed

articles/iot-edge/how-to-configure-proxy-support.md

Lines changed: 65 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -280,27 +280,76 @@ This step takes place once on the IoT Edge device during initial device setup.
280280

281281
2. In the config file, find the `[agent]` section, which contains all the configuration information for the edgeAgent module to use on startup. Check and make sure that the `[agent]`section is uncommented or add it if it is not included in the `config.toml`. The IoT Edge agent definition includes an `[agent.env]` subsection where you can add environment variables.
282282

283+
:::moniker-end
284+
285+
<!-- 1.3 -->
286+
:::moniker range="=iotedge-2020-11"
287+
283288
3. Add the **https_proxy** parameter to the environment variables section, and set your proxy URL as its value.
284289

285-
```toml
286-
[agent]
287-
name = "edgeAgent"
288-
type = "docker"
289-
290-
[agent.env]
291-
# "RuntimeLogLevel" = "debug"
292-
# "UpstreamProtocol" = "AmqpWs"
293-
"https_proxy" = "<proxy URL>"
294-
```
290+
```toml
291+
[agent]
292+
name = "edgeAgent"
293+
type = "docker"
294+
295+
[agent.config]
296+
image = "mcr.microsoft.com/azureiotedge-agent:1.3"
297+
298+
[agent.env]
299+
# "RuntimeLogLevel" = "debug"
300+
# "UpstreamProtocol" = "AmqpWs"
301+
"https_proxy" = "<proxy URL>"
302+
```
295303

296304
4. The IoT Edge runtime uses AMQP by default to talk to IoT Hub. Some proxy servers block AMQP ports. If that's the case, then you also need to configure edgeAgent to use AMQP over WebSocket. Uncomment the `UpstreamProtocol` parameter.
297305

298-
```toml
299-
[agent.env]
300-
# "RuntimeLogLevel" = "debug"
301-
"UpstreamProtocol" = "AmqpWs"
302-
"https_proxy" = "<proxy URL>"
303-
```
306+
```toml
307+
[agent.config]
308+
image = "mcr.microsoft.com/azureiotedge-agent:1.3"
309+
310+
[agent.env]
311+
# "RuntimeLogLevel" = "debug"
312+
"UpstreamProtocol" = "AmqpWs"
313+
"https_proxy" = "<proxy URL>"
314+
```
315+
316+
:::moniker-end
317+
318+
<!-- 1.4 -->
319+
:::moniker range=">=iotedge-1.4"
320+
321+
3. Add the **https_proxy** parameter to the environment variables section, and set your proxy URL as its value.
322+
323+
```toml
324+
[agent]
325+
name = "edgeAgent"
326+
type = "docker"
327+
328+
[agent.config]
329+
image = "mcr.microsoft.com/azureiotedge-agent:1.4"
330+
331+
[agent.env]
332+
# "RuntimeLogLevel" = "debug"
333+
# "UpstreamProtocol" = "AmqpWs"
334+
"https_proxy" = "<proxy URL>"
335+
```
336+
337+
4. The IoT Edge runtime uses AMQP by default to talk to IoT Hub. Some proxy servers block AMQP ports. If that's the case, then you also need to configure edgeAgent to use AMQP over WebSocket. Uncomment the `UpstreamProtocol` parameter.
338+
339+
```toml
340+
[agent.config]
341+
image = "mcr.microsoft.com/azureiotedge-agent:1.4"
342+
343+
[agent.env]
344+
# "RuntimeLogLevel" = "debug"
345+
"UpstreamProtocol" = "AmqpWs"
346+
"https_proxy" = "<proxy URL>"
347+
```
348+
349+
:::moniker-end
350+
351+
<!-- >= 1.3 -->
352+
:::moniker range=">=iotedge-2020-11"
304353

305354
5. Save the changes and close the editor. Apply your latest changes.
306355

0 commit comments

Comments
 (0)