awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: make --relay flag optional

Browse Source
This commit is contained in:
x032205
2025-11-05 15:49:55 -05:00
parent 190717e134
commit feabdbf559
2 changed files with 57 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/documentation/platform/gateways/gateway-deployment.mdx
View File

@@ -122,11 +122,13 @@ To successfully deploy an Infisical Gateway for use, follow these steps in order
<Tab title="Linux Server (Production)">
For production deployments on Linux servers, install the Gateway as a systemd service so that it runs securely in the background and automatically restarts on failure or system reboot:
```bash
sudo infisical gateway systemd install --token <your-machine-identity-token> --domain <your-infisical-domain> --name <gateway-name> --relay <relay-name>
sudo infisical gateway systemd install --token <your-machine-identity-token> --domain <your-infisical-domain> --name <gateway-name>
sudo systemctl start infisical-gateway
```
<Info>
By default, the gateway connects to the most optimal relay. Use the `--relay` flag to manually specify a different relay server.
</Info>
<Warning>
The systemd install command requires a Linux operating system with root/sudo
@@ -153,10 +155,13 @@ To successfully deploy an Infisical Gateway for use, follow these steps in order
--from-literal=INFISICAL_AUTH_METHOD=universal-auth \
--from-literal=INFISICAL_UNIVERSAL_AUTH_CLIENT_ID=<client-id> \
--from-literal=INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET=<client-secret> \
--from-literal=INFISICAL_RELAY_NAME=<relay-name> \
--from-literal=INFISICAL_GATEWAY_NAME=<gateway-name>
```
<Info>
By default, the gateway connects to the most optimal relay. Use the `--from-literal=INFISICAL_RELAY_NAME=<relay-name>` flag to manually specify a different relay server.
</Info>
#### Install the Gateway
```bash
@@ -168,8 +173,12 @@ To successfully deploy an Infisical Gateway for use, follow these steps in order
For development or testing environments:
```bash
infisical gateway start --token <token> --relay=<relay-name> --name=<gateway-name>
infisical gateway start --token <token> --name=<gateway-name>
```
<Info>
By default, the gateway connects to the most optimal relay. Use the `--relay` flag to manually specify a different relay server.
</Info>
</Tab>
</Tabs>
</Step>