git.iko.soy/project-m36
on master help sign in
add websocket server doc
commite6437b2a3cafafe50360adb248bc0b1f9e8ed33c authorAgentM <agentm@themactionfaction.com> dateFri 5 Aug 2016, 19:45 (10 years ago) parent1b5c0f0
1 file changed+23
compare with master
unifiedsplit
docs/websocket_server.markdown+23
docs/websocket_server.markdownnew file+23
@@ -0,0 +1,23 @@
1+# Project:M36 WebSocket Server
2+
3+## Purpose
4+
5+The Project:M36 WebSocket server makes it easy to connect non-Haskell programs to the Project:M36 database. This server operates as a proxy to an actual Project:M36 database.
6+
7+## Setup
8+
9+The websocket server is started with the same arguments as the normal [Project:M36 server](docs/server_mode.markdown):
10+
11+```
12+cabal run project-m36-server -- --database mydbname --hostname 127.0.0.1
13+```
14+
15+except that the websocket server is now listening for websocket connections on port 8888.
16+
17+## Client Connection
18+
19+A [simple JavaScript library](ProjectM36/Server/WebSocket/project-m36.js) to manage the WebSocket connection is available.
20+
21+## Sample Application
22+
23+The [WebSocket example application](ProjectM36/Server/WebSocket/websocket-client.html) can be used to learn TutorialD and for remote database access from the web browser.