Warm welcome pages over SSH ☺️
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
decentral1se d382b0526d
init
8 months ago
.gitignore init 8 months ago
LICENSE init 8 months ago
README.md init 8 months ago
go.mod init 8 months ago
go.sum init 8 months ago
logo.png init 8 months ago
sshww.go init 8 months ago

README.md

ssh-warm-welcome

SSH as a publishing interface 🎉

ssh-warm-welcome serves a TUI for reading markdown documents via a built-in SSH server. In the context of a pubnix or femserver it can be a convenient way to publish documentation to a general public via the terminal instead of the browser. It's designed to be easy to use for beginners: no user accounts or SSH keys are required, simply use your standard /usr/bin/ssh command to connect & start reading.

Here's a little demo video: vvvvvvaria.org/~decentral1se/sshww/demo.mp4

Quickstart

Download ssh-warm-welcome like so.

(only x86_64 is available right now but we can build more if you need it)

curl https://vvvvvvaria.org/~decentral1se/sshww/sshww -o sshww
chmod +x sshww

Write your warm welcome home page in markdown:

mkdir -p warm-welcome
echo "# hello, world!\n\nwelcome, welcome" > warm-welcome/welcome.md

Then turn on the built-in SSH server:

./sshww
2022/04/03 00:11:39 warm welcome waiting on port :1312

And from another terminal, connect with your SSH client:

ssh -p 1312 localhost

That's it!

Configure

  • sshww reads markdown files from a folder named warm-welcome in the current working directory. Any file it finds there will be included as a menu item in the warm welcome environment. welcome.md is the only required file, everything else is optional. Up to 10 markdown files are supported.

Acknowledgements

License