Add Readme.

This commit is contained in:
Marco Slater 2018-03-23 17:37:02 +00:00
parent c0d2a0d240
commit 4cca6407c9
No known key found for this signature in database
GPG Key ID: D2BCB5895E2F1FDB

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# ssh-chat docker
Docker image of [ssh-chat](https://github.com/shazow/ssh-chat) by [shazow](https://github.com/shazow).
# Usage
Generate keys outside of Docker to keep persistence, and not get warnings:
```
$ ssh-keygen -t rsa -b 4096 -N '' -f ./ssh-chat-key
```
Run the docker image:
```
$ docker run -p 2022:2022 -v /ssh-chat-key:/ssh_key marcoslater/ssh-chat:latest
```
You may supply additional arguments to the image, example:
```
$ docker run -p 22:22 -v /ssh-chat-key:/ssh_key marcoslater/ssh-chat:latest --bind ":22"
```
# Development
Improvements and ideas can be found on the projects issues section.