MSC3079 Low Bandwidth library for servers and clients
  • Go 99.4%
  • Dockerfile 0.4%
  • Shell 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2022-08-25 10:49:57 +01:00
.github/workflows Use latest Go 1.x version, rebuild Docker image monthly 2022-08-25 10:49:57 +01:00
cmd Set content-type header in response 2021-09-20 11:16:28 +01:00
mobile Update mobile deps 2021-09-16 12:25:30 +01:00
.gitignore Add proxy 2021-06-01 10:17:00 +01:00
cbor.go Add copyright 2021-05-11 11:29:53 +01:00
cbor_codec.go Add copyright 2021-05-11 11:29:53 +01:00
cbor_test.go Add copyright 2021-05-11 11:29:53 +01:00
cbor_v1.go Add copyright 2021-05-11 11:29:53 +01:00
coap.go Use matrix-org/go-coap 2021-06-02 19:25:34 +01:00
coap_http.go Use matrix-org/go-coap 2021-06-02 19:25:34 +01:00
coap_observe.go Use matrix-org/go-coap 2021-06-02 19:25:34 +01:00
coap_observe_sync.go Add copyright 2021-05-11 11:29:53 +01:00
coap_paths.go Add copyright 2021-05-11 11:29:53 +01:00
coap_paths_test.go Add copyright 2021-05-11 11:29:53 +01:00
coap_paths_v1.go Add copyright 2021-05-11 11:29:53 +01:00
Dockerfile Use latest Go 1.x version, rebuild Docker image monthly 2022-08-25 10:49:57 +01:00
example_cbor_test.go More docs 2021-05-11 14:17:38 +01:00
go.mod Update deps so /mobile can be accessed in lb 2021-09-16 12:32:07 +01:00
go.sum Update deps so /mobile can be accessed in lb 2021-09-16 12:32:07 +01:00
LICENSE Add CBOR bits 2021-05-07 17:50:14 +01:00
lowbandwidth.go Add copyright 2021-05-11 11:29:53 +01:00
README.md Add GH action maybe 2021-06-01 10:27:52 +01:00
run-builds.sh Build the client proxy under CI 2021-09-16 12:33:35 +01:00
run-tests.sh Add mobile bindings 2021-05-11 12:41:35 +01:00

Low Bandwidth Matrix

Go Reference

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 '-' '-'