gRPC proxying in Nginx - Commands & Configuration

Introduction

Sometimes you want to let NGINX handle gRPC requests and forward them to a backend server. This helps you manage traffic, add security, and balance load without changing your gRPC app.

When you want to expose a gRPC service securely over HTTPS using NGINX as a gateway.

When you need to load balance multiple gRPC backend servers behind one public endpoint.

When you want to add logging or rate limiting to gRPC calls without changing the service code.

When you want to terminate TLS at NGINX and forward plain gRPC traffic to backend servers.

When you want to combine gRPC and regular HTTP traffic on the same NGINX server.

Config File - nginx.conf

nginx.conf

worker_processes  1;

events {
    worker_connections  1024;
}

http {
    # Enable HTTP/2 for gRPC proxying
    server {
        listen  50051 ssl http2;

        # TLS configuration for secure gRPC
        ssl_certificate     /etc/nginx/certs/server.crt;
        ssl_certificate_key /etc/nginx/certs/server.key;

        # gRPC backend server
        location / {
            grpc_pass grpc://localhost:60051;
            error_page 502 = /errorgrpc;
        }

        location = /errorgrpc {
            internal;
            default_type application/grpc;
            add_header grpc-status 14;
            add_header grpc-message "Unavailable";
            return 204;
        }
    }
}

This configuration sets up NGINX to listen on port 50051 with HTTP/2 and SSL enabled, which is required for secure gRPC.

It uses TLS certificates for secure connections.

The location / block proxies all gRPC requests to a backend server running on localhost port 60051.

The error_page block handles backend errors gracefully by returning a proper gRPC error status.

Commands

Check the NGINX configuration file syntax to make sure there are no errors before starting.

Terminal

nginx -t

Expected Output

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok

nginx: configuration file /etc/nginx/nginx.conf test is successful

Restart NGINX to apply the new configuration for gRPC proxying.

Terminal

systemctl restart nginx

Expected Output

No output (command runs silently)

Test the gRPC proxy by sending a request through NGINX to the backend service on port 50051.

Terminal

grpcurl -proto yourservice.proto -d '{"name":"test"}' -insecure localhost:50051 YourService/YourMethod

Expected Output

{"message":"Hello test"}

→

-proto - Specifies the protobuf file describing the service.

→

-d - Sends JSON data as the request payload.

→

-insecure - Allows insecure connection without TLS verification for testing.

Key Concept

If you remember nothing else from this pattern, remember: NGINX must use HTTP/2 and grpc_pass to forward gRPC traffic correctly.

Common Mistakes

Not enabling HTTP/2 on the listen directive.

gRPC requires HTTP/2, so without it, NGINX cannot proxy gRPC requests properly.

Add 'http2' to the listen directive, for example: 'listen 50051 http2;'

Using 'proxy_pass' instead of 'grpc_pass' for gRPC traffic.

'proxy_pass' is for HTTP/1.x and will not handle gRPC framing correctly.

Use 'grpc_pass' to forward gRPC requests to the backend.

Not configuring TLS certificates when using secure gRPC.

gRPC clients expect TLS for secure connections; missing certificates cause connection failures.

Configure 'ssl_certificate' and 'ssl_certificate_key' with valid files.

Summary

Configure NGINX to listen with HTTP/2 and TLS for secure gRPC proxying.

Use 'grpc_pass' to forward gRPC requests to the backend server.

Test the setup with a gRPC client tool like grpcurl to verify proxying works.

Practice

1. What directive in nginx is used to forward gRPC requests to a backend server?

easy

A. fastcgi_pass

B. proxy_pass

C. grpc_pass

D. uwsgi_pass

Solution

1. Step 1: Understand gRPC proxying in nginx

   nginx uses a special directive to forward gRPC calls to backend servers.

2. Step 2: Identify the correct directive

   The directive grpc_pass is specifically designed for gRPC proxying, unlike proxy_pass which is for HTTP, or others for different protocols.

3. Final Answer:

   grpc_pass -> Option C

4. Quick Check:

   gRPC forwarding uses grpc_pass [OK]

Hint: gRPC proxying always uses grpc_pass directive [OK]

Common Mistakes:

• Confusing grpc_pass with proxy_pass
• Using fastcgi_pass for gRPC
• Not enabling HTTP/2 for gRPC

2. Which of the following is the correct syntax to proxy gRPC traffic to a backend at 127.0.0.1:50051 in nginx?

easy

A. grpc_pass grpc://127.0.0.1:50051;

B. grpc_pass http://127.0.0.1:50051;

C. proxy_pass grpc://127.0.0.1:50051;

D. proxy_pass http://127.0.0.1:50051;

Solution

1. Step 1: Recognize correct protocol prefix for grpc_pass

   The grpc_pass directive requires the backend address to start with grpc:// or grpcs:// for secure connections.

2. Step 2: Match syntax with correct directive and protocol

   grpc_pass grpc://127.0.0.1:50051; uses grpc_pass grpc://127.0.0.1:50051; which is the correct syntax. Options A and D use http:// which is incorrect for gRPC. proxy_pass grpc://127.0.0.1:50051; uses proxy_pass which is not for gRPC.

3. Final Answer:

   grpc_pass grpc://127.0.0.1:50051; -> Option A

4. Quick Check:

   grpc_pass + grpc:// = correct syntax [OK]

Hint: Use grpc_pass with grpc:// for gRPC backend URLs [OK]

Common Mistakes:

• Using proxy_pass instead of grpc_pass
• Using http:// instead of grpc://
• Omitting the semicolon at the end

3. Given this nginx snippet inside a server block:

location /grpc {
  grpc_pass grpc://backend:9000;
  error_page 502 = /error502grpc;
}

What happens if the backend server at backend:9000 is down?

medium

A. nginx silently drops the request without response

B. nginx returns the custom error page at /error502grpc

C. nginx returns a default 404 Not Found error

D. nginx retries the request indefinitely

Solution

1. Step 1: Understand error_page directive usage

   The error_page 502 = /error502grpc; tells nginx to serve the URI /error502grpc when a 502 Bad Gateway error occurs.

2. Step 2: Recognize backend down causes 502 error

   If the backend is down, nginx cannot connect and returns a 502 error, triggering the custom error page.

3. Final Answer:

   nginx returns the custom error page at /error502grpc -> Option B

4. Quick Check:

   502 error triggers custom error_page [OK]

Hint: 502 errors can be customized with error_page directive [OK]

Common Mistakes:

• Assuming 404 is returned for backend failure
• Thinking nginx retries endlessly
• Ignoring error_page directive effect

4. You configured nginx to proxy gRPC with:

grpc_pass grpc://backend:50051;

But clients report connection errors. Which nginx configuration is missing?

medium

A. fastcgi_pass backend;

B. listen 80;

C. proxy_http_version 1.1;

D. listen 443 ssl http2;

Solution

1. Step 1: Identify protocol requirements for gRPC

   gRPC requires HTTP/2 support, so nginx must listen with http2 enabled.

2. Step 2: Check the listen directive

   listen 443 ssl http2; includes listen 443 ssl http2; which enables HTTP/2 over TLS, necessary for secure gRPC connections. Options B and C do not enable HTTP/2, and A is unrelated.

3. Final Answer:

   listen 443 ssl http2; -> Option D

4. Quick Check:

   HTTP/2 is required for gRPC proxying [OK]

Hint: Enable HTTP/2 with listen directive for gRPC [OK]

Common Mistakes:

• Not enabling http2 in listen directive
• Using proxy_http_version 1.1 instead of http2
• Confusing fastcgi_pass with grpc_pass

5. You want nginx to proxy gRPC securely to a backend using TLS on port 50051. Which configuration snippet correctly sets this up?

hard

A. grpc_pass grpcs://backend:50051; listen 443 ssl http2;

B. grpc_pass grpc://backend:50051;

C. proxy_pass grpcs://backend:50051; listen 443 ssl http2;

D. grpc_pass grpc://backend:50051; listen 80;

Solution

1. Step 1: Use grpcs:// for secure gRPC backend

   To proxy gRPC over TLS, the backend URL must start with grpcs://.

2. Step 2: Enable SSL and HTTP/2 on nginx listen

   Listening on port 443 with ssl and http2 is required for secure gRPC proxying.

3. Step 3: Verify correct directive usage

   Use grpc_pass (not proxy_pass) with the secure URL and proper listen directive.

4. Final Answer:

   grpc_pass grpcs://backend:50051; listen 443 ssl http2; -> Option A

5. Quick Check:

   Secure gRPC needs grpcs:// and ssl http2 [OK]

Hint: Use grpcs:// and listen 443 ssl http2 for secure gRPC [OK]

Common Mistakes:

• Using grpc:// instead of grpcs:// for TLS
• Not enabling ssl and http2 on listen
• Using proxy_pass instead of grpc_pass