ToolJet/docs/versioned_docs/version-2.24.0/data-sources/grpc.md
Shubhendra Singh Chauhan da46eaf136
[docs] git sync - docs v2.24 (#8078)
* [docs] gitsync

* [docs]git sync

* updates after review

* added flow diagram and use cases

* changes after review

* Update docs/docs/gitsync.md

* note for workspace constants

* Added docs v2.24.0
2023-12-13 16:27:58 +05:30

2.1 KiB

id title
grpc gRPC
Self-hosted only

:::caution only self-hosted deployments will have access to a gRPC datasource that is capable of handling unary requests and responses. :::

Setup

Step 1: Upgrade ToolJet to the version 2.5 or above

Find instructions on how to do this in the setup guides located here: https://docs.tooljet.com/docs/setup/.

Step 2: Add proto files

At the root, create a directory named "protos" and add a "service.proto" file inside it.

Step 3: Mount Volumes

In the docker-compose.yml add

./protos:/app/protos

to the 2 volume sections for plugins and server

gRPC: datasource
gRPC: datasource

Step 4: Reboot the instance

docker-compose up -d

Querying gRPC

After setting up your proto files, you should be able to establish a connection to gRPC by going to the global datasource page.

Connect the gRPC datasource

ToolJet requires the following to connect to gRPC servers:

  • Server URL
  • Authentication type (None, Basic, Bearer, and API key)
gRPC: connection

Once you have added the gRPC from the global datasource page, you'll find it on the query panel of the application.

gRPC: connection

Creating query

You can now query a particular RPC method of the added services.

gRPC: connection