Skip to content

Commit

Permalink
Updated Config documentation README (#261)
Browse files Browse the repository at this point in the history
* updated root-ca validation to fail only if invalid path is passed.

* updated the Readme file

* corrected indentation errors

* removed few changes since it will break GG ST binary

* corrected typo
  • Loading branch information
HarshGandhi-AWS authored May 9, 2022
1 parent 1593325 commit 5f9d4ad
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To configure the AWS IoT Device Client via the JSON configuration file, you can
where `~/` refers to the home directory of the user running the Device Client. If you'd like to specify a different location
for your configuration file, you can pass the `--config-file <your-path>` flag to the AWS IoT Device Client.

There are five (5) fields that MUST be passed to the AWS IoT Device Client through some combination of either CLI arguments,
There are four (4) fields that MUST be passed to the AWS IoT Device Client through some combination of either CLI arguments,
JSON configuration, or both:

`endpoint` *or* `--endpoint`: This is the IoT Core endpoint that your device should connect to. This can be found by navigating to the settings
Expand All @@ -24,12 +24,12 @@ field by running `aws iot describe-endpoint` on the CLI.

`cert` *or* `--cert`: If your devices certificates were provisioned manually, then this is the path to your device's public certificate.

`key` *or* `--key`: If your device's certificates were provisioned manually, then this is the path to your device's private key.

`root-ca` *or* `--root-ca`: This is the path to your device's [Root Certificate Authority](https://www.amazontrust.com/repository/AmazonRootCA1.pem).
`key` *or* `--key`: If your device's certificates were provisioned manually, then this is the path to your device's private key.

`thing-name` *or* `--thing-name`: This is the name for your thing. It should be unique across your regional AWS account. Thing Name is also used as client id while connecting to the IoT core.

**Note:** If the `root-ca` *or* `--root-ca` file path is missing, Device Client will look for the ROOT-CA file stored on the IoT device. `root-ca` is no longer a mandatory field but we would recommend users to pass in the valid path to `root-ca` file via JSON or CLI config.

**Next**: [File and Directory Permission Requirements](PERMISSIONS.md)

[*Back To The Top*](#config)

0 comments on commit 5f9d4ad

Please sign in to comment.