Skip to content

Commit

Permalink
update edge agent readme (#421)
Browse files Browse the repository at this point in the history
Fix config source option and add default behavior for network id.
  • Loading branch information
philipktlin authored Oct 13, 2018
1 parent c92aa9d commit 33fcc81
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions edge-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ on Windows and "unix:///var/run/docker.sock" on Linux.
### DeviceConnectionString

Set to the IoT Hub connection string of the edge device. Needed when
`ConfigSource` is "iothubconnected".
`ConfigSource` is "twin".

### ConfigSource

May be set to "iothubconnected" or "standalone". When set to "iothubconnected",
May be set to "twin" or "local". When set to "twin",
the edge device twin is used as a configuration source for modules. When set to
standalone, a file (`config.json`) is used as a configuration source for modules.
"local", a file (`config.json`) is used as a configuration source for modules.
`DeviceConnectionString` must be set to a device connection string if `ConfigSource`
is set to "iothubconnected".
is set to "twin".

### DockerLoggingDriver

Expand Down Expand Up @@ -93,7 +93,7 @@ these logging drivers.

### NetworkId

Set to the Docker network you want the modules in the Edge deployment to be a part of.
Set to the Docker network you want the modules in the Edge deployment to be a part of. If not provided, it will run under "azure-iot-edge" docker network, which uses docker `bridge` network drvier.

### EdgeDeviceHostName

Expand Down

0 comments on commit 33fcc81

Please sign in to comment.