Stay organized with collections
Save and categorize content based on your preferences.
Name
kf proxy - Start a local reverse proxy to an App.
Synopsis
kf proxy APP_NAME [flags]
Description
Proxy creates a reverse HTTP proxy to the cluster's gateway on a local
port opened on the operating system's loopback device.
The proxy rewrites all HTTP requests, changing the HTTP Host header
and adding an additional header X-Kf-App to ensure traffic reaches
the specified App even if multiple are attached to the same route.
Proxy does not establish a direct connection to the App.
For proxy to work:
The cluster's gateway must be accessible from your local machine.
The App must have a public URL
If you need to establish a direct connection to an App, use the
port-forward command in kubectl. It establishes a proxied connection
directly to a port on a pod via the Kubernetes cluster. port-forward
bypasses all routing.
Examples
kf proxy myapp
Flags
--gateway=string
IP address of the HTTP gateway to route requests to.
-h, --help
help for proxy
--port=int
Local port to listen on. (default 8080)
Inherited flags
These flags are inherited from parent commands.
--as=string
Username to impersonate for the operation.
--as-group=strings
Group to impersonate for the operation. Include this flag multiple times to specify multiple groups.
--config=string
Path to the Kf config file to use for CLI requests.
--kubeconfig=string
Path to the kubeconfig file to use for CLI requests.
--log-http
Log HTTP requests to standard error.
--space=string
Space to run the command against. This flag overrides the currently targeted Space.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# kf proxy\n\n### Name\n\n`kf proxy` - Start a local reverse proxy to an App.\n\n### Synopsis\n\n```\nkf proxy APP_NAME [flags]\n```\n\n### Description\n\nProxy creates a reverse HTTP proxy to the cluster's gateway on a local\nport opened on the operating system's loopback device.\n\nThe proxy rewrites all HTTP requests, changing the HTTP Host header\nand adding an additional header X-Kf-App to ensure traffic reaches\nthe specified App even if multiple are attached to the same route.\n\nProxy does not establish a direct connection to the App.\n\nFor proxy to work:\n\n- The cluster's gateway must be accessible from your local machine.\n- The App must have a public URL\n\nIf you need to establish a direct connection to an App, use the\nport-forward command in kubectl. It establishes a proxied connection\ndirectly to a port on a pod via the Kubernetes cluster. port-forward\nbypasses all routing.\n\n### Examples\n\n```\nkf proxy myapp\n```\n\n### Flags\n\n`--gateway=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n\n: IP address of the HTTP gateway to route requests to.\n\n`-h, --help`\n\n: help for proxy\n\n`--port=`\u003cvar translate=\"no\"\u003eint\u003c/var\u003e\n\n: Local port to listen on. (default 8080)\n\n### Inherited flags\n\nThese flags are inherited from parent commands.\n\n`--as=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n\n: Username to impersonate for the operation.\n\n`--as-group=`\u003cvar translate=\"no\"\u003estrings\u003c/var\u003e\n\n: Group to impersonate for the operation. Include this flag multiple times to specify multiple groups.\n\n`--config=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n\n: Path to the Kf config file to use for CLI requests.\n\n`--kubeconfig=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n\n: Path to the kubeconfig file to use for CLI requests.\n\n`--log-http`\n\n: Log HTTP requests to standard error.\n\n`--space=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n\n: Space to run the command against. This flag overrides the currently targeted Space."]]
