+0
Daily
5,919
stars
427
forks
108
watchers
182
prs
260
issues
12
releases
README
ssh-chat
Custom SSH server written in Go. Instead of a shell, you get a chat prompt.
Demo
Join the party:
console
$ ssh ssh.chat
Please abide by our project's Code of Conduct while participating in chat.
The host's public key is ssh.chat ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKPrQofxXqoz2y9A7NFkkENt6iW8/mvpfes3RY/41Oyt and the fingerprint is SHA256:yoqMXkCysMTBsvhu2yRoMUl+EmZKlvkN+ZKmL3115xU (as of 2021-10-13).
If you see something different, you might be MITM'd.
(Apologies if the server is down, try again shortly.)
Downloading a release
Recent releases include builds for MacOS (darwin/amd64) and Linux (386,
amd64, and ARM6 for your RaspberryPi).
Grab the latest binary release here.
Play around with it. Additional deploy examples are here.
Compiling / Developing
Most people just want the latest binary release. If you're sure you want to compile it from source, read on:
You can compile ssh-chat by using make build. The resulting binary is portable and
can be run on any system with a similar OS and CPU arch. Go 1.8 or higher is required to compile.
If you're developing on this repo, there is a handy Makefile that should set
things up with make run.
Additionally, make debug runs the server with an http pprof server. This allows you to open
http://localhost:6060/debug/pprof/ and view profiling data. See
net/http/pprof for more information about pprof.
Quick Start
console
Usage:
ssh-chat [OPTIONS]
Application Options:
-v, --verbose Show verbose logging.
--version Print version and exit.
-i, --identity= Private key to identify server with. (default: ~/.ssh/id_rsa)
--bind= Host and port to listen on. (default: 0.0.0.0:2022)
--admin= File of public keys who are admins.
--allowlist= Optional file of public keys who are allowed to connect.
--motd= Optional Message of the Day file.
--log= Write chat log to this file.
--pprof= Enable pprof http server for profiling.
Help Options:
-h, --help Show this help message
After doing go get github.com/shazow/ssh-chat/... on this repo, you should be able
to run a command like:
console
$ ssh-chat --verbose --bind ":22" --identity ~/.ssh/id_dsa
To bind on port 22, you'll need to make sure it's free (move any other ssh
daemons to another port) and run ssh-chat as root (or with sudo).
Frequently Asked Questions
The FAQs can be found on the project's Wiki page.
Feel free to submit more questions to be answered and added to the page.
License
MITTop issues
#359bug: Zombie users (reproduceable)13 comments · 2020-08-10#375ssh.chat: Deploy Tor hidden service endpoint12 comments · 2021-03-07#47Decide and implement a persistent storage for state12 comments · 2014-12-14#404Whitelist not applying11 comments · 2021-11-08#265whitelist: Allow forcing a username in the pubkey comment field10 comments · 2018-05-07#406Latest DoS7 comments · 2021-11-26#254Add matterbridge support7 comments · 2017-11-19#373Official ssh-chat logo6 comments · 2021-02-24
Discussions
#438add /clear2 comments · 2025-02-18#436ssh-chat from an existing ssh server1 comments · 2024-10-19#435Add a client mode1 comments · 2024-10-19#426Enabling Telnet for ssh-chat3 comments · 2023-09-13#425How do you retain the user input when rendering messages to the client?2 comments · 2023-06-26
Latest release
v1.10 v1.10 2020-08-03- /rename: New command for ops, rename other users and add an optional cosmetic prefix to their name. Github sponsors get an emoji! 352 - /focus: New command for ignoring everyone except the people you're focusing on. 356 - /ignore: Fixed emote messages bypassing ignores. 349 (Thanks @medinae) - /names: Sort by name! 354 (Thanks @lucash-diskkun) - /whois: Ops get to see if you're an op. (Thanks @pavelz) - main: Autocomplete deprioritzes own name and sorts by last active. 355 (Thanks @pavelz) - /whois: Ops get to see the time of the user's last message. - /motd: When @