mirror of
https://github.com/shazow/ssh-chat.git
synced 2025-04-13 15:47:17 +03:00
Fleshing out the readme.
This commit is contained in:
parent
b646abffb8
commit
3f20f1795c
3
Makefile
3
Makefile
@ -20,3 +20,6 @@ $(KEY):
|
|||||||
|
|
||||||
run: $(BINARY) $(KEY)
|
run: $(BINARY) $(KEY)
|
||||||
./$(BINARY) -i $(KEY) -b ":$(PORT)" -vv
|
./$(BINARY) -i $(KEY) -b ":$(PORT)" -vv
|
||||||
|
|
||||||
|
test:
|
||||||
|
go test .
|
||||||
|
40
README.md
40
README.md
@ -1,6 +1,38 @@
|
|||||||
# ssh-chat
|
# ssh-chat
|
||||||
|
|
||||||
Coming real soon.
|
Custom SSH server written in Go. Instead of a shell, you get a chat prompt.
|
||||||
|
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage:
|
||||||
|
ssh-chat [OPTIONS]
|
||||||
|
|
||||||
|
Application Options:
|
||||||
|
-v, --verbose Show verbose logging.
|
||||||
|
-b, --bind= Host and port to listen on. (0.0.0.0:22)
|
||||||
|
-i, --identity= Private key to identify server with. (~/.ssh/id_rsa)
|
||||||
|
|
||||||
|
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 ":2022" --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).
|
||||||
|
|
||||||
|
|
||||||
|
## Developing
|
||||||
|
|
||||||
|
If you're developing on this repo, there is a handy Makefile that should set
|
||||||
|
things up with `make run`.
|
||||||
|
|
||||||
|
|
||||||
## TODO:
|
## TODO:
|
||||||
@ -17,3 +49,9 @@ Coming real soon.
|
|||||||
* [x] /nick
|
* [x] /nick
|
||||||
* [ ] pubkey fingerprint
|
* [ ] pubkey fingerprint
|
||||||
* [x] truncate usernames
|
* [x] truncate usernames
|
||||||
|
* [x] Some tests.
|
||||||
|
* [ ] More tests.
|
||||||
|
* [ ] Even more tests.
|
||||||
|
* [ ] Lots of refactoring
|
||||||
|
* [ ] Pull out the chat-related stuff into isolation from the ssh serving
|
||||||
|
stuff
|
||||||
|
@ -191,7 +191,7 @@ func (s *Server) Start(laddr string) error {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.Infof("Connection from: %s, %s, %s", sshConn.RemoteAddr(), sshConn.User(), sshConn.ClientVersion())
|
logger.Infof("Connection #%d from: %s, %s, %s", s.count+1, sshConn.RemoteAddr(), sshConn.User(), sshConn.ClientVersion())
|
||||||
|
|
||||||
go ssh.DiscardRequests(requests)
|
go ssh.DiscardRequests(requests)
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user