Add Mintlify steps to integration pages

This commit is contained in:
Tuan Dang
2023-12-14 11:35:50 +07:00
parent 51cbfdbc46
commit f3767d3963
27 changed files with 1004 additions and 989 deletions
+14 -13
View File
@@ -7,25 +7,26 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Bitbucket">
Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for Bitbucket Press on the Bitbucket tile and grant Infisical access to your Bitbucket account.
Press on the Bitbucket tile and grant Infisical access to your Bitbucket account. ![integrations bitbucket authorization](../../images/integrations/bitbucket/integrations-bitbucket-auth.png)
![integrations bitbucket authorization](../../images/integrations/bitbucket/integrations-bitbucket-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Bitbucket repo and press start integration to start syncing secrets to the repo.
## Start integration ![integrations bitbucket](../../images/integrations/bitbucket/integrations-bitbucket.png)
</Step>
Select which Infisical environment secrets you want to sync to which Bitbucket repo and press start integration to start syncing secrets to the repo. </Steps>
![integrations bitbucket](../../images/integrations/bitbucket/integrations-bitbucket.png)
+17 -16
View File
@@ -7,30 +7,31 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for CircleCI">
Obtain an API token in User Settings > Personal API Tokens
![integrations](../../images/integrations.png) ![integrations circleci token](../../images/integrations/circleci/integrations-circleci-token.png)
## Authorize Infisical for CircleCI Navigate to your project's integrations tab in Infisical.
Obtain an API token in User Settings > Personal API Tokens ![integrations](../../images/integrations.png)
![integrations circleci token](../../images/integrations/circleci/integrations-circleci-token.png) Press on the CircleCI tile and input your CircleCI API token to grant Infisical access to your CircleCI account.
Press on the CircleCI tile and input your CircleCI API token to grant Infisical access to your CircleCI account. ![integrations circleci authorization](../../images/integrations/circleci/integrations-circleci-auth.png)
![integrations circleci authorization](../../images/integrations/circleci/integrations-circleci-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which CircleCI project and press create integration to start syncing secrets to CircleCI.
## Start integration ![create integration circleci](../../images/integrations/circleci/integrations-circleci-create.png)
![integrations circleci](../../images/integrations/circleci/integrations-circleci.png)
Select which Infisical environment secrets you want to sync to which CircleCI project and press create integration to start syncing secrets to CircleCI. </Step>
</Steps>
![create integration circleci](../../images/integrations/circleci/integrations-circleci-create.png)
![integrations circleci](../../images/integrations/circleci/integrations-circleci.png)
+18 -17
View File
@@ -7,31 +7,32 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Codefresh">
Obtain an API key in User Settings > API Keys
![integrations](../../images/integrations.png) ![integrations codefresh dashboard](../../images/integrations/codefresh/integrations-codefresh-dashboard.png)
![integrations codefresh token](../../images/integrations/codefresh/integrations-codefresh-token.png)
## Authorize Infisical for Codefresh Navigate to your project's integrations tab in Infisical.
Obtain an API key in User Settings > API Keys ![integrations](../../images/integrations.png)
![integrations codefresh dashboard](../../images/integrations/codefresh/integrations-codefresh-dashboard.png) Press on the Codefresh tile and input your Codefresh API key to grant Infisical access to your Codefresh account.
![integrations codefresh token](../../images/integrations/codefresh/integrations-codefresh-token.png)
Press on the Codefresh tile and input your Codefresh API key to grant Infisical access to your Codefresh account. ![integrations codefresh authorization](../../images/integrations/codefresh/integrations-codefresh-auth.png)
![integrations codefresh authorization](../../images/integrations/codefresh/integrations-codefresh-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Codefresh service and press create integration to start syncing secrets to Codefresh.
## Start integration ![create integration codefresh](../../images/integrations/codefresh/integrations-codefresh-create.png)
![integrations codefresh](../../images/integrations/codefresh/integrations-codefresh.png)
Select which Infisical environment secrets you want to sync to which Codefresh service and press create integration to start syncing secrets to Codefresh. </Step>
</Steps>
![create integration codefresh](../../images/integrations/codefresh/integrations-codefresh-create.png)
![integrations codefresh](../../images/integrations/codefresh/integrations-codefresh.png)
+24 -24
View File
@@ -7,40 +7,40 @@ description: "How to sync secrets from Infisical to GitHub Actions"
<Tab title="Usage"> <Tab title="Usage">
<Warning> <Warning>
Infisical can sync secrets to GitHub repo secrets only. If your repo uses environment secrets, then stay tuned with this [issue](https://github.com/Infisical/infisical/issues/54). Infisical can sync secrets to GitHub repo secrets only. If your repo uses environment secrets, then stay tuned with this [issue](https://github.com/Infisical/infisical/issues/54).
</Warning> </Warning>
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Ensure you have admin privileges to the repo you want to sync secrets to. - Ensure you have admin privileges to the repo you want to sync secrets to.
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for GitHub">
Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for GitHub Press on the GitHub tile and grant Infisical access to your GitHub account (repo privileges only).
Press on the GitHub tile and grant Infisical access to your GitHub account (repo privileges only). ![integrations github authorization](../../images/integrations/github/integrations-github-auth.png)
![integrations github authorization](../../images/integrations/github/integrations-github-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant Infisical access to your project's environment variables. If this is your project's first cloud integration, then you'll have to grant Infisical access to your project's environment variables.
Although this step breaks E2EE, it's necessary for Infisical to sync the environment variables to the cloud platform. Although this step breaks E2EE, it's necessary for Infisical to sync the environment variables to the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which GitHub repo and press start integration to start syncing secrets to the repo.
## Start integration ![integrations github](../../images/integrations/github/integrations-github.png)
</Step>
Select which Infisical environment secrets you want to sync to which GitHub repo and press start integration to start syncing secrets to the repo. </Steps>
![integrations github](../../images/integrations/github/integrations-github.png)
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the GitHub integration on a self-hosted instance of Infisical requires configuring an OAuth application in GitHub Using the GitHub integration on a self-hosted instance of Infisical requires configuring an OAuth application in GitHub
and registering your instance with it. and registering your instance with it.
<Steps>
## Create an OAuth application in GitHub <Step title="Create an OAuth application in GitHub">
Navigate to your user Settings > Developer settings > OAuth Apps to create a new GitHub OAuth application. Navigate to your user Settings > Developer settings > OAuth Apps to create a new GitHub OAuth application.
![integrations github config](../../images/integrations/github/integrations-github-config-settings.png) ![integrations github config](../../images/integrations/github/integrations-github-config-settings.png)
@@ -56,9 +56,8 @@ Select which Infisical environment secrets you want to sync to which GitHub repo
If you have a GitHub organization, you can create an OAuth application under it If you have a GitHub organization, you can create an OAuth application under it
in your organization Settings > Developer settings > OAuth Apps > New Org OAuth App. in your organization Settings > Developer settings > OAuth Apps > New Org OAuth App.
</Note> </Note>
</Step>
## Add your OAuth application credentials to Infisical <Step title="Add your OAuth application credentials to Infisical">
Obtain the **Client ID** and generate a new **Client Secret** for your GitHub OAuth application. Obtain the **Client ID** and generate a new **Client Secret** for your GitHub OAuth application.
![integrations github config](../../images/integrations/github/integrations-github-config-credentials.png) ![integrations github config](../../images/integrations/github/integrations-github-config-credentials.png)
@@ -69,7 +68,8 @@ Select which Infisical environment secrets you want to sync to which GitHub repo
- `CLIENT_SECRET_GITHUB`: The **Client Secret** of your GitHub OAuth application. - `CLIENT_SECRET_GITHUB`: The **Client Secret** of your GitHub OAuth application.
Once added, restart your Infisical instance and use the GitHub integration. Once added, restart your Infisical instance and use the GitHub integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+44 -44
View File
@@ -6,84 +6,84 @@ description: "How to sync secrets from Infisical to GitLab"
<Tabs> <Tabs>
<Tab title="Usage"> <Tab title="Usage">
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) <AccordionGroup>
<AccordionGroup>
<Accordion title="Standard"> <Accordion title="Standard">
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for GitLab">
Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for GitLab Press on the GitLab tile and grant Infisical access to your GitLab account.
Press on the GitLab tile and grant Infisical access to your GitLab account. ![integrations gitlab authorization](../../images/integrations/gitlab/integrations-gitlab-auth.png)
![integrations gitlab authorization](../../images/integrations/gitlab/integrations-gitlab-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
## Start integration </Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which GitLab repository and press create integration to start syncing secrets to GitLab.
Select which Infisical environment secrets you want to sync to which GitLab repository and press create integration to start syncing secrets to GitLab. ![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab-create.png)
![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab-create.png) Note that the GitLab integration supports a few options in the **Options** tab:
Note that the GitLab integration supports a few options in the **Options** tab: - Secret Prefix: If inputted, the prefix is appended to the front of every secret name prior to being synced.
- Secret Suffix: If inputted, the suffix to appended to the back of every name of every secret prior to being synced.
- Secret Prefix: If inputted, the prefix is appended to the front of every secret name prior to being synced. Setting a secret prefix or suffix ensures that existing secrets in GitLab are not overwritten during the sync. As part of this process, Infisical abstains from mutating any secrets in GitLab without the specified prefix or suffix.
- Secret Suffix: If inputted, the suffix to appended to the back of every name of every secret prior to being synced.
Setting a secret prefix or suffix ensures that existing secrets in GCP Secret Manager are not overwritten during the sync. As part of this process, Infisical abstains from mutating any secrets in GitLab without the specified prefix or suffix. ![integrations gitlab options](../../images/integrations/gitlab/integrations-gitlab-create-options.png)
![integrations gitlab options](../../images/integrations/gitlab/integrations-gitlab-create-options.png) ![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab.png)
</Step>
![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab.png) </Steps>
</Accordion> </Accordion>
<Accordion title="Pipeline"> <Accordion title="Pipeline">
## Generate service token <Steps>
<Step title="Authorize Infisical for GitLab">
Generate an [Infisical Token](/documentation/platform/token) for the specific project and environment in Infisical.
Generate an [Infisical Token](/documentation/platform/token) for the specific project and environment in Infisical. Next, create a new variable called `INFISICAL_TOKEN` with the value set to the token from the previous step in Settings > CI/CD > Variables of your GitLab repository.
</Step>
<Step title="Configure Infisical in your pipeline">
Edit your `.gitlab-ci.yml` to include the Infisical CLI installation. This will allow you to use the CLI for fetching and injecting secrets into any script or command within your Gitlab CI/CD process.
## Set the Infisical Token in Gitlab #### Example
Create a new variable called `INFISICAL_TOKEN` with the value set to the token from the previous step in Settings > CI/CD > Variables of your GitLab repository. ```yaml
image: ubuntu
## Configure Infisical in your pipeline stages:
Edit your `.gitlab-ci.yml` to include the Infisical CLI installation. This will allow you to use the CLI for fetching and injecting secrets into any script or command within your Gitlab CI/CD process.
#### Example
```yaml
image: ubuntu
stages:
- build - build
- test - test
- deploy - deploy
build-job: build-job:
stage: build stage: build
script: script:
- apt update && apt install -y curl - apt update && apt install -y curl
- curl -1sLf 'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.deb.sh' | bash - curl -1sLf 'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.deb.sh' | bash
- apt-get update && apt-get install -y infisical - apt-get update && apt-get install -y infisical
- infisical run -- npm run build - infisical run -- npm run build
``` ```
</Step>
</Steps>
</Accordion> </Accordion>
</AccordionGroup> </AccordionGroup>
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the GitLab integration on a self-hosted instance of Infisical requires configuring an application in GitLab Using the GitLab integration on a self-hosted instance of Infisical requires configuring an application in GitLab
and registering your instance with it. and registering your instance with it.
## Create an OAuth application in GitLab <Steps>
<Step title="Create an OAuth application in GitLab">
Navigate to your user Settings > Applications to create a new GitLab application. Navigate to your user Settings > Applications to create a new GitLab application.
![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-edit-profile.png) ![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-edit-profile.png)
@@ -97,9 +97,8 @@ build-job:
If you have a GitLab group, you can create an OAuth application under it If you have a GitLab group, you can create an OAuth application under it
in your group Settings > Applications. in your group Settings > Applications.
</Note> </Note>
</Step>
## Add your OAuth application credentials to Infisical <Step title="Add your OAuth application credentials to Infisical">
Obtain the **Application ID** and **Secret** for your GitLab application. Obtain the **Application ID** and **Secret** for your GitLab application.
![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-credentials.png) ![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-credentials.png)
@@ -110,7 +109,8 @@ build-job:
- `CLIENT_SECRET_GITLAB`: The **Secret** of your GitLab application. - `CLIENT_SECRET_GITLAB`: The **Secret** of your GitLab application.
Once added, restart your Infisical instance and use the GitLab integration. Once added, restart your Infisical instance and use the GitLab integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+17 -16
View File
@@ -7,30 +7,31 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Travis CI">
Obtain your API token in User Settings > API authentication > Token
![integrations](../../images/integrations.png) ![integrations travis ci token](../../images/integrations/travis-ci/integrations-travisci-token.png)
## Authorize Infisical for Travis CI Navigate to your project's integrations tab in Infisical.
Obtain your API token in User Settings > API authentication > Token ![integrations](../../images/integrations.png)
![integrations travis ci token](../../images/integrations/travis-ci/integrations-travisci-token.png) Press on the Travis CI tile and input your Travis CI API token to grant Infisical access to your Travis CI account.
Press on the Travis CI tile and input your Travis CI API token to grant Infisical access to your Travis CI account. ![integrations travis ci authorization](../../images/integrations/travis-ci/integrations-travisci-auth.png)
![integrations travis ci authorization](../../images/integrations/travis-ci/integrations-travisci-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Travis CI repository and press create integration to start syncing secrets to Travis CI.
## Start integration ![create integration travis ci](../../images/integrations/travis-ci/integrations-travisci-create.png)
![integrations travis ci](../../images/integrations/travis-ci/integrations-travisci.png)
Select which Infisical environment secrets you want to sync to which Travis CI repository and press create integration to start syncing secrets to Travis CI. </Step>
</Steps>
![create integration travis ci](../../images/integrations/travis-ci/integrations-travisci-create.png)
![integrations travis ci](../../images/integrations/travis-ci/integrations-travisci.png)
+32 -31
View File
@@ -8,18 +8,18 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Set up AWS and have/create an IAM user - Set up AWS and have/create an IAM user
## Grant the IAM user permissions to access AWS Parameter Store <Steps>
<Step title="Grant the IAM user permissions to access AWS Parameter Store">
Navigate to your IAM user permissions and add a permission policy to grant access to AWS Parameter Store.
Navigate to your IAM user permissions and add a permission policy to grant access to AWS Parameter Store. ![integration IAM 1](../../images/integrations/aws/integrations-aws-iam-1.png)
![integration IAM 2](../../images/integrations/aws/integrations-aws-parameter-store-iam-2.png)
![integrations IAM 3](../../images/integrations/aws/integrations-aws-parameter-store-iam-3.png)
![integration IAM 1](../../images/integrations/aws/integrations-aws-iam-1.png) For enhanced security, here's a custom policy containing the minimum permissions required by Infisical to sync secrets to AWS Parameter Store for the IAM user that you can use:
![integration IAM 2](../../images/integrations/aws/integrations-aws-parameter-store-iam-2.png)
![integrations IAM 3](../../images/integrations/aws/integrations-aws-parameter-store-iam-3.png)
For enhanced security, here's a custom policy containing the minimum permissions required by Infisical to sync secrets to AWS Parameter Store for the IAM user that you can use: ```json
{
```json
{
"Version": "2012-10-17", "Version": "2012-10-17",
"Statement": [ "Statement": [
{ {
@@ -34,42 +34,43 @@ For enhanced security, here's a custom policy containing the minimum permissions
"Resource": "*" "Resource": "*"
} }
] ]
} }
``` ```
</Step>
<Step title="Authorize Infisical for AWS Parameter store">
Obtain a AWS access key ID and secret access key for your IAM user in IAM > Users > User > Security credentials > Access keys
## Navigate to your project's integrations tab ![access key 1](../../images/integrations/aws/integrations-aws-access-key-1.png)
![access key 2](../../images/integrations/aws/integrations-aws-access-key-2.png)
![access key 3](../../images/integrations/aws/integrations-aws-access-key-3.png)
![integrations](../../images/integrations.png) Navigate to your project's integrations tab in Infisical.
## Authorize Infisical for AWS Parameter store ![integrations](../../images/integrations.png)
Obtain a AWS access key ID and secret access key for your IAM user in IAM > Users > User > Security credentials > Access keys Press on the AWS Parameter Store tile and input your AWS access key ID and secret access key from the previous step.
![access key 1](../../images/integrations/aws/integrations-aws-access-key-1.png) ![integration auth](../../images/integrations/aws/integrations-aws-parameter-store-auth.png)
![access key 2](../../images/integrations/aws/integrations-aws-access-key-2.png)
![access key 3](../../images/integrations/aws/integrations-aws-access-key-3.png)
Press on the AWS Parameter Store tile and input your AWS access key ID and secret access key from the previous step. <Info>
![integration auth](../../images/integrations/aws/integrations-aws-parameter-store-auth.png)
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which AWS Parameter Store region and indicate the path for your secrets. Then, press create integration to start syncing secrets to AWS Parameter Store.
## Start integration ![integration create](../../images/integrations/aws/integrations-aws-parameter-store-create.png)
Select which Infisical environment secrets you want to sync to which AWS Parameter Store region and indicate the path for your secrets. Then, press create integration to start syncing secrets to AWS Parameter Store. <Tip>
![integration create](../../images/integrations/aws/integrations-aws-parameter-store-create.png)
<Tip>
Infisical requires you to add a path for your secrets to be stored in AWS Infisical requires you to add a path for your secrets to be stored in AWS
Parameter Store and recommends setting the path structure to Parameter Store and recommends setting the path structure to
`/[project_name]/[environment]/` according to best practices. This enables a `/[project_name]/[environment]/` according to best practices. This enables a
secret like `TEST` to be stored as `/[project_name]/[environment]/TEST` in AWS secret like `TEST` to be stored as `/[project_name]/[environment]/TEST` in AWS
Parameter Store. Parameter Store.
</Tip> </Tip>
</Step>
</Steps>
+31 -31
View File
@@ -8,18 +8,18 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Set up AWS and have/create an IAM user - Set up AWS and have/create an IAM user
## Grant the IAM user permissions to access AWS Secrets Manager <Steps>
<Step title="Grant the IAM user permissions to access AWS Secrets Manager">
Navigate to your IAM user permissions and add a permission policy to grant access to AWS Secrets Manager.
Navigate to your IAM user permissions and add a permission policy to grant access to AWS Secrets Manager. ![integration IAM 1](../../images/integrations/aws/integrations-aws-iam-1.png)
![integration IAM 2](../../images/integrations/aws/integrations-aws-secret-manager-iam-2.png)
![integrations IAM 3](../../images/integrations/aws/integrations-aws-secret-manager-iam-3.png)
![integration IAM 1](../../images/integrations/aws/integrations-aws-iam-1.png) For better security, here's a custom policy containing the minimum permissions required by Infisical to sync secrets to AWS Secrets Manager for the IAM user that you can use:
![integration IAM 2](../../images/integrations/aws/integrations-aws-secret-manager-iam-2.png)
![integrations IAM 3](../../images/integrations/aws/integrations-aws-secret-manager-iam-3.png)
For better security, here's a custom policy containing the minimum permissions required by Infisical to sync secrets to AWS Secrets Manager for the IAM user that you can use: ```json
{
```json
{
"Version": "2012-10-17", "Version": "2012-10-17",
"Statement": [ "Statement": [
{ {
@@ -33,41 +33,41 @@ For better security, here's a custom policy containing the minimum permissions r
"Resource": "*" "Resource": "*"
} }
] ]
} }
``` ```
</Step>
<Step title="Authorize Infisical for AWS Secrets Manager">
Obtain a AWS access key ID and secret access key for your IAM user in IAM > Users > User > Security credentials > Access keys
## Navigate to your project's integrations tab ![access key 1](../../images/integrations/aws/integrations-aws-access-key-1.png)
![access key 2](../../images/integrations/aws/integrations-aws-access-key-2.png)
![access key 3](../../images/integrations/aws/integrations-aws-access-key-3.png)
![integrations](../../images/integrations.png) Navigate to your project's integrations tab in Infisical.
## Authorize Infisical for AWS Secrets Manager ![integrations](../../images/integrations.png)
Obtain a AWS access key ID and secret access key for your IAM user in IAM > Users > User > Security credentials > Access keys Press on the AWS Secrets Manager tile and input your AWS access key ID and secret access key from the previous step.
![access key 1](../../images/integrations/aws/integrations-aws-access-key-1.png) ![integration auth](../../images/integrations/aws/integrations-aws-secret-manager-auth.png)
![access key 2](../../images/integrations/aws/integrations-aws-access-key-2.png)
![access key 3](../../images/integrations/aws/integrations-aws-access-key-3.png)
Press on the AWS Secrets Manager tile and input your AWS access key ID and secret access key from the previous step. <Info>
![integration auth](../../images/integrations/aws/integrations-aws-secret-manager-auth.png)
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which AWS Secrets Manager region and under which secret name. Then, press create integration to start syncing secrets to AWS Secrets Manager.
## Start integration ![integration create](../../images/integrations/aws/integrations-aws-secret-manager-create.png)
Select which Infisical environment secrets you want to sync to which AWS Secrets Manager region and under which secret name. Then, press create integration to start syncing secrets to AWS Secrets Manager. <Info>
![integration create](../../images/integrations/aws/integrations-aws-secret-manager-create.png)
<Info>
Infisical currently syncs environment variables to AWS Secrets Manager as Infisical currently syncs environment variables to AWS Secrets Manager as
key-value pairs under one secret. We're actively exploring ways to help users key-value pairs under one secret. We're actively exploring ways to help users
group environment variable key-pairs under multiple secrets for greater group environment variable key-pairs under multiple secrets for greater
control. control.
</Info> </Info>
</Step>
</Steps>
+24 -24
View File
@@ -7,42 +7,43 @@ description: "How to sync secrets from Infisical to Azure Key Vault"
<Tab title="Usage"> <Tab title="Usage">
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Set up Azure and have an existing key vault - Set up Azure and have an existing key vault
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Azure Key Vault">
Navigate to your project's integrations tab
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for Azure Key Vault Press on the Azure Key Vault tile and grant Infisical access to Azure Key Vault.
</Step>
<Step title="Start integration">
Obtain the Vault URI of your key vault in the Overview tab.
Press on the Azure Key Vault tile and grant Infisical access to Azure Key Vault. ![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault-vault-uri.png)
## Start Integration Select which Infisical environment secrets you want to sync to your key vault. Then, input your Vault URI from the previous step. Finally, press create integration to start syncing secrets to Azure Key Vault.
Obtain the Vault URI of your key vault in the Overview tab. ![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault-create.png)
![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault-vault-uri.png) ![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault.png)
Select which Infisical environment secrets you want to sync to your key vault. Then, input your Vault URI from the previous step. Finally, press create integration to start syncing secrets to Azure Key Vault. <Info>
![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault-create.png)
![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault.png)
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
</Steps>
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the Azure KV integration on a self-hosted instance of Infisical requires configuring an application in Azure Using the Azure KV integration on a self-hosted instance of Infisical requires configuring an application in Azure
and registering your instance with it. and registering your instance with it.
## Create an application in Azure <Steps>
<Step title="Create an application in Azure">
Navigate to Azure Active Directory > App registrations to create a new application. Navigate to Azure Active Directory > App registrations to create a new application.
![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-aad.png) ![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-aad.png)
@@ -51,9 +52,8 @@ Select which Infisical environment secrets you want to sync to your key vault. T
Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/azure-key-vault/oauth2/callback`. Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/azure-key-vault/oauth2/callback`.
![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-new-app-form.png) ![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-new-app-form.png)
</Step>
## Add your application credentials to Infisical <Step title="Add your application credentials to Infisical">
Obtain the **Application (Client) ID** in Overview and generate a **Client Secret** in Certificate & secrets for your Azure application. Obtain the **Application (Client) ID** in Overview and generate a **Client Secret** in Certificate & secrets for your Azure application.
![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-credentials-1.png) ![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-credentials-1.png)
@@ -66,8 +66,8 @@ Select which Infisical environment secrets you want to sync to your key vault. T
- `CLIENT_SECRET_AZURE`: The **Client Secret** of your Azure application. - `CLIENT_SECRET_AZURE`: The **Client Secret** of your Azure application.
Once added, restart your Infisical instance and use the Azure KV integration. Once added, restart your Infisical instance and use the Azure KV integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+22 -21
View File
@@ -7,44 +7,45 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Checkly">
Obtain a Checkly API Key in User Settings > API Keys.
![integrations](../../images/integrations.png) ![integrations checkly dashboard](../../images/integrations/checkly/integrations-checkly-dashboard.png)
![integrations checkly token](../../images/integrations/checkly/integrations-checkly-token.png)
## Enter your Checkly API Key Navigate to your project's integrations tab in Infisical.
Obtain a Checkly API Key in User Settings > API Keys. ![integrations](../../images/integrations.png)
![integrations checkly dashboard](../../images/integrations/checkly/integrations-checkly-dashboard.png) Press on the Checkly tile and input your Checkly API Key to grant Infisical access to your Checkly account.
![integrations checkly token](../../images/integrations/checkly/integrations-checkly-token.png)
Press on the Checkly tile and input your Checkly API Key to grant Infisical access to your Checkly account. ![integrations checkly authorization](../../images/integrations/checkly/integrations-checkly-auth.png)
![integrations checkly authorization](../../images/integrations/checkly/integrations-checkly-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to Checkly and press create integration to start syncing secrets.
## Start integration ![integrations checkly](../../images/integrations/checkly/integrations-checkly-create.png)
Select which Infisical environment secrets you want to sync to Checkly and press create integration to start syncing secrets. <Note>
![integrations checkly](../../images/integrations/checkly/integrations-checkly-create.png)
<Note>
Infisical integrates with Checkly's environment variables at the **global** and **group** levels. Infisical integrates with Checkly's environment variables at the **global** and **group** levels.
To sync secrets to a specific group, you can select a group from the Checkly Group dropdown; otherwise, leaving it empty will sync secrets globally. To sync secrets to a specific group, you can select a group from the Checkly Group dropdown; otherwise, leaving it empty will sync secrets globally.
</Note> </Note>
![integrations checkly](../../images/integrations/checkly/integrations-checkly.png) ![integrations checkly](../../images/integrations/checkly/integrations-checkly.png)
<Info> <Info>
In the new version of the Checkly integration, you are able to specify suffixes that depend on the secrets' environment and path. In the new version of the Checkly integration, you are able to specify suffixes that depend on the secrets' environment and path.
If you choose to do so, you should utilize such suffixes for ALL Checkly integrations – otherwise the integration system If you choose to do so, you should utilize such suffixes for ALL Checkly integrations – otherwise the integration system
might run into issues with deleting secrets from the wrong environments. might run into issues with deleting secrets from the wrong environments.
</Info> </Info>
</Step>
</Steps>
+22 -21
View File
@@ -7,38 +7,39 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Cloudflare Pages">
Obtain a Cloudflare [API token](https://dash.cloudflare.com/profile/api-tokens) and [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/):
![integrations](../../images/integrations.png) Create a new [API token](https://dash.cloudflare.com/profile/api-tokens) in My Profile > API Tokens
## Authorize Infisical for Cloudflare Pages ![integrations cloudflare credentials 1](../../images/integrations/cloudflare/integrations-cloudflare-credentials-1.png)
![integrations cloudflare credentials 2](../../images/integrations/cloudflare/integrations-cloudflare-credentials-2.png)
![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-credentials-3.png)
Obtain a Cloudflare [API token](https://dash.cloudflare.com/profile/api-tokens) and [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/): Copy your [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/) from Account > Workers & Pages > Overview
1. Create a new [API token](https://dash.cloudflare.com/profile/api-tokens) in My Profile > API Tokens ![integrations cloudflare credentials 4](../../images/integrations/cloudflare/integrations-cloudflare-credentials-4.png)
![integrations cloudflare credentials 1](../../images/integrations/cloudflare/integrations-cloudflare-credentials-1.png) Navigate to your project's integrations tab in Infisical.
![integrations cloudflare credentials 2](../../images/integrations/cloudflare/integrations-cloudflare-credentials-2.png)
![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-credentials-3.png)
2. Copy your [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/) from Account > Workers & Pages > Overview ![integrations](../../images/integrations.png)
![integrations cloudflare credentials 4](../../images/integrations/cloudflare/integrations-cloudflare-credentials-4.png) Press on the Cloudflare Pages tile and input your Cloudflare API token and account ID to grant Infisical access to your Cloudflare Pages.
Press on the Cloudflare Pages tile and input your Cloudflare API token and account ID to grant Infisical access to your Cloudflare Pages. ![integrations cloudflare authorization](../../images/integrations/cloudflare/integrations-cloudflare-auth.png)
![integrations cloudflare authorization](../../images/integrations/cloudflare/integrations-cloudflare-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to Cloudflare and press create integration to start syncing secrets.
## Start integration ![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare-create.png)
![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare.png)
Select which Infisical environment secrets you want to sync to Cloudflare and press create integration to start syncing secrets. </Step>
</Steps>
![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare-create.png)
![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare.png)
+21 -20
View File
@@ -7,37 +7,38 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Cloudflare Workers">
Obtain a Cloudflare [API token](https://dash.cloudflare.com/profile/api-tokens) and [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/):
![integrations](../../images/integrations.png) Create a new [API token](https://dash.cloudflare.com/profile/api-tokens) in My Profile > API Tokens
## Authorize Infisical for Cloudflare Workers ![integrations cloudflare credentials 1](../../images/integrations/cloudflare/integrations-cloudflare-credentials-1.png)
![integrations cloudflare credentials 2](../../images/integrations/cloudflare/integrations-cloudflare-credentials-2.png)
![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-credentials-3.png)
Obtain a Cloudflare [API token](https://dash.cloudflare.com/profile/api-tokens) and [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/): Copy your [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/) from Account > Workers & Pages > Overview
1. Create a new [API token](https://dash.cloudflare.com/profile/api-tokens) in My Profile > API Tokens ![integrations cloudflare credentials 4](../../images/integrations/cloudflare/integrations-cloudflare-credentials-4.png)
![integrations cloudflare credentials 1](../../images/integrations/cloudflare/integrations-cloudflare-credentials-1.png) Navigate to your project's integrations tab in Infisical.
![integrations cloudflare credentials 2](../../images/integrations/cloudflare/integrations-cloudflare-credentials-2.png)
![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-credentials-3.png)
2. Copy your [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/) from Account > Workers & Pages > Overview ![integrations](../../images/integrations.png)
![integrations cloudflare credentials 4](../../images/integrations/cloudflare/integrations-cloudflare-credentials-4.png) Press on the Cloudflare Workers tile and input your Cloudflare API token and account ID to grant Infisical access to your Cloudflare Workers.
Press on the Cloudflare Workers tile and input your Cloudflare API token and account ID to grant Infisical access to your Cloudflare Workers. ![integrations cloudflare authorization](../../images/integrations/cloudflare/integration-cloudflare-workers-connect.png)
![integrations cloudflare authorization](../../images/integrations/cloudflare/integration-cloudflare-workers-connect.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to Cloudflare Workers and press create integration to start syncing secrets.
## Start integration ![integrations cloudflare](../../images/integrations/cloudflare/integration-cloudflare-workers-create.png)
</Step>
Select which Infisical environment secrets you want to sync to Cloudflare Workers and press create integration to start syncing secrets. </Steps>
![integrations cloudflare](../../images/integrations/cloudflare/integration-cloudflare-workers-create.png)
+18 -17
View File
@@ -7,31 +7,32 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Fly.io">
Obtain a Fly.io access token in Access Tokens
![integrations](../../images/integrations.png) ![integrations fly dashboard](../../images/integrations/flyio/integrations-flyio-dashboard.png)
![integrations fly token](../../images/integrations/flyio/integrations-flyio-token.png)
## Enter your Fly.io Access Token Navigate to your project's integrations tab in Infisical.
Obtain a Fly.io access token in Access Tokens ![integrations](../../images/integrations.png)
![integrations fly dashboard](../../images/integrations/flyio/integrations-flyio-dashboard.png) Press on the Fly.io tile and input your Fly.io access token to grant Infisical access to your Fly.io account.
![integrations fly token](../../images/integrations/flyio/integrations-flyio-token.png)
Press on the Fly.io tile and input your Fly.io access token to grant Infisical access to your Fly.io account. ![integrations fly authorization](../../images/integrations/flyio/integrations-flyio-auth.png)
![integrations fly authorization](../../images/integrations/flyio/integrations-flyio-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Fly.io app and press create integration to start syncing secrets to Fly.io.
## Start integration ![integrations fly](../../images/integrations/flyio/integrations-flyio-create.png)
![integrations fly](../../images/integrations/flyio/integrations-flyio.png)
Select which Infisical environment secrets you want to sync to which Fly.io app and press create integration to start syncing secrets to Fly.io. </Step>
</Steps>
![integrations fly](../../images/integrations/flyio/integrations-flyio-create.png)
![integrations fly](../../images/integrations/flyio/integrations-flyio.png)
+65 -68
View File
@@ -5,126 +5,123 @@ description: "How to sync secrets from Infisical to GCP Secret Manager"
<Tabs> <Tabs>
<Tab title="Usage"> <Tab title="Usage">
<AccordionGroup>
<AccordionGroup>
<Accordion title="Connect with OAuth2"> <Accordion title="Connect with OAuth2">
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) <Steps>
## Navigate to your project's integrations tab <Step title="Authorize Infisical for GCP">
Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for GCP Press on the GCP Secret Manager tile and select **Continue with OAuth**
Press on the GCP Secret Manager tile and select **Continue with OAuth** ![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png)
![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png) Grant Infisical access to GCP.
Grant Infisical access to GCP. ![integrations GCP authorization](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth.png)
![integrations GCP authorization](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
In the **Connection** tab, select which Infisical environment secrets you want to sync to which GCP secret manager project. Lastly, press create integration to start syncing secrets to GCP secret manager.
## Start integration ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png)
In the **Connection** tab, select which Infisical environment secrets you want to sync to which GCP secret manager project. Lastly, press create integration to start syncing secrets to GCP secret manager. Note that the GCP Secret Manager integration supports a few options in the **Options** tab:
![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png) - Secret Prefix: If inputted, the prefix is appended to the front of every secret name prior to being synced.
- Secret Suffix: If inputted, the suffix to appended to the back of every name of every secret prior to being synced.
- Label in GCP Secret Manager: If selected, every secret will be labeled in GCP Secret Manager (e.g. as `managed-by:infisical`); labels can be customized.
Note that the GCP Secret Manager integration supports a few options in the **Options** tab: Setting a secret prefix, suffix, or enabling the labeling option ensures that existing secrets in GCP Secret Manager are not overwritten during the sync. As part of this process, Infisical abstains from mutating any secrets in GCP Secret Manager without the specified prefix, suffix, or attached label.
- Secret Prefix: If inputted, the prefix is appended to the front of every secret name prior to being synced. ![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png)
- Secret Suffix: If inputted, the suffix to appended to the back of every name of every secret prior to being synced.
- Label in GCP Secret Manager: If selected, every secret will be labeled in GCP Secret Manager (e.g. as `managed-by:infisical`); labels can be customized.
Setting a secret prefix, suffix, or enabling the labeling option ensures that existing secrets in GCP Secret Manager are not overwritten during the sync. As part of this process, Infisical abstains from mutating any secrets in GCP Secret Manager without the specified prefix, suffix, or attached label. ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png)
![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png) <Warning>
![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png)
<Warning>
Using Infisical to sync secrets to GCP Secret Manager requires that you enable Using Infisical to sync secrets to GCP Secret Manager requires that you enable
the Service Usage API and Cloud Resource Manager API in the Google Cloud project you want to sync secrets to. More on that [here](https://cloud.google.com/service-usage/docs/set-up-development-environment). the Service Usage API and Cloud Resource Manager API in the Google Cloud project you want to sync secrets to. More on that [here](https://cloud.google.com/service-usage/docs/set-up-development-environment).
</Warning> </Warning>
</Step>
</Steps>
</Accordion> </Accordion>
<Accordion title="Connect with Service Account JSON"> <Accordion title="Connect with Service Account JSON">
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Have a GCP project and have/create a [service account](https://cloud.google.com/iam/docs/service-account-overview) in it
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) <Steps>
- Have a GCP project and have/create a [service account](https://cloud.google.com/iam/docs/service-account-overview) in it <Step title="Authorize Infisical for GCP">
Navigate to **IAM & Admin** page in GCP and add the **Secret Manager Admin** and **Service Usage Admin** roles to the service account.
## Grant the service account permissions for GCP Secret Manager ![integrations GCP secret manager IAM](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam.png)
Navigate to **IAM & Admin** page in GCP and add the **Secret Manager Admin** and **Service Usage Admin** roles to the service account. <Info>
![integrations GCP secret manager IAM](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam.png)
<Info>
For enhanced security, you may want to assign more granular permissions to the service account. At minimum, For enhanced security, you may want to assign more granular permissions to the service account. At minimum,
the service account should be able to read/write secrets from/to GCP Secret Manager (e.g. **Secret Manager Admin** role) the service account should be able to read/write secrets from/to GCP Secret Manager (e.g. **Secret Manager Admin** role)
and list which GCP services are enabled/disabled (e.g. **Service Usage Admin** role). and list which GCP services are enabled/disabled (e.g. **Service Usage Admin** role).
</Info> </Info>
## Navigate to your project's integrations tab Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for GCP Press on the GCP Secret Manager tile and paste in your **GCP Service Account JSON** (you can create and download the JSON for your
service account in IAM & Admin > Service Accounts > Service Account > Keys).
Press on the GCP Secret Manager tile and paste in your **GCP Service Account JSON** (you can create and download the JSON for your ![integrations GCP authorization IAM key](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam-key.png)
service account in IAM & Admin > Service Accounts > Service Account > Keys).
![integrations GCP authorization IAM key](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam-key.png) ![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png)
![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
In the **Connection** tab, select which Infisical environment secrets you want to sync to the GCP secret manager project. Lastly, press create integration to start syncing secrets to GCP secret manager.
## Start integration ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png)
In the **Connection** tab, select which Infisical environment secrets you want to sync to the GCP secret manager project. Lastly, press create integration to start syncing secrets to GCP secret manager. Note that the GCP Secret Manager integration supports a few options in the **Options** tab:
![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png) - Secret Prefix: If inputted, the prefix is appended to the front of every secret name prior to being synced.
- Secret Suffix: If inputted, the suffix to appended to the back of every name of every secret prior to being synced.
- Label in GCP Secret Manager: If selected, every secret will be labeled in GCP Secret Manager (e.g. as `managed-by:infisical`); labels can be customized.
Note that the GCP Secret Manager integration supports a few options in the **Options** tab: Setting a secret prefix, suffix, or enabling the labeling option ensures that existing secrets in GCP Secret Manager are not overwritten during the sync. As part of this process, Infisical abstains from mutating any secrets in GCP Secret Manager without the specified prefix, suffix, or attached label.
- Secret Prefix: If inputted, the prefix is appended to the front of every secret name prior to being synced. ![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png)
- Secret Suffix: If inputted, the suffix to appended to the back of every name of every secret prior to being synced.
- Label in GCP Secret Manager: If selected, every secret will be labeled in GCP Secret Manager (e.g. as `managed-by:infisical`); labels can be customized.
Setting a secret prefix, suffix, or enabling the labeling option ensures that existing secrets in GCP Secret Manager are not overwritten during the sync. As part of this process, Infisical abstains from mutating any secrets in GCP Secret Manager without the specified prefix, suffix, or attached label. ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png)
![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png) <Warning>
![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png)
<Warning>
Using Infisical to sync secrets to GCP Secret Manager requires that you enable Using Infisical to sync secrets to GCP Secret Manager requires that you enable
the Service Usage API and Cloud Resource Manager API in the Google Cloud project you want to sync secrets to. More on that [here](https://cloud.google.com/service-usage/docs/set-up-development-environment). the Service Usage API and Cloud Resource Manager API in the Google Cloud project you want to sync secrets to. More on that [here](https://cloud.google.com/service-usage/docs/set-up-development-environment).
</Warning> </Warning>
</Step>
</Steps>
</Accordion> </Accordion>
</AccordionGroup> </AccordionGroup>
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the GCP Secret Manager integration (via the OAuth2 method) on a self-hosted instance of Infisical requires configuring an OAuth2 application in GCP Using the GCP Secret Manager integration (via the OAuth2 method) on a self-hosted instance of Infisical requires configuring an OAuth2 application in GCP
and registering your instance with it. and registering your instance with it.
## Create an OAuth2 application in GCP <Steps>
<Step title="Create an OAuth2 application in GCP">
Navigate to your project API & Services > Credentials to create a new OAuth2 application. Navigate to your project API & Services > Credentials to create a new OAuth2 application.
![integrations GCP secret manager config](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-config-api-services.png) ![integrations GCP secret manager config](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-config-api-services.png)
@@ -133,9 +130,8 @@ Setting a secret prefix, suffix, or enabling the labeling option ensures that ex
Create the application. As part of the form, add to **Authorized redirect URIs**: `https://your-domain.com/integrations/gcp-secret-manager/oauth2/callback`. Create the application. As part of the form, add to **Authorized redirect URIs**: `https://your-domain.com/integrations/gcp-secret-manager/oauth2/callback`.
![integrations GCP secret manager config](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-config-new-app-form.png) ![integrations GCP secret manager config](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-config-new-app-form.png)
</Step>
## Add your OAuth2 application credentials to Infisical <Step title="Add your OAuth2 application credentials to Infisical">
Obtain the **Client ID** and **Client Secret** for your GCP OAuth2 application. Obtain the **Client ID** and **Client Secret** for your GCP OAuth2 application.
![integrations GCP secret manager config](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-config-credentials.png) ![integrations GCP secret manager config](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-config-credentials.png)
@@ -146,7 +142,8 @@ Setting a secret prefix, suffix, or enabling the labeling option ensures that ex
- `CLIENT_SECRET_GCP_SECRET_MANAGER`: The **Client Secret** of your GCP OAuth2 application. - `CLIENT_SECRET_GCP_SECRET_MANAGER`: The **Client Secret** of your GCP OAuth2 application.
Once added, restart your Infisical instance and use the GCP Secret Manager integration. Once added, restart your Infisical instance and use the GCP Secret Manager integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+17 -16
View File
@@ -7,30 +7,31 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Hasura Cloud">
Obtain a Hasura Cloud Access Token in My Account > Access Tokens
![integrations](../../images/integrations.png) ![integrations hasura cloud tokens](../../images/integrations/hasura-cloud/integrations-hasura-cloud-tokens.png)
## Enter your Hasura Cloud Access Token Navigate to your project's integrations tab in Infisical.
Obtain a Hasura Cloud Access Token in My Account > Access Tokens ![integrations](../../images/integrations.png)
![integrations hasura cloud tokens](../../images/integrations/hasura-cloud/integrations-hasura-cloud-tokens.png) Press on the Hasura Cloud tile and input your Hasura Cloud access token to grant Infisical access to your Hasura Cloud account.
Press on the Hasura Cloud tile and input your Hasura Cloud access token to grant Infisical access to your Hasura Cloud account. ![integrations hasura cloud authorization](../../images/integrations/hasura-cloud/integrations-hasura-cloud-auth.png)
![integrations hasura cloud authorization](../../images/integrations/hasura-cloud/integrations-hasura-cloud-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Hasura Cloud project and press create integration to start syncing secrets to Hasura Cloud.
## Start integration ![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud-create.png)
![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud.png)
Select which Infisical environment secrets you want to sync to which Hasura Cloud project and press create integration to start syncing secrets to Hasura Cloud. </Step>
</Steps>
![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud-create.png)
![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud.png)
+22 -22
View File
@@ -7,38 +7,38 @@ description: "How to sync secrets from Infisical to Heroku"
<Tab title="Usage"> <Tab title="Usage">
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Heroku">
Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for Heroku Press on the Heroku tile and grant Infisical access to your Heroku account.
Press on the Heroku tile and grant Infisical access to your Heroku account. ![integrations heroku authorization](../../images/integrations/heroku/integrations-heroku-auth.png)
![integrations heroku authorization](../../images/integrations/heroku/integrations-heroku-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Heroku app and press create integration to start syncing secrets to Heroku.
## Start integration ![integrations heroku](../../images/integrations/heroku/integrations-heroku-create.png)
![integrations heroku](../../images/integrations/heroku/integrations-heroku.png)
Select which Infisical environment secrets you want to sync to which Heroku app and press create integration to start syncing secrets to Heroku. </Step>
</Steps>
![integrations heroku](../../images/integrations/heroku/integrations-heroku-create.png)
![integrations heroku](../../images/integrations/heroku/integrations-heroku.png)
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the Heroku integration on a self-hosted instance of Infisical requires configuring an API client in Heroku Using the Heroku integration on a self-hosted instance of Infisical requires configuring an API client in Heroku
and registering your instance with it. and registering your instance with it.
<Steps>
## Create an API client in Heroku <Step title="Create an API client in Heroku">
Navigate to your user Account settings > Applications to create a new API client. Navigate to your user Account settings > Applications to create a new API client.
![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-settings.png) ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-settings.png)
@@ -48,9 +48,8 @@ Select which Infisical environment secrets you want to sync to which Heroku app
Create the API client. As part of the form, set the **OAuth callback URL** to `https://your-domain.com/integrations/heroku/oauth2/callback`. Create the API client. As part of the form, set the **OAuth callback URL** to `https://your-domain.com/integrations/heroku/oauth2/callback`.
![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-new-app-form.png) ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-new-app-form.png)
</Step>
## Add your Heroku API client credentials to Infisical <Step title="Add your Heroku API client credentials to Infisical">
Obtain the **Client ID** and **Client Secret** for your Heroku API client. Obtain the **Client ID** and **Client Secret** for your Heroku API client.
![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-credentials.png) ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-credentials.png)
@@ -61,7 +60,8 @@ Select which Infisical environment secrets you want to sync to which Heroku app
- `CLIENT_SECRET_HEROKU`: The **Client Secret** of your Heroku API client. - `CLIENT_SECRET_HEROKU`: The **Client Secret** of your Heroku API client.
Once added, restart your Infisical instance and use the Heroku integration. Once added, restart your Infisical instance and use the Heroku integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+21 -19
View File
@@ -7,36 +7,38 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Laravel Forge">
Obtain a Laravel Forge access token in API Tokens
![integrations](../../images/integrations.png) ![integrations laravel forge dashboard](../../images/integrations/laravel-forge/integrations-laravelforge-dashboard.png)
![integrations laravel forge api tokens](../../images/integrations/laravel-forge/integrations-laravelforge-api.png)
## Enter your Laravel Forge Access Token and Server Id Obtain your Laravel Forge Server ID in Servers > Server ID
Obtain a Laravel Forge access token in API Tokens ![integrations laravel forge server](../../images/integrations/laravel-forge/integrations-laravelforge-servers.png)
![integrations laravel forge server id](../../images/integrations/laravel-forge/integrations-laravelforge-serverid.png)
![integrations laravel forge dashboard](../../images/integrations/laravel-forge/integrations-laravelforge-dashboard.png) Navigate to your project's integrations tab in Infisical.
![integrations laravel forge api tokens](../../images/integrations/laravel-forge/integrations-laravelforge-api.png)
Obtain your Laravel Forge Server ID in Servers > Server ID ![integrations](../../images/integrations.png)
![integrations laravel forge server](../../images/integrations/laravel-forge/integrations-laravelforge-servers.png) Press on the Laravel Forge tile and input your Laravel Forge access token and server ID to grant Infisical access to your Laravel Forge account.
![integrations laravel forge server id](../../images/integrations/laravel-forge/integrations-laravelforge-serverid.png)
Press on the Laravel Forge tile and input your Laravel Forge access token and server ID to grant Infisical access to your Laravel Forge account. ![integrations laravel forge authorization](../../images/integrations/laravel-forge/integrations-laravelforge-auth.png)
![integrations laravel forge authorization](../../images/integrations/laravel-forge/integrations-laravelforge-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Laravel Forge site and press create integration to start syncing secrets to Laravel Forge.
## Start integration ![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge-create.png)
![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge.png)
</Step>
</Steps>
Select which Infisical environment secrets you want to sync to which Laravel Forge site and press create integration to start syncing secrets to Laravel Forge.
![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge-create.png)
![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge.png)
+24 -24
View File
@@ -9,43 +9,42 @@ description: "How to sync secrets from Infisical to Netlify"
Infisical integrates with Netlify's new environment variable experience. If Infisical integrates with Netlify's new environment variable experience. If
your site uses Netlify's old environment variable experience, you'll have to your site uses Netlify's old environment variable experience, you'll have to
upgrade it to the new one to use this integration. upgrade it to the new one to use this integration.
</Warning> </Warning>
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Netlify">
Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png) ![integrations](../../images/integrations.png)
## Authorize Infisical for Netlify Press on the Netlify tile and grant Infisical access to your Netlify account.
Press on the Netlify tile and grant Infisical access to your Netlify account. ![integrations netlify authorization](../../images/integrations/netlify/integrations-netlify-auth.png)
![integrations netlify authorization](../../images/integrations/netlify/integrations-netlify-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
## Start integration <Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Netlify app and context. Lastly, press create integration to start syncing secrets to Netlify.
Select which Infisical environment secrets you want to sync to which Netlify app and context. Lastly, press create integration to start syncing secrets to Netlify.
![integrations netlify](../../images/integrations/netlify/integrations-netlify-create.png)
![integrations netlify](../../images/integrations/netlify/integrations-netlify.png)
![integrations netlify](../../images/integrations/netlify/integrations-netlify-create.png)
![integrations netlify](../../images/integrations/netlify/integrations-netlify.png)
</Step>
</Steps>
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the Netlify integration on a self-hosted instance of Infisical requires configuring an OAuth application in Netlify Using the Netlify integration on a self-hosted instance of Infisical requires configuring an OAuth application in Netlify
and registering your instance with it. and registering your instance with it.
<Steps>
## Create an OAuth application in Netlify <Step title="Create an OAuth application in Netlify">
Navigate to your User settings > Applications > OAuth to create a new OAuth application. Navigate to your User settings > Applications > OAuth to create a new OAuth application.
![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-user-settings.png) ![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-user-settings.png)
@@ -54,9 +53,8 @@ Select which Infisical environment secrets you want to sync to which Netlify app
Create the OAuth application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/netlify/oauth2/callback`. Create the OAuth application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/netlify/oauth2/callback`.
![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-new-app-form.png) ![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-new-app-form.png)
</Step>
## Add your Netlify OAuth application credentials to Infisical <Step title="Add your Netlify OAuth application credentials to Infisical">
Obtain the **Client ID** and **Secret** for your Netlify OAuth application. Obtain the **Client ID** and **Secret** for your Netlify OAuth application.
![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-credentials.png) ![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-credentials.png)
@@ -67,6 +65,8 @@ Select which Infisical environment secrets you want to sync to which Netlify app
- `CLIENT_SECRET_NETLIFY`: The **Secret** of your Netlify OAuth application. - `CLIENT_SECRET_NETLIFY`: The **Secret** of your Netlify OAuth application.
Once added, restart your Infisical instance and use the Netlify integration. Once added, restart your Infisical instance and use the Netlify integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+18 -17
View File
@@ -8,31 +8,32 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Have a [Northflank](https://northflank.com) project with a secret group ready - Have a [Northflank](https://northflank.com) project with a secret group ready
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Northflank">
Obtain a Northflank API token in Account settings > API > Tokens
![integrations](../../images/integrations.png) ![integrations northflank dashboard](../../images/integrations/northflank/integrations-northflank-dashboard.png)
![integrations northflank token](../../images/integrations/northflank/integrations-northflank-token.png)
## Enter your Northflank API Token Navigate to your project's integrations tab in Infisical.
Obtain a Northflank API token in Account settings > API > Tokens ![integrations](../../images/integrations.png)
![integrations northflank dashboard](../../images/integrations/northflank/integrations-northflank-dashboard.png) Press on the Northflank tile and input your Northflank API token to grant Infisical access to your Northflank account.
![integrations northflank token](../../images/integrations/northflank/integrations-northflank-token.png)
Press on the Northflank tile and input your Northflank API token to grant Infisical access to your Northflank account. ![integrations northflank authorization](../../images/integrations/northflank/integrations-northflank-auth.png)
![integrations northflank authorization](../../images/integrations/northflank/integrations-northflank-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Northflank project and secret group. Finally, press create integration to start syncing secrets to Northflank.
## Start integration ![integrations northflank](../../images/integrations/northflank/integrations-northflank-create.png)
![integrations northflank](../../images/integrations/northflank/integrations-northflank.png)
Select which Infisical environment secrets you want to sync to which Northflank project and secret group. Finally, press create integration to start syncing secrets to Northflank. </Step>
</Steps>
![integrations northflank](../../images/integrations/northflank/integrations-northflank-create.png)
![integrations northflank](../../images/integrations/northflank/integrations-northflank.png)
+20 -19
View File
@@ -7,37 +7,38 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Qovery">
Obtain a Qovery API Token in Settings > API Token.
![integrations](../../images/integrations.png) ![integrations qovery api token](../../images/integrations/qovery/integrations-qovery-token.png)
## Enter your Qovery API Token Navigate to your project's integrations tab in Infisical.
Obtain a Qovery API Token in Settings > API Token. ![integrations](../../images/integrations.png)
![integrations qovery api token](../../images/integrations/qovery/integrations-qovery-token.png) Press on the Qovery tile and input your Qovery API Token to grant Infisical access to your Qovery account.
Press on the Qovery tile and input your Qovery API Token to grant Infisical access to your Qovery account. ![integrations qovery authorization](../../images/integrations/qovery/integrations-qovery-auth.png)
![integrations qovery authorization](../../images/integrations/qovery/integrations-qovery-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it is necessary for Infisical to sync the environment variables to breaks E2EE, it is necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to Qovery and press create integration to start syncing secrets.
## Start integration ![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-1.png)
Select which Infisical environment secrets you want to sync to Qovery and press create integration to start syncing secrets. ![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-2.png)
![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-1.png) <Note>
![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-2.png)
<Note>
Infisical supports syncing secrets to various Qovery scopes including applications, jobs, or containers. Infisical supports syncing secrets to various Qovery scopes including applications, jobs, or containers.
</Note> </Note>
![integrations qovery settings](../../images/integrations/qovery/integrations-qovery.png) ![integrations qovery settings](../../images/integrations/qovery/integrations-qovery.png)
</Step>
</Steps>
+24 -25
View File
@@ -7,48 +7,47 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
<Steps>
<Step title="Authorize Infisical for Railway">
Obtain a Railway API Token in your Railway [Account Settings > Tokens](https://railway.app/account/tokens).
## Navigate to your project's integrations tab ![integrations railway dashboard](../../images/integrations/railway/integrations-railway-dashboard.png)
![integrations railway token](../../images/integrations/railway/integrations-railway-token.png)
![integrations](../../images/integrations.png) <Note>
## Enter your Railway API Token
Obtain a Railway API Token in your Railway [Account Settings > Tokens](https://railway.app/account/tokens).
![integrations railway dashboard](../../images/integrations/railway/integrations-railway-dashboard.png)
![integrations railway token](../../images/integrations/railway/integrations-railway-token.png)
<Note>
If this is your first time creating a Railway API token, then you'll be prompted to join If this is your first time creating a Railway API token, then you'll be prompted to join
Railway's Private Boarding Beta program on the Railway Account Settings > Tokens page. Railway's Private Boarding Beta program on the Railway Account Settings > Tokens page.
Note that Railway project tokens will not work for this integration since they don't work with Note that Railway project tokens will not work for this integration since they don't work with
Railway's Public API. Railway's Public API.
</Note> </Note>
Press on the Railway tile and input your Railway API Key to grant Infisical access to your Railway account. Navigate to your project's integrations tab in Infisical.
![integrations railway authorization](../../images/integrations/railway/integrations-railway-authorization.png) ![integrations](../../images/integrations.png)
<Info> Press on the Railway tile and input your Railway API Key to grant Infisical access to your Railway account.
![integrations railway authorization](../../images/integrations/railway/integrations-railway-authorization.png)
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Railway project and environment (and optionally service). Lastly, press create integration to start syncing secrets to Railway.
## Start integration ![integrations create railway](../../images/integrations/railway/integrations-railway-create.png)
Select which Infisical environment secrets you want to sync to which Railway project and environment (and optionally service). Lastly, press create integration to start syncing secrets to Railway. <Note>
![integrations create railway](../../images/integrations/railway/integrations-railway-create.png)
<Note>
Infisical integrates with both Railway's [shared variables](https://blog.railway.app/p/shared-variables-release) at the project environment level as well as service variables at the service level. Infisical integrates with both Railway's [shared variables](https://blog.railway.app/p/shared-variables-release) at the project environment level as well as service variables at the service level.
To sync secrets to a specific service in a project, you can select a service from the Railway Service dropdown; otherwise, leaving it empty will sync secrets to the shared variables of that project. To sync secrets to a specific service in a project, you can select a service from the Railway Service dropdown; otherwise, leaving it empty will sync secrets to the shared variables of that project.
</Note> </Note>
![integrations railway](../../images/integrations/railway/integrations-railway.png)
![integrations railway](../../images/integrations/railway/integrations-railway.png)
</Step>
</Steps>
+18 -17
View File
@@ -7,31 +7,32 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Render">
Obtain a Render API Key in your Render Account Settings > API Keys.
![integrations](../../images/integrations.png) ![integrations render dashboard](../../images/integrations/render/integrations-render-dashboard.png)
![integrations render token](../../images/integrations/render/integrations-render-token.png)
## Enter your Render API Key Navigate to your project's integrations tab in Infisical.
Obtain a Render API Key in your Render Account Settings > API Keys. ![integrations](../../images/integrations.png)
![integrations render dashboard](../../images/integrations/render/integrations-render-dashboard.png) Press on the Render tile and input your Render API Key to grant Infisical access to your Render account.
![integrations render token](../../images/integrations/render/integrations-render-token.png)
Press on the Render tile and input your Render API Key to grant Infisical access to your Render account. ![integrations render authorization](../../images/integrations/render/integrations-render-auth.png)
![integrations render authorization](../../images/integrations/render/integrations-render-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Render service and press create integration to start syncing secrets to Render.
## Start integration ![integrations render](../../images/integrations/render/integrations-render-create.png)
![integrations render](../../images/integrations/render/integrations-render.png)
Select which Infisical environment secrets you want to sync to which Render service and press create integration to start syncing secrets to Render. </Step>
</Steps>
![integrations render](../../images/integrations/render/integrations-render-create.png)
![integrations render](../../images/integrations/render/integrations-render.png)
+18 -17
View File
@@ -14,31 +14,32 @@ Prerequisites:
- Have an account and project set up at [Supabase](https://supabase.com/) - Have an account and project set up at [Supabase](https://supabase.com/)
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Supabase">
Obtain a Supabase Access Token in your Supabase [Account > Access Tokens](https://app.supabase.com/account/tokens).
![integrations supabase dashboard](../../images/integrations/supabase/integrations-supabase-dashboard.png)
![integrations supabase token](../../images/integrations/supabase/integrations-supabase-token.png)
![integrations](../../images/integrations.png) Navigate to your project's integrations tab in Infisical.
## Enter your Supabase Access Token ![integrations](../../images/integrations.png)
Obtain a Supabase Access Token in your Supabase [Account > Access Tokens](https://app.supabase.com/account/tokens). Press on the Supabase tile and input your Supabase Access Token to grant Infisical access to your Supabase account.
![integrations supabase dashboard](../../images/integrations/supabase/integrations-supabase-dashboard.png)
![integrations supabase token](../../images/integrations/supabase/integrations-supabase-token.png)
Press on the Supabase tile and input your Supabase Access Token to grant Infisical access to your Supabase account. ![integrations supabase authorization](../../images/integrations/supabase/integrations-supabase-authorization.png)
![integrations supabase authorization](../../images/integrations/supabase/integrations-supabase-authorization.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Supabase project. Lastly, press create integration to start syncing secrets to Supabase.
## Start integration ![integrations supabase create](../../images/integrations/supabase/integrations-supabase-create.png)
Select which Infisical environment secrets you want to sync to which Supabase project. Lastly, press create integration to start syncing secrets to Supabase. ![integrations supabase](../../images/integrations/supabase/integrations-supabase.png)
</Step>
![integrations supabase create](../../images/integrations/supabase/integrations-supabase-create.png) </Steps>
![integrations supabase](../../images/integrations/supabase/integrations-supabase.png)
+26 -25
View File
@@ -7,44 +7,45 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for TeamCity">
Obtain a TeamCity Access Token in Profile > Access Tokens
![integrations](../../images/integrations.png) ![integrations teamcity dashboard](../../images/integrations/teamcity/integrations-teamcity-dashboard.png)
![integrations teamcity token](../../images/integrations/teamcity/integrations-teamcity-token.png)
## Enter your TeamCity Access Token and Server URL <Note>
Obtain a TeamCity Access Token in Profile > Access Tokens
![integrations teamcity dashboard](../../images/integrations/teamcity/integrations-teamcity-dashboard.png)
![integrations teamcity token](../../images/integrations/teamcity/integrations-teamcity-token.png)
<Note>
For this integration to work, the TeamCity Access Token must either have the For this integration to work, the TeamCity Access Token must either have the
**Same as current user** account-wide permission enabled or, if **Limit per project** **Same as current user** account-wide permission enabled or, if **Limit per project**
is selected, then it must at minimum have the **View build configuration settings** and **Edit project** permissions enabled. is selected, then it must at minimum have the **View build configuration settings** and **Edit project** permissions enabled.
</Note> </Note>
<Info> Navigate to your project's integrations tab in Infisical.
![integrations](../../images/integrations.png)
Press on the TeamCity tile and input your TeamCity Access Token and Server URL to grant Infisical access to your TeamCity account.
![integrations teamcity authorization](../../images/integrations/teamcity/integrations-teamcity-auth.png)
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which TeamCity project (and optionally build configuration) and press create integration to start syncing secrets to TeamCity.
Press on the TeamCity tile and input your TeamCity Access Token and Server URL to grant Infisical access to your TeamCity account. ![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity-create.png)
![integrations teamcity authorization](../../images/integrations/teamcity/integrations-teamcity-auth.png) <Note>
## Start integration
Select which Infisical environment secrets you want to sync to which TeamCity project (and optionally build configuration) and press create integration to start syncing secrets to TeamCity.
![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity-create.png)
<Note>
Infisical integrates with both TeamCity's project-level and build configuration-level environment variables. Infisical integrates with both TeamCity's project-level and build configuration-level environment variables.
To sync secrets to a specific build configuration in a TeamCity project, you can select a build configuration from the **TeamCity Build Config** dropdown; otherwise, leaving it empty will sync secrets to TeamCity at the project-level. To sync secrets to a specific build configuration in a TeamCity project, you can select a build configuration from the **TeamCity Build Config** dropdown; otherwise, leaving it empty will sync secrets to TeamCity at the project-level.
</Note> </Note>
![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity.png) ![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity.png)
</Step>
</Steps>
+21 -20
View File
@@ -7,36 +7,37 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Terraform Cloud">
Obtain a Terraform Cloud API Token in User Settings > Tokens
![integrations](../../images/integrations.png) ![integrations terraform cloud dashboard](../../images/integrations/terraform/integrations-terraformcloud-dashboard.png)
![integrations terraform cloud tokens](../../images/integrations/terraform/integrations-terraformcloud-tokens.png)
## Enter your Terraform Cloud API Token and Workspace Id Obtain your Terraform Cloud Workspace Id in Projects & Workspaces > Workspace > ID
Obtain a Terraform Cloud API Token in User Settings > Tokens ![integrations terraform cloud projects & workspaces](../../images/integrations/terraform/integrations-terraformcloud-workspaces.png)
![integrations terraform cloud workspace id](../../images/integrations/terraform/integrations-terraformcloud-workspaceid.png)
![integrations terraform cloud dashboard](../../images/integrations/terraform/integrations-terraformcloud-dashboard.png) Navigate to your project's integrations tab in Infisical.
![integrations terraform cloud tokens](../../images/integrations/terraform/integrations-terraformcloud-tokens.png)
Obtain your Terraform Cloud Workspace Id in Projects & Workspaces > Workspace > ID ![integrations](../../images/integrations.png)
![integrations terraform cloud projects & workspaces](../../images/integrations/terraform/integrations-terraformcloud-workspaces.png) Press on the Terraform Cloud tile and input your Terraform Cloud API Token and Workspace Id to grant Infisical access to your Terraform Cloud account.
![integrations terraform cloud workspace id](../../images/integrations/terraform/integrations-terraformcloud-workspaceid.png)
Press on the Terraform Cloud tile and input your Terraform Cloud API Token and Workspace Id to grant Infisical access to your Terraform Cloud account. ![integrations terraform cloud authorization](../../images/integrations/terraform/integrations-terraformcloud-auth.png)
![integrations terraform cloud authorization](../../images/integrations/terraform/integrations-terraformcloud-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets and Terraform Cloud variable type you want to sync to which Terraform Cloud workspace/project and press create integration to start syncing secrets to Terraform Cloud.
## Start integration ![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud-create.png)
![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud.png)
Select which Infisical environment secrets and Terraform Cloud variable type you want to sync to which Terraform Cloud workspace/project and press create integration to start syncing secrets to Terraform Cloud. </Step>
</Steps>
![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud-create.png)
![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud.png)
+26 -26
View File
@@ -6,41 +6,39 @@ description: "How to sync secrets from Infisical to Vercel"
<Tabs> <Tabs>
<Tab title="Usage"> <Tab title="Usage">
Prerequisites: Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) <Steps>
<Step title="Authorize Infisical for Vercel">
Navigate to your project's integrations tab in Infisical.
## Navigate to your project's integrations tab ![integrations](../../images/integrations.png)
![integrations](../../images/integrations.png) Press on the Vercel tile and grant Infisical access to your Vercel account.
## Authorize Infisical for Vercel ![integrations vercel authorization](../../images/integrations/vercel/integrations-vercel-auth.png)
Press on the Vercel tile and grant Infisical access to your Vercel account. <Info>
![integrations vercel authorization](../../images/integrations/vercel/integrations-vercel-auth.png)
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Vercel app and environment. Lastly, press create integration to start syncing secrets to Vercel.
## Start integration ![integrations vercel](../../images/integrations/vercel/integrations-vercel-create.png)
![integrations vercel](../../images/integrations/vercel/integrations-vercel.png)
Select which Infisical environment secrets you want to sync to which Vercel app and environment. Lastly, press create integration to start syncing secrets to Vercel. <Info>
![integrations vercel](../../images/integrations/vercel/integrations-vercel-create.png)
![integrations vercel](../../images/integrations/vercel/integrations-vercel.png)
<Info>
Infisical syncs every envar to Vercel with type `encrypted` unless an existing Infisical syncs every envar to Vercel with type `encrypted` unless an existing
envar with the same name in Vercel exists with a different type. Note that envar with the same name in Vercel exists with a different type. Note that
Infisical will not be able to update Vercel envars with type `sensitive` since Infisical will not be able to update Vercel envars with type `sensitive` since
they can only be decrypted and modified by Vercel's deployment systems. they can only be decrypted and modified by Vercel's deployment systems.
</Info> </Info>
<Warning> <Warning>
The following environment variable names are reserved by Vercel and cannot be The following environment variable names are reserved by Vercel and cannot be
synced: `AWS_SECRET_KEY`, `AWS_EXECUTION_ENV`, `AWS_LAMBDA_LOG_GROUP_NAME`, synced: `AWS_SECRET_KEY`, `AWS_EXECUTION_ENV`, `AWS_LAMBDA_LOG_GROUP_NAME`,
`AWS_LAMBDA_LOG_STREAM_NAME`, `AWS_LAMBDA_FUNCTION_NAME`, `AWS_LAMBDA_LOG_STREAM_NAME`, `AWS_LAMBDA_FUNCTION_NAME`,
@@ -48,14 +46,16 @@ Select which Infisical environment secrets you want to sync to which Vercel app
`NOW_REGION`, `TZ`, `LAMBDA_TASK_ROOT`, `LAMBDA_RUNTIME_DIR`, `NOW_REGION`, `TZ`, `LAMBDA_TASK_ROOT`, `LAMBDA_RUNTIME_DIR`,
`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`,
`AWS_REGION`, and `AWS_DEFAULT_REGION`. `AWS_REGION`, and `AWS_DEFAULT_REGION`.
</Warning> </Warning>
</Step>
</Steps>
</Tab> </Tab>
<Tab title="Self-Hosted Setup"> <Tab title="Self-Hosted Setup">
Using the Vercel integration on a self-hosted instance of Infisical requires configuring an integration in Vercel. Using the Vercel integration on a self-hosted instance of Infisical requires configuring an integration in Vercel.
and registering your instance with it. and registering your instance with it.
## Create an integration in Vercel <Steps>
<Step title="Create an integration in Vercel">
Navigate to Integrations > Integration Console to create a new integration. Navigate to Integrations > Integration Console to create a new integration.
![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-integrations-console.png) ![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-integrations-console.png)
@@ -66,9 +66,8 @@ Select which Infisical environment secrets you want to sync to which Vercel app
![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-new-app-form-1.png) ![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-new-app-form-1.png)
![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-new-app-form-2.png) ![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-new-app-form-2.png)
</Step>
## Add your Vercel integration credentials and information to Infisical <Step title="Add your Vercel integration credentials and information to Infisical">
Obtain the **Client (Integration) ID** and **Client (Integration) Secret** as well as the **URL Slug** from earlier for your Vercel integration. Obtain the **Client (Integration) ID** and **Client (Integration) Secret** as well as the **URL Slug** from earlier for your Vercel integration.
![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-credentials.png) ![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-credentials.png)
@@ -80,7 +79,8 @@ Select which Infisical environment secrets you want to sync to which Vercel app
- `CLIENT_SLUG_VERCEL`: The **URL Slug** of your Vercel integration. - `CLIENT_SLUG_VERCEL`: The **URL Slug** of your Vercel integration.
Once added, restart your Infisical instance and use the Vercel integration. Once added, restart your Infisical instance and use the Vercel integration.
</Step>
</Steps>
</Tab> </Tab>
</Tabs> </Tabs>
+20 -19
View File
@@ -7,40 +7,41 @@ Prerequisites:
- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
## Navigate to your project's integrations tab <Steps>
<Step title="Authorize Infisical for Windmill">
Obtain a [Windmill](https://www.windmill.dev/) access token in Access Tokens
![integrations](../../images/integrations.png) ![integrations windmill dashboard](../../images/integrations/windmill/integrations-windmill-dashboard.png)
![integrations windmill token](../../images/integrations/windmill/integrations-windmill-token.png)
## Enter your Windmill Access Token Navigate to your project's integrations tab in Infisical.
Obtain a [Windmill](https://www.windmill.dev/) access token in Access Tokens ![integrations](../../images/integrations.png)
![integrations windmill dashboard](../../images/integrations/windmill/integrations-windmill-dashboard.png) Press on the Windmill tile and input your Windmill access token to grant Infisical access to your Windmill account.
![integrations windmill token](../../images/integrations/windmill/integrations-windmill-token.png)
Press on the Windmill tile and input your Windmill access token to grant Infisical access to your Windmill account. ![integrations windmill authorization](../../images/integrations/windmill/integrations-windmill-auth.png)
![integrations windmill authorization](../../images/integrations/windmill/integrations-windmill-auth.png) <Info>
<Info>
If this is your project's first cloud integration, then you'll have to grant If this is your project's first cloud integration, then you'll have to grant
Infisical access to your project's environment variables. Although this step Infisical access to your project's environment variables. Although this step
breaks E2EE, it's necessary for Infisical to sync the environment variables to breaks E2EE, it's necessary for Infisical to sync the environment variables to
the cloud platform. the cloud platform.
</Info> </Info>
</Step>
<Step title="Start integration">
Select which Infisical environment secrets you want to sync to which Windmill workspace and press create integration to start syncing secrets to Windmill.
## Start integration ![integrations windmill](../../images/integrations/windmill/integrations-windmill-create.png)
![integrations windmill](../../images/integrations/windmill/integrations-windmill.png)
Select which Infisical environment secrets you want to sync to which Windmill workspace and press create integration to start syncing secrets to Windmill. <Warning>
![integrations windmill](../../images/integrations/windmill/integrations-windmill-create.png)
![integrations windmill](../../images/integrations/windmill/integrations-windmill.png)
<Warning>
Secrets synced to Windmill are subject to the [ownership path Secrets synced to Windmill are subject to the [ownership path
prefix](https://www.windmill.dev/docs/core_concepts/roles_and_permissions) prefix](https://www.windmill.dev/docs/core_concepts/roles_and_permissions)
convention of Windmill. Accordingly, all secrets must be prefixed with either convention of Windmill. Accordingly, all secrets must be prefixed with either
`u/` or `f/` for user-based and folder-based secret along with the name of the `u/` or `f/` for user-based and folder-based secret along with the name of the
secret. Put differently, you must use the full path of the secret as its name secret. Put differently, you must use the full path of the secret as its name
in Infisical to be considered valid such as `u/user/FOO/BAR`. in Infisical to be considered valid such as `u/user/FOO/BAR`.
</Warning> </Warning>
</Step>
</Steps>