matrixprotobuf

git clone git://archive.git.mtrnord.blog/MTRNord/matrixprotobuf.git
Log | Files | Refs | README | LICENSE

README.md (956B)


      1 # Matrix Protobuf/gRPC Proxy
      2 
      3 This Repo contains a Protobuf and gRPC Proxy named MatrixProtoBuf for the [Matrix Protocol](https://matrix.org) together with example clients for both of them.
      4 They are designed to be run localy on a client or on Servers as they take a HS address on every request.
      5 
      6 ### Join the discussion
      7 
      8 Join the discussion about this and help making decisions in [#MatrixProtoBuf:matrix.org](https://matrix.to/#/#MatrixProtoBuf:matrix.org)
      9 
     10 ## How to build this?
     11 
     12 1. Install GB from [getgb.io](getgb.io)
     13 2. Run `gb vendor restore`
     14 3. Run `gb build`
     15 
     16 ## How and what to run?
     17 
     18 To run only the Proxy which provides the access to the gRPC Server and HTTP Protobuf Server just run the MatrixProtoBuf* file in `bin`.
     19 The Proxy currently listens on port `50051` fo gRPC and on `3000` for Protobuf over HTTP
     20 
     21 ## Where is the Protobuf definition?
     22 
     23 the .proto file is in `src/github.com/Nordgedanken/MatrixProtoBuf/matrixProtos` named matrix.proto