mirror of
https://github.com/matrix-org/lb.git
synced 2026-11-17 03:30:33 +00:00
MSC3079 Low Bandwidth library for servers and clients
- Go 99.4%
- Dockerfile 0.4%
- Shell 0.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github/workflows | ||
| cmd | ||
| mobile | ||
| .gitignore | ||
| cbor.go | ||
| cbor_codec.go | ||
| cbor_test.go | ||
| cbor_v1.go | ||
| coap.go | ||
| coap_http.go | ||
| coap_observe.go | ||
| coap_observe_sync.go | ||
| coap_paths.go | ||
| coap_paths_test.go | ||
| coap_paths_v1.go | ||
| Dockerfile | ||
| example_cbor_test.go | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| lowbandwidth.go | ||
| README.md | ||
| run-builds.sh | ||
| run-tests.sh | ||
Low Bandwidth Matrix
This repository implements MSC3079 in Go. It also provides several command line tools to get up to speed with existing low bandwidth enabled servers.
Mobile implementations
See mobile for Android/iOS bindings.
Command Line Tools
- jc: This tool can be used to convert JSON <--> CBOR.
- coap: This tool can be used to send a single CoAP request/response, similar to
curl. - proxy: This tool can be used to add low bandwidth support to any Matrix homeserver.
These can be tied together to interact with low-bandwidth enabled Matrix servers. For example:
# convert inline JSON to CBOR then pipe into coap to localhost:8008 then convert the CBOR response back to JSON and print to stdout
./jc -out "-" '{"auth":{"type":"m.login.dummy"},"username":"foo","password":"barbarbar"}' \
| ./coap -X POST -d '-' -H "Content-Type: application/cbor" -k https://localhost:8008/_matrix/client/r0/register \
| ./jc -c2j -out '-' '-'