From 14eac975f12c772e346df62d8bf944e6f7625f27 Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Wed, 9 Sep 2026 02:49:27 -0700 Subject: [PATCH] docs: use published GHCR image in README examples Point the install examples at ghcr.io/dstack-tee/dstack-openssh-installer:latest instead of a placeholder $NS namespace, lead with the GitHub-user import one-liner, and move the build-it-yourself steps below the install section. --- README.md | 38 +++++++++++++++----------------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 74c04ed..2f2884c 100644 --- a/README.md +++ b/README.md @@ -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 ``` ## Environment Variables