tvbeat / tvbeat-ssh

a small helper script to grant you ssh access to tvbeat systems

tvbeat-ssh - a small tool to grant you ssh access to tvbeat systems

after successfully installing tvbeat-ssh you can forget about this tool entirely - tvbeat-ssh will seamlessly work behind the scenes to grant you ssh access to tvbeat systems without you explicitly having to do anything

installation & configuration

• download, extract, and copy the tvbeat-ssh executable to your $PATH
• run tvbeat-ssh config --username <username> to configure your ssh client, where <username> is your username on all of our linux systems

installation - darwin

aanderse@macbook ~ % curl -O https://github.com/tvbeat/tvbeat-ssh/releases/download/v1.0.1/tvbeat-ssh-v1.0.1-darwin-amd64.tar.gz
aanderse@macbook ~ % tar xf tvbeat-ssh-v1.0.1-darwin-amd64.tar.gz
aanderse@macbook ~ % sudo mkdir /usr/local/bin/
aanderse@macbook ~ % sudo mv tvbeat-ssh /usr/local/bin/
aanderse@macbook ~ % tvbeat-ssh config --username aanderse
/Users/aanderse/.ssh/tvbeat.conf has been successfully generated.
aanderse@macbook ~ % # all done

You might get a popup window saying the tvbeat-ssh program cannot be run. On the popup window you should click the Show in Finder button, and once the Finder window is opened, right-click the tvbeat-ssh program and click Open. This will ensure tvbeat-ssh can run at any point in the future.

You can now repeat the tvbeat-ssh configuration command and everything should work:

aanderse@macbook ~ % tvbeat-ssh config --username aanderse
/Users/aanderse/.ssh/tvbeat.conf has been successfully generated.
aanderse@macbook ~ % # all done

installation - linux

aanderse@ubuntu:~$ wget https://github.com/tvbeat/tvbeat-ssh/releases/download/v1.0.1/tvbeat-ssh-v1.0.1-linux-amd64.tar.gz
aanderse@ubuntu:~$ tar xf tvbeat-ssh-v1.0.1-linux-amd64.tar.gz
aanderse@ubuntu:~$ sudo mv tvbeat-ssh /usr/local/bin/
aanderse@ubuntu:~$ tvbeat-ssh config --username aanderse
/home/aanderse/.ssh/tvbeat.conf has been successfully generated.
aanderse@ubuntu:~$ # all done

installation - windows

NOTE: the following assumes you are in a powershell terminal, though can be adapted for console emulators like cmder

PS C:\Users\aanderse> Invoke-WebRequest -Uri https://github.com/tvbeat/tvbeat-ssh/releases/download/v1.0.1/tvbeat-ssh-v1.0.1-windows-amd64.zip -OutFile tvbeat-ssh-v1.0.1-windows-amd64.zip
PS C:\Users\aanderse> New-Item -ItemType directory -Path "$env:USERPROFILE\bin" -Force
PS C:\Users\aanderse> Expand-Archive -Path tvbeat-ssh-v1.0.1-windows-amd64.zip -DestinationPath "$env:USERPROFILE\bin\" -Force
PS C:\Users\aanderse> [Environment]::SetEnvironmentVariable("PATH", [Environment]::GetEnvironmentVariable("PATH", "USER") + ";$env:USERPROFILE\bin", "USER")
PS C:\Users\aanderse> # at this point exit powershell, then enter again to refresh your $PATH
PS C:\Users\aanderse> tvbeat-ssh config --username aanderse
C:\Users\aanderse\.ssh\tvbeat.conf has been successfully generated.
PS C:\Users\aanderse> # all done

usage

you can ssh into any of the dev0-hetz servers (like slate.node, scoria.node, onix.node, etc...) as usual, though occasionally a web browser will pop up and confirm your identity:

aanderse@ubuntu:~$ ssh dev0-hetz+scoria.node
Last login: Thu Oct  5 00:58:33 2023

[aanderse@scoria:~]$ # easy peasy

conclusion

special care was taken to make this utility an unobtrusive as possible

tvbeat-ssh's Issues

setting up on chromeos flex

~/.cache dir is missing, mkdir ~/.cache resolves the issue.

lblasc@penguin:~$ tvbeat-ssh config --username lblasc
panic: mkdir /home/lblasc/.cache/tvbeat: no such file or directory

goroutine 1 [running]:
main.configAction(0xc00012c6c0)
        /github/workspace/main.go:243 +0xbc5
github.com/urfave/cli/v2.(*Command).Run(0xc0001e0000, 0xc00012c6c0, {0xc00011f3b0, 0x3, 0x3})
        /go/pkg/mod/github.com/urfave/cli/[email protected]/command.go:274 +0x93f
github.com/urfave/cli/v2.(*Command).Run(0xc0001e0420, 0xc00012c5c0, {0xc00012c000, 0x4, 0x4})
        /go/pkg/mod/github.com/urfave/cli/[email protected]/command.go:267 +0xb7d
github.com/urfave/cli/v2.(*App).RunContext(0xc0001de000, {0x93a8b0, 0xc58920}, {0xc00012c000, 0x4, 0x4})
        /go/pkg/mod/github.com/urfave/cli/[email protected]/app.go:332 +0x566
github.com/urfave/cli/v2.(*App).Run(...)
        /go/pkg/mod/github.com/urfave/cli/[email protected]/app.go:309
main.main()
        /github/workspace/main.go:224 +0x416

doesn't build on windows

according to https://github.com/tvbeat/tvbeat-ssh/actions/runs/7158701420/job/19491089251 this doesn't build on windows, specifically:

./main.go:459:58: undefined: syscall.SIGTSTP

maybe a generous person who runs windows could help... 😍

cc @doivosevic