Skip to content

docs: use published GHCR image in README examples #5

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
kvinwang merged 1 commit into from
Sep 9, 2026
Merged

docs: use published GHCR image in README examples #5

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
38 changes: 15 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,37 @@ A Docker-based installer for OpenSSH Server on read-only dstack systems.

## Quick Start

### Build the Installer
### Install OpenSSH Server

Put one of the instructions below in the prelaunch script of a dstack instance.
Prebuilt images are published to `ghcr.io/dstack-tee/dstack-openssh-installer`.

**Import ssh public keys from GitHub usernames (comma-separated):**
```bash
chmod +x build.sh
./build.sh $NS/dstack-openssh-installer latest
docker push $NS/dstack-openssh-installer:latest
docker run --rm --privileged --pid=host --net=host -v /:/host -e SSH_GITHUB_USER="alice,bob" ghcr.io/dstack-tee/dstack-openssh-installer:latest
```

### Install OpenSSH Server

Put one of the instuction below in the prelaunch script of a dstack instance.

**Single command installation with SSH public key:**
```bash
docker run --rm --privileged --pid=host --net=host -v /:/host \
-e SSH_PUBKEY="ssh-ed25519 AAAA... user@host" \
$NS/dstack-openssh-installer:latest
ghcr.io/dstack-tee/dstack-openssh-installer:latest
```

**Import ssh public keys from GitHub username:**
**Custom port:**
```bash
docker run --rm --privileged --pid=host --net=host -v /:/host \
-e SSH_GITHUB_USER="octocat" \
$NS/dstack-openssh-installer:latest
-e SSH_PORT=2222 \
-e SSH_PUBKEY="ssh-ed25519 AAAA..." \
ghcr.io/dstack-tee/dstack-openssh-installer:latest
```

**Import ssh public keys from multiple GitHub usernames:**
```bash
docker run --rm --privileged --pid=host --net=host -v /:/host \
-e SSH_GITHUB_USER="alice,bob" \
$NS/dstack-openssh-installer:latest
```
### Build the Installer Yourself

**Custom port:**
```bash
docker run --rm --privileged --pid=host --net=host -v /:/host \
-e SSH_PORT=2222 \
-e SSH_PUBKEY="ssh-ed25519 AAAA..." \
$NS/dstack-openssh-installer:latest
chmod +x build.sh
./build.sh $NS/dstack-openssh-installer latest
docker push $NS/dstack-openssh-installer:latest
Comment on lines +35 to +37
```

## Environment Variables
Expand Down
Loading