diff --git a/docs/getting-started/dashboard/integrations.mdx b/docs/getting-started/dashboard/integrations.mdx index 95541ca386..de25fa8614 100644 --- a/docs/getting-started/dashboard/integrations.mdx +++ b/docs/getting-started/dashboard/integrations.mdx @@ -4,8 +4,11 @@ title: "Integrations" Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production. -We're still early with integrations, but expect more soon. +We're still early with integrations, but expect more soon. + + + View all available integrations and their guide + ![integrations](../../images/project-integrations.png) -Check out our [integrations](/integrations/overview). diff --git a/docs/images/project-integrations.png b/docs/images/project-integrations.png index 90f50a8c42..7c2c35bd42 100644 Binary files a/docs/images/project-integrations.png and b/docs/images/project-integrations.png differ diff --git a/docs/integrations/frameworks/django.mdx b/docs/integrations/frameworks/django.mdx index 0fa785dcca..ea786a0f75 100644 --- a/docs/integrations/frameworks/django.mdx +++ b/docs/integrations/frameworks/django.mdx @@ -10,15 +10,18 @@ Prerequisites: ## Initialize Infisical for your [Django](https://www.djangoproject.com) project ```bash -# move to your Django project +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize Infisical infisical init ``` -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash +infisical run -- + +# Example infisical run -- python manage.py runserver ``` diff --git a/docs/integrations/frameworks/express.mdx b/docs/integrations/frameworks/express.mdx index c681babb37..363decf091 100644 --- a/docs/integrations/frameworks/express.mdx +++ b/docs/integrations/frameworks/express.mdx @@ -16,30 +16,18 @@ The steps apply to the following non-exhaustive list of frameworks: ## Initialize Infisical for your app ```bash -# move to your app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize Infisical infisical init ``` -## Modify the start script in your `package.json` - -```json -... -"scripts": { - "start": "infisical run -- node index.js" - "dev": "infisical run -- nodemon index.js" // if using nodemon for dev -} -... -``` - -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash -npm run start - -# or start development server +infisical run -- -npm run dev +# Example +infisical run -- npm run dev ``` diff --git a/docs/integrations/frameworks/fiber.mdx b/docs/integrations/frameworks/fiber.mdx index ed022c6446..0c7d6aab27 100644 --- a/docs/integrations/frameworks/fiber.mdx +++ b/docs/integrations/frameworks/fiber.mdx @@ -7,4 +7,21 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) - [Install the CLI](/cli/overview) -Coming soon. +## Initialize Infisical for your [Fiber](https://gofiber.io/) app + +```bash +# navigate to the root of your of your project +cd /path/to/project + +# then initialize Infisical +infisical init +``` + +## Start your application as usual but with Infisical + +```bash +infisical run -- + +# Example +infisical run -- go run server.go +``` \ No newline at end of file diff --git a/docs/integrations/frameworks/flask.mdx b/docs/integrations/frameworks/flask.mdx index 941b62b2e9..e80a993e88 100644 --- a/docs/integrations/frameworks/flask.mdx +++ b/docs/integrations/frameworks/flask.mdx @@ -10,15 +10,18 @@ Prerequisites: ## Initialize Infisical for your [Flask](https://flask.palletsprojects.com/en/2.2.x) app ```bash -# move to your Flask app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize Infisical infisical init ``` -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash +infisical run -- + +# Example infisical run -- flask run ``` diff --git a/docs/integrations/frameworks/gatsby.mdx b/docs/integrations/frameworks/gatsby.mdx index ee80be1d61..4e12265de0 100644 --- a/docs/integrations/frameworks/gatsby.mdx +++ b/docs/integrations/frameworks/gatsby.mdx @@ -10,31 +10,20 @@ Prerequisites: ## Initialize Infisical for your [Gatsby](https://www.gatsbyjs.com) app ```bash -# move to your app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize Infisical infisical init ``` -## Modify the start script in your `package.json` - -```json -... -"scripts": { - "develop": "infisical run -- gatsby develop", - "start": "infisical run -- gatsby develop", - "build": "infisical run -- gatsby build", - "serve": "infisical run -- gatsby serve", - "clean": "infisical run -- gatsby clean" -} -... -``` - -## Start your development server with environment variables injected +## Start your application as usual but with Infisical ```bash -npm run develop +infisical run -- + +# Example +infisical run -- npm run develop ``` diff --git a/docs/integrations/frameworks/laravel.mdx b/docs/integrations/frameworks/laravel.mdx index 0dfb219aab..0152e7c665 100644 --- a/docs/integrations/frameworks/laravel.mdx +++ b/docs/integrations/frameworks/laravel.mdx @@ -7,4 +7,21 @@ Prerequisites: - Set up and add envars to [Infisical Cloud](https://app.infisical.com) - [Install the CLI](/cli/overview) -Instructions coming soon. +## Initialize Infisical for your [Laravel](https://laravel.com/) app + +```bash +# navigate to the root of your of your project +cd /path/to/project + +# then initialize Infisical +infisical init +``` + +## Start your application as usual but with Infisical + +```bash +infisical run -- + +# Example +infisical run -- php artisan serve +``` diff --git a/docs/integrations/frameworks/nestjs.mdx b/docs/integrations/frameworks/nestjs.mdx index 8283b11759..5e224587ea 100644 --- a/docs/integrations/frameworks/nestjs.mdx +++ b/docs/integrations/frameworks/nestjs.mdx @@ -10,41 +10,18 @@ Prerequisites: ## Initialize Infisical for your [NestJS](https://nestjs.com) app ```bash -# move to your Next.js app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize infisical infisical init ``` -## Modify the start script in your `package.json` - -```json -... -"scripts": { - "prebuild": "rimraf dist", - "build": "nest build", - "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"", - "start": "infisical run -- nest start", - "start:dev": "infisical run -- nest start --watch", - "start:debug": "nest start --debug --watch", - "start:prod": "node dist/main", - "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix", - "test": "jest", - "test:watch": "jest --watch", - "test:cov": "jest --coverage", - "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand", - "test:e2e": "jest --config ./test/jest-e2e.json" -} -... -``` - -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash -npm run start - -# or start development server +infisical run -- -npm run start:dev +# Example +infisical run -- npm run start:dev ``` diff --git a/docs/integrations/frameworks/nextjs.mdx b/docs/integrations/frameworks/nextjs.mdx index a70cf6e41b..d6e46f54e6 100644 --- a/docs/integrations/frameworks/nextjs.mdx +++ b/docs/integrations/frameworks/nextjs.mdx @@ -10,33 +10,20 @@ Prerequisites: ## Initialize Infisical for your [Next.js](https://nextjs.org) app ```bash -# move to your Next.js app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize infisical infisical init ``` -## Modify the start script in your `package.json` - -```json -... -"scripts": { - "dev": "infisical run -- next dev", - "build": "infisical run -- next build", - "start": "infisical run -- next start" -} -... -``` - -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash -npm run build && npm run start - -# or start development server +infisical run -- -npm run dev +# Example +infisical run -- npm run dev ``` diff --git a/docs/integrations/frameworks/nuxt.mdx b/docs/integrations/frameworks/nuxt.mdx index 901ec35a59..8105940ee2 100644 --- a/docs/integrations/frameworks/nuxt.mdx +++ b/docs/integrations/frameworks/nuxt.mdx @@ -10,27 +10,18 @@ Prerequisites: ## Initialize Infisical for your [Nuxt](https://nuxtjs.org) app ```bash -# move to your Nuxt app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then 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 +## Start your application as usual but with Infisical ```bash -npm run dev +infisical run -- + +# Example +infisical run -- npm run dev ``` diff --git a/docs/integrations/frameworks/rails.mdx b/docs/integrations/frameworks/rails.mdx index 7e08bffa70..32e7cbd570 100644 --- a/docs/integrations/frameworks/rails.mdx +++ b/docs/integrations/frameworks/rails.mdx @@ -10,15 +10,18 @@ Prerequisites: ## Initialize Infisical for your [Rails](https://rubyonrails.org) app ```bash -# move to your Rails app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize Infisical infisical init ``` -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash +infisical run -- + +# Example infisical run -- bin/rails server ``` diff --git a/docs/integrations/frameworks/react.mdx b/docs/integrations/frameworks/react.mdx index 950505432e..0c394ac7e1 100644 --- a/docs/integrations/frameworks/react.mdx +++ b/docs/integrations/frameworks/react.mdx @@ -10,28 +10,18 @@ Prerequisites: ## Initialize Infisical for your [Create React App](https://create-react-app.dev) ```bash -# move to your React app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then initialize infisical infisical init ``` -## Modify the start script in your `package.json` - -```json -... -"scripts": { - "start": "infisical run -- react-scripts start", - "build": "react-scripts build", - "test": "react-scripts test", - "eject": "react-scripts eject" -} -... -``` - -## Start your server with environment variables injected +## Start your application as usual but with Infisical ```bash -npm start +infisical run -- + +# Example +infisical run -- npm run dev ``` diff --git a/docs/integrations/frameworks/remix.mdx b/docs/integrations/frameworks/remix.mdx index aa9956005a..cc37a263ed 100644 --- a/docs/integrations/frameworks/remix.mdx +++ b/docs/integrations/frameworks/remix.mdx @@ -10,32 +10,18 @@ Prerequisites: ## Initialize Infisical for your [Remix](https://remix.run) app ```bash -# move to your Vue app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then 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 +## Start your application as usual but with Infisical ```bash -npm run build && npm run start - -# or start development server +infisical run -- -npm run dev +# Example +infisical run -- npm run dev ``` diff --git a/docs/integrations/frameworks/vite.mdx b/docs/integrations/frameworks/vite.mdx index 251924ca7a..2c6e80ff0d 100644 --- a/docs/integrations/frameworks/vite.mdx +++ b/docs/integrations/frameworks/vite.mdx @@ -10,29 +10,20 @@ Prerequisites: ## Initialize Infisical for your [Vite](https://vitejs.dev) app ```bash -# move to your Vite app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then 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 +## Start your application as usual but with Infisical ```bash -npm run dev +infisical run -- + +# Example +infisical run -- npm run dev ``` diff --git a/docs/integrations/frameworks/vue.mdx b/docs/integrations/frameworks/vue.mdx index 15c4a12cf7..9bc17255c9 100644 --- a/docs/integrations/frameworks/vue.mdx +++ b/docs/integrations/frameworks/vue.mdx @@ -10,29 +10,20 @@ Prerequisites: ## Initialize Infisical for your [Vue](https://vuejs.org) app ```bash -# move to your Vue app +# navigate to the root of your of your project cd /path/to/project -# initialize infisical +# then 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 +## Start your application as usual but with Infisical ```bash -npm run serve +infisical run -- + +# Example +infisical run -- npm run dev ```