Finish documentation quickstarts update

This commit is contained in:
Tuan Dang
2023-04-29 20:38:58 +03:00
parent daabf5ab70
commit 75f550caf2
8 changed files with 75 additions and 176 deletions

View File

@@ -2,40 +2,74 @@
title: "Introduction"
---
Infisical is an [open-source](https://opensource.com/resources/what-open-source), [end-to-end encrypted](https://en.wikipedia.org/wiki/End-to-end_encryption) secret management platform that enables teams to easily manage and sync secrets like API keys, database credentials, and environment variables.
Infisical is an [open-source](https://opensource.com/resources/what-open-source), [end-to-end encrypted](https://en.wikipedia.org/wiki/End-to-end_encryption) secret management platform that enables teams to easily manage and sync their environment variables.
Start syncing environment variables with [Infisical Cloud](https://app.infisical.com) or learn how to [host Infisical](/self-hosting/overview) yourself.
## Learn about Infisical
<Card
href="/getting-started/quickstarts/platform"
title="Platform"
icon="laptop"
color="#dc2626"
>
Store secrets like API keys, database credentials, environment variables with Infisical
</Card>
## Integrate with Infisical
<CardGroup cols={2}>
<Card
title="Quickstarts"
href="/getting-started/quickstarts/overview"
icon="timer"
color="#ea5a0c"
title="SDKs"
href="/getting-started/quickstarts/sdks"
icon="boxes-stacked"
color="#3c8639"
>
Learn about Infisical and how to fetch secrets in minutes
Fetch secrets with any programming language on demand
</Card>
<Card href="/cli/overview" title="CLI" icon="square-terminal" color="#16a34a">
Install the CLI to inject secrets into apps and infra.
<Card href="/getting-started/quickstarts/cli" title="Command Line Interface" icon="square-terminal" color="#3775a9">
Inject secrets into any application process/environment
</Card>
<Card href="/sdks/overview" title="SDKs" icon="puzzle-piece" color="#16a34a">
Install an SDK into your app to fetch secrets.
<Card href="/getting-started/quickstarts/docker" title="Docker" icon="docker" color="#0078d3">
Inject secrets into Docker containers
</Card>
<Card
href="/self-hosting/overview"
title="Self-hosting"
href="/getting-started/quickstarts/kubernetes"
title="Kubernetes"
icon="server"
color="#0285c7"
color="#3775a9"
>
Learn how to configure and deploy Infisical.
Fetch and save secrets as native Kubernetes secrets
</Card>
</CardGroup>
## Resources
<Card
href="/self-hosting/overview"
title="Self-hosting"
icon="server"
color="#0285c7"
>
Learn how to configure and deploy Infisical.
</Card>
<CardGroup cols={2}>
<Card
href="/integrations/overview"
title="Integrations"
title="Native Integrations"
icon="clouds"
color="#dc2626"
>
Explore integrations for GitHub, Vercel, Netlify, and more.
</Card>
<Card
href="/integrations/overview"
title="Frameworks"
icon="plug"
color="#dc2626"
>
Explore integrations for Docker, AWS, Heroku, etc.
Explore integrations for Next.js, Express, Django, and more.
</Card>
</CardGroup>

View File

@@ -1,81 +0,0 @@
---
title: "Introduction"
---
Infisical is an [open-source](https://opensource.com/resources/what-open-source), [end-to-end encrypted](https://en.wikipedia.org/wiki/End-to-end_encryption) secret management platform that enables teams to easily manage and sync their environment variables.
Start syncing environment variables with [Infisical Cloud](https://app.infisical.com) or learn how to [host Infisical](/self-hosting/overview) yourself.
## Learn about Infisical
<Card
href="/getting-started/quickstarts/platform"
title="Platform"
icon="laptop"
color="#dc2626"
>
Store secrets like API keys, database credentials, environment variables with Infisical
</Card>
## Integrate with Infisical
<CardGroup cols={2}>
<Card
title="SDKs"
href="/getting-started/quickstarts/sdks"
icon="boxes-stacked"
color="#3c8639"
>
Fetch secrets for any programming language on demand
</Card>
<Card href="/getting-started/quickstarts/cli" title="Command Line Interface" icon="square-terminal" color="#3775a9">
Inject secrets into any application process/environment
</Card>
<Card href="/getting-started/quickstarts/docker" title="Docker" icon="docker" color="#0078d3">
Inject secrets into Docker containers
</Card>
<Card
href="/getting-started/quickstarts/k8s"
title="Kubernetes"
icon="server"
color="#3775a9"
>
Fetch and save secrets as native Kubernetes secrets
</Card>
</CardGroup>
## Resources
<CardGroup cols={2}>
<Card
title="Quickstarts"
href="/getting-started/quickstarts/overview"
icon="timer"
color="#ea5a0c"
>
Tour Infisical in a few minutes
</Card>
<Card href="/cli/overview" title="CLI" icon="square-terminal" color="#16a34a">
Install the CLI to inject secrets into apps and infra.
</Card>
<Card href="/sdks/overview" title="SDKs" icon="puzzle-piece" color="#16a34a">
Install an SDK into your app to fetch secrets.
</Card>
<Card
href="/self-hosting/overview"
title="Self-hosting"
icon="server"
color="#0285c7"
>
Learn how to configure and deploy Infisical.
</Card>
</CardGroup>
<Card
href="/integrations/overview"
title="Integrations"
icon="plug"
color="#dc2626"
>
Explore integrations for Docker, AWS, Heroku, etc.
</Card>

View File

@@ -2,7 +2,9 @@
title: "CLI"
---
The Infisical CLI can be used to inject secrets for local development, CI/CD needs and Docker image as environment variables.
The Infisical CLI can be used to inject secrets into any framework like Next.js, Express, Django and more in local development.
It can also be used to expose secrets from Infisical as environment variables in CI/CD pipelines and [Docker containers](/getting-started/quickstarts/docker)
Prerequisites:
@@ -108,28 +110,19 @@ $ infisical init
## Start your app with environment variables injected
```console
$ infisical run -- [your application start command]
$ infisical run -- <your_application_start_command>
```
Your app should now be running with the secrets from Infisical injected as environment variables. To see view all possible commands for the CLI, visit the commands tab on the sidebar.
## Example Start Commands
CLI framework resources:
```console
$ infisical run -- npm run dev
$ infisical run -- flask run
$ infisical run -- ./your_bash_script.sh
```
- [Express/Koa/Fastify](/integrations/frameworks/express)
- [NestJS](/integrations/frameworks/nestjs)
- [Fiber](/integrations/frameworks/fiber)
- [Django](/integrations/frameworks/django)
- [Flask](/integrations/frameworks/flask)
- [Laravel](/integrations/frameworks/laravel)
- [Ruby on Rails](/integrations/frameworks/rails)
- [React](/integrations/frameworks/react)
- [Vue](/integrations/frameworks/vue)
- [Next.js](/integrations/frameworks/nextjs)
- [SvelteKit](/integrations/frameworks/sveltekit)
- [Nuxt](/integrations/frameworks/nuxt)
- [Gatsby](/integrations/frameworks/gatsby)
- [Remix](/integrations/frameworks/remix)
- [Vite](/integrations/frameworks/vite)
- [Fiber](/integrations/frameworks/fiber)
Your app should now be running with the secrets from Infisical injected as environment variables.
Not seeing a framework? Throw in a [request](https://github.com/Infisical/infisical/issues).
Resources:
- [Documentation for the CLI](/cli/overview)

View File

@@ -177,4 +177,9 @@ Prerequisites:
Your containers should now be running with the secrets from Infisical available inside as environment variables.
</Tab>
</Tabs>
</Tabs>
Resources:
- [Documentation for Docker](/integrations/platforms/docker)
- [Documentation for Docker Compose](/integrations/platforms/docker-compose)

View File

@@ -3,7 +3,7 @@ title: "Kubernetes"
---
The Infisical Secrets Operator fetches secrets from Infisical and saves them as Kubernetes secrets using the custom `InfisicalSecret` resource to define authentication and storage methods.
The operator updates secrets continuously and can reloads dependent deployments automatically on secret changes.
The operator updates secrets continuously and can reload dependent deployments automatically on secret changes.
Prerequisites:

View File

@@ -1,41 +0,0 @@
---
title: "Overview"
---
### Learn about Infisical
<Card
href="/getting-started/quickstarts/platform"
title="Platform"
icon="laptop"
color="#dc2626"
>
Store secrets like API keys, database credentials, environment variables with Infisical
</Card>
### Integrate with Infisical
<CardGroup cols={2}>
<Card
title="SDKs"
href="/getting-started/quickstarts/sdks"
icon="boxes-stacked"
color="#3c8639"
>
Fetch secrets for any programming language on demand
</Card>
<Card href="/getting-started/quickstarts/cli" title="Command Line Interface" icon="square-terminal" color="#3775a9">
Inject secrets into any application process/environment
</Card>
<Card href="/getting-started/quickstarts/docker" title="Docker" icon="docker" color="#0078d3">
Inject secrets into Docker containers
</Card>
<Card
href="/getting-started/quickstarts/kubernetes"
title="Kubernetes"
icon="server"
color="#3775a9"
>
Fetch and save secrets as native Kubernetes secrets
</Card>
</CardGroup>

View File

@@ -8,7 +8,7 @@ This quickstart provides an overview of the functionalities offered by Infisical
## Projects
Projects hold secrets for applications, which are further organized into environments such as dev, testing and prod.
Projects hold secrets for applications, which are further organized into environments such as development, testing and production.
### Secrets Overview

View File

@@ -79,20 +79,17 @@
{
"group": "Overview",
"pages": [
"getting-started/introduction",
"getting-started/introduction2",
{
"group": "Quickstarts",
"group": "Getting Started",
"pages": [
"getting-started/quickstarts/overview",
"getting-started/introduction",
"getting-started/quickstarts/platform",
"getting-started/quickstarts/sdks",
"getting-started/quickstarts/cli",
"getting-started/quickstarts/docker",
"getting-started/quickstarts/kubernetes"
]
},
"getting-started/features"
}
]
},
{
@@ -189,13 +186,6 @@
"integrations/platforms/pm2"
]
},
{
"group": "Deployment options",
"pages": [
"self-hosting/deployments/linux",
"self-hosting/deployments/kubernetes"
]
},
{
"group": "Overview",
"pages": [
@@ -300,7 +290,6 @@
]
}
],
"backgroundImage": "/images/background.png",
"integrations": {
"intercom": "hsg644ru"
}