update request header variables where possible (ngrok#759)

mustafacco7 · May 30, 2024 · 33076ca · 33076ca
1 parent e5984f8
commit 33076ca
Show file tree

Hide file tree

Showing 12 changed files with 129 additions and 54 deletions.
diff --git a/docs/http/_http_header_templates.mdx b/docs/http/_http_header_templates.mdx
diff --git a/docs/http/request-headers.mdx b/docs/http/request-headers.mdx
@@ -64,7 +64,7 @@ For example to include geographical data about the client IP that initiated the
 request, you may construct a header value like so.
 
 ```bash
-ngrok http 80 --request-header-add 'country: ${.ngrok.geo.country_code}'
+ngrok http 80 --request-header-add 'country: ${conn.geo.country_code}'
 ```
 
 If you are specifying variable interpolation from the command line, make sure
@@ -245,7 +245,7 @@ with `Ctrl+C` and then restart ngrok with a new command.
 ngrok http https://httpbin.org \
   --domain your-domain.ngrok.app \
   --request-header-remove='user-agent' \
-  --request-header-add='country: ${.ngrok.geo.country_code}'
+  --request-header-add='country: ${conn.geo.country_code}'
 ```
 
 Then curl your endpoint again to see how the request headers have been updated:

diff --git a/examples/actions/add-headers.mdx b/examples/actions/add-headers.mdx
@@ -4,7 +4,7 @@ export const type = "add-headers";
 export const config = {
 	headers: {
 		"is-ngrok": "1",
-		country: "${.ngrok.geo.country_code}",
+		country: "${conn.geo.country_code}",
 	},
 };
 

diff --git a/examples/agent-cli/http-request-headers.mdx b/examples/agent-cli/http-request-headers.mdx
@@ -1,6 +1,6 @@
 ```bash
 ngrok http 80 \
   --request-header-add='is-ngrok: 1' \
-  --request-header-add='country: ${.ngrok.geo.country_code}' \
+  --request-header-add='country: ${conn.geo.country_code}' \
   --request-header-remove='referrer'
 ```
diff --git a/examples/agent-config/http-request-headers.mdx b/examples/agent-config/http-request-headers.mdx
@@ -4,6 +4,6 @@ tunnels:
     proto: http
     addr: 80
     request_header:
-      add: ["is-ngrok: 1", "country: ${.ngrok.geo.country_code}"]
+      add: ["is-ngrok: 1", "country: ${conn.geo.country_code}"]
       remove: ["referrer"]
 ```
diff --git a/examples/go-sdk/http-request-headers.mdx b/examples/go-sdk/http-request-headers.mdx
@@ -11,7 +11,7 @@ func ngrokListener(ctx context.Context) (net.Listener, error) {
 	return ngrok.Listen(ctx,
 		config.HTTPEndpoint(
 			config.WithRequestHeader("is-ngrok", "1"),
-			config.WithRequestHeader("country", "${.ngrok.geo.country_code}"),
+			config.WithRequestHeader("country", "${conn.geo.country_code}"),
 			config.WithRemoveRequestHeader("referrer"),
 		),
 		ngrok.WithAuthtokenFromEnv(),

diff --git a/examples/javascript-sdk/http-request-headers.mdx b/examples/javascript-sdk/http-request-headers.mdx
@@ -5,7 +5,7 @@ const ngrok = require("@ngrok/ngrok");
 	const listener = await ngrok.forward({
 		addr: 8080,
 		authtoken_from_env: true,
-		request_header_add: ["is-ngrok:1", "country:${.ngrok.geo.country_code}"],
+		request_header_add: ["is-ngrok:1", "country:${conn.geo.country_code}"],
 		request_header_remove: "referrer",
 	});
 

diff --git a/examples/k8s/http-request-headers.mdx b/examples/k8s/http-request-headers.mdx
@@ -8,7 +8,7 @@ modules:
     request:
       add:
         is-ngrok: "1"
-        country: "${.ngrok.geo.country_code}"
+        country: "${conn.geo.country_code}"
       remove: ["referrer"]
 ---
 apiVersion: networking.k8s.io/v1

diff --git a/examples/python-sdk/http-request-headers.mdx b/examples/python-sdk/http-request-headers.mdx
@@ -2,7 +2,7 @@
 import ngrok
 
 listener = ngrok.forward("localhost:8080", authtoken_from_env=True,
-    request_header_add=["is-ngrok:1", "country:${.ngrok.geo.country_code}"],
+    request_header_add=["is-ngrok:1", "country:${conn.geo.country_code}"],
     request_header_remove="referrer")
 
 print(f"Ingress established at: {listener.url()}");

diff --git a/examples/rust-sdk/http-request-headers.mdx b/examples/rust-sdk/http-request-headers.mdx
@@ -10,7 +10,7 @@ async fn listen_ngrok() -> anyhow::Result<impl Tunnel> {
     let tun = sess
         .http_endpoint()
         .request_header("is-ngrok", "1")
-        .request_header("country", "${.ngrok.geo.country_code}")
+        .request_header("country", "${conn.geo.country_code}")
         .remove_request_header("referrer")
         .listen()
         .await?;

diff --git a/examples/ssh/http-request-headers.mdx b/examples/ssh/http-request-headers.mdx
@@ -1,6 +1,6 @@
 ```bash
 ssh -R 443:localhost:80 [email protected] http \
   --request-header-add='is-ngrok: 1' \
-  --request-header-add='country: ${.ngrok.geo.country_code}' \
+  --request-header-add='country: ${conn.geo.country_code}' \
   --request-header-remove='referrer'
 ```
diff --git a/src/components/VariableInterpolation.tsx b/src/components/VariableInterpolation.tsx
@@ -3,7 +3,7 @@ import ConfigExample from "../../src/components/ConfigExample.tsx";
 
 export const config = {
 	headers: {
-		country: "${.ngrok.geo.country_code}",
+		country: "${conn.geo.country_code}",
 	},
 };