Skip to content

Commit e5d8249

Browse files
authored
Improve SST setup instructions
Updated instructions for enabling SST to include setting the SST_ROOT environment variable and using the --recurse-submodules flag.
1 parent b83fc5d commit e5d8249

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

docs/reference/security.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,14 @@ With `comm-type: SST`, both the initial connection setup and subsequent federate
108108

109109
### Enabling SST
110110

111-
To use SST, first clone the iotauth repository and initialize its submodules:
111+
To use SST, first clone the iotauth repository and initialize its submodules, and optionally, set the environment variable `SST_ROOT` to the path of the cloned repository:
112112

113113
```bash
114-
git clone https://github.com/iotauth/iotauth.git
115-
cd iotauth
116-
git submodule update --init
114+
git clone --recurse-submodules https://github.com/iotauth/iotauth.git
115+
export SST_ROOT="$(pwd)/iotauth"
117116
```
118117

119-
Then set the `comm-type` to `SST` and provide the path to your `iotauth` installation:
118+
Then set the `comm-type` to `SST` and provide the path to your local `iotauth` repository:
120119

121120
<ShowIfs>
122121
<ShowIf c>
@@ -262,4 +261,4 @@ If you would like to go back to non-AUTH mode, you would have to remove all cont
262261
Pluggable communication security (TLS and SST) is currently only supported for the **C** and **Python** targets. Support for other target languages is planned for the future.
263262
:::
264263

265-
</ShowOnly>
264+
</ShowOnly>

0 commit comments

Comments
 (0)