third-party-mirrors/ssh-chat
1
0
Fork 0
mirror of https://github.com/shazow/ssh-chat.git synced 2025-04-12 23:27:17 +03:00
Code Issues Projects Releases Wiki Activity

Merge compiling + developing sections, describe license section

Browse Source
This commit is contained in:
Sam Mauldin 2014-12-17 21:28:01 -06:00
parent 0e3b42085b
commit 28470aa7b7
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -16,6 +16,17 @@ The server's RSA key fingerprint is `e5:d5:d1:75:90:38:42:f6:c7:03:d7:d0:56:7d:6
(Apologies if the server is down, try again shortly.)
## Compiling / Developing
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.3 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](http://golang.org/pkg/net/http/pprof/) for more information about `pprof`.
## Quick Start
@ -46,11 +57,6 @@ $ 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).
## Compiling
You can compile ssh chat by using `make build`. The ssh chat binary is portable and
can be run on any system with a similar OS. Go 1.3 or higher is required to compile.
## Deploying with Docker
You can run ssh-chat using a Docker image without manually installing go-lang:
@ -62,14 +68,6 @@ $ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat alvin/s
See notes in the header of our Dockerfile for details on building your own image.
## Developing
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](http://golang.org/pkg/net/http/pprof/) for more information about `pprof`.
## License
MIT
This project is licensed under the MIT open source license.