From f27708bcf60539a5dc39169a93b8592ca71214f1 Mon Sep 17 00:00:00 2001 From: x032205 Date: Wed, 5 Nov 2025 15:59:24 -0500 Subject: [PATCH] add sudo to gateway start command examples --- docs/cli/commands/gateway.mdx | 28 +++++++++---------- .../platform/gateways/gateway-deployment.mdx | 2 +- .../components/GatewayCliDeploymentMethod.tsx | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/cli/commands/gateway.mdx b/docs/cli/commands/gateway.mdx index d7e9bb768..028c97e05 100644 --- a/docs/cli/commands/gateway.mdx +++ b/docs/cli/commands/gateway.mdx @@ -6,7 +6,7 @@ description: "Run the Infisical gateway or manage its systemd service" ```bash - infisical gateway start --name= --auth-method= + sudo infisical gateway start --name= --auth-method= ``` @@ -36,7 +36,7 @@ If you are moving from Gateway v1 to Gateway v2, this is NOT a drop-in switch. G Run the Infisical gateway component within your the network where your target resources are located. The gateway establishes an SSH reverse tunnel to a relay server and provides secure access to private resources within your network. ```bash -infisical gateway start --name= --auth-method= +sudo infisical gateway start --name= --auth-method= ``` @@ -74,7 +74,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=universal-auth --client-id= --client-secret= --name= + sudo infisical gateway start --auth-method=universal-auth --client-id= --client-secret= --name= ``` @@ -98,7 +98,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=kubernetes --machine-identity-id= --name= + sudo infisical gateway start --auth-method=kubernetes --machine-identity-id= --name= ``` @@ -119,7 +119,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=azure --machine-identity-id= --name= + sudo infisical gateway start --auth-method=azure --machine-identity-id= --name= ``` @@ -140,7 +140,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=gcp-id-token --machine-identity-id= --name= + sudo infisical gateway start --auth-method=gcp-id-token --machine-identity-id= --name= ``` @@ -162,7 +162,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=gcp-iam --machine-identity-id= --service-account-key-file-path= --name= + sudo infisical gateway start --auth-method=gcp-iam --machine-identity-id= --service-account-key-file-path= --name= ``` @@ -181,7 +181,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=aws-iam --machine-identity-id= --name= + sudo infisical gateway start --auth-method=aws-iam --machine-identity-id= --name= ``` @@ -203,7 +203,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=oidc-auth --machine-identity-id= --jwt= --name= + sudo infisical gateway start --auth-method=oidc-auth --machine-identity-id= --jwt= --name= ``` @@ -227,7 +227,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --auth-method=jwt-auth --jwt= --machine-identity-id= --name= + sudo infisical gateway start --auth-method=jwt-auth --jwt= --machine-identity-id= --name= ``` @@ -243,7 +243,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash - infisical gateway start --token= --name= + sudo infisical gateway start --token= --name= ``` @@ -259,7 +259,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash # Example - infisical gateway start --relay=my-relay --name=my-gateway --token= + sudo infisical gateway start --relay=my-relay --name=my-gateway --token= ``` **Note:** If using organization relays or self-hosted instance relays, you must first start a relay server using `infisical relay start` before connecting gateways to it. For Infisical Cloud users using instance relays, the relay infrastructure is already running and managed by Infisical. @@ -271,7 +271,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash # Example - infisical gateway start --name=my-gateway --token= + sudo infisical gateway start --name=my-gateway --token= ``` @@ -281,7 +281,7 @@ The gateway supports multiple authentication methods. Below are the available au ```bash # Example - infisical gateway start --domain=https://app.your-domain.com --name= + sudo infisical gateway start --domain=https://app.your-domain.com --name= ``` diff --git a/docs/documentation/platform/gateways/gateway-deployment.mdx b/docs/documentation/platform/gateways/gateway-deployment.mdx index 5c25914c0..c7b8763c2 100644 --- a/docs/documentation/platform/gateways/gateway-deployment.mdx +++ b/docs/documentation/platform/gateways/gateway-deployment.mdx @@ -173,7 +173,7 @@ To successfully deploy an Infisical Gateway for use, follow these steps in order For development or testing environments: ```bash - infisical gateway start --token --name= + sudo infisical gateway start --token --name= ``` diff --git a/frontend/src/pages/organization/NetworkingPage/components/GatewayTab/components/GatewayCliDeploymentMethod.tsx b/frontend/src/pages/organization/NetworkingPage/components/GatewayTab/components/GatewayCliDeploymentMethod.tsx index 17818f307..fd2e9b444 100644 --- a/frontend/src/pages/organization/NetworkingPage/components/GatewayTab/components/GatewayCliDeploymentMethod.tsx +++ b/frontend/src/pages/organization/NetworkingPage/components/GatewayTab/components/GatewayCliDeploymentMethod.tsx @@ -184,7 +184,7 @@ export const GatewayCliDeploymentMethod = () => { const command = useMemo(() => { const relayPart = relay?.id !== "_auto" ? ` --relay=${relay?.name || ""}` : ""; - return `infisical gateway start --name=${name}${relayPart} --domain=${siteURL} --token=${identityToken}`; + return `sudo infisical gateway start --name=${name}${relayPart} --domain=${siteURL} --token=${identityToken}`; }, [name, relay, identityToken, siteURL]); if (step === "command") {