Improved docs SEO

This commit is contained in:
Vladyslav Matsiiako
2023-01-28 12:53:44 -08:00
parent a5eba8e722
commit 3cea59ce5d
56 changed files with 59 additions and 8 deletions
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Commands" title: "Commands"
description: "Infisical CLI command overview"
--- ---
## Commands ## Commands
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "infisical export" title: "infisical export"
description: "Export Infisical secrets from CLI into different file formats"
--- ---
```bash ```bash
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "infisical init" title: "infisical init"
description: "Switch between Infisical projects within CLI"
--- ---
```bash ```bash
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "infisical login" title: "infisical login"
description: "Login into Infisical from the CLI"
--- ---
```bash ```bash
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "infisical run" title: "infisical run"
description: "The command that injects your secrets into local environment"
--- ---
<Tabs> <Tabs>
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "infisical secrets" title: "infisical secrets"
description: "Perform CRUD operations with Infisical secrets"
--- ---
``` ```
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "infisical vault" title: "infisical vault"
description: "Change the vault type in Infisical"
--- ---
<Tabs> <Tabs>
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "FAQ" title: "FAQ"
description: "Frequently Asked Questions about Infisical"
--- ---
Frequently asked questions about the CLI can be found on this page. Frequently asked questions about the CLI can be found on this page.
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: 'Install' title: 'Install'
description: "Infisical's CLI is one of the best way to manage environments and secrets. Install it here"
--- ---
Prerequisite: Set up an account with [Infisical Cloud](https://app.infisical.com) or via a [self-hosted installation](/self-hosting/overview). Prerequisite: Set up an account with [Infisical Cloud](https://app.infisical.com) or via a [self-hosted installation](/self-hosting/overview).
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Infisical Token" title: "Infisical Token"
description: "How to use Infical service token within the CLI."
--- ---
Prerequisite: [Infisical Token and How to Generate One](../../getting-started/dashboard/token). Prerequisite: [Infisical Token and How to Generate One](../../getting-started/dashboard/token).
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Usage" title: "Usage"
description: "How to manage you secrets with Infisical's CLI?"
--- ---
Prerequisite: [Install the CLI](/cli/overview) Prerequisite: [Install the CLI](/cli/overview)
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: "Code of Conduct" title: "Code of Conduct"
description: "" description: "What you should know before contributing to Infisical?"
--- ---
## Our Pledge ## Our Pledge
@@ -1,5 +1,6 @@
--- ---
title: "Activity Logs" title: "Activity Logs"
description: "See which events are triggered within your Infisical project."
--- ---
Activity logs record all actions going through Infisical including who performed which CRUD operations on environment variables and from what IP address. They help answer questions like: Activity logs record all actions going through Infisical including who performed which CRUD operations on environment variables and from what IP address. They help answer questions like:
@@ -1,5 +1,6 @@
--- ---
title: "Sign up" title: "Sign up"
description: "How to create an account in Infisical?"
--- ---
## Self-hosted ## Self-hosted
@@ -1,10 +1,11 @@
--- ---
title: "Integrations" title: "Integrations"
description: "How to sync your secrets among various 3rd-party services with Infisical."
--- ---
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 relatively early with integrations. 6+ integrations are already avaiable but expect more coming very soon.
<Card title="View integrations" icon="link" href="/integrations/overview"> <Card title="View integrations" icon="link" href="/integrations/overview">
View all available integrations and their guides View all available integrations and their guides
@@ -1,5 +1,6 @@
--- ---
title: "Organization" title: "Organization"
description: "How Infisical structures its organizations."
--- ---
An organization houses projects and members. An organization houses projects and members.
@@ -1,5 +1,6 @@
--- ---
title: "Point-in-Time Recovery" title: "Point-in-Time Recovery"
description: "How to rollback secrets and configs to any commit with Infisical."
--- ---
Point-in-time recovery allows environment variables to be rolled back to any point in time. It's powered by snapshots that get captured after mutations to environment variables. Point-in-time recovery allows environment variables to be rolled back to any point in time. It's powered by snapshots that get captured after mutations to environment variables.
@@ -1,5 +1,6 @@
--- ---
title: "Project" title: "Project"
description: "How Infisical organizes secrets into projects."
--- ---
A project houses environment variables for an application. A project houses environment variables for an application.
@@ -1,5 +1,6 @@
--- ---
title: "Secret Versioning" title: "Secret Versioning"
description: "Version secrets and configurations with Infisical"
--- ---
Secret versioning records changes made to every secret. Secret versioning records changes made to every secret.
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Infisical Token" title: "Infisical Token"
description: "Use Infisical service token as one of the authentication methods."
--- ---
An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials. An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials.
+2 -1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Features" title: "Features"
description: "A list of features that Infisical has to offer."
--- ---
This is a non-exhaustive list of features that Infisical offers: This is a non-exhaustive list of features that Infisical offers:
@@ -30,9 +31,9 @@ We're building the future of secret management, one that's comprehensive and acc
| More hosting options | Ongoing | | More hosting options | Ongoing |
| 1-Click Deploys | Ongoing | | 1-Click Deploys | Ongoing |
| Account recovery: Backup key | Ongoing | | Account recovery: Backup key | Ongoing |
| Access logs | Ongoing |
| Account recovery: Member-assisted | Coming soon | | Account recovery: Member-assisted | Coming soon |
| Slack & MS teams integrations | Coming soon | | Slack & MS teams integrations | Coming soon |
| Access logs | Coming soon |
| Version control for secrets | Coming soon | | Version control for secrets | Coming soon |
| 2FA | Coming soon | | 2FA | Coming soon |
| Restricted IPs | Coming soon | | Restricted IPs | Coming soon |
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Introduction" title: "Introduction"
description: "What is Infisical?"
--- ---
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 manager that enables teams to easily manage and sync their 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 manager that enables teams to easily manage and sync their environment variables.
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Quickstart" title: "Quickstart"
description: "Start managing your developer secrets and configs with Infisical in 10 minutes."
--- ---
This example demonstrates how to store and inject environment variables from [Infisical Cloud](https://app.infisical.com) into your application. This example demonstrates how to store and inject environment variables from [Infisical Cloud](https://app.infisical.com) into your application.
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "GitHub Actions" title: "GitHub Actions"
description: "How to automatically sync secrets from Infisical into your GitHub Actions."
--- ---
<Warning> <Warning>
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Fly.io" title: "Fly.io"
description: "How to automatically sync secrets from Infisical into your Fly.io project."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Heroku" title: "Heroku"
description: "How to automatically sync secrets from Infisical into your Heroku project."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Netlify" title: "Netlify"
description: "How to automatically sync secrets from Infisical into your Netlify project."
--- ---
<Warning> <Warning>
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Render" title: "Render"
description: "How to automatically sync secrets from Infisical into your Render project."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Vercel" title: "Vercel"
description: "How to automatically sync secrets from Infisical into your Vercel project."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Django" title: "Django"
description: "How to use Infisical to inject environment variables and secrets into a Django app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: ".NET" title: ".NET"
description: "How to use Infisical to inject environment variables and secrets into a .NET app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Express, Fastify, Koa" title: "Express, Fastify, Koa"
description: "How to use Infisical to inject environment variables and secrets into an Express app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Fiber" title: "Fiber"
description: "How to use Infisical to inject environment variables and secrets into a Fiber app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Flask" title: "Flask"
description: "How to use Infisical to inject environment variables and secrets into a Flask app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Gatsby" title: "Gatsby"
description: "How to use Infisical to inject environment variables and secrets into a Gatsby app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Laravel" title: "Laravel"
description: "How to use Infisical to inject environment variables and secrets into a Laravel app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "NestJS" title: "NestJS"
description: "How to use Infisical to inject environment variables and secrets into a NestJS app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Next.js" title: "Next.js"
description: "How to use Infisical to inject environment variables and secrets into a Next.js app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Nuxt" title: "Nuxt"
description: "How to use Infisical to inject environment variables and secrets into a Nuxt app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Ruby on Rails" title: "Ruby on Rails"
description: "How to use Infisical to inject environment variables and secrets into a Ruby on Rails app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "React" title: "React"
description: "How to use Infisical to inject environment variables and secrets into a React app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Remix" title: "Remix"
description: "How to use Infisical to inject environment variables and secrets into a Remix app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Vite" title: "Vite"
description: "How to use Infisical to inject environment variables and secrets into a Vite app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Vue" title: "Vue"
description: "How to use Infisical to inject environment variables and secrets into a Vue.js app."
--- ---
Prerequisites: Prerequisites:
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Overview" title: "Overview"
description: "How to use Infisical to inject secrets and configs into various 3-rd party services and frameworks."
--- ---
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.
@@ -1,5 +1,6 @@
--- ---
title: "Docker Compose" title: "Docker Compose"
description: "How to use Infisical to inject environment variables into container defined in your Docker Compose file."
--- ---
The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file. The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file.
+2 -1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Docker" title: "Docker"
description: "How to use Infisical to inject environment variables into a Docker container."
--- ---
Infisical can be used in a Dockerfile to inject environment variables into a Docker container. Infisical can be used in a Dockerfile to inject environment variables into a Docker container.
@@ -43,7 +44,7 @@ Infisical can be used in a Dockerfile to inject environment variables into a Doc
CMD ["infisical", "run", "---", "npm run start"] CMD ["infisical", "run", "---", "npm run start"]
# example with multiple commands # example with multiple commands
CMD ["infisical", "run", "--command" "npm run start && ..."] CMD ["infisical", "run", "--command", "npm run start && ..."]
``` ```
View more options for the `run` command [here](../../cli/commands/run) View more options for the `run` command [here](../../cli/commands/run)
@@ -1,5 +1,6 @@
--- ---
title: 'Kubernetes' title: 'Kubernetes'
description: "This page explains how to use Infisical to inject secrets into Kubernetes clusters."
--- ---
The Infisical Secrets Operator is a custom Kubernetes controller that helps keep secrets in a cluster up to date by synchronizing them. The Infisical Secrets Operator is a custom Kubernetes controller that helps keep secrets in a cluster up to date by synchronizing them.
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Data Model" title: "Data Model"
description: "Infisical's current Data Structure."
--- ---
Infisical stores a range of data namely user, secrets, keys, organization, project, and membership data. Infisical stores a range of data namely user, secrets, keys, organization, project, and membership data.
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Mechanics" title: "Mechanics"
description: "Quick explanation of how Infisical works."
--- ---
## Signup ## Signup
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Overview" title: "Overview"
description: "Infisical's security statement."
--- ---
## Summary ## Summary
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: "Email" title: "Email"
description: "" description: "How to configure your email when self-hosting Infisical."
--- ---
Infisical requires you to configure your own SMTP server for certain functionality like: Infisical requires you to configure your own SMTP server for certain functionality like:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: "Environment Variables" title: "Environment Variables"
description: "" description: "How to configure your environment variables when self-hosting Infisical."
--- ---
Configuring Infisical requires setting some environment variables. There is a file called [`.env.example`](https://github.com/Infisical/infisical/blob/main/.env.example) at the root directory of our main repo that you can use to create a `.env` file before you start the server. Configuring Infisical requires setting some environment variables. There is a file called [`.env.example`](https://github.com/Infisical/infisical/blob/main/.env.example) at the root directory of our main repo that you can use to create a `.env` file before you start the server.
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: "Kubernetes" title: "Kubernetes"
description: "Deploy with Kubernetes" description: "How to deploy Infisical with Kubernetes"
--- ---
<Info> <Info>
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: "Linux VM" title: "Linux VM"
description: "Deploy with Docker-Compose" description: "How to deploy Infisical with Docker-Compose"
--- ---
<Info> <Info>
+1
View File
@@ -1,5 +1,6 @@
--- ---
title: "Overview" title: "Overview"
description: "Infisical is an open-source end-to-end encrypted secrets manager that developers can set up within 15 minutes."
--- ---
<Info> <Info>