From 7447288e5ccfbeddbc09192149fc840ab2767d33 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Mon, 28 Nov 2022 09:57:17 -0500 Subject: [PATCH 1/6] Add integrations anchor and preliminary framework integrations to docs --- README.md | 19 +++++--- docs/cli/token.mdx | 4 +- docs/getting-started/dashboard/token.mdx | 2 +- docs/getting-started/introduction.mdx | 2 +- docs/integrations/{ => cloud}/heroku.mdx | 0 docs/integrations/frameworks/django.mdx | 5 ++ docs/integrations/frameworks/express.mdx | 42 ++++++++++++++++ docs/integrations/frameworks/flask.mdx | 21 ++++++++ docs/integrations/frameworks/gatsby.mdx | 39 +++++++++++++++ docs/integrations/frameworks/laravel.mdx | 5 ++ docs/integrations/frameworks/nestjs.mdx | 47 ++++++++++++++++++ docs/integrations/frameworks/nextjs.mdx | 37 ++++++++++++++ docs/integrations/frameworks/rails.mdx | 5 ++ docs/integrations/frameworks/react.mdx | 34 +++++++++++++ docs/integrations/frameworks/remix.mdx | 5 ++ docs/integrations/overview.mdx | 42 +++++++++------- .../{ => platforms}/docker-compose.mdx | 2 +- docs/integrations/{ => platforms}/docker.mdx | 2 +- docs/mint.json | 48 +++++++++++++++---- 19 files changed, 323 insertions(+), 38 deletions(-) rename docs/integrations/{ => cloud}/heroku.mdx (100%) create mode 100644 docs/integrations/frameworks/django.mdx create mode 100644 docs/integrations/frameworks/express.mdx create mode 100644 docs/integrations/frameworks/flask.mdx create mode 100644 docs/integrations/frameworks/gatsby.mdx create mode 100644 docs/integrations/frameworks/laravel.mdx create mode 100644 docs/integrations/frameworks/nestjs.mdx create mode 100644 docs/integrations/frameworks/nextjs.mdx create mode 100644 docs/integrations/frameworks/rails.mdx create mode 100644 docs/integrations/frameworks/react.mdx create mode 100644 docs/integrations/frameworks/remix.mdx rename docs/integrations/{ => platforms}/docker-compose.mdx (97%) rename docs/integrations/{ => platforms}/docker.mdx (95%) diff --git a/README.md b/README.md index d819b1cd9..5ca7bd43c 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ - **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure - **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.) - **Personal/Shared** scoping for environment variables -- **[Integrations](https://infisical.com/docs/integrations/heroku)** with CI/CD and production infrastructure (Heroku available, more coming soon) +- **[Integrations](https://infisical.com/docs/integrations/overview)** with CI/CD and production infrastructure (Heroku available, more coming soon) - 🔜 **1-Click Deploy** to Digital Ocean and Heroku - 🔜 **Authentication/Authorization** for projects (read/write controls soon) - 🔜 **Automatic Secret Rotation** @@ -92,19 +92,24 @@ Infisical officially launched as v.1.0 on November 21st, 2022. However, a lot of ## Integrations -We're currently setting the foundation and building integrations so secrets can be synced everywhere. Any help is welcome! :) +We're currently setting the foundation and building [integrations](https://infisical.com/docs/integrations/overview) so secrets can be synced everywhere. Any help is welcome! :) -- [x] [Docker](https://infisical.com/docs/integrations/docker) -- [x] [Docker Compose](https://infisical.com/docs/integrations/docker-compose) -- [x] [Heroku](https://infisical.com/docs/integrations/heroku) -- [ ] Vercel +- [x] [Docker](https://infisical.com/docs/integrations/platforms/docker) +- [x] [Docker Compose](https://infisical.com/docs/integrations/platforms/docker-compose) - [ ] Kubernetes +- [x] [Heroku](https://infisical.com/docs/integrations/cloud/heroku) +- [ ] Vercel - [ ] AWS - [ ] GCP - [ ] Azure - [ ] Digital Ocean - [ ] GitLab -- [ ] CircleCI +- [x] React +- [x] Express +- [x] Next.js +- [x] NestJS +- [x] Gatsby +- [x] Flask ## Open-source vs. paid diff --git a/docs/cli/token.mdx b/docs/cli/token.mdx index 043f07431..5b3d2fd6b 100644 --- a/docs/cli/token.mdx +++ b/docs/cli/token.mdx @@ -12,8 +12,8 @@ The CLI looks out for an environment variable called the `INFISICAL_TOKEN` which A common use-case is to use the Infisical Token to fetch environment variables with Docker. More specifically, a token can be passed to a container as an environment variable for the CLI to authenticate and pull its corresponding secrets. Check out the integration guides for that: -- [Docker](../../integrations/docker) -- [Docker Compose](../../integrations/docker-compose) +- [Docker](../../integrations/platforms/docker) +- [Docker Compose](../../integrations/platforms/docker-compose) Once the token is expired, the CLI using it will no longer be able to make diff --git a/docs/getting-started/dashboard/token.mdx b/docs/getting-started/dashboard/token.mdx index 5cde8d61d..85f46b799 100644 --- a/docs/getting-started/dashboard/token.mdx +++ b/docs/getting-started/dashboard/token.mdx @@ -4,7 +4,7 @@ title: "Infisical Token" An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials. -It's useful for the [Docker](/integrations/docker) and [Docker Compose](/integrations/docker-compose) integrations. +It's useful for the [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose) integrations. It's possible to generate the token in the settings of a project. diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx index 5f5d2a44d..72b86bf05 100644 --- a/docs/getting-started/introduction.mdx +++ b/docs/getting-started/introduction.mdx @@ -27,7 +27,7 @@ Start syncing environment variables with [Infisical Cloud](https://app.infisical Learn how to configure and deploy Infisical. Date: Mon, 28 Nov 2022 19:28:54 -0500 Subject: [PATCH 2/6] change link for infisical cloud to infisical.com instead of sign up page --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ca7bd43c..7bb57ec90 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

Slack | - Infisical Cloud | + Infisical Cloud | Self-Hosting | Docs | Website From 8953fdf1d81fba7b29df9abdf9d10103371921bf Mon Sep 17 00:00:00 2001 From: mv-turtle <78047717+mv-turtle@users.noreply.github.com> Date: Mon, 28 Nov 2022 21:12:10 -0500 Subject: [PATCH 3/6] Updated integrations in README.md --- README.md | 206 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 190 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 7bb57ec90..75459b39e 100644 --- a/README.md +++ b/README.md @@ -94,22 +94,196 @@ Infisical officially launched as v.1.0 on November 21st, 2022. However, a lot of We're currently setting the foundation and building [integrations](https://infisical.com/docs/integrations/overview) so secrets can be synced everywhere. Any help is welcome! :) -- [x] [Docker](https://infisical.com/docs/integrations/platforms/docker) -- [x] [Docker Compose](https://infisical.com/docs/integrations/platforms/docker-compose) -- [ ] Kubernetes -- [x] [Heroku](https://infisical.com/docs/integrations/cloud/heroku) -- [ ] Vercel -- [ ] AWS -- [ ] GCP -- [ ] Azure -- [ ] Digital Ocean -- [ ] GitLab -- [x] React -- [x] Express -- [x] Next.js -- [x] NestJS -- [x] Gatsby -- [x] Flask + + + + + + + + + +
Platforms Frameworks
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + ✔️ Docker + + + + ✔️ Docker Compose + + + + ✔️ Heroku + +
+ + 🔜 Vercel + + + + 🔜 GitLab CI/CD + + + + 🔜 Fly.io + +
+ + 🔜 Netlify + + + + 🔜 GitHub Actions + + + + 🔜 Railway + +
+ + 🔜 GCP + + + + 🔜 Kubernetes + + + + 🔜 CircleCI + +
+ + 🔜 Jenkins + + + + 🔜 Digital Ocean + + + + 🔜 Azure + +
+ + 🔜 TravisCI + + + + 🔜 AWS + +
+ + 		+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + ✔️ React + + + + ✔️ Express + +
+ + ✔️ Gatsby + + + + ✔️ Flask + +
+ + ✔️ Django + + + + ✔️ Laravel + +
+ + ✔️ NestJS + + + + ✔️ Remix + +
+ + ✔️ Next.js + + + + 🔜 Vite + +
+ + ✔️ Ruby on Rails + +
+ +
+ ## Open-source vs. paid From 078dbde45a37bf09c16aa3797768be42d0b6640e Mon Sep 17 00:00:00 2001 From: mv-turtle <78047717+mv-turtle@users.noreply.github.com> Date: Mon, 28 Nov 2022 21:37:47 -0500 Subject: [PATCH 4/6] Update README.md --- README.md | 50 +++++++++++++------------------------------------- 1 file changed, 13 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 75459b39e..1a517e148 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ **[Infisical](https://infisical.com)** is an open source, E2EE tool to help teams manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and take minutes to get going. -- **User-Friendly Dashboard** to manage your team's environment variables within projects +- **[User-Friendly Dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage your team's environment variables within projects - **[Language-Agnostic CLI](https://infisical.com/docs/cli/overview)** that pulls and injects environment variables into your local workflow - **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure - **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.) @@ -140,65 +140,43 @@ We're currently setting the foundation and building [integrations](https://infis - - 🔜 Netlify - + 🔜 AWS - - 🔜 GitHub Actions - + 🔜 GitHub Actions (https://github.com/Infisical/infisical/issues/54) - - 🔜 Railway - + 🔜 Railway - - 🔜 GCP - + 🔜 GCP - - 🔜 Kubernetes - + 🔜 Kubernetes - - 🔜 CircleCI - + 🔜 CircleCI - - 🔜 Jenkins - + 🔜 Jenkins - - 🔜 Digital Ocean - + 🔜 Digital Ocean - - 🔜 Azure - + 🔜 Azure - - 🔜 TravisCI - + 🔜 TravisCI - - 🔜 AWS - + 🔜 Netlify (https://github.com/Infisical/infisical/issues/55) @@ -265,9 +243,7 @@ We're currently setting the foundation and building [integrations](https://infis - - 🔜 Vite - + 🔜 Vite From 3ece5a0390bc8df44d3acb8e6f267f003819ebe5 Mon Sep 17 00:00:00 2001 From: mv-turtle <78047717+mv-turtle@users.noreply.github.com> Date: Mon, 28 Nov 2022 21:38:33 -0500 Subject: [PATCH 5/6] Update README.md --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1a517e148..b3d7cfae4 100644 --- a/README.md +++ b/README.md @@ -123,19 +123,13 @@ We're currently setting the foundation and building [integrations](https://infis - - 🔜 Vercel - + 🔜 Vercel - - 🔜 GitLab CI/CD - + 🔜 GitLab CI/CD - - 🔜 Fly.io - + 🔜 Fly.io From 4f5ad07ace55f067a3d75c6fe16a538638b17c3d Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Mon, 28 Nov 2022 22:34:31 -0500 Subject: [PATCH 6/6] Add more framework integrations to docs --- docs/integrations/frameworks/angular.mdx | 5 +++ docs/integrations/frameworks/fibre.mdx | 5 +++ docs/integrations/frameworks/gatsby.mdx | 14 +++++---- docs/integrations/frameworks/nextjs.mdx | 10 ++++-- docs/integrations/frameworks/nuxt.mdx | 5 +++ docs/integrations/frameworks/react.mdx | 2 +- docs/integrations/frameworks/vite.mdx | 40 ++++++++++++++++++++++++ docs/integrations/frameworks/vue.mdx | 5 +++ docs/integrations/overview.mdx | 7 ++++- docs/mint.json | 3 ++ 10 files changed, 86 insertions(+), 10 deletions(-) create mode 100644 docs/integrations/frameworks/angular.mdx create mode 100644 docs/integrations/frameworks/fibre.mdx create mode 100644 docs/integrations/frameworks/nuxt.mdx create mode 100644 docs/integrations/frameworks/vite.mdx create mode 100644 docs/integrations/frameworks/vue.mdx diff --git a/docs/integrations/frameworks/angular.mdx b/docs/integrations/frameworks/angular.mdx new file mode 100644 index 000000000..31c8e6790 --- /dev/null +++ b/docs/integrations/frameworks/angular.mdx @@ -0,0 +1,5 @@ +--- +title: "Angular" +--- + +Instructions coming soon. diff --git a/docs/integrations/frameworks/fibre.mdx b/docs/integrations/frameworks/fibre.mdx new file mode 100644 index 000000000..0d281a5f3 --- /dev/null +++ b/docs/integrations/frameworks/fibre.mdx @@ -0,0 +1,5 @@ +--- +title: "Fibre" +--- + +Coming soon. diff --git a/docs/integrations/frameworks/gatsby.mdx b/docs/integrations/frameworks/gatsby.mdx index 4e0b576c8..cc3ddb0af 100644 --- a/docs/integrations/frameworks/gatsby.mdx +++ b/docs/integrations/frameworks/gatsby.mdx @@ -28,12 +28,14 @@ infisical init ... ``` -## Start your server with environment variables injected +## Start your development server with environment variables injected ```bash -yarn run start - -# or start development server - -yarn run develop +npm run develop ``` + + + Note that for environment variables to be exposed to the client, you'll have + to prefix them with `GATSBY_`. Read more about that + [here](https://www.gatsbyjs.com/docs/how-to/local-development/environment-variables/#accessing-environment-variables-in-the-browser). + diff --git a/docs/integrations/frameworks/nextjs.mdx b/docs/integrations/frameworks/nextjs.mdx index 2b7a56468..5fa87297d 100644 --- a/docs/integrations/frameworks/nextjs.mdx +++ b/docs/integrations/frameworks/nextjs.mdx @@ -29,9 +29,15 @@ infisical init ## Start your server with environment variables injected ```bash -yarn run dev +npm run build && npm run start -# or +# or start development server npm run dev ``` + + + Note that for environment variables to be exposed to the client, you'll have + to prefix them with `NEXT_PUBLIC_`. Read more about that + [here](https://nextjs.org/docs/basic-features/environment-variables). + diff --git a/docs/integrations/frameworks/nuxt.mdx b/docs/integrations/frameworks/nuxt.mdx new file mode 100644 index 000000000..165da7e32 --- /dev/null +++ b/docs/integrations/frameworks/nuxt.mdx @@ -0,0 +1,5 @@ +--- +title: "Nuxt" +--- + +Instructions coming soon. diff --git a/docs/integrations/frameworks/react.mdx b/docs/integrations/frameworks/react.mdx index 80ee250cb..48523e179 100644 --- a/docs/integrations/frameworks/react.mdx +++ b/docs/integrations/frameworks/react.mdx @@ -30,5 +30,5 @@ infisical init ## Start your server with environment variables injected ```bash -yarn start +npm start ``` diff --git a/docs/integrations/frameworks/vite.mdx b/docs/integrations/frameworks/vite.mdx new file mode 100644 index 000000000..7c8b0642c --- /dev/null +++ b/docs/integrations/frameworks/vite.mdx @@ -0,0 +1,40 @@ +--- +title: "Vite" +--- + +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Vite](https://vitejs.dev) app + +```bash +# move to your Vite app +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Modify the start script in your `package.json` + +```json +... +"scripts": { + "dev": "infisical run -- vite", + "build": "infisical run -- vite build", + "preview": "infisical run -- vite preview" +} +... +``` + +## Start your development server with environment variables injected + +```bash +npm run dev +``` + + + Note that for environment variables to be exposed to the client, you'll have + to prefix them with `VITE_` and export them from the `vite.config.js` file. + Read more about that [here](https://vitejs.dev/guide/env-and-mode.html) and + [here](https://main.vitejs.dev/config). + diff --git a/docs/integrations/frameworks/vue.mdx b/docs/integrations/frameworks/vue.mdx new file mode 100644 index 000000000..d71d8227d --- /dev/null +++ b/docs/integrations/frameworks/vue.mdx @@ -0,0 +1,5 @@ +--- +title: "Vue" +--- + +Coming soon. diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx index 887efbec8..89511afdc 100644 --- a/docs/integrations/overview.mdx +++ b/docs/integrations/overview.mdx @@ -23,11 +23,16 @@ Missing an integration? Throw in a [request](https://github.com/Infisical/infisi | GitHub Actions | CI/CD | Coming soon | | Jenkins | CI/CD | Coming soon | | [React](/integrations/frameworks/react) | Framework | Available | -| [Express](integrations/frameworks/express) | Framework | Available | +| [Vue](/integrations/frameworks/vue) | Framework | Coming soon | +| [Angular](/integrations/frameworks/angular) | Framework | Coming soon | +| [Express](/integrations/frameworks/express) | Framework | Available | | [Next.js](/integrations/frameworks/nextjs) | Framework | Available | | [NestJS](/integrations/frameworks/nestjs) | Framework | Available | +| [Nuxt](/integrations/frameworks/nuxt) | Framework | Coming soon | | [Gatsby](/integrations/frameworks/gatsby) | Framework | Available | | [Remix](/integrations/frameworks/remix) | Framework | Coming soon | +| [Vite](/integrations/frameworks/vite) | Framework | Available | +| [Fibre](/integrations/frameworks/fibre) | Framework | Coming soon | | [Django](/integrations/) | Framework | Coming soon | | [Flask](/integrations/frameworks/flask) | Framework | Available | | [Laravel](/integrations/frameworks/laravel) | Framework | Coming soon | diff --git a/docs/mint.json b/docs/mint.json index 04891f7b8..0bdaecd16 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -134,11 +134,14 @@ "group": "Frameworks", "pages": [ "integrations/frameworks/react", + "integrations/frameworks/vue", + "integrations/frameworks/angular", "integrations/frameworks/express", "integrations/frameworks/nextjs", "integrations/frameworks/nestjs", "integrations/frameworks/gatsby", "integrations/frameworks/remix", + "integrations/frameworks/vite", "integrations/frameworks/django", "integrations/frameworks/flask", "integrations/frameworks/laravel",