Created FAQ (markdown)

S Leibrock 2016-08-16 11:02:49 -04:00
parent 9961fe108f
commit c681a68390

37
FAQ.md Normal file

@ -0,0 +1,37 @@
Frequently Answered Questions
=============================
## Is this a replacement for IRC?
```ssh-chat``` and IRC have overlapping scenarios. ```ssh-chat``` right now doesn't have channels like IRC does,
but for smaller projects and teams, ssh-chat might be better in the long run. ssh-chat identifies users
by their public keys so authentication is automatically handled by sshd. ```ssh-chat``` is also easier to set up
since all a user has to do is connect via ssh to a specified IP as opposed to installing an IRC client,
connecting to a server, and connecting to a specific channel.
## Can I block users from connecting?
Yes. ```ssh-chat``` has a whitelisting feature which allows you to take users' public keys and add them to a
whitelist, so that only they may connect when their public key matches the authorized keys given to ```ssh-chat```.
## How can I build ssh-chat?
First make sure you have a copy of the Go compiler (1.6+ should be fine). Next you need a workspace for
the Go compiler to do all of it's builds. Make a directory, something like ```work``` in your $HOME folder,
where we can place the source folder into.
The next step is setting up our GOPATH so Go knows where it can start building and downloading packages.
After that we can copy the source code into the GOPATH directory for compiling.
``` bash
mkdir ~/work
export GOPATH=~/work
git clone https://github.com/shazow/ssh-chat ~/work/src/github.com/shazow
cd ~/work/src/github.com/shazow/ssh-chat
make
```
That should make the workspace directory, export the GOPATH to your environment, clone the
repository into the workspace, change directory into the code, and start executing the Makefile instructions
for you.
If you have any trouble building, please open an issue on the tracker and let us know what problems you run
into during the build process.