Skip to content

Automated documentation update #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2025
Merged

Automated documentation update #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/google-cloud-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Installs the Google Cloud SDK and (optional) additional components.
|-----|-----|-----|-----|
| gcloudExtraPackages | Comma-separated list of additional Google Cloud SDK components to install. Example: `google-cloud-cli-app-engine-java,kubectl` | string | - |

## OS & Architecture Support

- Debian/Ubuntu Linux distributions with the `apt` package manager.
- `amd64`, `arm64`, and `arm/v7` architectures are supported.


---
Expand Down
21 changes: 17 additions & 4 deletions src/ngrok/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,25 @@ Globally distributed reverse proxy that secures, protects and accelerates your a
}
```

## Options

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

## Configuration of `authtoken`

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`.

**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.

```json
// Non-root user for Dev Container
"remoteUser": "coder",
// Post create command to add ngrok authtoken
"postCreateCommand": "ngrok config add-authtoken $NGROK_AUTH_TOKEN"
```

## OS & Architecture Support

- Debian/Ubuntu Linux distributions with the `apt` package manager.
- `amd64`, `arm64`, and `arm/v7` architectures are supported.


---
Expand Down