aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f6c7a5bed8634da254ede08721eb42d85d90ce97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# tomsg

tomsg is a simple chat server with a couple of clients: a webpage, a
[weechat](https://weechat.org/) plugin and an Android app. The client-server
protocol is documented in `protocol.md`.

The server accepts connections over a simple TCP socket, but for actual use you
should, of course, encrypt that connection. This can be done in any way you
please, but the supported options are using the websocket proxy behind a TLS
terminator or using the SSH proxy on the client and server sides. This SSH
proxy only uses the SSH protocol for its encryption; authentication is still
done as in the normal tomsg protocol.

The server storage backend is an SQLite database; the goal is that it is
lightweight and fast.