https://github.com/ananace/ruby-sinatra-matrix_sse
Middleware testbed for MSC2108 using Ruby+Sinatra
https://github.com/ananace/ruby-sinatra-matrix_sse
Last synced: 11 months ago
JSON representation
Middleware testbed for MSC2108 using Ruby+Sinatra
- Host: GitHub
- URL: https://github.com/ananace/ruby-sinatra-matrix_sse
- Owner: ananace
- License: mit
- Created: 2019-10-18T09:20:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-14T16:04:35.000Z (almost 4 years ago)
- Last Synced: 2025-07-24T08:03:44.479Z (11 months ago)
- Language: Ruby
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Matrix SSE
==========
A small testbed server for trying out [MSC2108][1] for the [Matrix protocol][2]
## Installation
Check out this repo, install the bundle, instantiate the config, and run `rackup` to launch the server.
Also available on [DockerHub][4] as `ananace/matrix_sse`.
An example configuration is provided as;
```json
{
"homeserver": "https://matrix.org",
"default_heartbeat": 5
}
```
## Usage
When the server is running, any requests to `/_matrix/client/r0/sync/sse` will
launch an SSE stream, taking the same parameters as the upstream
[sync request][3]. Except for `interval` and `since` as mentioned in the
[MSC][1].
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-sinatra-matrix_sse
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
[1]: https://github.com/matrix-org/matrix-doc/pull/2108
[2]: https://matrix.org
[3]: https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-sync
[4]: https://hub.docker.com/r/ananace/matrix_sse