From 11d169ad23352de7d660f59979f3f775c5e72fd1 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Tue, 29 Nov 2022 01:22:06 -0500 Subject: [PATCH 1/5] Add Nuxt, Remix, Vue framework integration instructions to docs --- docs/integrations/frameworks/nuxt.mdx | 30 ++++++++++++++++++++- docs/integrations/frameworks/remix.mdx | 35 ++++++++++++++++++++++++- docs/integrations/frameworks/vue.mdx | 36 +++++++++++++++++++++++++- docs/integrations/overview.mdx | 8 +++--- docs/mint.json | 2 ++ 5 files changed, 104 insertions(+), 7 deletions(-) diff --git a/docs/integrations/frameworks/nuxt.mdx b/docs/integrations/frameworks/nuxt.mdx index 165da7e320..2cbb189754 100644 --- a/docs/integrations/frameworks/nuxt.mdx +++ b/docs/integrations/frameworks/nuxt.mdx @@ -2,4 +2,32 @@ title: "Nuxt" --- -Instructions coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Nuxt](https://nuxtjs.org) app + +```bash +# move to your Nuxt app +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Modify the start script in your `package.json` + +```json +... +"scripts": { + "dev": "infisical run -- nuxt", + "build": "infisical run -- nuxt build", + "start": "infisical run -- nuxt start" +} +... +``` + +## Start your development server with environment variables injected + +```bash +npm run dev +``` diff --git a/docs/integrations/frameworks/remix.mdx b/docs/integrations/frameworks/remix.mdx index 6712c693ff..87aea3d65d 100644 --- a/docs/integrations/frameworks/remix.mdx +++ b/docs/integrations/frameworks/remix.mdx @@ -2,4 +2,37 @@ title: "Remix" --- -Instructions coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Remix](https://remix.run) app + +```bash +# move to your Vue app +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Modify the start script in your `package.json` + +```json +... +"scripts": { + ... + "dev": "infisical run -- run-p dev:*", + "start": "infisical run -- remix-serve build" + ... +} +... +``` + +## Start your server with environment variables injected + +```bash +npm run build && npm run start + +# or start development server + +npm run dev +``` diff --git a/docs/integrations/frameworks/vue.mdx b/docs/integrations/frameworks/vue.mdx index d71d8227d6..6c4816e6b9 100644 --- a/docs/integrations/frameworks/vue.mdx +++ b/docs/integrations/frameworks/vue.mdx @@ -2,4 +2,38 @@ title: "Vue" --- -Coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Vue](https://vuejs.org) app + +```bash +# move to your Vue app +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Modify the start script in your `package.json` + +```json +... +"scripts": { + "serve": "infisical run -- vue-cli-service serve", + "build": "infisical run -- vue-cli-service build", + "lint": "infisical run -- vue-cli-service lint" +} +... +``` + +## Start your development server with environment variables injected + +```bash +npm run serve +``` + + + Note that for environment variables to be exposed to the client, you'll have + to prefix them with `VUE_APP` Read more about that + [here](https://cli.vuejs.org/guide/mode-and-env.html). + diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx index 89511afdcc..8151d9d50d 100644 --- a/docs/integrations/overview.mdx +++ b/docs/integrations/overview.mdx @@ -23,17 +23,17 @@ 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 | -| [Vue](/integrations/frameworks/vue) | Framework | Coming soon | +| [Vue](/integrations/frameworks/vue) | Framework | Available | | [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 | +| [Nuxt](/integrations/frameworks/nuxt) | Framework | Available | | [Gatsby](/integrations/frameworks/gatsby) | Framework | Available | -| [Remix](/integrations/frameworks/remix) | Framework | Coming soon | +| [Remix](/integrations/frameworks/remix) | Framework | Available | | [Vite](/integrations/frameworks/vite) | Framework | Available | | [Fibre](/integrations/frameworks/fibre) | Framework | Coming soon | -| [Django](/integrations/) | Framework | Coming soon | +| [Django](/integrations/frameworks/django) | Framework | Coming soon | | [Flask](/integrations/frameworks/flask) | Framework | Available | | [Laravel](/integrations/frameworks/laravel) | Framework | Coming soon | | [Ruby on Rails](/integrations/frameworks/rails) | Framework | Coming soon | diff --git a/docs/mint.json b/docs/mint.json index 0bdaecd16b..71fcae2ee2 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -139,9 +139,11 @@ "integrations/frameworks/express", "integrations/frameworks/nextjs", "integrations/frameworks/nestjs", + "integrations/frameworks/nuxt", "integrations/frameworks/gatsby", "integrations/frameworks/remix", "integrations/frameworks/vite", + "integrations/frameworks/fibre", "integrations/frameworks/django", "integrations/frameworks/flask", "integrations/frameworks/laravel", From 4117781cd16babe9843f2263562101222a5cb8a5 Mon Sep 17 00:00:00 2001 From: 0xflotus <0xflotus@gmail.com> Date: Tue, 29 Nov 2022 16:18:17 +0100 Subject: [PATCH 2/5] fix: small typo error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b3d7cfae45..b054218bf6 100644 --- a/README.md +++ b/README.md @@ -257,7 +257,7 @@ We're currently setting the foundation and building [integrations](https://infis ## Open-source vs. paid -This repo is entirely MIT licensed, with the exception of the `ee` directory which will contain premium enterprise features requring a Infisical license in the future. We're currently focused on developing non-enterprise offerings first that should suit most use-cases. +This repo is entirely MIT licensed, with the exception of the `ee` directory which will contain premium enterprise features requiring a Infisical license in the future. We're currently focused on developing non-enterprise offerings first that should suit most use-cases. ## Security From 00dde5c2b48dd7323e79a937c42dd7f42ac634a2 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Tue, 29 Nov 2022 11:39:38 -0500 Subject: [PATCH 3/5] Remove Angular integration from docs (not applicable), patch stripe subscriptions attr in billing page --- docs/integrations/frameworks/angular.mdx | 5 ----- docs/integrations/overview.mdx | 1 - docs/mint.json | 1 - frontend/pages/settings/billing/[id].js | 2 +- 4 files changed, 1 insertion(+), 8 deletions(-) delete mode 100644 docs/integrations/frameworks/angular.mdx diff --git a/docs/integrations/frameworks/angular.mdx b/docs/integrations/frameworks/angular.mdx deleted file mode 100644 index 31c8e67906..0000000000 --- a/docs/integrations/frameworks/angular.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Angular" ---- - -Instructions coming soon. diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx index 8151d9d50d..651f86a6f3 100644 --- a/docs/integrations/overview.mdx +++ b/docs/integrations/overview.mdx @@ -24,7 +24,6 @@ Missing an integration? Throw in a [request](https://github.com/Infisical/infisi | Jenkins | CI/CD | Coming soon | | [React](/integrations/frameworks/react) | Framework | Available | | [Vue](/integrations/frameworks/vue) | Framework | Available | -| [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 | diff --git a/docs/mint.json b/docs/mint.json index 71fcae2ee2..f2f8a78778 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -135,7 +135,6 @@ "pages": [ "integrations/frameworks/react", "integrations/frameworks/vue", - "integrations/frameworks/angular", "integrations/frameworks/express", "integrations/frameworks/nextjs", "integrations/frameworks/nestjs", diff --git a/frontend/pages/settings/billing/[id].js b/frontend/pages/settings/billing/[id].js index 609648b9bb..00d1db23f2 100644 --- a/frontend/pages/settings/billing/[id].js +++ b/frontend/pages/settings/billing/[id].js @@ -51,7 +51,7 @@ export default function SettingsBilling() { orgId: localStorage.getItem("orgData.id"), }); - setCurrentPlan(subscriptions.data[0].plan.product); + setCurrentPlan(subscriptions.data[0].plan.id); const orgUsers = await getOrganizationUsers({ orgId: localStorage.getItem("orgData.id"), }); From c6777e43ed7c9ea1930258b50b3417d66bbb2f7c Mon Sep 17 00:00:00 2001 From: mv-turtle <78047717+mv-turtle@users.noreply.github.com> Date: Tue, 29 Nov 2022 17:00:47 -0500 Subject: [PATCH 4/5] Add contributors to README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b054218bf6..1b013b5dc3 100644 --- a/README.md +++ b/README.md @@ -271,4 +271,4 @@ Looking to report a security vulnerability? Please don't post about it in GitHub - + From 6468b356a60d75441c1dec7859d7f1829814527a Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Tue, 29 Nov 2022 19:38:41 -0500 Subject: [PATCH 5/5] Add Django, Rails integration instructions to docs and move cli login to overview page --- docs/cli/overview.mdx | 6 ++++++ docs/cli/usage.mdx | 16 +++++----------- docs/integrations/frameworks/django.mdx | 18 +++++++++++++++++- .../frameworks/{fibre.mdx => fiber.mdx} | 2 +- docs/integrations/frameworks/nextjs.mdx | 2 +- docs/integrations/frameworks/rails.mdx | 18 +++++++++++++++++- docs/integrations/overview.mdx | 6 +++--- docs/mint.json | 2 +- 8 files changed, 51 insertions(+), 19 deletions(-) rename docs/integrations/frameworks/{fibre.mdx => fiber.mdx} (59%) diff --git a/docs/cli/overview.mdx b/docs/cli/overview.mdx index bbe86d3794..8411b8e758 100644 --- a/docs/cli/overview.mdx +++ b/docs/cli/overview.mdx @@ -95,3 +95,9 @@ The Infisical CLI provides a way to inject environment variables from the platfo + +## Log in to the Infisical CLI + +```bash +infisical login +``` diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx index ea7180068f..4237f8154b 100644 --- a/docs/cli/usage.mdx +++ b/docs/cli/usage.mdx @@ -4,12 +4,6 @@ title: "Usage" Prerequisite: [Install the CLI](/cli/overview) -## Log in to the Infisical CLI - -```bash -infisical login -``` - ## Initialize Infisical for your project ```bash @@ -29,11 +23,11 @@ infisical run -- [your application start command] Options you can specify: -| Option | Description | Default value | -| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | -| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` | -| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` | -| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` | +| Option | Description | Default value | +| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | +| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` | +| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` | +| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` | ## Examples: diff --git a/docs/integrations/frameworks/django.mdx b/docs/integrations/frameworks/django.mdx index 1835c2e9e8..e3378d1b6e 100644 --- a/docs/integrations/frameworks/django.mdx +++ b/docs/integrations/frameworks/django.mdx @@ -2,4 +2,20 @@ title: "Django" --- -Instructions coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Django](https://www.djangoproject.com) project + +```bash +# move to your Django project +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Start your server with environment variables injected + +```bash +infisical run -- python manage.py runserver +``` diff --git a/docs/integrations/frameworks/fibre.mdx b/docs/integrations/frameworks/fiber.mdx similarity index 59% rename from docs/integrations/frameworks/fibre.mdx rename to docs/integrations/frameworks/fiber.mdx index 0d281a5f30..988fe901d1 100644 --- a/docs/integrations/frameworks/fibre.mdx +++ b/docs/integrations/frameworks/fiber.mdx @@ -1,5 +1,5 @@ --- -title: "Fibre" +title: "Fiber" --- Coming soon. diff --git a/docs/integrations/frameworks/nextjs.mdx b/docs/integrations/frameworks/nextjs.mdx index 5fa87297d9..d5733df528 100644 --- a/docs/integrations/frameworks/nextjs.mdx +++ b/docs/integrations/frameworks/nextjs.mdx @@ -4,7 +4,7 @@ title: "Next.js" Prerequisite: [Install the CLI](/cli/overview) -## Initialize Infisical for your [Next.js](https://nextjs.org) +## Initialize Infisical for your [Next.js](https://nextjs.org) app ```bash # move to your Next.js app diff --git a/docs/integrations/frameworks/rails.mdx b/docs/integrations/frameworks/rails.mdx index 9bb59f9200..8e1dcf6ed3 100644 --- a/docs/integrations/frameworks/rails.mdx +++ b/docs/integrations/frameworks/rails.mdx @@ -2,4 +2,20 @@ title: "Ruby on Rails" --- -Instructions coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Rails](https://rubyonrails.org) app + +```bash +# move to your Rails app +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Start your server with environment variables injected + +```bash +infisical run -- bin/rails server +``` diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx index 651f86a6f3..17c7a7f726 100644 --- a/docs/integrations/overview.mdx +++ b/docs/integrations/overview.mdx @@ -31,8 +31,8 @@ Missing an integration? Throw in a [request](https://github.com/Infisical/infisi | [Gatsby](/integrations/frameworks/gatsby) | Framework | Available | | [Remix](/integrations/frameworks/remix) | Framework | Available | | [Vite](/integrations/frameworks/vite) | Framework | Available | -| [Fibre](/integrations/frameworks/fibre) | Framework | Coming soon | -| [Django](/integrations/frameworks/django) | Framework | Coming soon | +| [Fiber](/integrations/frameworks/fiber) | Framework | Coming soon | +| [Django](/integrations/frameworks/django) | Framework | Available | | [Flask](/integrations/frameworks/flask) | Framework | Available | | [Laravel](/integrations/frameworks/laravel) | Framework | Coming soon | -| [Ruby on Rails](/integrations/frameworks/rails) | Framework | Coming soon | +| [Ruby on Rails](/integrations/frameworks/rails) | Framework | Available | diff --git a/docs/mint.json b/docs/mint.json index f2f8a78778..7d0317f0ef 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -142,7 +142,7 @@ "integrations/frameworks/gatsby", "integrations/frameworks/remix", "integrations/frameworks/vite", - "integrations/frameworks/fibre", + "integrations/frameworks/fiber", "integrations/frameworks/django", "integrations/frameworks/flask", "integrations/frameworks/laravel",