diff --git a/.travis.yml b/.travis.yml index 175aaf7..349a4c3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,9 +4,13 @@ notifications: email: false install: + - export PATH=$PATH:$HOME/gopath/bin + - go get github.com/GeertJohan/fgt + - go get github.com/golang/lint/golint - make deps -default: +script: + - fgt golint - make test go: diff --git a/Dockerfile b/Dockerfile index 4df88d1..19253bc 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,3 +1,8 @@ +# +# Usage example: +# $ docker build -t ssh-chat . +# $ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat ssh-chat +# FROM golang:1.4 MAINTAINER Alvin Lai diff --git a/README.md b/README.md index 750b296..5d1923b 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ $ 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). -## ssh-chat on Docker +## Deploying with Docker You can run ssh-chat using a Docker image without manually installing go-lang: @@ -49,17 +49,8 @@ $ docker pull alvin/ssh-chat $ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat alvin/ssh-chat ``` -Or you can build your own image: +See notes in the header of our Dockerfile for details on building your own image. -``` -$ docker build -t (your-docker-username)/ssh-chat . -``` - -then run it: - -``` -$ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat (your-docker-username)/ssh-chat -``` ## Developing @@ -67,33 +58,6 @@ If you're developing on this repo, there is a handy Makefile that should set things up with `make run`. -## TODO: - -* [x] Welcome message. -* [x] set term width properly -* [x] client map rather than list -* [x] backfill chat history -* [x] tab completion -* [x] /ban -* [ ] /ban by ip -* [x] /help -* [x] /about -* [x] /list -* [x] /nick -* [x] pubkey fingerprint -* [x] truncate usernames -* [ ] rename collision bug -* [ ] op ops on join -* [ ] piped stdout bug -* [ ] saner sanitizing of inputs (version string, allow space/period) -* [x] Some tests. -* [ ] More tests. -* [ ] Even more tests. -* [ ] Lots of refactoring -* [ ] Pull out the chat-related stuff into isolation from the ssh serving - stuff - - ## License MIT