diff --git a/docs/documentation/platform/gateways/overview.mdx b/docs/documentation/platform/gateways/overview.mdx new file mode 100644 index 000000000..304fb87db --- /dev/null +++ b/docs/documentation/platform/gateways/overview.mdx @@ -0,0 +1,79 @@ +--- +title: "Gateway" +sidebarTitle: "Overview" +description: "Learn how to provide access on private resources to Infisical." +--- + + + Note that Gateway is a paid feature. + + If you're using Infisical Cloud, then it is available under the **Enterprise Tier** + If you're self-hosting Infisical, then you should contact sales@infisical.com to purchase an enterprise license to use it. + + + +## Introduction + +Gateway is Infisical's solution for providing secure access to your private resources without exposing them to the internet. + +By "without exposing," we mean that your resources remain completely closed to inbound connections - no SSH ports, no TCP ports are open. +This level of security ensures that even port scanning cannot detect your resources. + +## How It Works + +A gateway is a simple server that acts as a bridge for direct communication between the Infisical server and your private, closed resources (such as databases). + +When deployed, the gateway establishes a connection with the relay server. Infisical then communicates with your gateway through these relays. +All communication between Infisical and the gateway is end-to-end encrypted, ensuring that only the platform and your gateway can decrypt the transmitted information. + +## Deployment + +You can easily deploy a gateway using the Infisical CLI by following these steps: + + + + 1. Navigate to your **Organization Access Control**. + 2. Create a dedicated identity for the gateway. + 3. Best practice: Use one unique identity per gateway. + ![create-gateway](../../../images/platform/gateways/create-identity-for-gateway.png) + + + + Set up authentication by following the [Identity Auth Method Configuration](../identities/universal-auth) guide. + + + + 1. Deploy the gateway using Infisical CLI with this command: + ```bash + INFISICAL_TOKEN=$(infisical login ...) infisical gateway + ``` + + Verify that the deployed gateway has access to your private resources + + + + + 1. Check the gateway log to have **Gateway started successfully** + + 2. Navigate to **Gateways** list page in Org Access Control + ![list-gateway](../../../images/platform/gateways/gateway-list.png) + + + +## Using Your Gateway + +### Configuring Dynamic Secrets + +To use your gateway with dynamic secrets: + +1. Navigate to your dynamic secret provider settings +2. Under **Gateway** options, switch from **Internet Gateway** to your deployed gateway + ![dynamic-secret-gateway](../../../images/platform/gateways/dynamic-secret.png) + +### Supported Providers + +Currently, gateways are supported for the following dynamic secret providers: + +- SQL Database Providers (MySQL, PostgreSQL, etc.) + +Additional provider support will be added in future updates. diff --git a/docs/images/platform/gateways/create-identity-for-gateway.png b/docs/images/platform/gateways/create-identity-for-gateway.png new file mode 100644 index 000000000..d7ef6b02a Binary files /dev/null and b/docs/images/platform/gateways/create-identity-for-gateway.png differ diff --git a/docs/images/platform/gateways/dynamic-secret.png b/docs/images/platform/gateways/dynamic-secret.png new file mode 100644 index 000000000..bf742413e Binary files /dev/null and b/docs/images/platform/gateways/dynamic-secret.png differ diff --git a/docs/images/platform/gateways/gateway-list.png b/docs/images/platform/gateways/gateway-list.png new file mode 100644 index 000000000..11f8206fe Binary files /dev/null and b/docs/images/platform/gateways/gateway-list.png differ diff --git a/docs/mint.json b/docs/mint.json index 62e40e1c9..9a355bcdf 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -201,6 +201,10 @@ "documentation/platform/dynamic-secrets/totp" ] }, + { + "group": "Gateway", + "pages": ["documentation/platform/gateways/overview"] + }, "documentation/platform/project-templates", { "group": "Workflow Integrations",