diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..15462b6 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# qChat - quick chat + +Очень маленький и минималистичный чат, который реализует собой чат поверх SSH. + +Внешних зависимостей нет, должен работать на любой картошке. + +# Установка и запуск + +Просто скачайте и запустите бинарник для соответствующей платформы. При первом +запуске в текущей рабочей директории будет создан конфиг файл с умолчальной +конфигурацией. При последующих запусках — будет он использоваться и не +пересоздаваться. + +В конфиге лежит приватный ключ! Его нужно хранить в секрете. Остальные параметры +там — дефолтный список каналов и название сервера. Их можно менять. + +# Установка с помощью Docker + +``` +docker volume create qchat_conf +docker run -d --name qchat -p 1337:1337 -v qchat_conf:/etc/qchat gitrepo.ru/neonxp/qchat /app/qchat -config /etc/qchat/config.json +``` + +# Подключение к чату + +Для подключения к чату достаточно стандартного клиента ssh. Во всех адекватных +ОС он есть из коробки. Для Windows - можно использовать Putty. + +``` +ssh [имя_пользователя@]хост -p 1337 +``` + +Например, при локально запущенном чате: + +``` +ssh localhost -p 1337 +``` + +Для подключения к демонстрационному серверу: + +``` +ssh neonxp.ru -p 1337 +``` + +Подойдёт любой эмулятор терминала совместимый с VT100. + +# Команды сервера + +Полную справку так же можно получить с помощью команды `/help`. + +- `/join [chan]` - подключиться к каналу [chan]. Если его нет, он будет создан. +- `/chans` - список каналов +- `/users` - список пользователей на сервере (не на канале, а именно на сервере) +- `/me [message]` - отправка сообщения как бы от третьего лица + +Форматирование сообщений: + +- `*Полужирный*` +- `+Курсив+` +- `-Зачёркнутый текст-` +- `_Подчёркнутый текст_` |