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:
12
docs/documentation/platform/audit-logs.mdx
Normal file
12
docs/documentation/platform/audit-logs.mdx
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: "Audit Logs"
|
||||
description: "See which events are triggered within your Infisical project."
|
||||
---
|
||||
|
||||
Audit 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:
|
||||
|
||||
- Who added or updated environment variables recently?
|
||||
- Did Bob read environment variables last week (if at all)?
|
||||
- What IP address was used for that action?
|
||||
|
||||

|
||||
16
docs/documentation/platform/create-account.mdx
Normal file
16
docs/documentation/platform/create-account.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: "Sign up"
|
||||
description: "How to create an account in Infisical?"
|
||||
---
|
||||
|
||||
## Self-hosted
|
||||
|
||||
If you're using a self-hosted installation, follow the [setup](/self-hosting/overview) then open your site URL `{SITE_URL}`.
|
||||
|
||||
## Infisical Cloud
|
||||
|
||||
Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to complete the signup sequence.
|
||||
|
||||
Once you've done that, you'll be taken to the dashboard where we've populated some default environment variables for demonstration.
|
||||
|
||||

|
||||
12
docs/documentation/platform/integrations.mdx
Normal file
12
docs/documentation/platform/integrations.mdx
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
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.
|
||||
|
||||
<Card title="View integrations" icon="link" href="/integrations/overview">
|
||||
View all available integrations and their guides
|
||||
</Card>
|
||||
|
||||

|
||||
18
docs/documentation/platform/mfa.mdx
Normal file
18
docs/documentation/platform/mfa.mdx
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: "MFA"
|
||||
description: "Secure your Infisical account with MFA"
|
||||
---
|
||||
|
||||
MFA requires users to provide multiple forms of identification to access their account. Currently, this means logging in with your password and a 6-digit code sent to your email.
|
||||
|
||||
## Email 2FA
|
||||
|
||||
Check the box in Personal Settings > Two-factor Authentication to enable email-based 2FA.
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
Infisical currently supports email-based 2FA. We're actively working on
|
||||
building support for other forms of identification via SMS and Authenticator
|
||||
App.
|
||||
</Note>
|
||||
41
docs/documentation/platform/organization.mdx
Normal file
41
docs/documentation/platform/organization.mdx
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: "Organization"
|
||||
description: "How Infisical structures its organizations."
|
||||
---
|
||||
|
||||
An organization houses projects and members.
|
||||
|
||||
By default, Infisical creates an organization under your name. You can manage your organization in your organization settings.
|
||||
|
||||

|
||||

|
||||
|
||||
## Members
|
||||
|
||||
Members of an organization can create and add other members to projects within that organization.
|
||||
|
||||
To add a member to your organization, scroll down to the "Organization Members" section and invite the member via email. They'll receive an email to confirm their organization invitation. If the member is an existing user on the platform, they will be automatically added to the organization.
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
Note that access to projects must be provisioned to new members after they've
|
||||
accepted their organization invitation, and they will not be added to any
|
||||
projects by default.
|
||||
</Note>
|
||||
|
||||
## Service Accounts
|
||||
|
||||
Service accounts represent machine identities such as VMs or application clients that can authenticate with Infisical. They can be provisioned read/write permissions for project(s) and environment(s).
|
||||
|
||||
To add a service account to your organization, scroll down to the "Service Accounts" section and create a service account. Afterwards, you can press on the edit button beside the service account to provision it permissions.
|
||||
|
||||

|
||||
|
||||
## Incident contacts
|
||||
|
||||
Incident contacts of an organization are alerted if anything abnormal is detected within the operations of an organization.
|
||||
|
||||
To add an incident contact to your organization, scroll down to the "Incident Contacts" section and add their email.
|
||||
|
||||

|
||||
24
docs/documentation/platform/pit-recovery.mdx
Normal file
24
docs/documentation/platform/pit-recovery.mdx
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Commits
|
||||
|
||||
Similar to Git, a commit in Infisical is a snapshot of your project's secrets at a specific point in time. You can browse and view your project's snapshots via the "Point-in-Time Recovery" sidebar.
|
||||
|
||||

|
||||

|
||||
|
||||
## Rolling back
|
||||
|
||||
Environment variables can be rolled back to any point in time via the "Rollback to this snapshot" button.
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
Rolling back environment variables to a past snapshot creates a new commit and
|
||||
snapshot at the top of the stack and updates secret versions.
|
||||
</Note>
|
||||
55
docs/documentation/platform/project.mdx
Normal file
55
docs/documentation/platform/project.mdx
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Project"
|
||||
description: "How Infisical organizes secrets into projects."
|
||||
---
|
||||
|
||||
A project houses environment variables for an application.
|
||||
|
||||
## Dashboard
|
||||
|
||||
The dashboard page is where you can manage environment variables for a given project.
|
||||
|
||||

|
||||
|
||||
### Environment variables
|
||||
|
||||
Environment variables can be added or removed from a project. By default, they are pre-populated in your first project for demonstration. For any subsequent project, it can be convenient to import existing environment variables by dragging and dropping a .env file containing them.
|
||||
|
||||
Here's what dragging and dropping a .env looks like:
|
||||
|
||||

|
||||
|
||||
### Environments
|
||||
|
||||
In most cases, environment variables belong to specific environments: development, staging, testing, and production. You can input environment variables for each environment that your project uses.
|
||||
|
||||

|
||||
|
||||
### Personal overrides
|
||||
|
||||
Every environment variable value can be overriden with a custom value.
|
||||
|
||||
- An overriden value can only be read and accesssed by the user that overrode the original shared value.
|
||||
- A (default) shared value can be read and accesssed by other users in a project.
|
||||
|
||||
You can turn overrides on/off by toggling the override/branch icon:
|
||||
|
||||

|
||||
|
||||
### Search
|
||||
|
||||
You can search for any environment variable by its key.
|
||||
|
||||

|
||||
|
||||
### Hide/Un-hide
|
||||
|
||||
You can hide or un-hide the values of your environment variables. By default, the values are hidden for your privacy.
|
||||
|
||||

|
||||
|
||||
### Download as .env
|
||||
|
||||
You can download your environment variables back in a .env file.
|
||||
|
||||

|
||||
15
docs/documentation/platform/secret-versioning.mdx
Normal file
15
docs/documentation/platform/secret-versioning.mdx
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: "Secret Versioning"
|
||||
description: "Version secrets and configurations with Infisical"
|
||||
---
|
||||
|
||||
Secret versioning records changes made to every secret.
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
You can copy and paste a secret version value to the "Value" input field "roll
|
||||
back" to that secret version. This creates a new secret version at the top of
|
||||
the stack. We're releasing the ability to press and automatically roll back to
|
||||
a secret version soon.
|
||||
</Note>
|
||||
21
docs/documentation/platform/token.mdx
Normal file
21
docs/documentation/platform/token.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: "Infisical Token"
|
||||
description: "Use the Infisical Token as one of the authentication methods."
|
||||
---
|
||||
|
||||
An Infisical Token is useful for:
|
||||
|
||||
- Authenticating the [Infisical CLI](/cli/overview) when there isn't an easy way to input your login credentials.
|
||||
- Granting the [Infisical SDKs](/sdks/overview) access to secrets scoped to a project and environment.
|
||||
|
||||
It's also useful for CI/CD environments and integrations such as [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose).
|
||||
|
||||
To generate the the token, head over to your project settings as shown below.
|
||||
|
||||

|
||||
|
||||
## Feeding Infisical Token to the CLI
|
||||
|
||||
The Infisical CLI checks for the presence of an environment variable called `INFISICAL_TOKEN`.
|
||||
If it detects this variable in the terminal where it is being run, it will use it to authenticate and retrieve the environment variables that the token is authorized to access.
|
||||
This allows you to use the CLI in environments where you are unable to run the `infisical login` command.
|
||||
Reference in New Issue
Block a user