github/infisical
1
0
Fork 0
mirror of https://github.com/Infisical/infisical.git synced 2026-01-10 07:58:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

edits to cli commands - gateway/relay

Browse Source
This commit is contained in:
Maidul Islam
2025-09-19 09:47:55 -04:00
parent 040fa8c3f9
commit 3b718fa205
2 changed files with 16 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/cli/commands/gateway.mdx
View File

@@ -25,29 +25,29 @@ The gateway system uses SSH reverse tunnels over TCP, eliminating firewall compl
<Warning>
**Deprecation and Migration Notice:** The legacy `infisical gateway` command (v1) will be removed in a future release. Please migrate to `infisical gateway start` (Gateway v2).
If you are moving from Gateway v1 to Gateway v2, this is NOT a drop-in switch. Gateway v2 creates new gateway instances with new gateway IDs. You must update any existing resources that reference gateway IDs (for example: dynamic secret configs, app connections, or other gateway-bound resources) to point to the new Gateway v2 gateway ID. Until you update those references, traffic will continue to target the old v1 gateway.
If you are moving from Gateway v1 to Gateway v2, this is NOT a drop-in switch. Gateway v2 creates new gateway instances with new gateway IDs. You must update any existing resources that reference gateway IDs (for example: dynamic secret configs, app connections, or other gateway-bound resources) to point to the new Gateway v2 gateway resource. Until you update those references, traffic will continue to target the old v1 gateway.
</Warning>
## Subcommands & flags
<Accordion title="infisical gateway start" defaultOpen="true">
Run the Infisical gateway component within your VPC. The gateway establishes an SSH reverse tunnel to the specified relay server and provides secure access to private resources.
Run the Infisical gateway component within your the network where your target resources are located. The gateway establishes an SSH reverse tunnel to the specified relay server and provides secure access to private resources within your network.
```bash
infisical gateway start --relay=<relay-name> --name=<name> --auth-method=<auth-method>
```
The gateway component:
Once started, the gateway component will:
- Establishes outbound SSH reverse tunnels to relay servers (no inbound firewall rules needed)
- Authenticates using SSH certificates issued by Infisical
- Automatically reconnects if the connection is lost
- Provides access to private resources within your network
- Establish outbound SSH reverse tunnels to relay servers (no inbound firewall rules needed)
- Authenticate using SSH certificates issued by Infisical
- Automatically reconnect if the connection is lost
- Provide access to private resources within your network
### Authentication
The Infisical CLI supports multiple authentication methods. Below are the available authentication methods, with their respective flags.
The Relay supports multiple authentication methods. Below are the available authentication methods, with their respective flags.
<AccordionGroup>
<Accordion title="Universal Auth">
@@ -361,11 +361,11 @@ sudo systemctl disable infisical-gateway # Disable auto-start on boot
</Accordion>
## Legacy Gateway Commands (Deprecated)
## Legacy Gateway Commands
<Accordion title="infisical gateway (deprecated)">
<Accordion title="infisical gateway">
<Warning>
**This command is deprecated and will be removed in a future release.**
**This command is to be deprecated and will be removed in a future release.**
Please migrate to `infisical gateway start` for the new TCP-based SSH tunnel architecture.
@@ -590,10 +590,10 @@ The Infisical CLI supports multiple authentication methods. Below are the availa
</Accordion>
</Accordion>
<Accordion title="infisical gateway install (deprecated)">
<Accordion title="infisical gateway install">
<Warning>
**This command is deprecated and will be removed in a future release.**
**This command is to be deprecated and will be removed in a future release.**
Please migrate to `infisical gateway systemd install` for the new TCP-based SSH tunnel architecture with enhanced security and better performance.
**Migration required:** If you previously installed Gateway v1 via `infisical gateway install`, moving to Gateway v2 is not in-place. Gateway v2 provisions new gateway instances with new gateway IDs. Update any resources that reference a gateway ID (for example: dynamic secret configs, app connections, or other gateway-bound resources) to use the new Gateway v2 gateway ID. Until you update those references, traffic will continue to target the old v1 gateway.

6
docs/cli/commands/relay.mdx
View File

@@ -24,8 +24,6 @@ description: "Relay-related commands for Infisical"
Relay-related commands for Infisical that provide identity-aware relay infrastructure for routing encrypted traffic. Relays are organization-deployed servers that route encrypted traffic between Infisical and your gateways.
The relay system uses SSH reverse tunnels over TCP, eliminating firewall complexity and providing excellent performance for enterprise environments.
## Subcommands & flags
<Accordion title="infisical relay start" defaultOpen="true">
@@ -51,7 +49,7 @@ infisical relay start --host=<host> --name=<name> --auth-method=<auth-method>
</Accordion>
<Accordion title="--name">
The name of the relay.
The name of the relay. This is an arbitrary identifier for your relay instance.
```bash
# Example
@@ -69,7 +67,7 @@ Relays support all standard Infisical authentication methods. Choose the authent
infisical relay start --host=192.168.1.100 --name=my-relay --auth-method=universal-auth --client-id=<client-id> --client-secret=<client-secret>
```
### Authentication Methods
### Available Authentication Methods
The Infisical CLI supports multiple authentication methods for relays. Below are the available authentication methods, with their respective flags.