README
¶
matrix-websockets-proxy
This project provides a websockets wrapper for a Matrix.org homeserver. See https://github.com/matrix-org/matrix-doc/blob/master/drafts/websockets.rst for information on the protocol it implements.
To run it, you will need a working go installation, including a correctly-set
GOPATH.
You can then download and build matrix-websockets-proxy with:
go get github.com/matrix-org/matrix-websockets-proxy
The above will clone the repository into
$GOPATH/src/github.com/matrix-org/matrix-websockets-proxy, and build the
binary at $GOPATH/bin/matrix-websockets.
To run it, just do:
$GOPATH/bin/matrix-websockets-proxy
To rebuild, use:
go build github.com/matrix-org/matrix-websockets-proxy
Documentation
¶
Overview ¶
matrix-websockets-proxy provides a websockets interface to a Matrix homeserver implementing the REST API.
It listens on a TCP port (localhost:8009 by default), and turns any incoming connections into REST requests to the configured homeserver.
It exposes only the one HTTP endpoint '/stream'. It is intended that an SSL-aware reverse proxy (such as Apache or nginx) be used in front of it, to direct most requests to the homeserver, but websockets requests to this proxy.
You can also visit http://localhost:8009/test/test.html, which is a very simple client for testing the websocket interface.
Source Files
Directories