Skip to content

Commit 03b2253

Browse files
committed
Edits based on reviews
1 parent b6d0e5f commit 03b2253

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

articles/iot-edge/configure-device.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,17 @@ services: iot-edge
1111

1212
# Configure IoT Edge device settings
1313

14-
This article shows settings and options for configuring the IoT Edge *config.toml* file found in the `/etc/aziot` directory on an IoT Edge device. IoT Edge uses the *config.toml* file to initialize settings for the device. Each of the sections of the `config.toml` file has several options. Not all options are mandatory, as they apply to specific scenarios.
14+
This article shows settings and options for configuring the IoT Edge *config.toml* file of an IoT Edge device. IoT Edge uses the *config.toml* file to initialize settings for the device. Each of the sections of the `config.toml` file has several options. Not all options are mandatory, as they apply to specific scenarios.
1515

16-
A template containing all options can be found in the *config.toml.template* file within the `/etc/aziot` directory on an IoT Edge device.
16+
## Configuration template
1717

18-
> [!IMPORTANT]
19-
> The hostname, parent_hostname, and trust_bundle_cert parameters, must be at the beginning of the configuration file before any sections. Adding the parameter before defined sections, ensures it's applied correctly.
20-
>
18+
A template containing all options can be found in the *config.toml.template* file within the `/etc/aziot` directory on an IoT Edge device. You can copy the contents of the template over to your *config.toml* file and uncomment the sections you need.
19+
20+
### Top of the config.toml file
21+
22+
The `hostname`, `parent_hostname`, and `trust_bundle_cert` parameters must be at the beginning of the configuration file before any other sections. Adding parameters before defined sections ensures they are applied correctly.
2123

22-
## Hostname
24+
### Hostname
2325

2426
To enable gateway discovery, every IoT Edge gateway (parent) device needs to specify a hostname parameter that its child devices use to find it on the local network.
2527

@@ -29,7 +31,7 @@ For the **hostname**, replace **my-device** with your device name to override th
2931
hostname = "my-device"
3032
```
3133

32-
## Parent hostname
34+
### Parent hostname
3335

3436
Parent hostname is used when the IoT Edge device is nested. Every downstream IoT Edge device needs to specify a **parent_hostname** parameter to identify its parent. In a hierarchical scenario where a single IoT Edge device is both a parent and a child device, it needs both parameters.
3537

@@ -51,7 +53,7 @@ trust_bundle_cert = "file:///var/aziot/certs/trust-bundle.pem"
5153

5254
For more information about the IoT Edge trust bundle, see [Manage trusted root CA](how-to-manage-device-certificates.md#manage-trusted-root-ca-trust-bundle).
5355

54-
## Elevated Docker Permissions Flag
56+
### Elevated Docker Permissions Flag
5557

5658
Some docker capabilities can be used to gain root access. By default, the **--privileged** flag and all capabilities listed in the **CapAdd** parameter of the docker **HostConfig** are allowed.
5759

0 commit comments

Comments
 (0)