synced/infisical
1
0
Fork 0
mirror of https://github.com/Infisical/infisical.git synced 2025-03-29 22:02:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revise integrations docs

Browse Source
This commit is contained in:
Maidul Islam
2022-12-09 12:57:21 -05:00
parent 3d25baa319
commit caddb45394
16 changed files with 118 additions and 182 deletions

7
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. 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.
<Card title="View integrations documentation" icon="link" href="/integrations/overview">
View all available integrations and their guide
</Card>
![integrations](../../images/project-integrations.png) ![integrations](../../images/project-integrations.png)
Check out our [integrations](/integrations/overview).

BIN
docs/images/project-integrations.png

Binary file not shown.
Side by Side Swipe Overlay

Before

(image error) Size: 445 KiB

After

(image error) Size: 213 KiB

9
docs/integrations/frameworks/django.mdx

@ -10,15 +10,18 @@ Prerequisites:
## Initialize Infisical for your [Django](https://www.djangoproject.com) project ## Initialize Infisical for your [Django](https://www.djangoproject.com) project
```bash ```bash
# move to your Django project # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Start your server with environment variables injected ## Start your application as usual but with Infisical
```bash ```bash
infisical run -- <your application start command>
# Example
infisical run -- python manage.py runserver infisical run -- python manage.py runserver
``` ```

24
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 ## Initialize Infisical for your app
```bash ```bash
# move to your app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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
```bash ```bash
npm run start infisical run -- <your application start command>
# or start development server # Example
infisical run -- npm run dev
npm run dev
``` ```

19
docs/integrations/frameworks/fiber.mdx

@ -7,4 +7,21 @@ 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)
- [Install the CLI](/cli/overview) - [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 -- <your application start command>
# Example
infisical run -- go run server.go
```

9
docs/integrations/frameworks/flask.mdx

@ -10,15 +10,18 @@ Prerequisites:
## Initialize Infisical for your [Flask](https://flask.palletsprojects.com/en/2.2.x) app ## Initialize Infisical for your [Flask](https://flask.palletsprojects.com/en/2.2.x) app
```bash ```bash
# move to your Flask app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Start your server with environment variables injected ## Start your application as usual but with Infisical
```bash ```bash
infisical run -- <your application start command>
# Example
infisical run -- flask run infisical run -- flask run
``` ```

25
docs/integrations/frameworks/gatsby.mdx

@ -10,31 +10,20 @@ Prerequisites:
## Initialize Infisical for your [Gatsby](https://www.gatsbyjs.com) app ## Initialize Infisical for your [Gatsby](https://www.gatsbyjs.com) app
```bash ```bash
# move to your app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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
```bash ```bash
npm run develop infisical run -- <your application start command>
# Example
infisical run -- npm run develop
``` ```
<Note> <Note>

19
docs/integrations/frameworks/laravel.mdx

@ -7,4 +7,21 @@ 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)
- [Install the CLI](/cli/overview) - [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 -- <your application start command>
# Example
infisical run -- php artisan serve
```

35
docs/integrations/frameworks/nestjs.mdx

@ -10,41 +10,18 @@ Prerequisites:
## Initialize Infisical for your [NestJS](https://nestjs.com) app ## Initialize Infisical for your [NestJS](https://nestjs.com) app
```bash ```bash
# move to your Next.js app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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
```bash ```bash
npm run start infisical run -- <your application start command>
# or start development server # Example
infisical run -- npm run start:dev
npm run start:dev
``` ```

25
docs/integrations/frameworks/nextjs.mdx

@ -10,33 +10,20 @@ Prerequisites:
## Initialize Infisical for your [Next.js](https://nextjs.org) app ## Initialize Infisical for your [Next.js](https://nextjs.org) app
```bash ```bash
# move to your Next.js app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```json
...
"scripts": {
"dev": "infisical run -- next dev",
"build": "infisical run -- next build",
"start": "infisical run -- next start"
}
...
```
## Start your server with environment variables injected
```bash ```bash
npm run build && npm run start infisical run -- <your application start command>
# or start development server # Example
infisical run -- npm run dev
npm run dev
``` ```
<Note> <Note>

23
docs/integrations/frameworks/nuxt.mdx

@ -10,27 +10,18 @@ Prerequisites:
## Initialize Infisical for your [Nuxt](https://nuxtjs.org) app ## Initialize Infisical for your [Nuxt](https://nuxtjs.org) app
```bash ```bash
# move to your Nuxt app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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 ```bash
npm run dev infisical run -- <your application start command>
# Example
infisical run -- npm run dev
``` ```

9
docs/integrations/frameworks/rails.mdx

@ -10,15 +10,18 @@ Prerequisites:
## Initialize Infisical for your [Rails](https://rubyonrails.org) app ## Initialize Infisical for your [Rails](https://rubyonrails.org) app
```bash ```bash
# move to your Rails app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Start your server with environment variables injected ## Start your application as usual but with Infisical
```bash ```bash
infisical run -- <your application start command>
# Example
infisical run -- bin/rails server infisical run -- bin/rails server
``` ```

24
docs/integrations/frameworks/react.mdx

@ -10,28 +10,18 @@ Prerequisites:
## Initialize Infisical for your [Create React App](https://create-react-app.dev) ## Initialize Infisical for your [Create React App](https://create-react-app.dev)
```bash ```bash
# move to your React app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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
```bash ```bash
npm start infisical run -- <your application start command>
# Example
infisical run -- npm run dev
``` ```

26
docs/integrations/frameworks/remix.mdx

@ -10,32 +10,18 @@ Prerequisites:
## Initialize Infisical for your [Remix](https://remix.run) app ## Initialize Infisical for your [Remix](https://remix.run) app
```bash ```bash
# move to your Vue app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```json
...
"scripts": {
...
"dev": "infisical run -- run-p dev:*",
"start": "infisical run -- remix-serve build"
...
}
...
```
## Start your server with environment variables injected
```bash ```bash
npm run build && npm run start infisical run -- <your application start command>
# or start development server # Example
infisical run -- npm run dev
npm run dev
``` ```

23
docs/integrations/frameworks/vite.mdx

@ -10,29 +10,20 @@ Prerequisites:
## Initialize Infisical for your [Vite](https://vitejs.dev) app ## Initialize Infisical for your [Vite](https://vitejs.dev) app
```bash ```bash
# move to your Vite app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize Infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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 ```bash
npm run dev infisical run -- <your application start command>
# Example
infisical run -- npm run dev
``` ```
<Note> <Note>

23
docs/integrations/frameworks/vue.mdx

@ -10,29 +10,20 @@ Prerequisites:
## Initialize Infisical for your [Vue](https://vuejs.org) app ## Initialize Infisical for your [Vue](https://vuejs.org) app
```bash ```bash
# move to your Vue app # navigate to the root of your of your project
cd /path/to/project cd /path/to/project
# initialize infisical # then initialize infisical
infisical init infisical init
``` ```
## Modify the start script in your `package.json` ## Start your application as usual but with Infisical
```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 ```bash
npm run serve infisical run -- <your application start command>
# Example
infisical run -- npm run dev
``` ```
<Note> <Note>