aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Smeding <tom.smeding@gmail.com>2020-09-11 15:15:20 +0200
committerTom Smeding <tom.smeding@gmail.com>2020-09-11 15:15:20 +0200
commit363c8357e8de4a2478547f1ccbdf9a7038101cec (patch)
tree9c85aa25380de8474523f32599a13df9961816a4
parentcbba4e772ec06dff01e6c14cb036895f1923125e (diff)
Update readme to reflect current reality a bit better
-rw-r--r--README.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index d41d4bc..f6c7a5b 100644
--- a/README.md
+++ b/README.md
@@ -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.