tyler.durden
/
ssh-chat
mirror of https://github.com/shazow/ssh-chat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Chat over SSH.
553 Commits 15 Branches 20 Tags 1 MiB
Go 98.1%
Makefile 1%
Shell 0.7%
Dockerfile 0.2%
Go to file
Andrey Petrov fb73ace458
Merge pull request #385 from sytranvn/build-apple-silocon 
Add build script for apple silicon
 		2021-04-19 09:45:02 -04:00
.github Update bug_report.md 2021-02-06 09:33:28 -05:00
chat chat: Add /mute command for op 2021-04-13 11:21:16 -04:00
cmd/ssh-chat cmd/ssh-chat: Use x/term instead of howeyc/gopass, update prompt 2021-03-26 12:26:18 -04:00
internal chat, internal/humantime: Tweak departure message 2019-03-17 15:01:41 -04:00
set set: Add Interface, ZeroValue helper 2020-08-03 11:32:16 -04:00
sshd sshd, chat/message: Add more debug logging for close failures 2021-04-05 11:06:44 -04:00
.gitignore vendor: Switch to using `go dep` 2017-10-12 13:40:35 -04:00
.travis.yml travisci: Remove explicit dep fetch (#287) 2018-12-25 14:53:38 -05:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2020-08-03 12:32:03 -04:00
CONTRIBUTING.md Adding a contribituion file and issue template (#248) 2017-10-03 13:49:52 -04:00
Dockerfile Add Dockerfile and docker-compose.yml 2020-10-28 16:19:16 +01:00
Gopkg.lock /uptime and /whois relative timestamps made more precise 2018-01-19 12:35:45 -05:00
Gopkg.toml vendor: Switch to using `go dep` 2017-10-12 13:40:35 -04:00
LICENSE LICENSE, todo. 2014-12-12 17:52:05 -08:00
Makefile Add build script for apple silicon 2021-04-18 07:31:13 +07:00
NOTICE legal: Put sshd/terminal notice in root 2019-03-18 15:36:21 -04:00
README.md README: Add CoC link 2020-08-03 11:51:56 -04:00
auth.go Better comments 2019-02-24 09:40:47 -06:00
auth_test.go /ban query support (#286) 2018-12-25 14:29:19 -05:00
build_release Windows support (fixed #217) 2016-09-15 13:52:55 -04:00
docker-compose.yml Add Dockerfile and docker-compose.yml 2020-10-28 16:19:16 +01:00
go.mod main: Update host_test.go to pass vet, use errgroup 2021-03-26 12:49:08 -04:00
go.sum main: Update host_test.go to pass vet, use errgroup 2021-03-26 12:49:08 -04:00
godoc.go Better comments 2019-02-24 09:40:47 -06:00
host.go host: Fix /msg vs /reply message formatting 2021-04-06 09:28:48 -04:00
host_test.go main: Update host_test.go to pass vet, use errgroup 2021-03-26 12:49:08 -04:00
identity.go /away: Fix output for admin whois 2021-04-13 11:27:44 -04:00
logger.go Better comments 2019-02-24 09:40:47 -06:00
motd.txt /motd: Add reload functionality when msg is @ 2020-08-03 13:26:12 -04:00

README.md

Build Status GoDoc Downloads Bountysource

ssh-chat

Custom SSH server written in Go. Instead of a shell, you get a chat prompt.

Demo

Join the party:

$ ssh ssh.chat

Please abide by our project's Code of Conduct while participating in chat.

The server's RSA key fingerprint is MD5:e5:d5:d1:75:90:38:42:f6:c7:03:d7:d0:56:7d:6a:db or SHA256:HQDLlZsXL3t0lV5CHM0OXeZ5O6PcfHuzkS8cRbbTLBI. 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

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.
      --whitelist= 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:

$ 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

MIT