Skip to content

Commit 5711b1d

Browse files
authored
Merge pull request #4 from jmcombs:automated-documentation-update-12614103795
Automated documentation update
2 parents 8f17f27 + 0921bb7 commit 5711b1d

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

src/google-cloud-sdk/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Installs the Google Cloud SDK and (optional) additional components.
1717
|-----|-----|-----|-----|
1818
| gcloudExtraPackages | Comma-separated list of additional Google Cloud SDK components to install. Example: `google-cloud-cli-app-engine-java,kubectl` | string | - |
1919

20+
## OS & Architecture Support
21+
22+
- Debian/Ubuntu Linux distributions with the `apt` package manager.
23+
- `amd64`, `arm64`, and `arm/v7` architectures are supported.
2024

2125

2226
---

src/ngrok/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,25 @@ Globally distributed reverse proxy that secures, protects and accelerates your a
1111
}
1212
```
1313

14-
## Options
1514

16-
| Options Id | Description | Type | Default Value |
17-
|-----|-----|-----|-----|
18-
| authtoken | Connect ngrok to your account by providing your `authtoken` | string | - |
1915

16+
## Configuration of `authtoken`
17+
18+
Features are installed inside devcontainers using the `root` user, but `ngrok` configuration is user-specific. When running devcontainers, a non-root user is typically used. It is recommended to use `postCreateCommand` and `remoteUser` to set the `authtoken`.
19+
20+
**NOTE:** It is recommended to use the `NGROK_AUTH_TOKEN` environment variable to store the `authtoken` securely and avoid storing it in the `devcontainer.json` file.
21+
22+
```json
23+
// Non-root user for Dev Container
24+
"remoteUser": "coder",
25+
// Post create command to add ngrok authtoken
26+
"postCreateCommand": "ngrok config add-authtoken $NGROK_AUTH_TOKEN"
27+
```
28+
29+
## OS & Architecture Support
30+
31+
- Debian/Ubuntu Linux distributions with the `apt` package manager.
32+
- `amd64`, `arm64`, and `arm/v7` architectures are supported.
2033

2134

2235
---

0 commit comments

Comments
 (0)