README: update to use breakglass tool

This commit is contained in:
Michael Stapelberg 2020-05-25 09:44:56 +02:00
parent 8157f8ee60
commit 942ef7f559

View File

@ -21,6 +21,7 @@ command, e.g.:
``` ```
gokr-packer -overwrite=/dev/sdx \ gokr-packer -overwrite=/dev/sdx \
github.com/gokrazy/hello \ github.com/gokrazy/hello \
github.com/gokrazy/serial-busybox \
github.com/gokrazy/breakglass github.com/gokrazy/breakglass
``` ```
@ -35,6 +36,27 @@ sudo install -m 600 ~/.ssh/id_*.pub /media/sdx4/breakglass.authorized_keys
## Usage ## Usage
Be sure to install the convenience SSH wrapper tool on the host:
```
go install github.com/gokrazy/breakglass/cmd/breakglass
```
### Start a shell
If you have `github.com/gokrazy/serial-busybox` installed on your gokrazy
installation, you can directly start a shell without having to upload your own
tools. Run:
```
breakglass gokrazy
```
If you prefer, you can also manually start `breakglass` in the gokrazy web
interface and then use `ssh gokrazy` to log in.
### Run your own tools
1. Create a tarball containing your statically linked arm64 binaries 1. Create a tarball containing your statically linked arm64 binaries
and any other files youll need. and any other files youll need.
2. SCP that tarball to your gokrazy installation, where breakglass 2. SCP that tarball to your gokrazy installation, where breakglass
@ -52,8 +74,7 @@ busybox: ELF 64-bit LSB executable, ARM aarch64, version 1 (SYSV), statically li
for GNU/Linux 3.7.0, BuildID[sha1]=c9e20e9849ed0ca3c2bd058427ac31a27c008efe, stripped for GNU/Linux 3.7.0, BuildID[sha1]=c9e20e9849ed0ca3c2bd058427ac31a27c008efe, stripped
$ ln -s busybox sh $ ln -s busybox sh
$ tar cf breakglass.tar --dereference sh $ tar cf breakglass.tar --dereference sh
$ scp breakglass.tar gokrazy: $ breakglass -debug_tarball_pattern=debug.tar gokrazy
$ ssh gokrazy
/tmp/breakglass564067692 # df -h /tmp/breakglass564067692 # df -h
Filesystem Size Used Available Use% Mounted on Filesystem Size Used Available Use% Mounted on
/dev/root 60.5M 60.5M 0 100% / /dev/root 60.5M 60.5M 0 100% /