ToolJet/docs/versioned_docs/version-3.5.0-LTS/data-sources/grpc.md
2025-05-02 12:44:25 +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: ToolJet 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 the following to the volumes sections for plugins and server

./protos:/app/protos
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
    • 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