awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-10-10 12:28:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

add sudo to gateway start command examples

Browse Source
This commit is contained in:
x032205
2025-11-05 15:59:24 -05:00
parent e0c50fdfc6
commit f27708bcf6
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/commands/gateway.mdx
+14 -14
View File
@@ -6,7 +6,7 @@ description: "Run the Infisical gateway or manage its systemd service"
<Tabs> <Tabs>
<Tab title="Start gateway"> <Tab title="Start gateway">
```bash ```bash
infisical gateway start --name=<name> --auth-method=<auth-method> sudo infisical gateway start --name=<name> --auth-method=<auth-method>
``` ```
</Tab> </Tab>
<Tab title="Start gateway as background daemon (Linux only)"> <Tab title="Start gateway as background daemon (Linux only)">
@@ -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. 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 ```bash
infisical gateway start --name=<name> --auth-method=<auth-method> sudo infisical gateway start --name=<name> --auth-method=<auth-method>
``` ```
<Info> <Info>
@@ -74,7 +74,7 @@ The gateway supports multiple authentication methods. Below are the available au
</ParamField> </ParamField>
```bash ```bash
infisical gateway start --auth-method=universal-auth --client-id=<client-id> --client-secret=<client-secret> --name=<name> sudo infisical gateway start --auth-method=universal-auth --client-id=<client-id> --client-secret=<client-secret> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -98,7 +98,7 @@ The gateway supports multiple authentication methods. Below are the available au
```bash ```bash
infisical gateway start --auth-method=kubernetes --machine-identity-id=<machine-identity-id> --name=<name> sudo infisical gateway start --auth-method=kubernetes --machine-identity-id=<machine-identity-id> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -119,7 +119,7 @@ The gateway supports multiple authentication methods. Below are the available au
```bash ```bash
infisical gateway start --auth-method=azure --machine-identity-id=<machine-identity-id> --name=<name> sudo infisical gateway start --auth-method=azure --machine-identity-id=<machine-identity-id> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -140,7 +140,7 @@ The gateway supports multiple authentication methods. Below are the available au
```bash ```bash
infisical gateway start --auth-method=gcp-id-token --machine-identity-id=<machine-identity-id> --name=<name> sudo infisical gateway start --auth-method=gcp-id-token --machine-identity-id=<machine-identity-id> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -162,7 +162,7 @@ The gateway supports multiple authentication methods. Below are the available au
</ParamField> </ParamField>
```bash ```bash
infisical gateway start --auth-method=gcp-iam --machine-identity-id=<machine-identity-id> --service-account-key-file-path=<service-account-key-file-path> --name=<name> sudo infisical gateway start --auth-method=gcp-iam --machine-identity-id=<machine-identity-id> --service-account-key-file-path=<service-account-key-file-path> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -181,7 +181,7 @@ The gateway supports multiple authentication methods. Below are the available au
</ParamField> </ParamField>
```bash ```bash
infisical gateway start --auth-method=aws-iam --machine-identity-id=<machine-identity-id> --name=<name> sudo infisical gateway start --auth-method=aws-iam --machine-identity-id=<machine-identity-id> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -203,7 +203,7 @@ The gateway supports multiple authentication methods. Below are the available au
</ParamField> </ParamField>
```bash ```bash
infisical gateway start --auth-method=oidc-auth --machine-identity-id=<machine-identity-id> --jwt=<oidc-jwt> --name=<name> sudo infisical gateway start --auth-method=oidc-auth --machine-identity-id=<machine-identity-id> --jwt=<oidc-jwt> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -227,7 +227,7 @@ The gateway supports multiple authentication methods. Below are the available au
```bash ```bash
infisical gateway start --auth-method=jwt-auth --jwt=<jwt> --machine-identity-id=<machine-identity-id> --name=<name> sudo infisical gateway start --auth-method=jwt-auth --jwt=<jwt> --machine-identity-id=<machine-identity-id> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -243,7 +243,7 @@ The gateway supports multiple authentication methods. Below are the available au
</ParamField> </ParamField>
```bash ```bash
infisical gateway start --token=<token> --name=<name> sudo infisical gateway start --token=<token> --name=<name>
``` ```
</Accordion> </Accordion>
@@ -259,7 +259,7 @@ The gateway supports multiple authentication methods. Below are the available au
```bash ```bash
# Example # Example
infisical gateway start --relay=my-relay --name=my-gateway --token=<token> sudo infisical gateway start --relay=my-relay --name=my-gateway --token=<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. **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 ```bash
# Example # Example
infisical gateway start --name=my-gateway --token=<token> sudo infisical gateway start --name=my-gateway --token=<token>
``` ```
</Accordion> </Accordion>
@@ -281,7 +281,7 @@ The gateway supports multiple authentication methods. Below are the available au
```bash ```bash
# Example # Example
infisical gateway start --domain=https://app.your-domain.com --name=<name> sudo infisical gateway start --domain=https://app.your-domain.com --name=<name>
``` ```
</Accordion> </Accordion>
docs/documentation/platform/gateways/gateway-deployment.mdx
+1 -1
View File
@@ -173,7 +173,7 @@ To successfully deploy an Infisical Gateway for use, follow these steps in order
For development or testing environments: For development or testing environments:
```bash ```bash
infisical gateway start --token <token> --name=<gateway-name> sudo infisical gateway start --token <token> --name=<gateway-name>
``` ```
<Info> <Info>
frontend/src/pages/organization/NetworkingPage/components/GatewayTab/components/GatewayCliDeploymentMethod.tsx
+1 -1
View File
@@ -184,7 +184,7 @@ export const GatewayCliDeploymentMethod = () => {
const command = useMemo(() => { const command = useMemo(() => {
const relayPart = relay?.id !== "_auto" ? ` --relay=${relay?.name || ""}` : ""; 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]); }, [name, relay, identityToken, siteURL]);
if (step === "command") { if (step === "command") {