Adds an example of a Proxy request (#410)

wojtekmach · Sep 4, 2024 · 0e61902 · 0e61902
1 parent fb92cb5
commit 0e61902
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/lib/req.ex b/lib/req.ex
@@ -403,6 +403,21 @@ defmodule Req do
       iex> URI.to_string(req.url)
       "https://elixir-lang.org"
 
+    Performing a request through a proxy with basic authentication:
+
+      iex> Req.new(
+      ...>  url: "https://www.google.com/",
+      ...>  connect_options: [
+      ...>    proxy_headers: [{"proxy-authorization", "Basic " <> Base.encode64("user:pass")}]
+      ...>  ],
+      ...>  proxy: {:http, "your.proxy.com", 8888, []},
+      ...>  transport_opts: [
+      ...>    # verify: :verify_none,
+      ...>    cacertfile: "/your/cert/File.pem"
+      ...>  ]
+      ...> )
+      iex> |> Req.get!()
+
   Fake adapter:
 
       iex> fake = fn request ->