third-party-mirrors/ssh-chat
1
0
Fork 0
mirror of https://github.com/shazow/ssh-chat.git synced 2025-05-25 03:07:42 +03:00
Code Issues Projects Releases Wiki Activity

Fixing TOC because it just didn't work

Steven L 2016-08-22 16:12:41 -04:00
parent 7795efaf84
commit 081ebeb468
1 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
FAQ.md

@ -2,22 +2,20 @@ Frequently Answered Questions
=============================
### Table of Contents
* [Is this a replacement for IRC?](replacement)
* [How can I build ssh-chat?](building)
* [How can I contribue to ssh-chat?](contribue)
* [What features are planned for ssh-chat?](features)
* [How can I click on URLs posted in chat?](clickable)
* [Can I block users from connecting? How do I assign admins?](whitelisting)
* [How do I add color escape codes to my motd file?](escapecodes)
* [Is this a replacement for IRC?](https://github.com/shazow/ssh-chat/wiki/FAQ#is-this-a-replacement-for-irc)
* [How can I build ssh-chat?](https://github.com/shazow/ssh-chat/wiki/FAQ#how-can-i-build-ssh-chat)
* [How can I contribue to ssh-chat?](https://github.com/shazow/ssh-chat/wiki/FAQ#how-can-i-contribute-to-ssh-chat)
* [What features are planned for ssh-chat?](https://github.com/shazow/ssh-chat/wiki/FAQ#what-features-are-planned-for-ssh-chat)
* [How can I click on URLs posted in chat?](https://github.com/shazow/ssh-chat/wiki/FAQ#how-can-i-click-on-urls-posted-in-chat)
* [Can I block users from connecting? How do I assign admins?](https://github.com/shazow/ssh-chat/wiki/FAQ#can-i-block-users-from-connecting-how-do-i-assign-admins)
* [How do I add color escape codes to my motd file?](https://github.com/shazow/ssh-chat/wiki/FAQ#how-do-i-add-color-escape-codes-to-my-motd-file)
<a href="replacement">
## Is this a replacement for IRC?
It can be for some scenarios, but the goals are not identical.
ssh-chat focuses more on secure chat with small teams. Traditionally to achieve this with IRC, you'd setup an ssh server for your friends and run a localhost IRC server on it that your friends would connect to by tunnelling over ssh. ssh-chat achieves a similar level of security without setting up multiple servers and tunnels.
<a href="building">
## How can I build ssh-chat?
You'll need a recent version of the Go compiler (1.7 is best, but 1.5+ should work).
@ -41,7 +39,6 @@ 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.
<a href="contribute">
## How can I contribute to ssh-chat?
So once you've set up the build phase, you can start contributing right away! `ssh-chat` uses
@ -85,13 +82,11 @@ That should push your changes to your repository instead of the `ssh-chat` repos
create a Pull Request which will compare your changes to the upstream's (original repository) Git, and
if the changes are approved by the owner, then they will get merged!
<a href="features">
## What features are planned for ssh-chat?
Check the [milestones page](https://github.com/shazow/ssh-chat/milestones) which should have
a list of features planned.
<a href="clickable">
## How can I click on URLs posted in chat?
Do you have clickable/yankable URL support in your terminal emulator? Depending on your terminal, you
@ -99,7 +94,6 @@ might be able to check the settings to see if it has URL support.
Usually it's ctrl+click or cmd+click.
<a href="whitelisting">
## Can I block users from connecting? How do I assign admins?
`ssh-chat` has whitelisting features which limit access based on ssh public keys. For example, you can whitelist your friends to be the only ones who can connect to the server, or add them to be admins on your server.
@ -119,7 +113,6 @@ Or if you wanted to add everyone who has access to the server as admins:
$ ssh-chat --admin=$HOME/.ssh/authorized_keys ...
```
<a href="escapecodes">
## How do I add color escape codes to my motd file?
Use an editor that supports ANSI escape codes. For example: