Skip to content

Add gRPC proxy support to proxy configuration docs #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add gRPC proxy support to proxy configuration docs #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion get-started/configure/proxy-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

Fill in the required fields:

- **Hostname**: The proxy server's domain or IP address (e.g., `example.com`).

Check warning on line 47 in get-started/configure/proxy-config.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

get-started/configure/proxy-config.mdx#L47 

Did you really mean 'Hostname'?
- **Port**: The port number for the proxy connection (e.g., `3000`).

## 5. Enabling Authentication (Optional)
Expand Down Expand Up @@ -73,10 +73,23 @@
- **Disabled**: Disables the proxy for this collection.

3. Choose **inherit, enabled, or disabled**.
4. Enter the **Hostname, Port, Protocol, Username, and Password** if needed.

Check warning on line 76 in get-started/configure/proxy-config.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

get-started/configure/proxy-config.mdx#L76 

Did you really mean 'Hostname'?
5. Click **Save** to apply the settings.

## 7. Saving Proxy Configuration
## 7. Proxy support for gRPC requests

Bruno's proxy settings apply to both HTTP and gRPC requests. However, gRPC proxy support has the following limitations:

- **Only HTTP proxies are supported** — gRPC connections use HTTP CONNECT tunneling. SOCKS4, SOCKS5, and HTTPS proxy protocols are not supported for gRPC. If you configure one of these protocols, gRPC requests will bypass the proxy and connect directly.
- **Authentication is supported** — proxy username and password work the same as for HTTP requests.
- **Bypass rules apply** — the bypass proxy list is respected for gRPC requests.
- **System proxy mode** — when set to "System Proxy", gRPC uses the standard `http_proxy`/`https_proxy` environment variables. Only HTTP-protocol system proxies are used; non-HTTP system proxies are ignored.

<Note>
If your proxy is configured with a SOCKS or HTTPS protocol, gRPC requests will connect directly without going through the proxy. HTTP/REST requests are unaffected and will continue to use the configured proxy protocol.
</Note>

## 8. Saving proxy configuration

After entering the proxy details, click the **Save** button to apply the changes. Your proxy settings are now configured in Bruno.

Loading