Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

Commit 4790448

Browse files
authored
Merge pull request #11 from joshspicer/jospicer/features
add additional information about dev container features
2 parents 175ce04 + 359b88a commit 4790448

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,21 @@ For instance, if you are using a `VPN` to connect to your enterprise network to
1717

1818
2. The extension relies on `gh codespace ssh` command to establish SSH tunnel to a Codespace, hence you need to setup ssh keys if you didn't before. If you can do `sudo gh codespace ssh` (`sudo` is important since kernel might use different identity under non-root user) and connect to a Codespace successfully, - you are good to go. Refer to [Generating a new SSH key and adding it to the ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for more info. List of known issues and workarounds for them can be found [here](https://github.com/github/gh-net/issues?q=is%3Aissue+is%3Aopen+label%3Aknown-issue).
1919

20-
3. If your Codespaces use non-default image, make sure that [GitHub CLI](https://cli.github.com/) and SSH server are installed inside the Codespaces. It might be as simple as adding `"github-cli": "latest"` and `"sshd": "latest"` to the `"feartures"` section of the `devcontainer.json` file!
20+
3. If your codespace uses a non-default image, ensure that both the [GitHub CLI](https://cli.github.com/) and an SSH server are installed inside the codespace.
21+
22+
One way to install these prereqs on a debian-based image is by adding the following to the `features` property of your `devcontainer.json` file.
23+
```jsonc
24+
// devcontainer.json
25+
{
26+
"features": {
27+
"github-cli": "latest",
28+
"sshd": "latest"
29+
}
30+
}
31+
```
32+
33+
Rebuild the codespace to apply the newly added dev container features.
34+
2135

2236

2337
## Installation

0 commit comments

Comments
 (0)