mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
Begin adding guides to docs
This commit is contained in:
@@ -46,23 +46,30 @@ Start syncing environment variables with [Infisical Cloud](https://app.infisical
|
|||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
<Card
|
|
||||||
href="/self-hosting/overview"
|
|
||||||
title="Self-hosting"
|
|
||||||
icon="server"
|
|
||||||
color="#0285c7"
|
|
||||||
>
|
|
||||||
Learn how to configure and deploy Infisical.
|
|
||||||
</Card>
|
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
|
<Card
|
||||||
|
href="/self-hosting/overview"
|
||||||
|
title="Self-hosting"
|
||||||
|
icon="server"
|
||||||
|
color="#0285c7"
|
||||||
|
>
|
||||||
|
Learn how to configure and deploy Infisical
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/documentation/guides/introduction"
|
||||||
|
title="Guide"
|
||||||
|
icon="book-open"
|
||||||
|
color="#dc2626"
|
||||||
|
>
|
||||||
|
Explore guides for every language and stack
|
||||||
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
href="/integrations/overview"
|
href="/integrations/overview"
|
||||||
title="Native Integrations"
|
title="Native Integrations"
|
||||||
icon="clouds"
|
icon="clouds"
|
||||||
color="#dc2626"
|
color="#dc2626"
|
||||||
>
|
>
|
||||||
Explore integrations for GitHub, Vercel, Netlify, and more.
|
Explore integrations for GitHub, Vercel, Netlify, and more
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
href="/integrations/overview"
|
href="/integrations/overview"
|
||||||
@@ -70,6 +77,14 @@ Start syncing environment variables with [Infisical Cloud](https://app.infisical
|
|||||||
icon="plug"
|
icon="plug"
|
||||||
color="#dc2626"
|
color="#dc2626"
|
||||||
>
|
>
|
||||||
Explore integrations for Next.js, Express, Django, and more.
|
Explore integrations for Next.js, Express, Django, and more
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="https://calendly.com/team-infisical/infisical-demo"
|
||||||
|
title="Contact Us"
|
||||||
|
icon="user-headset"
|
||||||
|
color="#0285c7"
|
||||||
|
>
|
||||||
|
Questions? Need help setting up? Book a 1x1 meeting with us
|
||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
@@ -9,11 +9,12 @@ Prerequisites:
|
|||||||
- Have a project with secrets ready in [Infisical Cloud](https://app.infisical.com).
|
- Have a project with secrets ready in [Infisical Cloud](https://app.infisical.com).
|
||||||
- Create an [Infisical Token](/getting-started/dashboard/token) scoped to an environment in your project in Infisical.
|
- Create an [Infisical Token](/getting-started/dashboard/token) scoped to an environment in your project in Infisical.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Follow the instructions for your language to install the SDK for it.
|
||||||
|
|
||||||
<Tabs>
|
<Tabs>
|
||||||
<Tab title="Node">
|
<Tab title="Node">
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Run `npm` to add [infisical-node](https://github.com/Infisical/infisical-node) to your project.
|
Run `npm` to add [infisical-node](https://github.com/Infisical/infisical-node) to your project.
|
||||||
|
|
||||||
@@ -134,7 +135,7 @@ Prerequisites:
|
|||||||
- [Rust](https://github.com/Infisical/infisical/issues/437)
|
- [Rust](https://github.com/Infisical/infisical/issues/437)
|
||||||
- [PHP](https://github.com/Infisical/infisical/issues/531)
|
- [PHP](https://github.com/Infisical/infisical/issues/531)
|
||||||
|
|
||||||
Missing a language? Throw in a [request](https://github.com/Infisical/infisical/issues).
|
Missing a language? [Throw in a request](https://github.com/Infisical/infisical/issues).
|
||||||
</Tab>
|
</Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
41
docs/documentation/guides/introduction.mdx
Normal file
41
docs/documentation/guides/introduction.mdx
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
---
|
||||||
|
title: "Introduction"
|
||||||
|
---
|
||||||
|
|
||||||
|
Whether you're running a Node application on Heroku, Next.js application with Vercel, or Kubernetes on AWS, Infisical has a secret management strategy from local development to production for you.
|
||||||
|
|
||||||
|
## Guides by Language
|
||||||
|
|
||||||
|
<CardGroup cols={2}>
|
||||||
|
<Card
|
||||||
|
title="Node"
|
||||||
|
href="/documentation/guides/node"
|
||||||
|
icon="node"
|
||||||
|
color="#3c8639"
|
||||||
|
>
|
||||||
|
Manage secrets across your Node stack
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/documentation/guides/python"
|
||||||
|
title="Python"
|
||||||
|
icon="python"
|
||||||
|
color="#3775a9"
|
||||||
|
>
|
||||||
|
Manage secrets across your Python stack
|
||||||
|
</Card>
|
||||||
|
</CardGroup>
|
||||||
|
|
||||||
|
## Guides by Stack
|
||||||
|
|
||||||
|
<CardGroup cols={2}>
|
||||||
|
<Card
|
||||||
|
title="Next.js + Vercel"
|
||||||
|
href="/getting-started/quickstarts/sdks"
|
||||||
|
icon="cloud"
|
||||||
|
color="#3c8639"
|
||||||
|
>
|
||||||
|
Manage secrets for your Next.js + Vercel stack
|
||||||
|
</Card>
|
||||||
|
</CardGroup>
|
||||||
|
|
||||||
|
Want a guide? [Throw in a request](https://github.com/Infisical/infisical/issues).
|
||||||
4
docs/documentation/guides/nextjs-vercel.mdx
Normal file
4
docs/documentation/guides/nextjs-vercel.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: "Next.js + Vercel"
|
||||||
|
description: "Manage secrets across your Next.js + Vercel stack"
|
||||||
|
---
|
||||||
19
docs/documentation/guides/node.mdx
Normal file
19
docs/documentation/guides/node.mdx
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
title: "Node"
|
||||||
|
---
|
||||||
|
|
||||||
|
This guide demonstrates how to manage secrets for your Node stack from local development to production. It uses:
|
||||||
|
|
||||||
|
- Infisical (you can use [Infisical Cloud](https://app.infisical.com) or a [self-hosted instance of Infisical](https://infisical.com/docs/self-hosting/overview)) to store your secrets.
|
||||||
|
- The [infisical-node](https://github.com/Infisical/infisical-node) client SDK to fetch secrets back to your Node application on demand.
|
||||||
|
|
||||||
|
## Video Guide
|
||||||
|
|
||||||
|
TODO: insert video
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
If you get stuck while working through this guide, refer to the [full example on GitHub]().
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Project Setup
|
||||||
|
|
||||||
4
docs/documentation/guides/python.mdx
Normal file
4
docs/documentation/guides/python.mdx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: "Python"
|
||||||
|
description: "Manage secrets across your Python stack"
|
||||||
|
---
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Features"
|
|
||||||
description: "A non-exhaustive list of features that Infisical has to offer."
|
|
||||||
---
|
|
||||||
|
|
||||||
## Platform
|
|
||||||
|
|
||||||
- Provision members access to organizations and projects.
|
|
||||||
- Manage secrets by adding, deleting, updating them across environments; search, sort, hide/un-hide, export/import them.
|
|
||||||
- Sync secrets to platforms via integrations to platforms like GitHub, Vercel, and Netlify.
|
|
||||||
- Rollback secrets to any point in time.
|
|
||||||
- Rollback each secrets to any version.
|
|
||||||
- Track actions through audit logs.
|
|
||||||
|
|
||||||
## CLI
|
|
||||||
|
|
||||||
The [CLI](/cli/overview) is used to inject environment variables into applications and infrastructure.
|
|
||||||
|
|
||||||
- Inject environment variables.
|
|
||||||
- Inject environment variables into containers via service tokens for Docker.
|
|
||||||
|
|
||||||
## SDKs
|
|
||||||
|
|
||||||
[SDKs](/sdks/overview) enable apps to fetch back secrets using an [Infisical Token](/getting-started/dashboard/token) scoped to a project and environment.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
|
|
||||||
We're building the future of secret management, one that's comprehensive and accessible to all. Check out our [roadmap](https://www.notion.so/infisical/be2d2585a6694e40889b03aef96ea36b?v=5b19a8127d1a4060b54769567a8785fa).
|
|
||||||
|
|
||||||
Interested in contributing? Check out the [guide](/contributing/overview).
|
|
||||||
@@ -1,116 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Quickstarts"
|
|
||||||
description: "Start managing developer secrets and configs with Infisical in minutes."
|
|
||||||
---
|
|
||||||
|
|
||||||
These examples demonstrate how to store and fetch environment variables from [Infisical Cloud](https://app.infisical.com) into your application.
|
|
||||||
|
|
||||||
## Set up Infisical Cloud
|
|
||||||
|
|
||||||
1. Login or create an account at `app.infisical.com`.
|
|
||||||
2. Create a new project.
|
|
||||||
3. Keep the default environment variables or populate them as in the image below.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Fetch Secrets for Your App
|
|
||||||
|
|
||||||
<Tabs>
|
|
||||||
<Tab title="CLI">
|
|
||||||
|
|
||||||
The Infisical CLI is platform-agnostic and enables you to inject environment variables into your app across many tech stacks and frameworks.
|
|
||||||
|
|
||||||
### Set up the CLI
|
|
||||||
|
|
||||||
1. Follow the instructions to [install our platform-agnostic CLI](/cli/overview).
|
|
||||||
|
|
||||||
2. Initialize Infisical for your project.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# move to your project
|
|
||||||
cd /path/to/project
|
|
||||||
|
|
||||||
# initialize infisical
|
|
||||||
infisical init
|
|
||||||
```
|
|
||||||
|
|
||||||
### Start your app with environment variables injected
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# inject environment variables into app
|
|
||||||
infisical run -- [your application start command]
|
|
||||||
```
|
|
||||||
|
|
||||||
Your app should now be running with the environment variables injected.
|
|
||||||
|
|
||||||
Check out our [integrations](/integrations/overview) for injecting environment variables into frameworks and platforms like Docker.
|
|
||||||
|
|
||||||
</Tab>
|
|
||||||
<Tab title="SDK">
|
|
||||||
[Infisical SDKs](/sdks/overview) let your app fetch back secrets using an [Infisical Token](/getting-started/dashboard/token) that is scoped to a project and environment in Infisical. In this example, we demonstrate how to use the [Node SDK](/sdks/languages/node).
|
|
||||||
|
|
||||||
Using Python? We have a [Python SDK](/sdks/languages/python) as well.
|
|
||||||
|
|
||||||
### Obtain an [Infisical Token](/getting-started/dashboard/token)
|
|
||||||
|
|
||||||
Head to your project settings to create a token scoped to the project and environment you wish to fetch secrets from.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Install the SDK
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install infisical-node --save
|
|
||||||
```
|
|
||||||
|
|
||||||
### Initialize the Infisical client
|
|
||||||
|
|
||||||
```js
|
|
||||||
import InfisicalClient from "infisical-node";
|
|
||||||
|
|
||||||
const client = new InfisicalClient({
|
|
||||||
token: "your_infisical_token",
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Get a value
|
|
||||||
|
|
||||||
```js
|
|
||||||
const value = await client.getSecret("SOME_KEY");
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example with Express
|
|
||||||
|
|
||||||
```js
|
|
||||||
import InfisicalClient from "infisical-node";
|
|
||||||
import express from "express";
|
|
||||||
const app = express();
|
|
||||||
const PORT = 3000;
|
|
||||||
|
|
||||||
const client = InfisicalClient({
|
|
||||||
token: "st.xxx.xxx",
|
|
||||||
});
|
|
||||||
|
|
||||||
// your application logic
|
|
||||||
|
|
||||||
app.get("/", async (req, res) => {
|
|
||||||
const name = await client.getSecret("NAME");
|
|
||||||
res.send(`Hello! My name is: ${name.secretValue}`);
|
|
||||||
});
|
|
||||||
|
|
||||||
app.listen(PORT, async () => {
|
|
||||||
console.log(`App listening on port ${port}`);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
<Warning>
|
|
||||||
We do not recommend hardcoding your [Infisical
|
|
||||||
Token](/getting-started/dashboard/token). Setting it as an environment
|
|
||||||
variable would be best.
|
|
||||||
|
|
||||||
</Warning>
|
|
||||||
|
|
||||||
Check out our [SDKs](/sdks/overview) for other language SDKs.
|
|
||||||
|
|
||||||
</Tab>
|
|
||||||
</Tabs>
|
|
||||||
@@ -5,7 +5,7 @@ description: "How to use Infisical to inject secrets and configs into various 3-
|
|||||||
|
|
||||||
Integrations allow environment variables to be synced from Infisical into your local development workflow, CI/CD pipelines, and production infrastructure.
|
Integrations allow environment variables to be synced from Infisical into your local development workflow, CI/CD pipelines, and production infrastructure.
|
||||||
|
|
||||||
Missing an integration? Throw in a [request](https://github.com/Infisical/infisical/issues).
|
Missing an integration? [Throw in a request](https://github.com/Infisical/infisical/issues).
|
||||||
|
|
||||||
| Integration | Type | Status |
|
| Integration | Type | Status |
|
||||||
| -------------------------------------------------------------- | --------- | ----------- |
|
| -------------------------------------------------------------- | --------- | ----------- |
|
||||||
|
|||||||
@@ -82,12 +82,21 @@
|
|||||||
{
|
{
|
||||||
"group": "Getting Started",
|
"group": "Getting Started",
|
||||||
"pages": [
|
"pages": [
|
||||||
"getting-started/introduction",
|
"documentation/getting-started/introduction",
|
||||||
"getting-started/quickstarts/platform",
|
"documentation/getting-started/platform",
|
||||||
"getting-started/quickstarts/sdks",
|
"documentation/getting-started/sdks",
|
||||||
"getting-started/quickstarts/cli",
|
"documentation/getting-started/cli",
|
||||||
"getting-started/quickstarts/docker",
|
"documentation/getting-started/docker",
|
||||||
"getting-started/quickstarts/kubernetes"
|
"documentation/getting-started/kubernetes"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group": "Guides",
|
||||||
|
"pages": [
|
||||||
|
"documentation/guides/introduction",
|
||||||
|
"documentation/guides/node",
|
||||||
|
"documentation/guides/python",
|
||||||
|
"documentation/guides/nextjs-vercel"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -95,13 +104,13 @@
|
|||||||
{
|
{
|
||||||
"group": "Platform",
|
"group": "Platform",
|
||||||
"pages": [
|
"pages": [
|
||||||
"getting-started/dashboard/organization",
|
"documentation/platform/organization",
|
||||||
"getting-started/dashboard/project",
|
"documentation/platform/project",
|
||||||
"getting-started/dashboard/pit-recovery",
|
"documentation/platform/pit-recovery",
|
||||||
"getting-started/dashboard/secret-versioning",
|
"documentation/platform/secret-versioning",
|
||||||
"getting-started/dashboard/audit-logs",
|
"documentation/platform/audit-logs",
|
||||||
"getting-started/dashboard/mfa",
|
"documentation/platform/mfa",
|
||||||
"getting-started/dashboard/token"
|
"documentation/platform/token"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -3,14 +3,63 @@ title: "Overview"
|
|||||||
description: "How to use Infisical SDKs to fetch back secrets for your app"
|
description: "How to use Infisical SDKs to fetch back secrets for your app"
|
||||||
---
|
---
|
||||||
|
|
||||||
Whether it be for local development or production, Infisical SDKs provide the easiest way for your app to fetch back secrets using an [Infisical Token](/getting-started/dashboard/token).
|
Whether it be for local development or production, Infisical SDKs provide the easiest way for your app to fetch back secrets from Infisical on demand.
|
||||||
|
|
||||||
We currently have the [Node SDK](https://github.com/Infisical/infisical-node) and [Python SDK](https://github.com/Infisical/infisical-python) available with more language SDKs coming out soon:
|
<CardGroup cols={2}>
|
||||||
|
<Card
|
||||||
- [Node](https://github.com/Infisical/infisical-node)
|
title="Node"
|
||||||
- [Python](https://github.com/Infisical/infisical-python)
|
href="https://github.com/Infisical/infisical-node"
|
||||||
- [Java](/sdks/languages/java)
|
icon="node"
|
||||||
- [Ruby](/sdks/languages/ruby)
|
color="#68a063"
|
||||||
- [Go](/sdks/languages/go)
|
>
|
||||||
- [Rust](/sdks/languages/rust)
|
Manage secrets for your Node application on demand
|
||||||
- [PHP](/sdks/languages/php)
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="https://github.com/Infisical/infisical-python"
|
||||||
|
title="Python"
|
||||||
|
icon="python"
|
||||||
|
color="#4c8abe"
|
||||||
|
>
|
||||||
|
Manage secrets for your Python application on demand
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/sdks/languages/java"
|
||||||
|
title="Java"
|
||||||
|
icon="java"
|
||||||
|
color="#e41f23"
|
||||||
|
>
|
||||||
|
Manage secrets for your Java application on demand
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/sdks/languages/ruby"
|
||||||
|
title="Ruby"
|
||||||
|
icon="gem"
|
||||||
|
color="#ac0d01"
|
||||||
|
>
|
||||||
|
Manage secrets for your Ruby application on demand
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/sdks/languages/go"
|
||||||
|
title="Golang"
|
||||||
|
icon="golang"
|
||||||
|
color="#00add8"
|
||||||
|
>
|
||||||
|
Manage secrets for your Go application on demand
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/sdks/languages/rust"
|
||||||
|
title="Rust"
|
||||||
|
icon="rust"
|
||||||
|
color="#cd412b"
|
||||||
|
>
|
||||||
|
Manage secrets for your Rust application on demand
|
||||||
|
</Card>
|
||||||
|
<Card
|
||||||
|
href="/sdks/languages/php"
|
||||||
|
title="PHP"
|
||||||
|
icon="php"
|
||||||
|
color="#787cb4"
|
||||||
|
>
|
||||||
|
Manage secrets for your PHP application on demand
|
||||||
|
</Card>
|
||||||
|
</CardGroup>
|
||||||
Reference in New Issue
Block a user