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

Commit 845da01

Browse files
authored
[readme]: add LINUX_DEPENDENCIES doc
1 parent baa455d commit 845da01

File tree

2 files changed

+51
-16
lines changed

2 files changed

+51
-16
lines changed

README.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,7 @@ For instance, if you are using a `VPN` client to connect to private enterprise n
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 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-
35-
20+
3. If your codespace uses a non-default image, ensure that both the [GitHub CLI](https://cli.github.com/), `openssh-server` and `sudo` are installed inside the codespace. Some distros need an `ssh` group too. Please see [linux dependencies doc](./docs/LINUX_DEPENDENCIES.md) for per-distro instructions.
3621

3722
## Installation
3823

docs/LINUX_DEPENDENCIES.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## List of Linux dependencies by distro
2+
3+
### Ubuntu/Debian
4+
5+
#### Automatic setup
6+
7+
Add to `devcontainer.json`:
8+
9+
```jsonc
10+
{
11+
"features": {
12+
"github-cli": "latest",
13+
"sshd": "latest"
14+
}
15+
}
16+
```
17+
18+
#### Manual setup
19+
20+
1. Sudo: `apt install sudo`
21+
22+
2. GitHub CLI: see https://github.com/cli/cli/blob/trunk/docs/install_linux.md#debian-ubuntu-linux-raspberry-pi-os-apt
23+
24+
3. Openssh server: `sudo apt install openssh-server && service ssh start`
25+
26+
### Alpine Linux
27+
28+
1. GitHub CLI: see https://github.com/cli/cli/blob/trunk/docs/install_linux.md#alpine-linux
29+
30+
### Arch Linux
31+
32+
1. Sudo: `echo "y" | pacman -S sudo`
33+
34+
2. GitHub CLI: see https://github.com/cli/cli/blob/trunk/docs/install_linux.md#arch-linux
35+
36+
3. SSH group: `sudo groupadd -f ssh`
37+
38+
### CentOS
39+
40+
1. Sudo
41+
42+
```shell
43+
dnf --disablerepo '*' --enablerepo=extras swap -y centos-linux-repos centos-stream-repos
44+
dnf -y distro-sync
45+
dnf install -y sudo
46+
```
47+
48+
2. GitHub CLI: see https://github.com/cli/cli/blob/trunk/docs/install_linux.md#fedora-centos-red-hat-enterprise-linux-dnf
49+
50+
3. SSH group: `groupadd ssh`

0 commit comments

Comments
 (0)