mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
Add integrations anchor and preliminary framework integrations to docs
This commit is contained in:
5
docs/integrations/frameworks/django.mdx
Normal file
5
docs/integrations/frameworks/django.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Django"
|
||||
---
|
||||
|
||||
Instructions coming soon.
|
||||
42
docs/integrations/frameworks/express.mdx
Normal file
42
docs/integrations/frameworks/express.mdx
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: "Express, Fastify, Koa"
|
||||
---
|
||||
|
||||
Prerequisite: [Install the CLI](/cli/overview)
|
||||
|
||||
The steps apply to the following non-exhaustive list of frameworks:
|
||||
|
||||
- [Express](https://expressjs.com)
|
||||
- [Fastify](https://www.fastify.io)
|
||||
- [Koa](https://koajs.com)
|
||||
|
||||
## Initialize Infisical for your app
|
||||
|
||||
```bash
|
||||
# move to your app
|
||||
cd /path/to/project
|
||||
|
||||
# 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
|
||||
|
||||
```bash
|
||||
npm run start
|
||||
|
||||
# or start development server
|
||||
|
||||
npm run dev
|
||||
```
|
||||
21
docs/integrations/frameworks/flask.mdx
Normal file
21
docs/integrations/frameworks/flask.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: "Flask"
|
||||
---
|
||||
|
||||
Prerequisite: [Install the CLI](/cli/overview)
|
||||
|
||||
## Initialize Infisical for your [Flask](https://flask.palletsprojects.com/en/2.2.x) app
|
||||
|
||||
```bash
|
||||
# move to your Flask app
|
||||
cd /path/to/project
|
||||
|
||||
# initialize infisical
|
||||
infisical init
|
||||
```
|
||||
|
||||
## Start your server with environment variables injected
|
||||
|
||||
```bash
|
||||
infisical run -- flask run
|
||||
```
|
||||
39
docs/integrations/frameworks/gatsby.mdx
Normal file
39
docs/integrations/frameworks/gatsby.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Gatsby"
|
||||
---
|
||||
|
||||
Prerequisite: [Install the CLI](/cli/overview)
|
||||
|
||||
## Initialize Infisical for your [Gatsby](https://www.gatsbyjs.com) app
|
||||
|
||||
```bash
|
||||
# move to your app
|
||||
cd /path/to/project
|
||||
|
||||
# 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 server with environment variables injected
|
||||
|
||||
```bash
|
||||
yarn run start
|
||||
|
||||
# or start development server
|
||||
|
||||
yarn run develop
|
||||
```
|
||||
5
docs/integrations/frameworks/laravel.mdx
Normal file
5
docs/integrations/frameworks/laravel.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Laravel"
|
||||
---
|
||||
|
||||
Instructions coming soon.
|
||||
47
docs/integrations/frameworks/nestjs.mdx
Normal file
47
docs/integrations/frameworks/nestjs.mdx
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: "NestJS"
|
||||
---
|
||||
|
||||
Prerequisite: [Install the CLI](/cli/overview)
|
||||
|
||||
## Initialize Infisical for your [NestJS](https://nestjs.com) app
|
||||
|
||||
```bash
|
||||
# move to your Next.js app
|
||||
cd /path/to/project
|
||||
|
||||
# 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
|
||||
|
||||
```bash
|
||||
npm run start
|
||||
|
||||
# or start development server
|
||||
|
||||
npm run start:dev
|
||||
```
|
||||
37
docs/integrations/frameworks/nextjs.mdx
Normal file
37
docs/integrations/frameworks/nextjs.mdx
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "Next.js"
|
||||
---
|
||||
|
||||
Prerequisite: [Install the CLI](/cli/overview)
|
||||
|
||||
## Initialize Infisical for your [Next.js](https://nextjs.org)
|
||||
|
||||
```bash
|
||||
# move to your Next.js app
|
||||
cd /path/to/project
|
||||
|
||||
# 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
|
||||
|
||||
```bash
|
||||
yarn run dev
|
||||
|
||||
# or
|
||||
|
||||
npm run dev
|
||||
```
|
||||
5
docs/integrations/frameworks/rails.mdx
Normal file
5
docs/integrations/frameworks/rails.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Ruby on Rails"
|
||||
---
|
||||
|
||||
Instructions coming soon.
|
||||
34
docs/integrations/frameworks/react.mdx
Normal file
34
docs/integrations/frameworks/react.mdx
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "React"
|
||||
---
|
||||
|
||||
Prerequisite: [Install the CLI](/cli/overview)
|
||||
|
||||
## Initialize Infisical for your [Create React App](https://create-react-app.dev)
|
||||
|
||||
```bash
|
||||
# move to your React app
|
||||
cd /path/to/project
|
||||
|
||||
# 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
|
||||
|
||||
```bash
|
||||
yarn start
|
||||
```
|
||||
5
docs/integrations/frameworks/remix.mdx
Normal file
5
docs/integrations/frameworks/remix.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Remix"
|
||||
---
|
||||
|
||||
Instructions coming soon.
|
||||
@@ -6,19 +6,29 @@ Integrations allow environment variables to be synced from Infisical into your l
|
||||
|
||||
Missing an integration? Throw in a [request](https://github.com/Infisical/infisical/issues).
|
||||
|
||||
| Integration | Status |
|
||||
| ---------------------------------------------- | ----------- |
|
||||
| [Docker](/integrations/docker) | Available |
|
||||
| [Docker-Compose](/integrations/docker-compose) | Available |
|
||||
| [Heroku](/integrations/heroku) | Available |
|
||||
| Kubernetes | Coming soon |
|
||||
| Vercel | Coming soon |
|
||||
| AWS | Coming soon |
|
||||
| GCP | Coming soon |
|
||||
| Azure | Coming soon |
|
||||
| DigitalOcean | Coming soon |
|
||||
| GitLab | Coming soon |
|
||||
| CircleCI | Coming soon |
|
||||
| TravisCI | Coming soon |
|
||||
| GitHub Actions | Coming soon |
|
||||
| Jenkins | Coming soon |
|
||||
| Integration | Type | Status |
|
||||
| -------------------------------------------------------- | --------- | ----------- |
|
||||
| [Docker](/integrations/platforms/docker) | Platform | Available |
|
||||
| [Docker-Compose](/integrations/platforms/docker-compose) | Platform | Available |
|
||||
| Kubernetes | Platform | Coming soon |
|
||||
| [Heroku](/integrations/cloud/heroku) | Cloud | Available |
|
||||
| Vercel | Cloud | Coming soon |
|
||||
| AWS | Cloud | Coming soon |
|
||||
| GCP | Cloud | Coming soon |
|
||||
| Azure | Cloud | Coming soon |
|
||||
| DigitalOcean | Cloud | Coming soon |
|
||||
| GitLab | CI/CD | Coming soon |
|
||||
| CircleCI | CI/CD | Coming soon |
|
||||
| TravisCI | CI/CD | Coming soon |
|
||||
| GitHub Actions | CI/CD | Coming soon |
|
||||
| Jenkins | CI/CD | Coming soon |
|
||||
| [React](/integrations/frameworks/react) | Framework | Available |
|
||||
| [Express](integrations/frameworks/express) | Framework | Available |
|
||||
| [Next.js](/integrations/frameworks/nextjs) | Framework | Available |
|
||||
| [NestJS](/integrations/frameworks/nestjs) | Framework | Available |
|
||||
| [Gatsby](/integrations/frameworks/gatsby) | Framework | Available |
|
||||
| [Remix](/integrations/frameworks/remix) | Framework | Coming soon |
|
||||
| [Django](/integrations/) | 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 |
|
||||
|
||||
@@ -6,7 +6,7 @@ The Docker Compose integration enables you to inject environment variables from
|
||||
|
||||
## Add the CLI to your Dockerfile(s)
|
||||
|
||||
Follow steps 1 through 3 on our [guide to configure Infisical CLI](../integrations/docker) in your Dockerfile.
|
||||
Follow steps 1 through 3 on our [guide to configure Infisical CLI](../integrations/platforms/docker) in your Dockerfile.
|
||||
|
||||
## Generate Infisical Token
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Docker"
|
||||
---
|
||||
|
||||
The Docker integration enables you to inject environment variables from Infisical into a container.
|
||||
Infisical can be used in a Dockerfile to inject environment variables into a Docker container.
|
||||
|
||||
## Add the CLI to your Dockerfile
|
||||
|
||||
Reference in New Issue
Block a user