Skip to content

Commit b69b4f2

Browse files
committed
docs: clarify stance regarding grpc
1 parent 493b5dd commit b69b4f2

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,13 @@ General instruction:
5959
- Check to have set other values from [enverant.json](.vscode/enverant.json)
6060
- full list of variable possible to set available in help command `go run . help`
6161
- install [Taskfile](https://taskfile.dev/usage/) and check [commands to run](Taskfile.yml)
62-
- run some command, for example `task web`
62+
- run `task swag: build`
63+
- run `templ generate`
64+
- run some command, for example `task web` or u could run `go run . web` directly at this point
6365
- if u wish access to `task dev:watch` that reloads running web server on file changes, then install `pip install watchdog[watchmedo]` and ensure `watchmedo` binary is available to `task dev:watch` command written [in Taskfile](Taskfile.yml)
6466

6567
If u have problems with configuring development environment, then seek my contacts below to help you through it ^_^
6668

67-
# Development, how to regenerate proto related code
68-
69-
- task grpc:docker:gateway // for docker way to run file updates for grpc and its gateway // assumes docker is available of unix socket
70-
- task grpc:protoc:gateway // to run grpc file updates locally without docker. // assumes u did same stuff as `protoc` stage in Dockerfile
71-
7269
# Features
7370

7471
- Long term maintance support for dozen of years. Minimum dependencies software with Golang and Htmx.
@@ -93,18 +90,22 @@ If u have problems with configuring development environment, then seek my contac
9390
- deployed Discovery can be found at https://darkstat.dd84ai.com/swagger/index.html
9491
- deployed Vanilla can be found at https://darkstat-vanilla.dd84ai.com/swagger/index.html
9592

96-
# Alternatively we offer Client generation through gRPC!
93+
# gRPC existed but was removed
94+
95+
In the past we offered **grpc client** too, but it **was decommissioned** due being not very used and creating maintanance overhead
96+
- https://github.com/darklab8/fl-darkstat/pull/158
97+
- if there will be ever demand for gRPC, we could make it back
9798

98-
- With gRPC you can export our proto file and generate client with precise data structs and methods of API for your any language! Be it C#, Javascript, Python or even C++
99+
- With gRPC you could export our proto file and generate client with precise data structs and methods of API for your any language! Be it C#, Javascript, Python or even C++
99100
- Full list of supported languages here https://grpc.io/docs/languages/
100101
- You get static typing validations
101102
- You get performance boosts from using grpc compression stuff
102103
- We change server side smth? Just regenerate the lib to keep up with updates ^_^
103-
- Import [darkstat proto file](./darkapis/darkgrpc/statproto/darkstat.proto) for its usage and generate client lib from it with `protoc` command
104+
- Import [darkstat proto file](https://github.com/darklab8/fl-darkstat/blob/8a4903a459e2024bdacf8a3444603fc67403037a/darkapis/darkgrpc/statproto/darkstat.proto) for its usage and generate client lib from it with `protoc` command
104105
- addresses to connect:
105106
- for local instance localhost:50051, or optionally unix socket `/tmp/darkstat/grpc.sock` at linux for extra performance boosts.
106107
- for deployed instances for discovery and vanilla, they are hosted over darkgrpc.dd84ai.com and darkgrpc-vanilla.dd84ai.com accordingly. 80 and 443 ports accordingly
107-
- [see example in golang](./darkapis/darkgrpc/server_test.go) of interacting with grpc if desired
108+
- [see example in golang](https://github.com/darklab8/fl-darkstat/blob/8a4903a459e2024bdacf8a3444603fc67403037a/darkapis/darkgrpc/server_test.go) of interacting with grpc if desired
108109
- up to date exposed grpc domains can be found [in this file](./tf/production/main.tf) as rpc_prefix + zone combination
109110
- Make sure to set in your client option to increase accepting data size `grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(32 * 10e6))`.
110111
- NOTE: By default Grpc goes through grpc endpoint and uses compression of Protocol Buffers. Ability to go Json in API Gateway (for which Swagger documentation is provided) is ONLY FALLBACK for situations when people unable to go gRPC native way. If you will go through gRPC getting started instruction, u will receive automatically for your language client generated to utilize Protocol Buffers

0 commit comments

Comments
 (0)