Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
vmatsiiako committed Nov 29, 2022
2 parents e818029 + 4f5ad07 commit fe339d9
Show file tree
Hide file tree
Showing 24 changed files with 552 additions and 47 deletions.
181 changes: 165 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<h4 align="center">
<a href="https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g">Slack</a> |
<a href="https://infisical.com/signup">Infisical Cloud</a> |
<a href="https://infisical.com/">Infisical Cloud</a> |
<a href="https://infisical.com/docs/self-hosting/overview">Self-Hosting</a> |
<a href="https://infisical.com/docs/getting-started/introduction">Docs</a> |
<a href="https://www.infisical.com">Website</a>
Expand All @@ -33,12 +33,12 @@

**[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.)
- **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**
Expand Down Expand Up @@ -92,19 +92,168 @@ 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! :)

- [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
- [ ] Kubernetes
- [ ] AWS
- [ ] GCP
- [ ] Azure
- [ ] Digital Ocean
- [ ] GitLab
- [ ] CircleCI
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! :)

<table>
<tr>
<th>Platforms </th>
<th>Frameworks</th>
</tr>
<tr>
<td>

<table>
<tbody>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/platforms/docker">
✔️ Docker
</a>
</td>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/platforms/docker-compose">
✔️ Docker Compose
</a>
</td>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/cloud/heroku">
✔️ Heroku
</a>
</td>
</tr>
<tr>
<td align="left" valign="middle">
🔜 Vercel
</td>
<td align="left" valign="middle">
🔜 GitLab CI/CD
</td>
<td align="left" valign="middle">
🔜 Fly.io
</td>
</tr>
<tr>
<td align="left" valign="middle">
🔜 AWS
</td>
<td align="left" valign="middle">
🔜 GitHub Actions (https://github.com/Infisical/infisical/issues/54)
</td>
<td align="left" valign="middle">
🔜 Railway
</td>
</tr>
<tr>
<td align="left" valign="middle">
🔜 GCP
</td>
<td align="left" valign="middle">
🔜 Kubernetes
</td>
<td align="left" valign="middle">
🔜 CircleCI
</td>
</tr>
<tr>
<td align="left" valign="middle">
🔜 Jenkins
</td>
<td align="left" valign="middle">
🔜 Digital Ocean
</td>
<td align="left" valign="middle">
🔜 Azure
</td>
</tr>
<tr>
<td align="left" valign="middle">
🔜 TravisCI
</td>
<td align="left" valign="middle">
🔜 Netlify (https://github.com/Infisical/infisical/issues/55)
</td>
</tr>
</tbody>
</table>

</td>
<td>


<table>
<tbody>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/react">
✔️ React
</a>
</td>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/express">
✔️ Express
</a>
</td>
</tr>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/gatsby">
✔️ Gatsby
</a>
</td>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/flask">
✔️ Flask
</a>
</td>
</tr>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/django">
✔️ Django
</a>
</td>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/laravel">
✔️ Laravel
</a>
</td>
</tr>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/nestjs">
✔️ NestJS
</a>
</td>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/remix">
✔️ Remix
</a>
</td>
</tr>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/nextjs">
✔️ Next.js
</a>
</td>
<td align="left" valign="middle">
🔜 Vite
</td>
</tr>
<tr>
<td align="left" valign="middle">
<a href="https://infisical.com/docs/integrations/frameworks/rails">
✔️ Ruby on Rails
</a>
</td>
</tr>
</tbody>
</table>

</td>
</tr>
</table>


## Open-source vs. paid

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<Info>
Once the token is expired, the CLI using it will no longer be able to make
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/dashboard/token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Start syncing environment variables with [Infisical Cloud](https://app.infisical
Learn how to configure and deploy Infisical.
</Card>
<Card
href="/integrations/heroku"
href="/integrations/overview"
title="Integrations"
icon="plug"
color="#dc2626"
Expand Down
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/integrations/frameworks/angular.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Angular"
---

Instructions coming soon.
5 changes: 5 additions & 0 deletions docs/integrations/frameworks/django.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Django"
---

Instructions coming soon.
42 changes: 42 additions & 0 deletions docs/integrations/frameworks/express.mdx
Original file line number Diff line number Diff line change
@@ -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
```
5 changes: 5 additions & 0 deletions docs/integrations/frameworks/fibre.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Fibre"
---

Coming soon.
21 changes: 21 additions & 0 deletions docs/integrations/frameworks/flask.mdx
Original file line number Diff line number Diff line change
@@ -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
```
41 changes: 41 additions & 0 deletions docs/integrations/frameworks/gatsby.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
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 development server with environment variables injected

```bash
npm run develop
```

<Note>
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).
</Note>
5 changes: 5 additions & 0 deletions docs/integrations/frameworks/laravel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Laravel"
---

Instructions coming soon.
Loading

0 comments on commit fe339d9

Please sign in to comment.