diff options
| -rw-r--r-- | README.md | 17 |
1 files changed, 11 insertions, 6 deletions
@@ -1,10 +1,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. Its main interface -is over a TCP socket, but there is a websocket bridge to support web access. -There is basically no security. The storage backend is an SQLite database. +[weechat](https://weechat.org/) plugin and an Android app. The client-server +protocol is documented in `protocol.md`. -The client-server protocol is documented in `protocol.md`; however, for -security, clients should always connect through either the SSH proxy or the -websocket proxy behind an SSL terminator. +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. |