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

docs: wrap accordions in accordiongroup for CLI reference

Browse Source
This commit is contained in:
x032205
2025-10-20 17:53:54 -04:00
parent 430f81f1cb
commit 57fc8cdaec
2 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -31,6 +31,7 @@ If you are moving from Gateway v1 to Gateway v2, this is NOT a drop-in switch. G
## Subcommands & flags
<AccordionGroup>
<Accordion title="infisical gateway start" defaultOpen="true">
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.
@@ -245,6 +246,7 @@ The Relay supports multiple authentication methods. Below are the available auth
### Other Flags
<AccordionGroup>
<Accordion title="--relay">
The name of the relay that this gateway should connect to. The relay must be running and registered before starting the gateway.
@@ -276,6 +278,7 @@ The Relay supports multiple authentication methods. Below are the available auth
```
</Accordion>
</AccordionGroup>
</Accordion>
<Accordion title="infisical gateway systemd install">
@@ -293,6 +296,7 @@ sudo infisical gateway systemd install --token=<token> --domain=<domain> --name=
### Flags
<AccordionGroup>
<Accordion title="--token">
The machine identity access token to authenticate with Infisical.
@@ -334,6 +338,7 @@ sudo infisical gateway systemd install --token=<token> --domain=<domain> --name=
```
</Accordion>
</AccordionGroup>
### Service Details
@@ -360,9 +365,11 @@ sudo systemctl disable infisical-gateway # Disable auto-start on boot
```
</Accordion>
</AccordionGroup>
## Legacy Gateway Commands
<AccordionGroup>
<Accordion title="infisical gateway (deprecated)">
<Warning>
**This command is deprecated and will be removed in a future release.**
@@ -579,6 +586,7 @@ The Infisical CLI supports multiple authentication methods. Below are the availa
### Other Flags
<AccordionGroup>
<Accordion title="--domain">
Domain of your self-hosted Infisical instance.
@@ -588,6 +596,7 @@ The Infisical CLI supports multiple authentication methods. Below are the availa
```
</Accordion>
</AccordionGroup>
</Accordion>
<Accordion title="infisical gateway install (deprecated)">
@@ -614,6 +623,7 @@ sudo infisical gateway install --token=<token> --domain=<domain>
### Flags
<AccordionGroup>
<Accordion title="--token">
The machine identity access token to authenticate with Infisical.
@@ -635,6 +645,7 @@ sudo infisical gateway install --token=<token> --domain=<domain>
```
</Accordion>
</AccordionGroup>
### Service Details
@@ -659,3 +670,4 @@ sudo systemctl disable infisical-gateway # Disable auto-start on boot
```
</Accordion>
</AccordionGroup>

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

@@ -13,7 +13,7 @@ description: "Relay-related commands for Infisical"
```bash
# Install systemd service
sudo infisical relay systemd install --host=<host> --name=<name> --token=<token>
# Uninstall systemd service
sudo infisical relay systemd uninstall
```
@@ -26,6 +26,7 @@ Relay-related commands for Infisical that provide identity-aware relay infrastru
## Subcommands & flags
<AccordionGroup>
<Accordion title="infisical relay start" defaultOpen="true">
Run the Infisical relay component. The relay handles network traffic routing between Infisical and your gateways.
@@ -35,6 +36,7 @@ infisical relay start --host=<host> --name=<name> --auth-method=<auth-method>
### Flags
<AccordionGroup>
<Accordion title="--host">
The host (IP address or hostname) of the instance where the relay is deployed. This must be a static public IP or resolvable hostname that gateways can reach.
@@ -57,6 +59,7 @@ infisical relay start --host=<host> --name=<name> --auth-method=<auth-method>
```
</Accordion>
</AccordionGroup>
### Authentication
@@ -280,6 +283,7 @@ infisical relay systemd <subcommand>
### Subcommands
<AccordionGroup>
<Accordion title="install">
Install and enable systemd service for the relay. Must be run with sudo on Linux systems.
@@ -289,6 +293,7 @@ sudo infisical relay systemd install --host=<host> --name=<name> --token=<token>
#### Flags
<AccordionGroup>
<Accordion title="--host">
The host (IP address or hostname) of the instance where the relay is deployed. This must be a static public IP or resolvable hostname that gateways can reach.
@@ -331,6 +336,7 @@ sudo infisical relay systemd install --domain=http://localhost:8080 --token=<tok
```
</Accordion>
</AccordionGroup>
#### Examples
@@ -386,5 +392,7 @@ sudo infisical relay systemd uninstall
- Cleans up the service configuration
</Accordion>
</AccordionGroup>
</Accordion>
</AccordionGroup>