proxy

command
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 5, 2024 License: ISC Imports: 23 Imported by: 0

README

gRPC HTTP Gateway Proxy Server

A proxy server can be used when a client application is not able to connect to BCHD via gRPC for one reason or another.

Build

  1. Install the latest grpc-gateway library via:
$ go install \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
    github.com/golang/protobuf/protoc-gen-go \
    google.golang.org/grpc/cmd/protoc-gen-go-grpc
  1. $ make

This will generate all of the files required for the gateway proxy and also the files for the swagger API docs.

Run the Proxy

$ ./gw -http-addr :8080 -bchd-grpc-url <BCHD gRPC server url>:8335 -bchd-grpc-certpath <path to self-signed cert>

If you are using a certificate signed by a CA then you do not need to specify a value for -bchd-grpc-certpath.

Swagger API Docs

The proxy server will also host the static swagger files located in the ./web directory.

Run tests

go test gw_test.go

You can specify another BCHD backend using the same parameters as above for gw.go.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL