chore: update docs with proxy infos

tbckr · Oct 29, 2023 · 3cc4e79 · 3cc4e79
1 parent d68ad8b
commit 3cc4e79
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/usage/proxy.md b/docs/usage/proxy.md
@@ -0,0 +1,21 @@
+# Proxy Support
+
+SGPT supports proxying requests through SOCKS and HTTP proxies. This is useful for environments where direct internet
+access is not allowed, but proxying is allowed.
+
+You can configure SGPT to use a proxy using the `http_proxy` and `https_proxy` environment variables.
+
+```bash
+$ export http_proxy=http://proxy.example.com:8080
+$ export https_proxy=http://proxy.example.com:8080
+$ sgpt "say hello"
+Hello! How can I assist you today?
+```
+
+Exceptions can be made for specific hosts by setting the `no_proxy` environment variable.
+
+```bash
+$ export no_proxy=example.com
+$ sgpt "say hello"
+Hello! How can I assist you today?
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -72,5 +72,6 @@ nav:
       - Chat: 'usage/chat.md'
       - Docker: 'usage/docker.md'
       - Personas: 'usage/personas.md'
+      - Proxy Support: 'usage/proxy.md'
   - Configuration: 'configuration.md'
   - Examples: 'examples.md'