From f3767d39632c494b832b3a2874f7d23a4abfeb8a Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Thu, 14 Dec 2023 11:35:50 +0700 Subject: [PATCH] Add Mintlify steps to integration pages --- docs/integrations/cicd/bitbucket.mdx | 35 +-- docs/integrations/cicd/circleci.mdx | 41 ++-- docs/integrations/cicd/codefresh.mdx | 47 ++-- docs/integrations/cicd/githubactions.mdx | 100 ++++---- docs/integrations/cicd/gitlab.mdx | 170 +++++++------- docs/integrations/cicd/travisci.mdx | 41 ++-- .../cloud/aws-parameter-store.mdx | 105 ++++----- .../integrations/cloud/aws-secret-manager.mdx | 102 ++++----- docs/integrations/cloud/azure-key-vault.mdx | 96 ++++---- docs/integrations/cloud/checkly.mdx | 63 +++--- docs/integrations/cloud/cloudflare-pages.mdx | 53 ++--- .../integrations/cloud/cloudflare-workers.mdx | 49 ++-- docs/integrations/cloud/flyio.mdx | 43 ++-- .../integrations/cloud/gcp-secret-manager.mdx | 213 +++++++++--------- docs/integrations/cloud/hasura-cloud.mdx | 43 ++-- docs/integrations/cloud/heroku.mdx | 92 ++++---- docs/integrations/cloud/laravel-forge.mdx | 50 ++-- docs/integrations/cloud/netlify.mdx | 100 ++++---- docs/integrations/cloud/northflank.mdx | 45 ++-- docs/integrations/cloud/qovery.mdx | 49 ++-- docs/integrations/cloud/railway.mdx | 69 +++--- docs/integrations/cloud/render.mdx | 43 ++-- docs/integrations/cloud/supabase.mdx | 47 ++-- docs/integrations/cloud/teamcity.mdx | 63 +++--- docs/integrations/cloud/terraform-cloud.mdx | 49 ++-- docs/integrations/cloud/vercel.mdx | 126 +++++------ docs/integrations/cloud/windmill.mdx | 59 ++--- 27 files changed, 1004 insertions(+), 989 deletions(-) diff --git a/docs/integrations/cicd/bitbucket.mdx b/docs/integrations/cicd/bitbucket.mdx index 357de5ee5..8f29e43a5 100644 --- a/docs/integrations/cicd/bitbucket.mdx +++ b/docs/integrations/cicd/bitbucket.mdx @@ -7,25 +7,26 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## 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 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) + + 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. + + + + Select which Infisical environment secrets you want to sync to which Bitbucket repo and press start integration to start syncing secrets to the repo. - - 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. - - -## 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. - -![integrations bitbucket](../../images/integrations/bitbucket/integrations-bitbucket.png) + ![integrations bitbucket](../../images/integrations/bitbucket/integrations-bitbucket.png) + + \ No newline at end of file diff --git a/docs/integrations/cicd/circleci.mdx b/docs/integrations/cicd/circleci.mdx index 5310748ac..ed14b891e 100644 --- a/docs/integrations/cicd/circleci.mdx +++ b/docs/integrations/cicd/circleci.mdx @@ -7,30 +7,31 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + 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. + + + + Select which Infisical environment secrets you want to sync to which CircleCI project and press create integration to start syncing secrets to CircleCI. - - 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. - - -## 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. - -![create integration circleci](../../images/integrations/circleci/integrations-circleci-create.png) -![integrations circleci](../../images/integrations/circleci/integrations-circleci.png) + ![create integration circleci](../../images/integrations/circleci/integrations-circleci-create.png) + ![integrations circleci](../../images/integrations/circleci/integrations-circleci.png) + + \ No newline at end of file diff --git a/docs/integrations/cicd/codefresh.mdx b/docs/integrations/cicd/codefresh.mdx index 4d0f78d33..e41e00f50 100644 --- a/docs/integrations/cicd/codefresh.mdx +++ b/docs/integrations/cicd/codefresh.mdx @@ -7,31 +7,32 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + Navigate to your project's integrations tab in Infisical. -## Authorize Infisical for Codefresh + ![integrations](../../images/integrations.png) + + Press on the Codefresh tile and input your Codefresh API key to grant Infisical access to your Codefresh account. -Obtain an API key in User Settings > API Keys + ![integrations codefresh authorization](../../images/integrations/codefresh/integrations-codefresh-auth.png) -![integrations codefresh dashboard](../../images/integrations/codefresh/integrations-codefresh-dashboard.png) -![integrations codefresh token](../../images/integrations/codefresh/integrations-codefresh-token.png) + + 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. + + + + Select which Infisical environment secrets you want to sync to which Codefresh service and press create integration to start syncing secrets to Codefresh. -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) - - - 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. - - -## 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. - -![create integration codefresh](../../images/integrations/codefresh/integrations-codefresh-create.png) -![integrations codefresh](../../images/integrations/codefresh/integrations-codefresh.png) + ![create integration codefresh](../../images/integrations/codefresh/integrations-codefresh-create.png) + ![integrations codefresh](../../images/integrations/codefresh/integrations-codefresh.png) + + \ No newline at end of file diff --git a/docs/integrations/cicd/githubactions.mdx b/docs/integrations/cicd/githubactions.mdx index 272594dfa..95fe53ece 100644 --- a/docs/integrations/cicd/githubactions.mdx +++ b/docs/integrations/cicd/githubactions.mdx @@ -5,71 +5,71 @@ description: "How to sync secrets from Infisical to GitHub Actions" - - 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). + -Prerequisites: + Prerequisites: -- 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. + - 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. -## 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 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) + + 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. + + + + Select which Infisical environment secrets you want to sync to which GitHub repo and press start integration to start syncing secrets to the repo. - - 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. - - -## 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. - -![integrations github](../../images/integrations/github/integrations-github.png) + ![integrations github](../../images/integrations/github/integrations-github.png) + + Using the GitHub integration on a self-hosted instance of Infisical requires configuring an OAuth application in GitHub and registering your instance with it. - - ## Create an OAuth application in GitHub - - 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-dev-settings.png) - ![integrations github config](../../images/integrations/github/integrations-github-config-new-app.png) + + + 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-dev-settings.png) + ![integrations github config](../../images/integrations/github/integrations-github-config-new-app.png) - Create the OAuth application. As part of the form, set the **Homepage URL** to your self-hosted domain `https://your-domain.com` - and the **Authorization callback URL** to `https://your-domain.com/integrations/github/oauth2/callback`. + Create the OAuth application. As part of the form, set the **Homepage URL** to your self-hosted domain `https://your-domain.com` + and the **Authorization callback URL** to `https://your-domain.com/integrations/github/oauth2/callback`. - ![integrations github config](../../images/integrations/github/integrations-github-config-new-app-form.png) - - - 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. - - - ## Add your OAuth application credentials to Infisical - - 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) - - Back in your Infisical instance, add two new environment variables for the credentials of your GitHub OAuth application: + ![integrations github config](../../images/integrations/github/integrations-github-config-new-app-form.png) + + + 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. + + + + 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) + + Back in your Infisical instance, add two new environment variables for the credentials of your GitHub OAuth application: - - `CLIENT_ID_GITHUB`: The **Client ID** 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. - + - `CLIENT_ID_GITHUB`: The **Client ID** 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. + + diff --git a/docs/integrations/cicd/gitlab.mdx b/docs/integrations/cicd/gitlab.mdx index 8635a5527..976c81a6d 100644 --- a/docs/integrations/cicd/gitlab.mdx +++ b/docs/integrations/cicd/gitlab.mdx @@ -5,112 +5,112 @@ description: "How to sync secrets from Infisical to GitLab" - 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 in Infisical. - - - ## Navigate to your project's integrations tab + ![integrations](../../images/integrations.png) -![integrations](../../images/integrations.png) + Press on the GitLab tile and grant Infisical access to your GitLab account. -## Authorize Infisical for GitLab + ![integrations gitlab authorization](../../images/integrations/gitlab/integrations-gitlab-auth.png) -Press on the GitLab tile and grant Infisical access to your GitLab account. + + 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. + + + + 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 authorization](../../images/integrations/gitlab/integrations-gitlab-auth.png) + ![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab-create.png) - - 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. - -## Start integration + Note that the GitLab integration supports a few options in the **Options** tab: -Select which Infisical environment secrets you want to sync to which GitLab repository and press create integration to start syncing secrets to GitLab. + - 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. -![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab-create.png) + 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. -Note that the GitLab integration supports a few options in the **Options** tab: + ![integrations gitlab options](../../images/integrations/gitlab/integrations-gitlab-create-options.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. + ![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab.png) + + + + + + + Generate an [Infisical Token](/documentation/platform/token) for the specific project and environment in Infisical. -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. + 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. + + + 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. -![integrations gitlab options](../../images/integrations/gitlab/integrations-gitlab-create-options.png) + #### Example -![integrations gitlab](../../images/integrations/gitlab/integrations-gitlab.png) - - - ## Generate service token + ```yaml + image: ubuntu -Generate an [Infisical Token](/documentation/platform/token) for the specific project and environment in Infisical. + stages: + - build + - test + - deploy -## Set the Infisical Token in Gitlab - -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. - -## 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. - -#### Example - -```yaml -image: ubuntu - -stages: - - build - - test - - deploy - -build-job: - stage: build - script: - - apt update && apt install -y curl - - curl -1sLf 'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.deb.sh' | bash - - apt-get update && apt-get install -y infisical - - infisical run -- npm run build -``` - - + build-job: + stage: build + script: + - apt update && apt install -y curl + - curl -1sLf 'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.deb.sh' | bash + - apt-get update && apt-get install -y infisical + - infisical run -- npm run build + ``` + + + + - Using the GitLab integration on a self-hosted instance of Infisical requires configuring an application in GitLab - and registering your instance with it. - - ## Create an OAuth 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. - 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-new-app.png) - - Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/gitlab/oauth2/callback`. + + + 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-new-app.png) + + Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/gitlab/oauth2/callback`. - ![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-new-app-form.png) - - - If you have a GitLab group, you can create an OAuth application under it - in your group Settings > Applications. - - - ## Add your OAuth application credentials to Infisical - - Obtain the **Application ID** and **Secret** for your GitLab application. - - ![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-credentials.png) - - Back in your Infisical instance, add two new environment variables for the credentials of your GitLab application: + ![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-new-app-form.png) + + + If you have a GitLab group, you can create an OAuth application under it + in your group Settings > Applications. + + + + Obtain the **Application ID** and **Secret** for your GitLab application. + + ![integrations gitlab config](../../images/integrations/gitlab/integrations-gitlab-config-credentials.png) + + Back in your Infisical instance, add two new environment variables for the credentials of your GitLab application: - - `CLIENT_ID_GITLAB`: The **Client ID** of your GitLab application. - - `CLIENT_SECRET_GITLAB`: The **Secret** of your GitLab application. - - Once added, restart your Infisical instance and use the GitLab integration. - + - `CLIENT_ID_GITLAB`: The **Client ID** of your GitLab application. + - `CLIENT_SECRET_GITLAB`: The **Secret** of your GitLab application. + + Once added, restart your Infisical instance and use the GitLab integration. + + diff --git a/docs/integrations/cicd/travisci.mdx b/docs/integrations/cicd/travisci.mdx index c0f917d5f..4e70c7696 100644 --- a/docs/integrations/cicd/travisci.mdx +++ b/docs/integrations/cicd/travisci.mdx @@ -7,30 +7,31 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + 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. + + + + 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. - - 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. - - -## 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. - -![create integration travis ci](../../images/integrations/travis-ci/integrations-travisci-create.png) -![integrations travis ci](../../images/integrations/travis-ci/integrations-travisci.png) + ![create integration travis ci](../../images/integrations/travis-ci/integrations-travisci-create.png) + ![integrations travis ci](../../images/integrations/travis-ci/integrations-travisci.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/aws-parameter-store.mdx b/docs/integrations/cloud/aws-parameter-store.mdx index 1ebb6d500..6fd341018 100644 --- a/docs/integrations/cloud/aws-parameter-store.mdx +++ b/docs/integrations/cloud/aws-parameter-store.mdx @@ -8,68 +8,69 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up AWS and have/create an IAM user -## 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) -![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: -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 -{ - "Version": "2012-10-17", - "Statement": [ + ```json { - "Sid": "AllowSSMAccess", - "Effect": "Allow", - "Action": [ - "ssm:PutParameter", - "ssm:DeleteParameter", - "ssm:GetParametersByPath", - "ssm:DeleteParameters" - ], - "Resource": "*" + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "AllowSSMAccess", + "Effect": "Allow", + "Action": [ + "ssm:PutParameter", + "ssm:DeleteParameter", + "ssm:GetParametersByPath", + "ssm:DeleteParameters" + ], + "Resource": "*" + } + ] } - ] -} -``` + ``` + + + 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) + + Navigate to your project's integrations tab in Infisical. -![integrations](../../images/integrations.png) + ![integrations](../../images/integrations.png) -## Authorize Infisical for AWS Parameter store + Press on the AWS Parameter Store tile and input your AWS access key ID and secret access key from the previous step. -Obtain a AWS access key ID and secret access key for your IAM user in IAM > Users > User > Security credentials > Access keys + ![integration auth](../../images/integrations/aws/integrations-aws-parameter-store-auth.png) -![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) + + 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. + + + + 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. -Press on the AWS Parameter Store tile and input your AWS access key ID and secret access key from the previous step. + ![integration create](../../images/integrations/aws/integrations-aws-parameter-store-create.png) -![integration auth](../../images/integrations/aws/integrations-aws-parameter-store-auth.png) + + Infisical requires you to add a path for your secrets to be stored in AWS + Parameter Store and recommends setting the path structure to + `/[project_name]/[environment]/` according to best practices. This enables a + secret like `TEST` to be stored as `/[project_name]/[environment]/TEST` in AWS + Parameter Store. + + + - - 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. - - -## 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. - -![integration create](../../images/integrations/aws/integrations-aws-parameter-store-create.png) - - - Infisical requires you to add a path for your secrets to be stored in AWS - Parameter Store and recommends setting the path structure to - `/[project_name]/[environment]/` according to best practices. This enables a - secret like `TEST` to be stored as `/[project_name]/[environment]/TEST` in AWS - Parameter Store. - diff --git a/docs/integrations/cloud/aws-secret-manager.mdx b/docs/integrations/cloud/aws-secret-manager.mdx index eadb66d91..f761d5164 100644 --- a/docs/integrations/cloud/aws-secret-manager.mdx +++ b/docs/integrations/cloud/aws-secret-manager.mdx @@ -8,66 +8,66 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Set up AWS and have/create an IAM user -## 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) -![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: -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 -{ - "Version": "2012-10-17", - "Statement": [ + ```json { - "Sid": "AllowSecretsManagerAccess", - "Effect": "Allow", - "Action": [ - "secretsmanager:GetSecretValue", - "secretsmanager:CreateSecret", - "secretsmanager:UpdateSecret" - ], - "Resource": "*" + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "AllowSecretsManagerAccess", + "Effect": "Allow", + "Action": [ + "secretsmanager:GetSecretValue", + "secretsmanager:CreateSecret", + "secretsmanager:UpdateSecret" + ], + "Resource": "*" + } + ] } - ] -} -``` + ``` + + + 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) + + Navigate to your project's integrations tab in Infisical. -![integrations](../../images/integrations.png) + ![integrations](../../images/integrations.png) -## Authorize Infisical for AWS Secrets Manager + Press on the AWS Secrets Manager tile and input your AWS access key ID and secret access key from the previous step. -Obtain a AWS access key ID and secret access key for your IAM user in IAM > Users > User > Security credentials > Access keys + ![integration auth](../../images/integrations/aws/integrations-aws-secret-manager-auth.png) -![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) + + 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. + + + + 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. -Press on the AWS Secrets Manager tile and input your AWS access key ID and secret access key from the previous step. + ![integration create](../../images/integrations/aws/integrations-aws-secret-manager-create.png) -![integration auth](../../images/integrations/aws/integrations-aws-secret-manager-auth.png) - - - 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. - - -## 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. - -![integration create](../../images/integrations/aws/integrations-aws-secret-manager-create.png) - - - Infisical currently syncs environment variables to AWS Secrets Manager as - key-value pairs under one secret. We're actively exploring ways to help users - group environment variable key-pairs under multiple secrets for greater - control. - + + Infisical currently syncs environment variables to AWS Secrets Manager as + key-value pairs under one secret. We're actively exploring ways to help users + group environment variable key-pairs under multiple secrets for greater + control. + + + \ No newline at end of file diff --git a/docs/integrations/cloud/azure-key-vault.mdx b/docs/integrations/cloud/azure-key-vault.mdx index 77e03d555..3a4b68e39 100644 --- a/docs/integrations/cloud/azure-key-vault.mdx +++ b/docs/integrations/cloud/azure-key-vault.mdx @@ -5,69 +5,69 @@ description: "How to sync secrets from Infisical to Azure Key Vault" - Prerequisites: + Prerequisites: -- Set up and add envars to [Infisical Cloud](https://app.infisical.com) -- Set up Azure and have an existing key vault + - Set up and add envars to [Infisical Cloud](https://app.infisical.com) + - Set up Azure and have an existing key vault -## Navigate to your project's integrations tab + + + 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. + + + 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. - -![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault-create.png) - -![integrations](../../images/integrations/azure-key-vault/integrations-azure-key-vault.png) - - - 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. - + + 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. + + + - Using the Azure KV integration on a self-hosted instance of Infisical requires configuring an application in Azure - and registering your instance with it. - - ## Create an application in Azure - - 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-new-app.png) + Using the Azure KV integration on a self-hosted instance of Infisical requires configuring an application in Azure + and registering your instance with it. - 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) - - ## 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. + + + 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-new-app.png) - ![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-2.png) - ![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-credentials-3.png) - - Back in your Infisical instance, add two new environment variables for the credentials of your Azure application. + 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) + + + Obtain the **Application (Client) ID** in Overview and generate a **Client Secret** in Certificate & secrets for your Azure application. - - `CLIENT_ID_AZURE`: The **Application (Client) ID** 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. + ![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-2.png) + ![integrations Azure KV config](../../images/integrations/azure-key-vault/integrations-azure-key-vault-config-credentials-3.png) + + Back in your Infisical instance, add two new environment variables for the credentials of your Azure application. - + - `CLIENT_ID_AZURE`: The **Application (Client) ID** 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. + + diff --git a/docs/integrations/cloud/checkly.mdx b/docs/integrations/cloud/checkly.mdx index 6b4709be9..618082a3b 100644 --- a/docs/integrations/cloud/checkly.mdx +++ b/docs/integrations/cloud/checkly.mdx @@ -7,44 +7,45 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) -![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. -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) + + 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. + + + + Select which Infisical environment secrets you want to sync to Checkly and press create integration to start syncing secrets. - - 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. - + ![integrations checkly](../../images/integrations/checkly/integrations-checkly-create.png) -## Start integration + + 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. + -Select which Infisical environment secrets you want to sync to Checkly and press create integration to start syncing secrets. + ![integrations checkly](../../images/integrations/checkly/integrations-checkly.png) -![integrations checkly](../../images/integrations/checkly/integrations-checkly-create.png) - - - 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. - - -![integrations checkly](../../images/integrations/checkly/integrations-checkly.png) - - - 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 - might run into issues with deleting secrets from the wrong environments. - + + 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 + might run into issues with deleting secrets from the wrong environments. + + + \ No newline at end of file diff --git a/docs/integrations/cloud/cloudflare-pages.mdx b/docs/integrations/cloud/cloudflare-pages.mdx index 7160aeb58..4d28cc574 100644 --- a/docs/integrations/cloud/cloudflare-pages.mdx +++ b/docs/integrations/cloud/cloudflare-pages.mdx @@ -7,38 +7,39 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + Navigate to your project's integrations tab in Infisical. -![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) + ![integrations](../../images/integrations.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 + 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 credentials 4](../../images/integrations/cloudflare/integrations-cloudflare-credentials-4.png) + ![integrations cloudflare authorization](../../images/integrations/cloudflare/integrations-cloudflare-auth.png) -Press on the Cloudflare Pages tile and input your Cloudflare API token and account ID to grant Infisical access to your Cloudflare Pages. + + 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. + + + + Select which Infisical environment secrets you want to sync to Cloudflare and press create integration to start syncing secrets. -![integrations cloudflare authorization](../../images/integrations/cloudflare/integrations-cloudflare-auth.png) - - - 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. - - -## Start integration - -Select which Infisical environment secrets you want to sync to Cloudflare and press create integration to start syncing secrets. - -![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare-create.png) -![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare.png) + ![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare-create.png) + ![integrations cloudflare](../../images/integrations/cloudflare/integrations-cloudflare.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/cloudflare-workers.mdx b/docs/integrations/cloud/cloudflare-workers.mdx index e8d10b153..de81ca083 100644 --- a/docs/integrations/cloud/cloudflare-workers.mdx +++ b/docs/integrations/cloud/cloudflare-workers.mdx @@ -7,37 +7,38 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) -![integrations cloudflare credentials 2](../../images/integrations/cloudflare/integrations-cloudflare-credentials-2.png) -![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-credentials-3.png) + Navigate to your project's integrations tab in Infisical. -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) + + 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. + + + + Select which Infisical environment secrets you want to sync to Cloudflare Workers and press create integration to start syncing secrets. - - 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. - - -## Start integration - -Select which Infisical environment secrets you want to sync to Cloudflare Workers and press create integration to start syncing secrets. - -![integrations cloudflare](../../images/integrations/cloudflare/integration-cloudflare-workers-create.png) + ![integrations cloudflare](../../images/integrations/cloudflare/integration-cloudflare-workers-create.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/flyio.mdx b/docs/integrations/cloud/flyio.mdx index 7fe89495d..71b24e2a9 100644 --- a/docs/integrations/cloud/flyio.mdx +++ b/docs/integrations/cloud/flyio.mdx @@ -7,31 +7,32 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) -![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. -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) + + 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. + + + + 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. - - 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. - - -## 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. - -![integrations fly](../../images/integrations/flyio/integrations-flyio-create.png) -![integrations fly](../../images/integrations/flyio/integrations-flyio.png) + ![integrations fly](../../images/integrations/flyio/integrations-flyio-create.png) + ![integrations fly](../../images/integrations/flyio/integrations-flyio.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/gcp-secret-manager.mdx b/docs/integrations/cloud/gcp-secret-manager.mdx index 505475009..0f21a6a9d 100644 --- a/docs/integrations/cloud/gcp-secret-manager.mdx +++ b/docs/integrations/cloud/gcp-secret-manager.mdx @@ -5,148 +5,145 @@ description: "How to sync secrets from Infisical to GCP Secret Manager" + + + Prerequisites: + - Set up and add envars to [Infisical Cloud](https://app.infisical.com) - - - - Prerequisites: + + + Navigate to your project's integrations tab in Infisical. -- Set up and add envars to [Infisical Cloud](https://app.infisical.com) - ## Navigate to your project's integrations tab + ![integrations](../../images/integrations.png) -![integrations](../../images/integrations.png) + Press on the GCP Secret Manager tile and select **Continue with OAuth** -## Authorize Infisical for GCP + ![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png) -Press on the GCP Secret Manager tile and select **Continue with OAuth** + Grant Infisical access to GCP. -![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png) + ![integrations GCP authorization](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth.png) -Grant Infisical access to GCP. + + 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. + + + + 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. -![integrations GCP authorization](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth.png) + ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png) - - 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. - + Note that the GCP Secret Manager integration supports a few options in the **Options** tab: -## Start integration + - 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. -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. + 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-create.png) + ![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png) -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.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. + + 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). + + + + + + 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 -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. + + + Navigate to **IAM & Admin** page in GCP and add the **Secret Manager Admin** and **Service Usage Admin** roles to the service account. -![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png) + ![integrations GCP secret manager IAM](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam.png) -![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png) + + 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) + and list which GCP services are enabled/disabled (e.g. **Service Usage Admin** role). + - - 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). - - - - Prerequisites: + Navigate to your project's integrations tab in Infisical. -- 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 + ![integrations](../../images/integrations.png) -## Grant the service account permissions for GCP Secret Manager + 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). -Navigate to **IAM & Admin** page in GCP and add the **Secret Manager Admin** and **Service Usage Admin** roles to the service account. + ![integrations GCP authorization IAM key](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam-key.png) -![integrations GCP secret manager IAM](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam.png) + ![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png) - - 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) - and list which GCP services are enabled/disabled (e.g. **Service Usage Admin** role). - + + 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. + + + + 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. -## Navigate to your project's integrations tab + ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png) -![integrations](../../images/integrations.png) + Note that the GCP Secret Manager integration supports a few options in the **Options** tab: -## Authorize Infisical for GCP + - 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. -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). + 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 authorization IAM key](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-iam-key.png) + ![integrations GCP secret manager options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png) -![integrations GCP authorization options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-auth-options.png) + ![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png) - - 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. - - -## 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. - -![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create.png) - -Note that the GCP Secret Manager 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. -- 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 options](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager-create-options.png) - -![integrations GCP secret manager](../../images/integrations/gcp-secret-manager/integrations-gcp-secret-manager.png) - - - 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). - - - + + 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). + + + + + - 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. - - ## Create an OAuth2 application in GCP - - 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-new-app.png) - - 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) - - ## Add your OAuth2 application credentials to Infisical - - 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) - - Back in your Infisical instance, add two new environment variables for the credentials of your GCP OAuth2 application: + 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. - - `CLIENT_ID_GCP_SECRET_MANAGER`: The **Client ID** 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. + + + 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-new-app.png) + + 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) + + + 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) + + Back in your Infisical instance, add two new environment variables for the credentials of your GCP OAuth2 application: + - `CLIENT_ID_GCP_SECRET_MANAGER`: The **Client ID** 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. + + diff --git a/docs/integrations/cloud/hasura-cloud.mdx b/docs/integrations/cloud/hasura-cloud.mdx index 770852742..48d9d301b 100644 --- a/docs/integrations/cloud/hasura-cloud.mdx +++ b/docs/integrations/cloud/hasura-cloud.mdx @@ -7,30 +7,31 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + 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 tokens](../../images/integrations/hasura-cloud/integrations-hasura-cloud-tokens.png) + ![integrations hasura cloud authorization](../../images/integrations/hasura-cloud/integrations-hasura-cloud-auth.png) -Press on the Hasura Cloud tile and input your Hasura Cloud access token to grant Infisical access to your Hasura Cloud account. + + 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. + + + + 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. -![integrations hasura cloud authorization](../../images/integrations/hasura-cloud/integrations-hasura-cloud-auth.png) - - - 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. - - -## 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. - -![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud-create.png) -![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud.png) + ![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud-create.png) + ![integrations hasura cloud](../../images/integrations/hasura-cloud/integrations-hasura-cloud.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/heroku.mdx b/docs/integrations/cloud/heroku.mdx index bcac12f21..2d8fdc445 100644 --- a/docs/integrations/cloud/heroku.mdx +++ b/docs/integrations/cloud/heroku.mdx @@ -5,63 +5,63 @@ description: "How to sync secrets from Infisical to Heroku" - 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 + + + 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) - - - 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. - - -## 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. - -![integrations heroku](../../images/integrations/heroku/integrations-heroku-create.png) -![integrations heroku](../../images/integrations/heroku/integrations-heroku.png) + + 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. + + + + Select which Infisical environment secrets you want to sync to which Heroku app and press create integration to start syncing secrets to Heroku. + + ![integrations heroku](../../images/integrations/heroku/integrations-heroku-create.png) + ![integrations heroku](../../images/integrations/heroku/integrations-heroku.png) + + - Using the Heroku integration on a self-hosted instance of Infisical requires configuring an API client in Heroku - and registering your instance with it. - - ## Create an API client in Heroku - - Navigate to your user Account settings > Applications to create a new API client. + Using the Heroku integration on a self-hosted instance of Infisical requires configuring an API client in Heroku + and registering your instance with it. + + + 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-applications.png) - ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-new-app.png) - - 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-settings.png) + ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-applications.png) + ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-new-app.png) + + 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) - - ## Add your Heroku API client credentials to Infisical - - Obtain the **Client ID** and **Client Secret** for your Heroku API client. - - ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-credentials.png) - - Back in your Infisical instance, add two new environment variables for the credentials of your Heroku API client. - - - `CLIENT_ID_HEROKU`: The **Client ID** 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. + ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-new-app-form.png) + + + Obtain the **Client ID** and **Client Secret** for your Heroku API client. + + ![integrations Heroku config](../../images/integrations/heroku/integrations-heroku-config-credentials.png) + + Back in your Infisical instance, add two new environment variables for the credentials of your Heroku API client. + - `CLIENT_ID_HEROKU`: The **Client ID** 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. + + diff --git a/docs/integrations/cloud/laravel-forge.mdx b/docs/integrations/cloud/laravel-forge.mdx index 67a771e6f..5797692ea 100644 --- a/docs/integrations/cloud/laravel-forge.mdx +++ b/docs/integrations/cloud/laravel-forge.mdx @@ -7,36 +7,38 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + Navigate to your project's integrations tab in Infisical. -![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) + ![integrations](../../images/integrations.png) -Obtain your Laravel Forge Server ID in Servers > Server ID + 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](../../images/integrations/laravel-forge/integrations-laravelforge-servers.png) -![integrations laravel forge server id](../../images/integrations/laravel-forge/integrations-laravelforge-serverid.png) + ![integrations laravel forge authorization](../../images/integrations/laravel-forge/integrations-laravelforge-auth.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. + + 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. + + + + 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 authorization](../../images/integrations/laravel-forge/integrations-laravelforge-auth.png) + ![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge-create.png) + ![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge.png) + + - - 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. - - -## 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. - -![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge-create.png) -![integrations laravel forge](../../images/integrations/laravel-forge/integrations-laravelforge.png) diff --git a/docs/integrations/cloud/netlify.mdx b/docs/integrations/cloud/netlify.mdx index 6fe401021..f9b20abda 100644 --- a/docs/integrations/cloud/netlify.mdx +++ b/docs/integrations/cloud/netlify.mdx @@ -5,68 +5,68 @@ description: "How to sync secrets from Infisical to Netlify" - - Infisical integrates with Netlify's new environment variable experience. If - your site uses Netlify's old environment variable experience, you'll have to - upgrade it to the new one to use this integration. - + + Infisical integrates with Netlify's new environment variable experience. If + your site uses Netlify's old environment variable experience, you'll have to + upgrade it to the new one to use this integration. + + + 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 in Infisical. + + ![integrations](../../images/integrations.png) -## Navigate to your project's integrations tab + Press on the Netlify tile and grant Infisical access to your Netlify account. -![integrations](../../images/integrations.png) + ![integrations netlify authorization](../../images/integrations/netlify/integrations-netlify-auth.png) -## Authorize Infisical for Netlify - -Press on the Netlify tile and grant Infisical access to your Netlify account. - -![integrations netlify authorization](../../images/integrations/netlify/integrations-netlify-auth.png) - - - 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. - - -## 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. - -![integrations netlify](../../images/integrations/netlify/integrations-netlify-create.png) -![integrations netlify](../../images/integrations/netlify/integrations-netlify.png) + + 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. + + + + 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) + + Using the Netlify integration on a self-hosted instance of Infisical requires configuring an OAuth application in Netlify and registering your instance with it. - - ## Create an OAuth application in Netlify - - 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-new-app.png) - - Create the OAuth application. As part of the form, set the **Redirect URI** to `https://your-domain.com/integrations/netlify/oauth2/callback`. + + + 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-new-app.png) + + 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) + + + Obtain the **Client ID** and **Secret** for your Netlify OAuth application. + + ![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-credentials.png) + + Back in your Infisical instance, add two new environment variables for the credentials of your Netlify OAuth application. - ## Add your Netlify OAuth application credentials to Infisical - - Obtain the **Client ID** and **Secret** for your Netlify OAuth application. - - ![integrations Netlify config](../../images/integrations/netlify/integrations-netlify-config-credentials.png) - - Back in your Infisical instance, add two new environment variables for the credentials of your Netlify OAuth application. - - - `CLIENT_ID_NETLIFY`: The **Client ID** 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. + - `CLIENT_ID_NETLIFY`: The **Client ID** 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. + + diff --git a/docs/integrations/cloud/northflank.mdx b/docs/integrations/cloud/northflank.mdx index c677e871c..117ac73a8 100644 --- a/docs/integrations/cloud/northflank.mdx +++ b/docs/integrations/cloud/northflank.mdx @@ -8,31 +8,32 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) - Have a [Northflank](https://northflank.com) project with a secret group ready -## Navigate to your project's integrations tab + + + 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) + + Navigate to your project's integrations tab in Infisical. -## Enter your Northflank API Token + ![integrations](../../images/integrations.png) -Obtain a Northflank API token in Account settings > API > Tokens + Press on the Northflank tile and input your Northflank API token to grant Infisical access to your Northflank account. -![integrations northflank dashboard](../../images/integrations/northflank/integrations-northflank-dashboard.png) -![integrations northflank token](../../images/integrations/northflank/integrations-northflank-token.png) + ![integrations northflank authorization](../../images/integrations/northflank/integrations-northflank-auth.png) -Press on the Northflank tile and input your Northflank API token to grant Infisical access to your Northflank account. + + 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. + + + + 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. -![integrations northflank authorization](../../images/integrations/northflank/integrations-northflank-auth.png) - - - 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. - - -## 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. - -![integrations northflank](../../images/integrations/northflank/integrations-northflank-create.png) -![integrations northflank](../../images/integrations/northflank/integrations-northflank.png) + ![integrations northflank](../../images/integrations/northflank/integrations-northflank-create.png) + ![integrations northflank](../../images/integrations/northflank/integrations-northflank.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/qovery.mdx b/docs/integrations/cloud/qovery.mdx index 98539dc8f..6eae9b954 100644 --- a/docs/integrations/cloud/qovery.mdx +++ b/docs/integrations/cloud/qovery.mdx @@ -7,37 +7,38 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + 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 is necessary for Infisical to sync the environment variables to + the cloud platform. + + + + Select which Infisical environment secrets you want to sync to Qovery and press create integration to start syncing secrets. - - 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 is necessary for Infisical to sync the environment variables to - the cloud platform. - + ![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-1.png) -## Start integration + ![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-2.png) -Select which Infisical environment secrets you want to sync to Qovery and press create integration to start syncing secrets. + + Infisical supports syncing secrets to various Qovery scopes including applications, jobs, or containers. + -![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-1.png) - -![integrations qovery create](../../images/integrations/qovery/integrations-qovery-create-2.png) - - - Infisical supports syncing secrets to various Qovery scopes including applications, jobs, or containers. - - -![integrations qovery settings](../../images/integrations/qovery/integrations-qovery.png) \ No newline at end of file + ![integrations qovery settings](../../images/integrations/qovery/integrations-qovery.png) + + diff --git a/docs/integrations/cloud/railway.mdx b/docs/integrations/cloud/railway.mdx index e12881995..3f08d75a0 100644 --- a/docs/integrations/cloud/railway.mdx +++ b/docs/integrations/cloud/railway.mdx @@ -7,48 +7,47 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) + + + 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) + + 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. + + Note that Railway project tokens will not work for this integration since they don't work with + Railway's Public API. + -## Enter your Railway API Token + Navigate to your project's integrations tab in Infisical. -Obtain a Railway API Token in your Railway [Account Settings > Tokens](https://railway.app/account/tokens). + ![integrations](../../images/integrations.png) -![integrations railway dashboard](../../images/integrations/railway/integrations-railway-dashboard.png) -![integrations railway token](../../images/integrations/railway/integrations-railway-token.png) + Press on the Railway tile and input your Railway API Key to grant Infisical access to your Railway account. - - 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. - - Note that Railway project tokens will not work for this integration since they don't work with - Railway's Public API. - + ![integrations railway authorization](../../images/integrations/railway/integrations-railway-authorization.png) -Press on the Railway tile and input your Railway API Key to grant Infisical access to your Railway account. + + 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. + + + + 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. -![integrations railway authorization](../../images/integrations/railway/integrations-railway-authorization.png) + ![integrations create railway](../../images/integrations/railway/integrations-railway-create.png) - - 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. - - -## 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. - -![integrations create railway](../../images/integrations/railway/integrations-railway-create.png) - - - 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. - - -![integrations railway](../../images/integrations/railway/integrations-railway.png) + + 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. + + ![integrations railway](../../images/integrations/railway/integrations-railway.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/render.mdx b/docs/integrations/cloud/render.mdx index 237226562..970789a31 100644 --- a/docs/integrations/cloud/render.mdx +++ b/docs/integrations/cloud/render.mdx @@ -7,31 +7,32 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) -![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. -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) + + 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. + + + + Select which Infisical environment secrets you want to sync to which Render service and press create integration to start syncing secrets to Render. - - 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. - - -## 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. - -![integrations render](../../images/integrations/render/integrations-render-create.png) -![integrations render](../../images/integrations/render/integrations-render.png) + ![integrations render](../../images/integrations/render/integrations-render-create.png) + ![integrations render](../../images/integrations/render/integrations-render.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/supabase.mdx b/docs/integrations/cloud/supabase.mdx index 14e113ea6..3e94c0f51 100644 --- a/docs/integrations/cloud/supabase.mdx +++ b/docs/integrations/cloud/supabase.mdx @@ -14,31 +14,32 @@ Prerequisites: - Have an account and project set up at [Supabase](https://supabase.com/) - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) + + Navigate to your project's integrations tab in Infisical. -![integrations](../../images/integrations.png) + ![integrations](../../images/integrations.png) + + Press on the Supabase tile and input your Supabase Access Token to grant Infisical access to your Supabase account. -## Enter your Supabase Access Token + ![integrations supabase authorization](../../images/integrations/supabase/integrations-supabase-authorization.png) -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) + + 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. + + + + Select which Infisical environment secrets you want to sync to which Supabase project. Lastly, press create integration to start syncing secrets to Supabase. -Press on the Supabase tile and input your Supabase Access Token to grant Infisical access to your Supabase account. + ![integrations supabase create](../../images/integrations/supabase/integrations-supabase-create.png) -![integrations supabase authorization](../../images/integrations/supabase/integrations-supabase-authorization.png) - - - 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. - - -## 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. - -![integrations supabase create](../../images/integrations/supabase/integrations-supabase-create.png) - -![integrations supabase](../../images/integrations/supabase/integrations-supabase.png) \ No newline at end of file + ![integrations supabase](../../images/integrations/supabase/integrations-supabase.png) + + diff --git a/docs/integrations/cloud/teamcity.mdx b/docs/integrations/cloud/teamcity.mdx index 2ade11a66..20a9dfbea 100644 --- a/docs/integrations/cloud/teamcity.mdx +++ b/docs/integrations/cloud/teamcity.mdx @@ -7,44 +7,45 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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 + + 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** + is selected, then it must at minimum have the **View build configuration settings** and **Edit project** permissions enabled. + -Obtain a TeamCity Access Token in Profile > Access Tokens + Navigate to your project's integrations tab in Infisical. -![integrations teamcity dashboard](../../images/integrations/teamcity/integrations-teamcity-dashboard.png) -![integrations teamcity token](../../images/integrations/teamcity/integrations-teamcity-token.png) + ![integrations](../../images/integrations.png) - - 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** - is selected, then it must at minimum have the **View build configuration settings** and **Edit project** permissions enabled. - + Press on the TeamCity tile and input your TeamCity Access Token and Server URL to grant Infisical access to your TeamCity account. - - 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. - + ![integrations teamcity authorization](../../images/integrations/teamcity/integrations-teamcity-auth.png) -Press on the TeamCity tile and input your TeamCity Access Token and Server URL to grant Infisical access to your TeamCity account. + + 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. + + + + 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 authorization](../../images/integrations/teamcity/integrations-teamcity-auth.png) + ![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity-create.png) -## Start integration + + 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. + -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) - - - 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. - - -![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity.png) + ![integrations teamcity](../../images/integrations/teamcity/integrations-teamcity.png) + + diff --git a/docs/integrations/cloud/terraform-cloud.mdx b/docs/integrations/cloud/terraform-cloud.mdx index 0d68b02e3..3fd70df73 100644 --- a/docs/integrations/cloud/terraform-cloud.mdx +++ b/docs/integrations/cloud/terraform-cloud.mdx @@ -7,36 +7,37 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) -![integrations terraform cloud tokens](../../images/integrations/terraform/integrations-terraformcloud-tokens.png) + Navigate to your project's integrations tab in Infisical. -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) -![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. -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) + + 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. + + + + 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. - - 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. - - -## 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. - -![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud-create.png) -![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud.png) + ![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud-create.png) + ![integrations terraform cloud](../../images/integrations/terraform/integrations-terraformcloud.png) + + \ No newline at end of file diff --git a/docs/integrations/cloud/vercel.mdx b/docs/integrations/cloud/vercel.mdx index b7396d067..a88c6616b 100644 --- a/docs/integrations/cloud/vercel.mdx +++ b/docs/integrations/cloud/vercel.mdx @@ -5,82 +5,82 @@ description: "How to sync secrets from Infisical to Vercel" - 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 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. + + 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. + + + + 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. -![integrations vercel authorization](../../images/integrations/vercel/integrations-vercel-auth.png) + ![integrations vercel](../../images/integrations/vercel/integrations-vercel-create.png) + ![integrations vercel](../../images/integrations/vercel/integrations-vercel.png) - - 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. - + + 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 + 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. + -## 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. - -![integrations vercel](../../images/integrations/vercel/integrations-vercel-create.png) -![integrations vercel](../../images/integrations/vercel/integrations-vercel.png) - - - 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 - 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. - - - - The following environment variable names are reserved by Vercel and cannot be - synced: `AWS_SECRET_KEY`, `AWS_EXECUTION_ENV`, `AWS_LAMBDA_LOG_GROUP_NAME`, - `AWS_LAMBDA_LOG_STREAM_NAME`, `AWS_LAMBDA_FUNCTION_NAME`, - `AWS_LAMBDA_FUNCTION_MEMORY_SIZE`, `AWS_LAMBDA_FUNCTION_VERSION`, - `NOW_REGION`, `TZ`, `LAMBDA_TASK_ROOT`, `LAMBDA_RUNTIME_DIR`, - `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`, - `AWS_REGION`, and `AWS_DEFAULT_REGION`. - + + The following environment variable names are reserved by Vercel and cannot be + synced: `AWS_SECRET_KEY`, `AWS_EXECUTION_ENV`, `AWS_LAMBDA_LOG_GROUP_NAME`, + `AWS_LAMBDA_LOG_STREAM_NAME`, `AWS_LAMBDA_FUNCTION_NAME`, + `AWS_LAMBDA_FUNCTION_MEMORY_SIZE`, `AWS_LAMBDA_FUNCTION_VERSION`, + `NOW_REGION`, `TZ`, `LAMBDA_TASK_ROOT`, `LAMBDA_RUNTIME_DIR`, + `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`, + `AWS_REGION`, and `AWS_DEFAULT_REGION`. + + + - Using the Vercel integration on a self-hosted instance of Infisical requires configuring an integration in Vercel. - and registering your instance with it. - - ## Create an integration in Vercel - - 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-new-app.png) + Using the Vercel integration on a self-hosted instance of Infisical requires configuring an integration in Vercel. + and registering your instance with it. - Create the application. As part of the form, set a **URL Slug** to a unique slug like `infisical-your-domain` and keep it handy. Also, set **Redirect URL** to `https://your-domain.com/integrations/vercel/oauth2/callback`. Lastly, - be sure to set the API Scopes according to the second screenshot below. - - ![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) - - ## 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. + + + 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-new-app.png) + + Create the application. As part of the form, set a **URL Slug** to a unique slug like `infisical-your-domain` and keep it handy. Also, set **Redirect URL** to `https://your-domain.com/integrations/vercel/oauth2/callback`. Lastly, + be sure to set the API Scopes according to the second screenshot below. + + ![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) + + + 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) - - Back in your Infisical instance, add three new environment variables for the credentials of your Vercel integration. - - - `CLIENT_ID_VERCEL`: The **Client (Integration) ID** of your Vercel integration. - - `CLIENT_SECRET_VERCEL`: The **Client (Integration) Secret** 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. + ![integrations Vercel config](../../images/integrations/vercel/integrations-vercel-config-credentials.png) + + Back in your Infisical instance, add three new environment variables for the credentials of your Vercel integration. + - `CLIENT_ID_VERCEL`: The **Client (Integration) ID** of your Vercel integration. + - `CLIENT_SECRET_VERCEL`: The **Client (Integration) Secret** 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. + + diff --git a/docs/integrations/cloud/windmill.mdx b/docs/integrations/cloud/windmill.mdx index 9b41b12bd..0fc6fddeb 100644 --- a/docs/integrations/cloud/windmill.mdx +++ b/docs/integrations/cloud/windmill.mdx @@ -7,40 +7,41 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) -## Navigate to your project's integrations tab + + + 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) -![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. -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) + + 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. + + + + Select which Infisical environment secrets you want to sync to which Windmill workspace and press create integration to start syncing secrets to Windmill. - - 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. - + ![integrations windmill](../../images/integrations/windmill/integrations-windmill-create.png) + ![integrations windmill](../../images/integrations/windmill/integrations-windmill.png) -## 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. - -![integrations windmill](../../images/integrations/windmill/integrations-windmill-create.png) -![integrations windmill](../../images/integrations/windmill/integrations-windmill.png) - - - Secrets synced to Windmill are subject to the [ownership path - prefix](https://www.windmill.dev/docs/core_concepts/roles_and_permissions) - 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 - 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`. - + + Secrets synced to Windmill are subject to the [ownership path + prefix](https://www.windmill.dev/docs/core_concepts/roles_and_permissions) + 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 + 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`. + + + \ No newline at end of file