diff --git a/docs/api-reference/overview/authentication.mdx b/docs/api-reference/overview/authentication.mdx index dcf9719ea..f2224577e 100644 --- a/docs/api-reference/overview/authentication.mdx +++ b/docs/api-reference/overview/authentication.mdx @@ -1,9 +1,9 @@ --- title: "Authentication" -description: "How to authenticate with the Infisical Public API" +description: "Learn how to authenticate with the Infisical Public API." --- -You can authenticate with the Infisical API using [Identities](/documentation/platform/identities/overview) paired with authentication modes such as [Universal Auth](/documentation/platform/identities/universal-auth). +You can authenticate with the Infisical API using [Identities](/documentation/platform/identities/machine-identities) paired with authentication modes such as [Universal Auth](/documentation/platform/identities/universal-auth). To interact with the Infisical API, you will need to obtain an access token. Follow the step by [step guide](/documentation/platform/identities/universal-auth) to get an access token via Universal Auth. diff --git a/docs/api-reference/overview/introduction.mdx b/docs/api-reference/overview/introduction.mdx index 06ee491b5..6d577e15b 100644 --- a/docs/api-reference/overview/introduction.mdx +++ b/docs/api-reference/overview/introduction.mdx @@ -1,5 +1,6 @@ --- -title: "Introduction" +title: "API Reference" +sidebarTitle: "Introduction" --- Infisical's Public (REST) API provides users an alternative way to programmatically access and manage diff --git a/docs/documentation/getting-started/introduction.mdx b/docs/documentation/getting-started/introduction.mdx index edd4b163e..bd9354aa1 100644 --- a/docs/documentation/getting-started/introduction.mdx +++ b/docs/documentation/getting-started/introduction.mdx @@ -1,99 +1,97 @@ --- -title: "Introduction" +title: "What is Infisical?" +sidebarTitle: "What is Infisical?" +description: "An Introduction to the Infisical secret management platform." --- -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) secrets management platform for storing, managing, and syncing -application configuration and secrets like API keys, database credentials, and environment variables across applications and infrastructure. +Infisical is an [open-source](https://github.com/infisical/infisical) secret management platform for developers. +It provides capabilities for storing, managing, and syncing application configuration and secrets like API keys, database +credentials, and certificates across infrastructure. In addition, Infisical prevents secrets leaks to git and enables secure +sharing of secrets among engineers. -Start syncing environment variables with [Infisical Cloud](https://app.infisical.com) or learn how to [host Infisical](/self-hosting/overview) yourself. - -## Learn about Infisical - - - Store secrets like API keys, database credentials, environment variables with Infisical - - -## Access secrets +Start managing secrets securely with [Infisical Cloud](https://app.infisical.com) or learn how to [host Infisical](/self-hosting/overview) yourself. - - Inject secrets into any application process/environment + + Get started with Infisical Cloud in just a few minutes. + + + Self-host Infisical on your own infrastructure. + + + +## Why Infisical? + +Infisical helps developers achieve secure centralized secret management and provides all the tools to easily manage secrets in various environments and infrastructure components. In particular, here are some of the most common points that developers mention after adopting Infisical: +- Streamlined **local development** processes (switching .env files to [Infisical CLI](/cli/commands/run) and removing secrets from developer machines). +- **Best-in-class developer experience** with an easy-to-use [Web Dashboard](/documentation/platform/project). +- Simple secret management inside **[CI/CD pipelines](/integrations/cicd/githubactions)** and staging environments. +- Secure and compliant secret management practices in **[production environments](/sdks/overview)**. +- **Facilitated workflows** around [secret change management](/documentation/platform/pr-workflows), [access requests](/documentation/platform/access-controls/access-requests), [temporary access provisioning](/documentation/platform/access-controls/temporary-access), and more. +- **Improved security posture** thanks to [secret scanning](/cli/scanning-overview), [granular access control policies](/documentation/platform/access-controls/overview), [automated secret rotation](http://localhost:3000/documentation/platform/secret-rotation/overview), and [dynamic secrets](/documentation/platform/dynamic-secrets/overview) capabilities. + +## How does Infisical work? + +To make secret management effortless and secure, Infisical follows a certain structure for enabling secret management workflows as defined below. + +**Identities** in Infisical are users or machine which have a certain set of roles and permissions assigned to them. Such identities are able to manage secrets in various **Clients** throughout the entire infrastructure. To do that, identities have to verify themselves through one of the available **Authentication Methods**. + +As a result, the 3 main concepts that are important to understand are: +- **[Identities](/documentation/platform/identities/overview)**: users or machines with a set permissions assigned to them. +- **[Clients](/integrations/platforms/kubernetes)**: Infisical-developed tools for managing secrets in various infrastructure components (e.g., [Kubernetes Operator](/integrations/platforms/kubernetes), [Infisical Agent](/integrations/platforms/infisical-agent), [CLI](/cli/usage), [SDKs](/sdks/overview), [API](/api-reference/overview/introduction), [Web Dashboard](/documentation/platform/organization)). +- **[Authentication Methods](/documentation/platform/identities/universal-auth)**: ways for Identities to authenticate inside different clients (e.g., SAML SSO for Web Dashboard, Universal Auth for Infisical Agent, etc.). + +## How to get started with Infisical? + +Depending on your use case, it might be helpful to look into some of the resources and guides provided below. + + + + Inject secrets into any application process/environment. - Fetch secrets with any programming language on demand + Fetch secrets with any programming language on demand. - - Inject secrets into Docker containers + + Inject secrets into Docker containers. - Fetch and save secrets as native Kubernetes secrets + Fetch and save secrets as native Kubernetes secrets. - Fetch secrets via HTTP request - - - -## Resources - - - - Learn how to configure and deploy Infisical - - - Explore guides for every language and stack + Fetch secrets via HTTP request. - Explore integrations for GitHub, Vercel, Netlify, and more - - - Explore integrations for Next.js, Express, Django, and more - - - Scan and prevent 140+ secret type leaks in your codebase + Explore integrations for GitHub, Vercel, AWS, and more. diff --git a/docs/documentation/getting-started/platform.mdx b/docs/documentation/getting-started/platform.mdx index 429524161..1a1164a40 100644 --- a/docs/documentation/getting-started/platform.mdx +++ b/docs/documentation/getting-started/platform.mdx @@ -21,7 +21,7 @@ Here, you can also create a new project. The **Members** page lets you add or remove external members to your organization. Note that you can configure your organization in Infisical to have members authenticate with the platform via protocols like SAML 2.0. -![organization members](../../images/organization-members.png) +![organization members](../../images/organization/platform/organization-members.png) ## Managing your Projects diff --git a/docs/documentation/guides/local-development.mdx b/docs/documentation/guides/local-development.mdx new file mode 100644 index 000000000..c2651cb58 --- /dev/null +++ b/docs/documentation/guides/local-development.mdx @@ -0,0 +1,34 @@ +--- +title: "Secret Management in Development Environments" +sidebarTitle: "Local Development" +description: "Learn how to manage secrets in local development environments." +--- + +## Problem at hand + +There is a number of issues that arise with secret management in local development environment: +1. **Getting secrets onto local machines**. When new developers join or a new project is created, the process of getting the development set of secrets onto local machines is often unclear. As a result, developers end up spending a lot of time onboarding and risk potentially following insecure practices when sharing secrets from one developer to another. +2. **Syncing secrets with teammates**. One of the problems with .env files is that they become unsynced when one of the developers updates a secret or configuration. Even if the rest of the team is notified, developers don't make all the right changes immediately, and later on end up spending a lot of time debugging an issue due to missing environment variables. This leads to a lot of inefficiencies and lost time. +3. **Accidentally leaking secrets**. When developing locally, it's common for developers to accidentally leak a hardcoded as part of a commit. As soon as the secret is part of the git history, it becomes hard to get it removed and create a security vulnerability. + +## Solution + +One of the main benefits of Infisical is the facilitation of secret management workflows in local development use cases. In particular, Infisical heavily follows the "Security Shift Left" principle to enable developers to effotlessly follow secure practices when coding. + +### CLI + +[Infisical CLI](/cli/overview) is the most frequently used Infisical tool for secret management in local development environments. It makes it easy to inject secrets right into the local application environments based on the permissions given to corresponsing developers. + +### Dashboard + +On top of that, Infisical provides a great [Web Dashboard](https://app.infisical.com/signup) that can be used to making quick secret updates. + +![project dashboard](../../images/dashboard.png) + +### Personal Overrides + +By default, all the secrets in the Infisical environments are shared among project members who have the permission to access those environment. At the same time, when doing local development, it is often desirable to change the value of a certain secret only for a particular self. For such use cases, Infisical supports the functionality of **Personal Overrides** – which allow developers to override values of any secrets without affecting the workflows of the rest of the team. Personal Overrides can be created both in the dashboard or via [Infisical CLI](/cli/overview). + +### Secret Scanning + +In addition, Infisical also provides a set of tools to automatically prevent secret leaks to git history. This functionlality can be set up on the level of [Infisical CLI using pre-commit hooks](/cli/scanning-overview#automatically-scan-changes-before-you-commit) or through a direct integration with platforms like GitHub. \ No newline at end of file diff --git a/docs/documentation/platform/access-controls/access-requests.mdx b/docs/documentation/platform/access-controls/access-requests.mdx new file mode 100644 index 000000000..e8a52b0e4 --- /dev/null +++ b/docs/documentation/platform/access-controls/access-requests.mdx @@ -0,0 +1,13 @@ +--- +title: "Access Requests" +description: "Learn how to request access to sensitive resources in Infisical." +--- + +In certain situations, developers need to expand their access to certain new project or a sensitive environment. For those use cases, it is helpful to utilize Infisical's **Access Requests** functionality. + +This functionality works in the following way: +1. A project administrator sets up a policy that assigns access managers to a certain sensitive folder or environment. +2. When a developer requests access to one of such sensitive resources, corresponding access managers get an email notification about it. +3. An access manager can approve or deny the access request as well as specify the duration of access in the case of approval. +4. As soon as the request is approved, developer is able to access the sought resources. + diff --git a/docs/documentation/platform/access-controls/additional-privileges.mdx b/docs/documentation/platform/access-controls/additional-privileges.mdx new file mode 100644 index 000000000..9c22dfab7 --- /dev/null +++ b/docs/documentation/platform/access-controls/additional-privileges.mdx @@ -0,0 +1,22 @@ +--- +title: "Additional Privileges" +description: "Learn how to add specific privileges on top of predefined roles." +--- + +Even though Infisical supports full-fledged [role-base access controls](./role-based-access-controls) with ability to set predefined permissions for user and machine identities, it is sometimes desired to set additional privileges for specific user or machine identities on top of their roles. + +Infisical **Additional Privileges** functionality enables specific permissions with access to sensitive secrets/folders by identities within certain projects. It is possible to set up additional privileges through Web UI or API. + +To provision specific privileges through Web UI: +1. Click on the `Edit` button next to the set of roles for user or identities. +![Edit User Role](../../images/platform/access-controls/edit-role.png) + +2. Click `Add Additional Privileges` in the corresponding section of the permission management modal. +![Add Specific Privilege](../../images/platform/access-controls/add-additional-privileges.png) + +3. Fill out the necessary parameters in the privilege entry that appears. It is possible to specify the `Environment` and `Secret Path` to which you want to enable access. +It is also possible to define the range of permissions (`View`, `Create`, `Modify`, `Delete`) as well as how long the access should last (e.g., permanent or timed). +![Additional privileges](../../images/platform/access-controls/additional-privileges.png) + +4. Click the `Save` button to enable the additional privilege. +![Confirm Specific Privilege](../../images/platform/access-controls/confirm-additional-privileges.png) \ No newline at end of file diff --git a/docs/documentation/platform/access-controls/overview.mdx b/docs/documentation/platform/access-controls/overview.mdx new file mode 100644 index 000000000..54fc8ff25 --- /dev/null +++ b/docs/documentation/platform/access-controls/overview.mdx @@ -0,0 +1,58 @@ +--- +title: "Access Controls" +sidebarTitle: "Overview" +description: "Learn about Infisical's access control toolset." +--- + +To make sure that users and machine identities are only accessing the resources and performing actions they are authorized to, Infisical supports a wide range of access control tools. + + + + Manage user and machine identitity permissions through predefined roles. + + + Add specific privileges to users and machines on top of their roles. + + + Grant timed access to roles and specific privileges. + + + Enable users to request (temporary) access to sensitive resources. + + + Set up review policies for secret changes in sensitive environments. + + + Track every action performed by user and machine identities in Infisical. + + diff --git a/docs/documentation/platform/access-controls/role-based-access-controls.mdx b/docs/documentation/platform/access-controls/role-based-access-controls.mdx new file mode 100644 index 000000000..e12153425 --- /dev/null +++ b/docs/documentation/platform/access-controls/role-based-access-controls.mdx @@ -0,0 +1,44 @@ +--- +title: "Role-based Access Controls" +description: "Learn how to use RBAC to manage user permissions." +--- + +Infisical's Role-based Access Controls (RBAC) enable the usage of predefined and custom roles that imply a set of permissions for user and machine identities. Such roles male it possible to restrict access to resources and the range of actions that can be performed. + +In general, access controls can be split up across [projects](/documentation/platform/project) and [organizations](/documentation/platform/organization). + +## Organization-level access controls + +By default, every user and machine identity in a organization is either an **admin** or a **member**. + +**Admins** are able to perform every action with the organization, including adding and removing organization members, managing access controls, setting up security settings, and creating new projects. + +**Members**, on the other hand, are restricted from removing organization members, modifying billing information, updating access controls, and performing a number of other actions. + +Overall, organization-level access controls are significantly of administrative nature. Access to projects, secrets and other sensitive data is specified on the project level. + +![Org member role](../../images/platform/rbac/org-member-role.png) + +## Project-level access controls + +By default, every user in a project is either a **viewer**, **developer**, or an **admin**. Each of these roles comes with a varying access to different features and resources inside projects. + +As such: +- **Admin**: This role enables identities to have access to all environments, folders, secrets, and actions within the project. +- **Developers**: This role restricts identities from performing project control actions, updating Approval Workflow policies, managing roles/members, and more. +- **Viewer**: The most limiting bulit-in role on the project level – it forbids user and machine identities to perform any action and rather shows them in the read-only mode. + +![Project member role](../../images/platform/access-controls/rbac.png) + +## Creating custom roles + +By creating custom roles, you are able to adjust permissions to the needs of your organization. This can be useful for: +- Creating superadmin roles, roles specific to SRE engineers, etc. +- Restricting access of users to specific secrets, folders, and environments. +- Embedding these specific roles into [Approval Workflow policies](/documentation/platform/pr-workflows). + + +It is worth noting that users are able to assume multiple built-in and custom roles. A user will gain access to all actions within the roles assigned to them, not just the actions those roles share in common. + + +![project member custom role](../../images/platform/rbac/project-member-custom-role.png) diff --git a/docs/documentation/platform/access-controls/temporary-access.mdx b/docs/documentation/platform/access-controls/temporary-access.mdx new file mode 100644 index 000000000..c113f0f85 --- /dev/null +++ b/docs/documentation/platform/access-controls/temporary-access.mdx @@ -0,0 +1,26 @@ +--- +title: "Temporary Access" +description: "Learn how to set up timed access to sensitive resources for user and machine identities." +--- + +Certain environments and secrets are so sensitive that it is recommended to not give any user permanent access to those. For such use cases, Infisical supports the functionality of **Temporary Access** provisioning. + + +To provision temporary access through Web UI: +1. Click on the `Edit` button next to the set of roles for user or identities. +![Edit User Role](../../images/platform/access-controls/edit-role.png) + +2. Click `Permanent` next to the role or specific privilege that you want to make temporary. + +3. Specify the duration of remporary access (e.g., `1m`, `2h`, `3d`). +![Configure temp access](../../images/platform/access-controls/configure-temporary-access.png) + +4. Click `Grant`. + +5. Click the corresponding `Save` button to enable remporary access. +![Temporary Access](../../images/platform/access-controls/temporary-access.png) + + +Every user and machine identity should always have at least one permanent role attached to it. + + diff --git a/docs/documentation/platform/audit-logs.mdx b/docs/documentation/platform/audit-logs.mdx index b5a47df50..be2381da2 100644 --- a/docs/documentation/platform/audit-logs.mdx +++ b/docs/documentation/platform/audit-logs.mdx @@ -1,27 +1,28 @@ --- title: "Audit Logs" -description: "See which events are triggered within your Infisical project." +description: "Track evert event action performed within Infisical projects." --- Note that Audit Logs is a paid feature. - If you're using Infisical Cloud, then it is available under the **Team Tier**, **Pro Tier**, + If you're using Infisical Cloud, then it is available under the **Pro**, and **Enterprise Tier** with varying retention periods. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. Infisical provides audit logs for security and compliance teams to monitor information access. -With this feature, teams can track 25+ different events; -filter audit logs by event, actor, source, date or any combination of these filters; -and inspect extensive metadata in the event of any suspicious activity or incident review. +With the Audit Log functionality, teams can: +- **Track** 40+ different events; +- **Filter** audit logs by event, actor, source, date or any combination of these filters; +- **Inspect** extensive metadata in the event of any suspicious activity or incident review. ![Audit logs](../../images/platform/audit-logs/audit-logs-table.png) Each log contains the following data: -- Event: The underlying action such as create, list, read, update, or delete secret(s). -- Actor: The entity responsible for performing or causing the event; this can be a user or service. -- Timestamp: The date and time at which point the event occurred. -- Source (User agent + IP): The software (user agent) and network address (IP) from which the event was initiated. -- Metadata: Additional data to provide context for each event. For example, this could be the path at which a secret was fetched from etc. +- **Event**: The underlying action such as create, list, read, update, or delete secret(s). +- **Actor**: The entity responsible for performing or causing the event; this can be a user or service. +- **Timestamp**: The date and time at which point the event occurred. +- **Source** (User agent + IP): The software (user agent) and network address (IP) from which the event was initiated. +- **Metadata**: Additional data to provide context for each event. For example, this could be the path at which a secret was fetched from etc. diff --git a/docs/documentation/platform/auth-methods/email-password.mdx b/docs/documentation/platform/auth-methods/email-password.mdx new file mode 100644 index 000000000..82eae1642 --- /dev/null +++ b/docs/documentation/platform/auth-methods/email-password.mdx @@ -0,0 +1,14 @@ +--- +title: "Email and Pasword" +description: "Learn how to authenticate into Infisical with email and password." +--- + +**Email and Password** is the most common authentication method that can be used by user identities for authentication into Web Dashboard and Infisical CLI. It is recommended to utilize [Multi-factor Authentication](/documentation/platform/mfa) in addition to it. + +It is currently possible to use the **Email and Password** auth method to authenticate into the Web Dashboard and Infisical CLI. + +Every **Email and Password** is accompanied by an emergency kit given to users during signup. If the password is lost or forgotten, emergency kit is only way to retrieve the access to your account. It is possible to generate a new emergency kit with the following steps: +1. Open the `Personal Settings` menu. +![open personal settings](../../images/auth-methods/access-personal-settings.png) +2. Scroll down to the `Emergency Kit` section. +3. Enter your current password and click `Save`. \ No newline at end of file diff --git a/docs/documentation/platform/folder.mdx b/docs/documentation/platform/folder.mdx index 162cabfb9..a3636a2ea 100644 --- a/docs/documentation/platform/folder.mdx +++ b/docs/documentation/platform/folder.mdx @@ -1,11 +1,12 @@ --- title: "Folders" -description: "Organize your secrets with folders" +description: "Learn how to organize secrets with folders." --- -Infisical's folder feature lets you store secrets at a specific folder; we also call this **path-based secret storage**. -This is great for organizing secrets around hierarchies when multiple services, types of secrets, etc. are involved at great quantities. -With folders that can go infinitely deep, you can mirror your application architecture (be it microservices or monorepos) +Infisical Folders enable users to organize secrets using custom structures dependent on the intended use case (also known as **path-based secret storage**). + +It is great for organizing secrets around hierarchies with multiple services or types of secrets involved at large quantities. +Infisical Folders can be infinitely nested to mirror your application architecture – whether it's microservices, monorepos, or any logical grouping that best suits your needs. Consider the following structure for a microservice architecture: @@ -25,9 +26,7 @@ In this example, we store environment variables for each microservice under each We also store user-specific secrets for micro-service 1 under `/service1/users`. With this folder structure in place, your applications only need to specify a path like `/microservice1/envars` to fetch secrets from there. By extending this example, you can see how path-based secret storage provides a versatile approach to manage secrets for any architecture. -## Folders - -### Managing folders +## Managing folders To add a folder, press the downward chevron to the right of the **Add Secret** button; then press on the **Add Folder** button. diff --git a/docs/documentation/platform/identities/machine-identities.mdx b/docs/documentation/platform/identities/machine-identities.mdx new file mode 100644 index 000000000..f5088a3e2 --- /dev/null +++ b/docs/documentation/platform/identities/machine-identities.mdx @@ -0,0 +1,59 @@ +--- +title: Machine Identities +description: "Learn how to use Machine Identities to programmatically interact with Infisical." +--- + +## Concept + +An Infisical machine identity is an entity that represents a workload or application that require access to various resources in Infisical. This is conceptually similar to an IAM user in AWS or service account in Google Cloud Platform (GCP). + +Each identity must authenticate with the API using a supported authentication method like [Universal Auth](/documentation/platform/identities/universal-auth) to get back a short-lived access token to be used in subsequent requests. + +![organization identities](../../images/platform/organization/organization-machine-identities.png) + +Key Features: + +- Role Assignment: Identities must be assigned [roles](/documentation/platform/role-based-access-controls). These roles determine the scope of access to resources, either at the organization level or project level. +- Auth/Token Configuration: Identities must be configured with corresponding authentication methods and access token properties to securely interact with the Infisical API. + +## Workflow + +A typical workflow for using identities consists of four steps: + +1. Creating the identity with a name and [role](/documentation/platform/role-based-access-controls) in Organization Access Control > Machine Identities. +This step also involves configuring an authentication method for it such as [Universal Auth](/documentation/platform/identities/universal-auth). +2. Adding the identity to the project(s) you want it to have access to. +3. Authenticating the identity with the Infisical API based on the configured authentication method on it and receiving a short-lived access token back. +4. Authenticating subsequent requests with the Infisical API using the short-lived access token. + + + + Currently, identities can only be used to make authenticated requests to the Infisical API, SDKs, Terraform, Kubernetes Operator, and Infisical Agent. They do not work with clients such as CLI, Ansible look up plugin, etc. + + Machine Identity support for the rest of the clients is planned to be released in the current quarter. + + + +## Authentication Methods + +To interact with various resources in Infisical, Machine Identities are able to authenticate using: + +- [Universal Auth](/documentation/platform/identities/universal-auth): the most versatile authentication method that can be configured on an identity from any platform/environment to access Infisical. + +## FAQ + + + + A service token is a project-level authentication method that is being phased out in favor of identities. + + Amongst many differences, identities provide broader access over the Infisical API, utilizes the same + permission system as user identities, and come with a significantly larger number of configurable authentication and security features. + + + There are a few reasons for why this might happen: + + - You have insufficient organization permissions to create, read, update, delete identities. + - The identity you are trying to read, update, or delete is more privileged than yourself. + - The role you are trying to create an identity for or update an identity to is more privileged than yours. + + diff --git a/docs/documentation/platform/identities/overview.mdx b/docs/documentation/platform/identities/overview.mdx index 4aae6fd08..18c173766 100644 --- a/docs/documentation/platform/identities/overview.mdx +++ b/docs/documentation/platform/identities/overview.mdx @@ -1,53 +1,26 @@ --- -title: Identities -description: "Programmatically interact with Infisical" +title: "User and Machine Identities" +sidebarTitle: "Overview" +description: "Learn more about identities to interact with resources in Infisical." --- - - Currently, identities can only be used to make authenticated requests to the Infisical API, SDKs, Terraform, K8s Operator, and Agent. They do not work with clients such as CLI, Ansible look up plugin, etc. +To interact with secrets and resource with Infisical, it is important to undrestand the concept of identities. +Identities can be of two types: +- **People** (e.g., developers, platform engineers, administrators) +- **Machines** (e.g., machine entities for managing secrets in CI/CD pipelines, production applications, and more) - We will be releasing compatibility with it across clients in the coming quarter. - +Both people and machines are able to utilize corresponding clients (e.g., Dashboard UI, CLI, SDKs, API, Kubernetes Operator) together with allowed authentication methods (e.g., email & password, SAML SSO, LDAP, OIDC, Universal Auth). -## Concept - -A (machine) identity is an entity that you can create in an Infisical organization to represent a workload or application that requires access to the Infisical API. This is conceptually similar to an IAM user in AWS or service account in Google Cloud Platform (GCP). - -Each identity must authenticate with the API using a supported authentication method like [Universal Auth](/documentation/platform/identities/universal-auth) to get back a short-lived access token to be used in subsequent requests. - -Key Features: - -- Role Assignment: Identities must be assigned [roles](/documentation/platform/role-based-access-controls). These roles determine the scope of access to resources, either at the organization level or project level. -- Auth/Token Configuration: Identities must be configured with auth methods and access token properties to securely interact with the Infisical API. - -## Workflow - -A typical workflow for using identities consists of four steps: - -1. Creating the identity with a name and [role](/documentation/platform/role-based-access-controls) in Organization Access Control > Machine Identities. -This step also involves configuring an authentication method for it such as [Universal Auth](/documentation/platform/identities/universal-auth). -2. Adding the identity to the project(s) you want it to have access to. -3. Authenticating the identity with the Infisical API based on the configured authentication method on it and receiving a short-lived access token back. -4. Authenticating subsequent requests with the Infisical API using the short-lived access token. - -Check out the following authentication method-specific guides for step-by-step instruction on how to use identities to access Infisical: - -- [Universal Auth](/documentation/platform/identities/universal-auth) - -**FAQ** - - - - A service token is a project-level authentication method that is being phased out in favor of identities. - - Amongst many differences, identities provide broader access over the Infisical API, utilizes the same role-based - permission system used by users, and comes with ample more configurable authentication and security features. - - - There are a few reasons for why this might happen: - - - You have insufficient organization permissions to create, read, update, delete identities. - - The identity you are trying to read, update, or delete is more privileged than yourself. - - The role you are trying to create an identity for or update an identity to is more privileged than yours. - - + + + Learn more about the concept on user identities in Infisical. + + + Understand the concept of machine identities in Infisical. + + diff --git a/docs/documentation/platform/identities/universal-auth.mdx b/docs/documentation/platform/identities/universal-auth.mdx index e60ae1e33..a9f4dffae 100644 --- a/docs/documentation/platform/identities/universal-auth.mdx +++ b/docs/documentation/platform/identities/universal-auth.mdx @@ -1,9 +1,9 @@ --- title: Universal Auth -description: "Authenticate with Infisical from any platform/environment" +description: "Learn how to authenticate to Infisical from any platform or environment." --- -**Universal Auth** is the most versatile authentication method that can be configured on an identity from any platform/environment to access Infisical. +**Universal Auth** is the most versatile authentication method that can be configured for a [machine identity](/documentation/platform/identities/machine-identities) to access Infisical from any platform or environment. In this method, each identity is given a **Client ID** for which you can generate one or more **Client Secret(s)**. Together, a **Client ID** and **Client Secret** can be exchanged for an access token to authenticate with the Infisical API. @@ -50,7 +50,7 @@ using the Universal Auth authentication method. Restricting **Client Secret** and access token usage to specific trusted IPs is a paid feature. - If you’re using Infisical Cloud, then it is available under the Pro Tier. If you’re self-hosting Infisical, then you should contact team@infisical.com to purchase an enterprise license to use it. + If you’re using Infisical Cloud, then it is available under the Pro Tier. If you’re self-hosting Infisical, then you should contact sales@infisical.com to purchase an enterprise license to use it. diff --git a/docs/documentation/platform/identities/user-identities.mdx b/docs/documentation/platform/identities/user-identities.mdx new file mode 100644 index 000000000..e88752d84 --- /dev/null +++ b/docs/documentation/platform/identities/user-identities.mdx @@ -0,0 +1,23 @@ +--- +title: User Identities +description: "Read more about the concept of user identities in Infisical." +--- + +## Concept + +A **user identity** (also known as **user**) represents a developer, admin, or any other human entity interacting with resources in Infisical. + +Users can be added manually (through Web UI) or programmatically (e.g., API) to [organizations](../organization) and [projects](../projects). + +Upon being added to an organizaztion and projects, users assume a certain set of roles and permissions that represents their identity. + +![organization members](../../images/platform/organization/organization-members.png) + +## Authentication methods + +To interact with various resources in Infisical, users are able to utilize a number of authentication methods: +- **Email & Password**: the most common authentication method that is used for authentication into Web Dashboard and Infisical CLI. It is recommended to utilize [Multi-factor Authentication](/documentation/platform/mfa) in addition to it. +- **Service Tokens**: Service tokens allow users authenticate into CLI and other clients under their own identity. For the majority of use cases, it is not a recommended approach. Instead, it is often a good idea to utilize [Machine Identities](./machine-identities) with [Universal Authentication](/documentation/platform/identities/universal-auth). +- **SSO**: Infisical natively integrates with a number of SSO identity providers like [Google](/documentation/platform/sso/google), [GitHub](/documentation/platform/sso/github), and [GitLab](/documentation/platform/sso/gitlab). +- **SAML SSO**: It is also possible to set up SAML SSO integration with identity providers like [Okta](/documentation/platform/sso/okta), [Microsoft Entra ID](/documentation/platform/sso/azure) (formerly known as Azure AD), [JumpCloud](/documentation/platform/sso/jumpcloud), [Google](/documentation/platform/sso/google-saml), and more. +- **LDAP**: For organizations with more advanced needs, Infisical also provides user authentication with [LDAP](/documentation/platform/ldap/overview) that includes a number of LDAP providers. diff --git a/docs/documentation/platform/ip-allowlisting.mdx b/docs/documentation/platform/ip-allowlisting.mdx index f0844e685..7f787fff8 100644 --- a/docs/documentation/platform/ip-allowlisting.mdx +++ b/docs/documentation/platform/ip-allowlisting.mdx @@ -14,7 +14,7 @@ description: "Restrict access to your secrets in Infisical using trusted IPs" Note that IP Allowlisting is a paid feature. If you're using Infisical Cloud, then it is available under the **Pro Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. Projects in Infisical can be configured to restrict client access to specific IP addresses or CIDR ranges. This applies to any client using service tokens and diff --git a/docs/documentation/platform/ldap.mdx b/docs/documentation/platform/ldap.mdx index 01237e1c9..ba01aa743 100644 --- a/docs/documentation/platform/ldap.mdx +++ b/docs/documentation/platform/ldap.mdx @@ -7,7 +7,7 @@ description: "Log in to Infisical with LDAP" LDAP is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. You can configure your organization in Infisical to have members authenticate with the platform via [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol). diff --git a/docs/documentation/platform/ldap/general.mdx b/docs/documentation/platform/ldap/general.mdx index 137538cff..5e50b736b 100644 --- a/docs/documentation/platform/ldap/general.mdx +++ b/docs/documentation/platform/ldap/general.mdx @@ -1,12 +1,12 @@ --- title: "General LDAP" -description: "Log in to Infisical with LDAP" +description: "Learn how to log in to Infisical with LDAP." --- LDAP is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. You can configure your organization in Infisical to have members authenticate with the platform via [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) diff --git a/docs/documentation/platform/ldap/jumpcloud.mdx b/docs/documentation/platform/ldap/jumpcloud.mdx index 5e7e42ca8..454a4d522 100644 --- a/docs/documentation/platform/ldap/jumpcloud.mdx +++ b/docs/documentation/platform/ldap/jumpcloud.mdx @@ -1,12 +1,12 @@ --- title: "JumpCloud LDAP" -description: "Configure JumpCloud LDAP for Logging into Infisical" +description: "Learn how to configure JumpCloud LDAP for authenticating into Infisical." --- LDAP is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. diff --git a/docs/documentation/platform/ldap/overview.mdx b/docs/documentation/platform/ldap/overview.mdx index d19095b7c..2423be8c0 100644 --- a/docs/documentation/platform/ldap/overview.mdx +++ b/docs/documentation/platform/ldap/overview.mdx @@ -1,6 +1,7 @@ --- title: "LDAP Overview" -description: "Log in to Infisical with LDAP" +sidebarTitle: "Overview" +description: "Learn how to authenticate into Infisical with LDAP." --- LDAP is a paid feature. @@ -9,9 +10,9 @@ description: "Log in to Infisical with LDAP" then you should contact sales@infisical.com to purchase an enterprise license to use it. -You can configure your organization in Infisical to have members authenticate with the platform via [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) +You can configure your organization in Infisical to have members authenticate with the platform via [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol). -To note, configuring LDAP retains the end-to-end encrypted architecture of Infisical because we decouple the authentication and decryption steps; the LDAP server cannot and will not have access to the decryption key needed to decrypt your secrets. +To note, configuring LDAP retains the end-to-end encrypted nature of authentication in Infisical because we decouple the authentication and decryption steps; the LDAP server cannot and will not have access to the decryption key needed to decrypt your secrets. LDAP providers: @@ -20,4 +21,7 @@ LDAP providers: - AWS Directory Service - Foxpass -Check out the general instructions for configuring LDAP [here](/documentation/platform/ldap/general). +Read the general instructions for configuring LDAP [here](/documentation/platform/ldap/general). + +If the documentation for your required identity provider is not shown in the list above, please reach out to [team@infisical.com](mailto:team@infisical.com) for assistance. + diff --git a/docs/documentation/platform/mfa.mdx b/docs/documentation/platform/mfa.mdx index 7629401eb..3ca9c5dff 100644 --- a/docs/documentation/platform/mfa.mdx +++ b/docs/documentation/platform/mfa.mdx @@ -1,6 +1,7 @@ --- -title: "MFA" -description: "Secure your Infisical account with MFA" +title: "Multi-factor Authentication" +sidebarTitle: "MFA" +description: "Learn how to 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. diff --git a/docs/documentation/platform/organization.mdx b/docs/documentation/platform/organization.mdx index 82a4058a5..d45bb6d4f 100644 --- a/docs/documentation/platform/organization.mdx +++ b/docs/documentation/platform/organization.mdx @@ -1,9 +1,9 @@ --- -title: "Organization" -description: "How Infisical structures its organizations." +title: "Organizations" +description: "Learn more and understand the concept of Infisical organizations." --- -An organization houses projects and members. +An Infisical organization is a set of [projects](./project) that use the same billing. Organizations allow one or more users to control billing and project permissions for all of the projects belonging to the organization. Each project belongs to an organization. ## Projects @@ -18,21 +18,23 @@ The **Settings** page lets you manage information about your organization includ - Name: The name of your organization. - Incident contacts: Emails that should be alerted if anything abnormal is detected within the organization. -- SAML Authentication: The SAML SSO configuration of the organization (if applicable); Infisical currently -supports Okta, Azure, and JumpCloud identity providers. ![organization settings general](../../images/platform/organization/organization-settings-general.png) + + +- Security and Authentication: A set of setting to enforce or manage [SAML](/documentation/platform/sso/overview), [SCIM](/documentation/platform/scim/overview), [LDAP](/documentation/platform/ldap/overview), and other authentication configurations. + ![organization settings auth](../../images/platform/organization/organization-settings-auth.png) -## Members +## Access Control -The **Members** page is where you can manage members and their permissions within the organization. -In the **Members** tab, you can add external members to your organization or remove them; you can also -change their role. +The **Access Control** page is where you can manage identities (both people and machines) that are part of your organization. +You can add or remove additional members as well as modify their permissions. -![organization members](../../images/organization-members.png) +![organization members](../../images/platform/organization/organization-members.png) +![organization identities](../../images/platform/organization/organization-machine-identities.png) -In the **Roles** tab, you can manage roles for members within the organization. +In the **Organization Roles** tab, you can edit current or create new custom roles for members within the organization. Note that Role-Based Access Management (RBAC) is partly a paid feature. @@ -41,13 +43,13 @@ In the **Roles** tab, you can manage roles for members within the organization. at the organization and project level for free. If you're using Infisical Cloud, the ability to create custom roles is available under the **Pro Tier**. - If you're self-hosting Infisical, then you should contact team@infisical.com to purchase an enterprise license to use it. + If you're self-hosting Infisical, then you should contact sales@infisical.com to purchase an enterprise license to use it. ![organization roles](../../images/platform/organization/organization-members-roles.png) -As you can see next, Infisical supports granular permissions that you can tailor to each role. So, -if you need certain members to only be able to access billing details, for example, then you can +As you can see next, Infisical supports granular permissions that you can tailor to each role. +If you need certain members to only be able to access billing details, for example, then you can assign them that permission only. ![organization role permissions](../../images/platform/organization/organization-members-roles-add-perm.png) diff --git a/docs/documentation/platform/pit-recovery.mdx b/docs/documentation/platform/pit-recovery.mdx index 3cad5eff2..448faddbb 100644 --- a/docs/documentation/platform/pit-recovery.mdx +++ b/docs/documentation/platform/pit-recovery.mdx @@ -1,21 +1,21 @@ --- title: "Point-in-Time Recovery" -description: "How to rollback secrets and configs to any commit with Infisical." +description: "Learn how to rollback secrets and configurations to any snapshot with Infisical." --- Point-in-Time Recovery is a paid feature. - If you're using Infisical Cloud, then it is available under the **Team Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + If you're using Infisical Cloud, then it is available under the **Pro Tier**. If you're self-hosting Infisical, + then you should contact sales@infisical.com to purchase an enterprise license to use it. -Infisical's point-in-time recovery feature allows secrets to be rolled back to any point in time for any given [folder](./folder). -Under the hood, snapshots, capturing the state of the folder, get taken after any mutation an item within that folder. +Infisical's point-in-time recovery functionality allows secrets to be rolled back to any point in time for any given [folder](./folder) or [environment](/documentation/platform/project#project-environments). +Every time a secret is updated, a new snapshot is taken – capturing the state of the folder and environment at that point of time. ## Snapshots -Similar to Git, a commit (aka snapshot) in Infisical is the state of your project's secrets at a specific point in time scoped to +Similar to Git, a commit (also known as snapshot) in Infisical is the state of your project's secrets at a specific point in time scoped to an environment and [folder](./folder) within it. To view a list of snapshots for the current folder, press the **Commits** button. @@ -28,12 +28,14 @@ This opens up a sidebar from which you can select to view a particular snapshot: ## Rolling back -After pressing on a snapshot from the sidebar, you can view it and even roll back the state +After pressing on a snapshot from the sidebar, you can view it and roll back the state of the folder to that point in time by pressing the **Rollback** button. ![PIT snapshot](../../images/platform/pit-recovery/pit-recovery-rollback.png) Rolling back secrets to a past snapshot creates a creates a snapshot at the top of the stack and updates secret versions. -Note that rollbacks are localized to not affect other folders within the same environment. This means each [folder](./folder) maintains its own independent history of changes, offering precise and isolated control over rollback actions. + +Rollbacks are localized to not affect other folders within the same environment. This means each [folder](./folder) maintains its own independent history of changes, offering precise and isolated control over rollback actions. Put differently, every [folder](./folder) possesses a distinct and separate timeline, providing granular control when managing your secrets. + \ No newline at end of file diff --git a/docs/documentation/platform/pr-workflows.mdx b/docs/documentation/platform/pr-workflows.mdx index 1c7bb9787..9df123612 100644 --- a/docs/documentation/platform/pr-workflows.mdx +++ b/docs/documentation/platform/pr-workflows.mdx @@ -1,6 +1,6 @@ --- -title: "PR Workflows" -description: "Infisical PR Workflows allows you to create a set of policies to control secret operations." +title: "Approval Workflows" +description: "Learn how to enable a set of policies to manage changes to sensitive secrets and environments." --- ## Problem at hand @@ -14,15 +14,15 @@ Updating secrets in high-stakes environments (e.g., production) can have a numbe As a wide-spread software engineering practice, developers have to submit their code as a PR that needs to be approved before the code is merged into the main branch. -In a similar way, to solve the above-mentioned issues, Infisical provides a feature called `PR Workflows` for secret management. This is a set of policies and workflows that help advance access controls, compliance procedures, and stability of a particular environment. In other words, **PR Workflows** help you secure, stabilize, and streamline the change of secrets in high-stakes environments. +In a similar way, to solve the above-mentioned issues, Infisical provides a feature called `Approval Workflows` for secret management. This is a set of policies and workflows that help advance access controls, compliance procedures, and stability of a particular environment. In other words, **Approval Workflows** help you secure, stabilize, and streamline the change of secrets in high-stakes environments. ### Setting a policy -First, you would need to create a set of policies for a certain environment. In the example below you can see a generic policy for a production environment. In this case, any user who submits a change to `prod` would first have to get an approval by a predefined user (or multiple users). +First, you would need to create a set of policies for a certain environment. In the example below, a generic policy for a production environment is shown. In this case, any user who submits a change to `prod` would first have to get an approval by a predefined approver (or multiple approvers). ![create secret update policy](../../images/platform/pr-workflows/secret-update-policy.png) -### Example of updating secrets with PR workflows +### Example of updating secrets with Approval workflows When a user submits a change to an enviropnment that is under a particular policy, a corresponsing change request will go to a predefined approver (or multiple approvers). diff --git a/docs/documentation/platform/project.mdx b/docs/documentation/platform/project.mdx index 06ad3eaa7..bd80d8ae5 100644 --- a/docs/documentation/platform/project.mdx +++ b/docs/documentation/platform/project.mdx @@ -1,13 +1,21 @@ --- -title: "Project" -description: "How Infisical organizes secrets into projects." +title: "Projects" +description: "Learn more and understand the concept of Infisical projects." --- -A project houses application configuration and secrets for an application. +A project in Infisical belongs to an [organization](./organization) and contains a number of environments, folders, and secrets. +Only users and machine identities who belong to a project can access resources inside of it according to predefined permissions. + +## Project environments + +For both visual and organizational structure, Infisical allows splitting up secrets into environments (e.g., development, staging, production). In project settings, such environments can be +customized depending on the intended use case. + +![project secrets overview](../../images/platform/project/project-environments.png) ## Secrets Overview -The **Secrets Overview** page captures a birds-eye-view of secrets and folders across environments like development, staging, or production. +The **Secrets Overview** page captures a birds-eye-view of secrets and [folders](./folder) across environments. This is useful for comparing secrets, identifying if anything is missing, and making quick changes. ![project secrets overview](../../images/platform/project/project-secrets-overview-open.png) diff --git a/docs/documentation/platform/role-based-access-controls.mdx b/docs/documentation/platform/role-based-access-controls.mdx deleted file mode 100644 index ba774f0d1..000000000 --- a/docs/documentation/platform/role-based-access-controls.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Role-based Access Controls" -description: "Infisical's Role-based Access Controls enable creating permissions for user and machine identities to restrict access to resources and the range of actions that can be performed." ---- - -### General access controls - -Access Control Policies provide a highly granular declarative way to grant or forbid access to certain resources and operations in Infisical. In general, access controls can be split up across projects and organizations. - -### Organization-level access controls - -By default, every user in a organization is either an **admin** or a **member**. - -Admins are able to perform every action with the organization, including adding and removing organization members, managing access controls, setting up security settings, and creating new projects. Members, on the other hand, are restricted from removing organization members, modifying billing information, updating access controls, and performing a number of other actions. - -Overall, organization-level access controls are significantly of administrative nature. Access to projects, secrets and other sensitive data is specified on the project level. - -![Org member role](../../images/platform/rbac/org-member-role.png) - -### Project-level access controls - -By default, every user in a project is either a **viewer**, **developer**, or an **admin**. Each of these roles comes with a varying access to different features and resources inside projects. As such, **admins** by default have access to all environments, folders, secrets, and actions within the project. At the same time, **developers** are restricted from performing project control actions, updating PR Workflow policies, managing roles/members, and more. Lastly, **viewer** is the most limiting default role on the project level – it forbids developers to perform any action and rather shows them in the read-only mode. - -### Creating custom roles - -By creating custom roles, you are able to adjust permissions to the needs of your organization. This can be useful for: -- Creating superadmin roles, roles specific to SRE engineers, etc. -- Restricting access of users to specific secrets, folders, and environments. -- Embedding these specific roles into [PR Workflow policies](https://infisical.com/docs/documentation/platform/pr-workflows) - -![project member custom role](../../images/platform/rbac/project-member-custom-role.png) diff --git a/docs/documentation/platform/scim/azure.mdx b/docs/documentation/platform/scim/azure.mdx index 45f95e135..ff46fe4e7 100644 --- a/docs/documentation/platform/scim/azure.mdx +++ b/docs/documentation/platform/scim/azure.mdx @@ -1,13 +1,13 @@ --- title: "Azure SCIM" -description: "Configure SCIM provisioning with Azure for Infisical" +description: "Learn how to configure SCIM provisioning with Azure for Infisical." --- Azure SCIM provisioning is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. Prerequisites: diff --git a/docs/documentation/platform/scim/jumpcloud.mdx b/docs/documentation/platform/scim/jumpcloud.mdx index 68bb9b66f..cf8d1aa88 100644 --- a/docs/documentation/platform/scim/jumpcloud.mdx +++ b/docs/documentation/platform/scim/jumpcloud.mdx @@ -1,13 +1,13 @@ --- title: "JumpCloud SCIM" -description: "Configure SCIM provisioning with JumpCloud for Infisical" +description: "Learn how to configure SCIM provisioning with JumpCloud for Infisical." --- JumpCloud SCIM provisioning is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. Prerequisites: diff --git a/docs/documentation/platform/scim/okta.mdx b/docs/documentation/platform/scim/okta.mdx index 4baa19815..e5d5bb48b 100644 --- a/docs/documentation/platform/scim/okta.mdx +++ b/docs/documentation/platform/scim/okta.mdx @@ -1,13 +1,13 @@ --- title: "Okta SCIM" -description: "Configure SCIM provisioning with Okta for Infisical" +description: "Learn how to configure SCIM provisioning with Okta for Infisical." --- Okta SCIM provisioning is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. Prerequisites: diff --git a/docs/documentation/platform/scim/overview.mdx b/docs/documentation/platform/scim/overview.mdx index deec8b630..2bc73d810 100644 --- a/docs/documentation/platform/scim/overview.mdx +++ b/docs/documentation/platform/scim/overview.mdx @@ -1,13 +1,13 @@ --- title: "SCIM Overview" -description: "Provision users for Infisical via SCIM" +description: "Learn how to provision users for Infisical via SCIM." --- SCIM provisioning is a paid feature. If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. You can configure your organization in Infisical to have members be provisioned/deprovisioned using [SCIM](https://scim.cloud/#Implementations2) via providers like Okta, Azure, JumpCloud, etc. diff --git a/docs/documentation/platform/secret-reference.mdx b/docs/documentation/platform/secret-reference.mdx index 66961db99..042f7525b 100644 --- a/docs/documentation/platform/secret-reference.mdx +++ b/docs/documentation/platform/secret-reference.mdx @@ -1,11 +1,12 @@ --- -title: "Secret Referencing / Importing" -description: "How to use reference secrets in Infisical" +title: "Secret Referencing and Importing" +sidebarTitle: "Referencing and Importing" +description: "Learn the fundamentals of secret referencing and importing in Infisical." --- ## Secret Referencing -Infisical's secret referencing feature lets you reference the value of a "base" secret when defining the value of another secret. +Infisical's secret referencing functionality makes it possible to reference the value of a "base" secret when defining the value of another secret. This means that updating the value of a base secret propagates directly to other secrets whose values depend on the base secret. @@ -43,7 +44,7 @@ Here are a few more helpful examples for how to reference secrets in different c ## Secret Imports -Infisical's secret imports feature lets you import the items of another environment or folder into the current folder context. +Infisical's Secret Imports functionality makes it possible to import the secrets from another environment or folder into the current folder context. This can be useful if you have common secrets that need to be available across multiple environments/folders. To add a secret import, press the downward chevron to the right of the **Add Secret** button; then press on the **Add Import** button. diff --git a/docs/documentation/platform/secret-rotation/aws-iam.mdx b/docs/documentation/platform/secret-rotation/aws-iam.mdx index b4247af80..c524abfbc 100644 --- a/docs/documentation/platform/secret-rotation/aws-iam.mdx +++ b/docs/documentation/platform/secret-rotation/aws-iam.mdx @@ -1,6 +1,6 @@ --- title: "AWS IAM User" -description: "Rotated access key id and secret key of AWS IAM Users" +description: "Learn how to automatically rotate Access Key Id and Secret Key of AWS IAM Users." --- Infisical's AWS IAM User secret rotation capability lets you update the **Access key** and **Secret access key** credentials of a target IAM user from within Infisical diff --git a/docs/documentation/platform/secret-rotation/mysql.mdx b/docs/documentation/platform/secret-rotation/mysql.mdx index 5bd658a0d..02356de48 100644 --- a/docs/documentation/platform/secret-rotation/mysql.mdx +++ b/docs/documentation/platform/secret-rotation/mysql.mdx @@ -1,6 +1,6 @@ --- title: "MySQL/MariaDB" -description: "How to rotate MySQL/MariaDB database user passwords" +description: "Learn how to automatically rotate MySQL/MariaDB user passwords." --- The Infisical MySQL secret rotation allows you to automatically rotate your MySQL database user's password at a predefined interval. diff --git a/docs/documentation/platform/secret-rotation/overview.mdx b/docs/documentation/platform/secret-rotation/overview.mdx index 284375401..57ad17e09 100644 --- a/docs/documentation/platform/secret-rotation/overview.mdx +++ b/docs/documentation/platform/secret-rotation/overview.mdx @@ -1,4 +1,8 @@ -# Secret Rotation Overview +--- +title: "Secret Rotation" +sidebarTitle: "Overview" +description: "Learn how to set up automated secret rotation in Infisical." +--- ## Introduction @@ -7,8 +11,8 @@ Rotating secrets helps prevent unauthorized access to systems and sensitive data Rotated secrets may include, but are not limited to: -1. API keys for external services -2. Database credentials for various platforms +1. API keys for external services; +2. Database credentials for various platforms. ## Rotation Process @@ -42,3 +46,4 @@ Finally, the system promotes the future active (pending) secret to be the new cu 1. [SendGrid Integration](./sendgrid) 2. [PostgreSQL/CockroachDB Implementation](./postgres) 3. [MySQL/MariaDB Configuration](./mysql) +4. [AWS IAM User](./aws-iam) diff --git a/docs/documentation/platform/secret-rotation/postgres.mdx b/docs/documentation/platform/secret-rotation/postgres.mdx index 1ddc7d558..0a6339e4e 100644 --- a/docs/documentation/platform/secret-rotation/postgres.mdx +++ b/docs/documentation/platform/secret-rotation/postgres.mdx @@ -1,6 +1,6 @@ --- title: "PostgreSQL/CockroachDB" -description: "How to rotate postgreSQL/cockroach database user passwords" +description: "Learn how to automatically rotate PostgreSQL/CockroachDB user passwords." --- The Infisical Postgres secret rotation allows you to automatically rotate your Postgres database user's password at a predefined interval. diff --git a/docs/documentation/platform/secret-rotation/sendgrid.mdx b/docs/documentation/platform/secret-rotation/sendgrid.mdx index 2a7b91a15..4f27057ad 100644 --- a/docs/documentation/platform/secret-rotation/sendgrid.mdx +++ b/docs/documentation/platform/secret-rotation/sendgrid.mdx @@ -1,6 +1,6 @@ --- title: "Twilio SendGrid" -description: "How to rotate Twilio SendGrid API keys" +description: "Find out how to rotate Twilio SendGrid API keys." --- Eliminate the use of long lived secrets by rotating Twilio SendGrid API keys with Infisical. @@ -9,7 +9,7 @@ Eliminate the use of long lived secrets by rotating Twilio SendGrid API keys wit You will need a valid SendGrid admin key with the necessary scope to create additional API keys. -Follow the [SendGrid Docs to create an admin api key](https://docs.sendgrid.com/ui/account-and-settings/api-keys) +Follow the [SendGrid Docs to create an admin api key](https://docs.sendgrid.com/ui/account-and-settings/api-keys). ## How it works diff --git a/docs/documentation/platform/secret-versioning.mdx b/docs/documentation/platform/secret-versioning.mdx index 04c3086cd..741bbc308 100644 --- a/docs/documentation/platform/secret-versioning.mdx +++ b/docs/documentation/platform/secret-versioning.mdx @@ -1,15 +1,20 @@ --- title: "Secret Versioning" -description: "Version secrets and configurations with Infisical" +description: "Learn how secret versioning works in Infisical." --- -Secret versioning records changes made to every secret. +Every time a secret change is persformed, a new version of the same secret is created. -![secret versioning](../../images/secret-versioning.png) +Such versions can be accessed visually by opening up the [secret sidebar](/documentation/platform/project#drawer) (as seen below) or [retrived via API](/api-reference/endpoints/secrets/read) +by specifying the `version` query parameter. + +![secret versioning](../../images/platform/secret-versioning.png) + +The secret versioning functionality is heavily connected to [Point-in-time Recovery](/documentation/platform/pit-recovery) of secrets in Infisical. 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 + the stack. We're releasing the ability to automatically roll back to a secret version soon. diff --git a/docs/documentation/platform/sso/azure.mdx b/docs/documentation/platform/sso/azure.mdx index 30622e6e8..cbd5a7d0e 100644 --- a/docs/documentation/platform/sso/azure.mdx +++ b/docs/documentation/platform/sso/azure.mdx @@ -1,13 +1,13 @@ --- -title: "Azure SAML" -description: "Configure Azure SAML for Infisical SSO" +title: "Entra ID / Azure AD SAML" +description: "Learn how to configure Microsoft Entra ID for Infisical SSO." --- Azure SAML SSO is a paid feature. If you're using Infisical Cloud, then it is available under the **Pro Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. diff --git a/docs/documentation/platform/sso/github.mdx b/docs/documentation/platform/sso/github.mdx index 87d1b3cf7..53a9b9156 100644 --- a/docs/documentation/platform/sso/github.mdx +++ b/docs/documentation/platform/sso/github.mdx @@ -1,6 +1,6 @@ --- title: "GitHub SSO" -description: "Configure GitHub SSO for Infisical" +description: "Learn how to configure GitHub SSO for Infisical." --- Using GitHub SSO on a self-hosted instance of Infisical requires configuring an OAuth2 application in GitHub and registering your instance with it. diff --git a/docs/documentation/platform/sso/gitlab.mdx b/docs/documentation/platform/sso/gitlab.mdx index 446758ae0..d2a537bfa 100644 --- a/docs/documentation/platform/sso/gitlab.mdx +++ b/docs/documentation/platform/sso/gitlab.mdx @@ -1,6 +1,6 @@ --- title: "GitLab SSO" -description: "Configure GitLab SSO for Infisical" +description: "Learn how to configure GitLab SSO for Infisical." --- Using GitLab SSO on a self-hosted instance of Infisical requires configuring an OAuth application in GitLab and registering your instance with it. diff --git a/docs/documentation/platform/sso/google-saml.mdx b/docs/documentation/platform/sso/google-saml.mdx index 743c4e3ff..1897a651a 100644 --- a/docs/documentation/platform/sso/google-saml.mdx +++ b/docs/documentation/platform/sso/google-saml.mdx @@ -1,13 +1,13 @@ --- title: "Google SAML" -description: "Configure Google SAML for Infisical SSO" +description: "Learn how to configure Google SAML for Infisical SSO." --- Google SAML SSO feature is a paid feature. If you're using Infisical Cloud, then it is available under the **Pro Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. diff --git a/docs/documentation/platform/sso/google.mdx b/docs/documentation/platform/sso/google.mdx index cf35dcb68..36ee511d1 100644 --- a/docs/documentation/platform/sso/google.mdx +++ b/docs/documentation/platform/sso/google.mdx @@ -1,6 +1,6 @@ --- title: "Google SSO" -description: "Configure Google SSO for Infisical" +description: "Learn how to configure Google SSO for Infisical." --- Using Google SSO on a self-hosted instance of Infisical requires configuring an OAuth2 application in GCP and registering your instance with it. diff --git a/docs/documentation/platform/sso/jumpcloud.mdx b/docs/documentation/platform/sso/jumpcloud.mdx index 8b64c8643..781f5224a 100644 --- a/docs/documentation/platform/sso/jumpcloud.mdx +++ b/docs/documentation/platform/sso/jumpcloud.mdx @@ -1,13 +1,13 @@ --- title: "JumpCloud SAML" -description: "Configure JumpCloud SAML for Infisical SSO" +description: "Learn how to configure JumpCloud SAML for Infisical SSO." --- JumpCloud SAML SSO is a paid feature. If you're using Infisical Cloud, then it is available under the **Pro Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. diff --git a/docs/documentation/platform/sso/okta.mdx b/docs/documentation/platform/sso/okta.mdx index f18203963..c81141c92 100644 --- a/docs/documentation/platform/sso/okta.mdx +++ b/docs/documentation/platform/sso/okta.mdx @@ -1,13 +1,13 @@ --- title: "Okta SAML" -description: "Configure Okta SAML 2.0 for Infisical SSO" +description: "Learn how to configure Okta SAML 2.0 for Infisical SSO." --- Okta SAML SSO is a paid feature. If you're using Infisical Cloud, then it is available under the **Pro Tier**. If you're self-hosting Infisical, - then you should contact team@infisical.com to purchase an enterprise license to use it. + then you should contact sales@infisical.com to purchase an enterprise license to use it. diff --git a/docs/documentation/platform/sso/overview.mdx b/docs/documentation/platform/sso/overview.mdx index e1fd25957..42c2d986b 100644 --- a/docs/documentation/platform/sso/overview.mdx +++ b/docs/documentation/platform/sso/overview.mdx @@ -1,6 +1,7 @@ --- title: "SSO Overview" -description: "Log in to Infisical via SSO protocols" +sidebarTitle: "Overview" +description: "Learn how to log in to Infisical via SSO protocols." --- @@ -13,8 +14,12 @@ description: "Log in to Infisical via SSO protocols" You can configure your organization in Infisical to have members authenticate with the platform via protocols like [SAML 2.0](https://en.wikipedia.org/wiki/SAML_2.0). -To note, configuring SSO retains the end-to-end encrypted architecture of Infisical because we decouple the **authentication** and **decryption** steps. In all login with SSO implementations, -your IdP cannot and will not have access to the decryption key needed to decrypt your secrets. +To note, Infisical's SSO implementation decouples the **authentication** and **decryption** steps – which implies that no +Identitiy Provider can have access to the decryption key needed to decrypt your secrets (this also implies that Infisical requires entering the user's Master Password on top of authenticating with SSO). + +## Identity providers + +Infisical these and many other identity providers: - [Google SSO](/documentation/platform/sso/google) - [GitHub SSO](/documentation/platform/sso/github) @@ -23,3 +28,5 @@ your IdP cannot and will not have access to the decryption key needed to decrypt - [Azure SAML](/documentation/platform/sso/azure) - [JumpCloud SAML](/documentation/platform/sso/jumpcloud) - [Google SAML](/documentation/platform/sso/google-saml) + +If your required identity provider is not shown in the list above, please reach out to [team@infisical.com](mailto:team@infisical.com) for assistance. diff --git a/docs/documentation/platform/token.mdx b/docs/documentation/platform/token.mdx index 9e304de3d..efb1e05d4 100644 --- a/docs/documentation/platform/token.mdx +++ b/docs/documentation/platform/token.mdx @@ -1,6 +1,6 @@ --- -title: "Service token" -description: "Infisical service tokens allows you to programmatically interact with Infisical" +title: "Service Token" +description: "Infisical service tokens allow users to programmatically interact with Infisical." --- Service tokens are authentication credentials that services can use to access designated endpoints in the Infisical API to manage project resources like secrets. @@ -43,6 +43,10 @@ Also, note that Infisical supports [glob patterns](https://www.malikbrowne.com/b In the above screenshot, you can see that we are creating a token token with `read` access to all subfolders at any depth of the `/common` path within the development environment of the project; the token expires in 6 months and can be used from any IP address. + +For a deeper understanding of service tokens, it is recommended to read [this guide](http://localhost:3000/internals/service-tokens). + + **FAQ** diff --git a/docs/documentation/platform/webhooks.mdx b/docs/documentation/platform/webhooks.mdx index e0de7be05..22277dd8c 100644 --- a/docs/documentation/platform/webhooks.mdx +++ b/docs/documentation/platform/webhooks.mdx @@ -1,6 +1,6 @@ --- title: "Webhooks" -description: "How Infisical webhooks works?" +description: "Learn the fundamentals of Infisical webhooks." --- Webhooks can be used to trigger changes to your integrations when secrets are modified, providing smooth integration with other third-party applications. diff --git a/docs/images/auth-methods/access-personal-settings.png b/docs/images/auth-methods/access-personal-settings.png new file mode 100644 index 000000000..a5e1989c1 Binary files /dev/null and b/docs/images/auth-methods/access-personal-settings.png differ diff --git a/docs/images/organization-members.png b/docs/images/organization-members.png deleted file mode 100644 index 70190df0c..000000000 Binary files a/docs/images/organization-members.png and /dev/null differ diff --git a/docs/images/platform/access-controls/add-additional-privileges.png b/docs/images/platform/access-controls/add-additional-privileges.png new file mode 100644 index 000000000..28848075a Binary files /dev/null and b/docs/images/platform/access-controls/add-additional-privileges.png differ diff --git a/docs/images/platform/access-controls/additional-privileges.png b/docs/images/platform/access-controls/additional-privileges.png new file mode 100644 index 000000000..4561021ba Binary files /dev/null and b/docs/images/platform/access-controls/additional-privileges.png differ diff --git a/docs/images/platform/access-controls/configure-temporary-access.png b/docs/images/platform/access-controls/configure-temporary-access.png new file mode 100644 index 000000000..0c16bbc35 Binary files /dev/null and b/docs/images/platform/access-controls/configure-temporary-access.png differ diff --git a/docs/images/platform/access-controls/confirm-additional-privileges.png b/docs/images/platform/access-controls/confirm-additional-privileges.png new file mode 100644 index 000000000..b6fdbf518 Binary files /dev/null and b/docs/images/platform/access-controls/confirm-additional-privileges.png differ diff --git a/docs/images/platform/access-controls/edit-role.png b/docs/images/platform/access-controls/edit-role.png new file mode 100644 index 000000000..598f585b8 Binary files /dev/null and b/docs/images/platform/access-controls/edit-role.png differ diff --git a/docs/images/platform/access-controls/rbac.png b/docs/images/platform/access-controls/rbac.png new file mode 100644 index 000000000..22380c805 Binary files /dev/null and b/docs/images/platform/access-controls/rbac.png differ diff --git a/docs/images/platform/access-controls/temporary-access.png b/docs/images/platform/access-controls/temporary-access.png new file mode 100644 index 000000000..24be8a584 Binary files /dev/null and b/docs/images/platform/access-controls/temporary-access.png differ diff --git a/docs/images/platform/organization/organization-machine-identities.png b/docs/images/platform/organization/organization-machine-identities.png new file mode 100644 index 000000000..17bea6e9b Binary files /dev/null and b/docs/images/platform/organization/organization-machine-identities.png differ diff --git a/docs/images/platform/organization/organization-members-roles.png b/docs/images/platform/organization/organization-members-roles.png index 454af0809..08c2d1e90 100644 Binary files a/docs/images/platform/organization/organization-members-roles.png and b/docs/images/platform/organization/organization-members-roles.png differ diff --git a/docs/images/platform/organization/organization-members.png b/docs/images/platform/organization/organization-members.png new file mode 100644 index 000000000..a79d3bbe0 Binary files /dev/null and b/docs/images/platform/organization/organization-members.png differ diff --git a/docs/images/platform/organization/organization-settings-auth.png b/docs/images/platform/organization/organization-settings-auth.png index 8643c44da..ca2340e9f 100644 Binary files a/docs/images/platform/organization/organization-settings-auth.png and b/docs/images/platform/organization/organization-settings-auth.png differ diff --git a/docs/images/platform/project/project-environments.png b/docs/images/platform/project/project-environments.png new file mode 100644 index 000000000..e468f2b82 Binary files /dev/null and b/docs/images/platform/project/project-environments.png differ diff --git a/docs/images/platform/secret-versioning.png b/docs/images/platform/secret-versioning.png new file mode 100644 index 000000000..593e8c96f Binary files /dev/null and b/docs/images/platform/secret-versioning.png differ diff --git a/docs/integrations/cloud/aws-parameter-store.mdx b/docs/integrations/cloud/aws-parameter-store.mdx index 6fd341018..d54458db9 100644 --- a/docs/integrations/cloud/aws-parameter-store.mdx +++ b/docs/integrations/cloud/aws-parameter-store.mdx @@ -1,6 +1,6 @@ --- title: "AWS Parameter Store" -description: "How to sync secrets from Infisical to AWS Parameter Store" +description: "Learn how to sync secrets from Infisical to AWS Parameter Store." --- Prerequisites: diff --git a/docs/integrations/cloud/aws-secret-manager.mdx b/docs/integrations/cloud/aws-secret-manager.mdx index 094f22d54..0eab1a561 100644 --- a/docs/integrations/cloud/aws-secret-manager.mdx +++ b/docs/integrations/cloud/aws-secret-manager.mdx @@ -1,6 +1,6 @@ --- title: "AWS Secrets Manager" -description: "How to sync secrets from Infisical to AWS Secrets Manager" +description: "Learn how to sync secrets from Infisical to AWS Secrets Manager." --- Prerequisites: diff --git a/docs/integrations/frameworks/terraform.mdx b/docs/integrations/frameworks/terraform.mdx index 2643ca5af..7d30ec0d9 100644 --- a/docs/integrations/frameworks/terraform.mdx +++ b/docs/integrations/frameworks/terraform.mdx @@ -1,6 +1,6 @@ --- title: "Terraform" -description: "Fetch Secrets From Infisical With Terraform" +description: "Learn how to fetch Secrets From Infisical With Terraform." --- This guide provides step-by-step guidance on how to fetch secrets from Infisical using Terraform. diff --git a/docs/integrations/platforms/ansible.mdx b/docs/integrations/platforms/ansible.mdx index 2d524d55c..ad95d0d5d 100644 --- a/docs/integrations/platforms/ansible.mdx +++ b/docs/integrations/platforms/ansible.mdx @@ -1,6 +1,6 @@ --- title: "Ansible" -description: "How to use Infisical for secret management in Ansible" +description: "Learn how to use Infisical for secret management in Ansible." --- The documentation for using Infisical to manage secrets in Ansible is currently available [here](https://galaxy.ansible.com/ui/repo/published/infisical/vault/). diff --git a/docs/integrations/platforms/docker-compose.mdx b/docs/integrations/platforms/docker-compose.mdx index 238e3dd71..1c061e04e 100644 --- a/docs/integrations/platforms/docker-compose.mdx +++ b/docs/integrations/platforms/docker-compose.mdx @@ -1,6 +1,6 @@ --- title: "Docker Compose" -description: "How to use Infisical to inject environment variables into services defined in your Docker Compose file." +description: "Find out how to use Infisical to inject environment variables into services defined in your Docker Compose file." --- Prerequisites: diff --git a/docs/integrations/platforms/docker-intro.mdx b/docs/integrations/platforms/docker-intro.mdx index 2823fc8ca..bec0f4213 100644 --- a/docs/integrations/platforms/docker-intro.mdx +++ b/docs/integrations/platforms/docker-intro.mdx @@ -1,6 +1,6 @@ --- title: "Docker" -description: "Learn how to feed secrets from Infisical into your Docker application" +description: "Learn how to feed secrets from Infisical into your Docker application." --- There are many methods to inject Infisical secrets into Docker-based applications. Regardless of the method you choose, they all inject secrets from Infisical as environment variables into your Docker container. diff --git a/docs/integrations/platforms/docker-pass-envs.mdx b/docs/integrations/platforms/docker-pass-envs.mdx index d6451de71..04cc36d6b 100644 --- a/docs/integrations/platforms/docker-pass-envs.mdx +++ b/docs/integrations/platforms/docker-pass-envs.mdx @@ -1,6 +1,6 @@ --- title: "Docker Run" -description: "Pass secrets to your docker container at run time" +description: "Learn how to pass secrets to your docker container at run time." --- This method allows you to feed secrets from Infisical into your container using the `--env-file` flag of `docker run` command. diff --git a/docs/infisical-agent/guides/docker-swarm-with-agent.mdx b/docs/integrations/platforms/docker-swarm-with-agent.mdx similarity index 98% rename from docs/infisical-agent/guides/docker-swarm-with-agent.mdx rename to docs/integrations/platforms/docker-swarm-with-agent.mdx index 8ab4ca962..30118a8f0 100644 --- a/docs/infisical-agent/guides/docker-swarm-with-agent.mdx +++ b/docs/integrations/platforms/docker-swarm-with-agent.mdx @@ -1,6 +1,6 @@ --- title: 'Docker Swarm' -description: "How to manage secrets in Docker Swarm services" +description: "Learn how to manage secrets in Docker Swarm services." --- In this guide, we'll demonstrate how to use Infisical for managing secrets within Docker Swarm. diff --git a/docs/integrations/platforms/docker.mdx b/docs/integrations/platforms/docker.mdx index 8fbf288ad..92bd57943 100644 --- a/docs/integrations/platforms/docker.mdx +++ b/docs/integrations/platforms/docker.mdx @@ -1,6 +1,6 @@ --- title: "Docker Entrypoint" -description: "How to use Infisical to inject environment variables into a Docker container." +description: "Learn how to use Infisical to inject environment variables into a Docker container." --- This approach allows you to inject secrets from Infisical directly into your application. diff --git a/docs/integrations/platforms/ecs-with-agent.mdx b/docs/integrations/platforms/ecs-with-agent.mdx index bbb88ea64..43760d2bb 100644 --- a/docs/integrations/platforms/ecs-with-agent.mdx +++ b/docs/integrations/platforms/ecs-with-agent.mdx @@ -1,6 +1,6 @@ --- title: 'Amazon ECS' -description: "How to deliver secrets to Amazon Elastic Container Service" +description: "Learn how to deliver secrets to Amazon Elastic Container Service." --- ![ecs diagram](/images/guides/agent-with-ecs/ecs-diagram.png) diff --git a/docs/infisical-agent/overview.mdx b/docs/integrations/platforms/infisical-agent.mdx similarity index 99% rename from docs/infisical-agent/overview.mdx rename to docs/integrations/platforms/infisical-agent.mdx index 9265d9bfe..17fa0e2a9 100644 --- a/docs/infisical-agent/overview.mdx +++ b/docs/integrations/platforms/infisical-agent.mdx @@ -1,5 +1,5 @@ --- -title: "Overview" +title: "Infisical Agent" description: "This page describes how to manage secrets using Infisical Agent." --- diff --git a/docs/internals/components.mdx b/docs/internals/components.mdx index 29522b0bb..65506a500 100644 --- a/docs/internals/components.mdx +++ b/docs/internals/components.mdx @@ -1,6 +1,6 @@ --- title: "Components" -description: "Infisical's components span multiple clients, an API, and a storage backend" +description: "Infisical's components span multiple clients, an API, and a storage backend." --- ## Infisical API diff --git a/docs/internals/flows.mdx b/docs/internals/flows.mdx index e18a37a31..0da671d64 100644 --- a/docs/internals/flows.mdx +++ b/docs/internals/flows.mdx @@ -1,6 +1,6 @@ --- title: "Flows" -description: "Infisical's core flows have strong cryptographic underpinnings" +description: "Infisical's core flows have strong cryptographic underpinnings." --- ## Signup diff --git a/docs/internals/overview.mdx b/docs/internals/overview.mdx index e5c47682d..e64327a03 100644 --- a/docs/internals/overview.mdx +++ b/docs/internals/overview.mdx @@ -1,6 +1,6 @@ --- title: "Overview" -description: "How Infisical works under the hood" +description: "Read how Infisical works under the hood." --- This section covers the internals of Infisical including its technical underpinnings, architecture, and security properties. @@ -12,26 +12,26 @@ This section covers the internals of Infisical including its technical underpinn ## Learn More - - Learn about the fundamental parts of Infisical + + Learn about the fundamental parts of Infisical. - - Find out more about the structure of core user flows in Infisical + + Find out more about the structure of core user flows in Infisical. - Read about most common security-related topics and questions + Read about most common security-related topics and questions. - Learn best practices for utilizing Infisical service tokens + Learn best practices for utilizing Infisical service tokens. diff --git a/docs/internals/security.mdx b/docs/internals/security.mdx index b47f38251..1b0fb9f32 100644 --- a/docs/internals/security.mdx +++ b/docs/internals/security.mdx @@ -1,6 +1,6 @@ --- title: "Security" -description: "Infisical's security model includes many considerations and initiatives" +description: "Infisical's security model includes many considerations and initiatives." --- Given that Infisical is a secret management platform that manages sensitive data, the Infisical security model is very important. diff --git a/docs/internals/service-tokens.mdx b/docs/internals/service-tokens.mdx index a04eccee7..3222b1aa8 100644 --- a/docs/internals/service-tokens.mdx +++ b/docs/internals/service-tokens.mdx @@ -1,6 +1,6 @@ --- title: "Service tokens" -description: "Understanding service tokens and their best practices" +description: "Understanding service tokens and their best practices." --- ​ Many clients use service tokens to authenticate and read/write secrets from/to Infisical; they can be created in your project settings. diff --git a/docs/mint.json b/docs/mint.json index 3ad3c0ca9..9d9759f0e 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -8,19 +8,24 @@ }, "favicon": "/favicon.png", "colors": { - "primary": "#A1B659", - "light": "#E1EB55", + "primary": "#26272b", + "light": "#97b31d", "dark": "#A1B659", - "ultraLight": "#EFF4DD", + "ultraLight": "#E7F256", "ultraDark": "#8D9F4C", "background": { + "light": "#ffffff", "dark": "#0D1117" }, "anchors": { - "from": "#A1B659", - "to": "#F8B7BD" + "from": "#000000", + "to": "#707174" } }, + "modeToggle": { + "default": "light", + "isHidden": true + }, "feedback": { "suggestEdit": true, "raiseIssue": true, @@ -41,8 +46,12 @@ }, "tabs": [ { - "name": "Changelog", - "url": "changelog" + "name": "Integrations", + "url": "integrations" + }, + { + "name": "CLI", + "url": "cli" }, { "name": "API Reference", @@ -53,52 +62,21 @@ "url": "sdks" }, { - "name": "Contributing", - "url": "contributing" - } - ], - "anchors": [ - - { - "name": "Contributing", - "icon": "code", - "url": "contributing" - }, - - { - "name": "Blog", - "icon": "newspaper", - "url": "https://infisical.com/blog" - }, - { - "name": "Slack", - "icon": "slack", - "url": "https://infisical.com/slack" - }, - { - "name": "GitHub", - "icon": "github", - "url": "https://github.com/Infisical/infisical" - }, - { - "name": "Internals", - "icon": "sitemap", - "url": "internals" + "name": "Changelog", + "url": "changelog" } ], "navigation": [ { - "group": "Overview", + "group": "Getting Started", "pages": [ + "documentation/getting-started/introduction", { - "group": "Getting Started", + "group": "Quickstart", "pages": [ - "documentation/getting-started/introduction", - "documentation/getting-started/platform", - "documentation/getting-started/sdks", - "integrations/platforms/kubernetes", - "integrations/platforms/docker-intro", - "documentation/getting-started/api" + "documentation/guides/local-development", + "documentation/guides/staging", + "documentation/guides/production" ] }, { @@ -118,21 +96,35 @@ "documentation/platform/organization", "documentation/platform/project", "documentation/platform/folder", - "documentation/platform/secret-reference", - "documentation/platform/webhooks", - "documentation/platform/pit-recovery", - "documentation/platform/audit-logs", + { + "group": "Secrets", + "pages": [ + "documentation/platform/secret-versioning", + "documentation/platform/pit-recovery", + "documentation/platform/secret-reference", + "documentation/platform/webhooks" + ] + }, { "group": "Identities", "pages": [ "documentation/platform/identities/overview", - "documentation/platform/identities/universal-auth" + "documentation/platform/identities/user-identities", + "documentation/platform/identities/machine-identities" + ] + }, + { + "group": "Access Control", + "pages": [ + "documentation/platform/access-controls/overview", + "documentation/platform/access-controls/role-based-access-controls", + "documentation/platform/access-controls/additional-privileges", + "documentation/platform/access-controls/temporary-access", + "documentation/platform/access-controls/access-requests", + "documentation/platform/pr-workflows", + "documentation/platform/audit-logs" ] }, - "documentation/platform/token", - "documentation/platform/mfa", - "documentation/platform/pr-workflows", - "documentation/platform/role-based-access-controls", { "group": "Secret Rotation", "pages": [ @@ -149,7 +141,16 @@ "documentation/platform/dynamic-secrets/overview", "documentation/platform/dynamic-secrets/postgresql" ] - }, + } + ] + }, + { + "group": "Authentication Methods", + "pages": [ + "documentation/platform/auth-methods/email-password", + "documentation/platform/token", + "documentation/platform/identities/universal-auth", + "documentation/platform/mfa", { "group": "SSO", "pages": [ @@ -239,19 +240,6 @@ "cli/faq" ] }, - { - "group": "Agent", - "pages": [ - "infisical-agent/overview", - { - "group": "Use cases", - "pages": [ - "infisical-agent/guides/docker-swarm-with-agent", - "integrations/platforms/ecs-with-agent" - ] - } - ] - }, { "group": "Infrastructure Integrations", "pages": [ @@ -259,10 +247,11 @@ "group": "Container orchestrators", "pages": [ "integrations/platforms/kubernetes", - "infisical-agent/guides/docker-swarm-with-agent", + "integrations/platforms/docker-swarm-with-agent", "integrations/platforms/ecs-with-agent" ] }, + "integrations/platforms/infisical-agent", { "group": "Docker", "pages": [ @@ -286,19 +275,23 @@ "integrations/cloud/aws-secret-manager" ] }, - { - "group": "Digital Ocean", - "pages": ["integrations/cloud/digital-ocean-app-platform"] - }, "integrations/cloud/vercel", "integrations/cloud/azure-key-vault", "integrations/cloud/gcp-secret-manager", + { + "group": "Cloudflare", + "pages": [ + "integrations/cloud/cloudflare-pages", + "integrations/cloud/cloudflare-workers" + ] + }, + "integrations/cloud/heroku", + "integrations/cloud/render", { "group": "View more", "pages": [ - "integrations/cloud/heroku", + "integrations/cloud/digital-ocean-app-platform", "integrations/cloud/netlify", - "integrations/cloud/render", "integrations/cloud/railway", "integrations/cloud/flyio", "integrations/cloud/laravel-forge", @@ -306,8 +299,6 @@ "integrations/cloud/northflank", "integrations/cloud/hasura-cloud", "integrations/cloud/terraform-cloud", - "integrations/cloud/cloudflare-pages", - "integrations/cloud/cloudflare-workers", "integrations/cloud/qovery", "integrations/cloud/hashicorp-vault", "integrations/cloud/cloud-66", @@ -319,17 +310,17 @@ { "group": "CI/CD Integrations", "pages": [ - "integrations/cloud/teamcity", + "integrations/cicd/jenkins", "integrations/cicd/githubactions", "integrations/cicd/gitlab", + "integrations/cicd/bitbucket", + "integrations/cloud/teamcity", { "group": "View more", "pages": [ "integrations/cicd/circleci", "integrations/cicd/travisci", - "integrations/cicd/bitbucket", "integrations/cicd/codefresh", - "integrations/cicd/jenkins", "integrations/cloud/checkly" ] } @@ -368,7 +359,7 @@ "pages": ["integrations/build-tools/gradle"] }, { - "group": "Overview", + "group": "", "pages": [ "sdks/overview" ] @@ -524,11 +515,11 @@ ] }, { - "group": "Overview", + "group": "", "pages": ["changelog/overview"] }, { - "group": "", + "group": "Contributing", "pages": [ { "group": "Getting Started", diff --git a/docs/sdks/overview.mdx b/docs/sdks/overview.mdx index d032311f2..578e8ad0f 100644 --- a/docs/sdks/overview.mdx +++ b/docs/sdks/overview.mdx @@ -1,5 +1,6 @@ --- -title: "Introduction" +title: "SDKs" +sidebarTitle: "Introduction" --- From local development to production, Infisical SDKs provide the easiest way for your app to fetch back secrets from Infisical on demand. diff --git a/docs/self-hosting/configuration/envars.mdx b/docs/self-hosting/configuration/envars.mdx index 4bb56ebcd..dae2e8044 100644 --- a/docs/self-hosting/configuration/envars.mdx +++ b/docs/self-hosting/configuration/envars.mdx @@ -1,6 +1,6 @@ --- title: "Configurations" -description: "Configure environment variables for self-hosted Infisical" +description: "Read how to configure environment variables for self-hosted Infisical." --- diff --git a/docs/self-hosting/configuration/requirements.mdx b/docs/self-hosting/configuration/requirements.mdx index 262c7fb7c..40fd80246 100644 --- a/docs/self-hosting/configuration/requirements.mdx +++ b/docs/self-hosting/configuration/requirements.mdx @@ -1,6 +1,6 @@ --- title: "Requirements" -description: "" +description: "Find out the minimal requirements for operating Infisical." --- This page details the minimum requirements necessary for installing and using Infisical. diff --git a/docs/self-hosting/configuration/schema-migrations.mdx b/docs/self-hosting/configuration/schema-migrations.mdx index 6a94af751..d0608c9c2 100644 --- a/docs/self-hosting/configuration/schema-migrations.mdx +++ b/docs/self-hosting/configuration/schema-migrations.mdx @@ -1,6 +1,6 @@ --- title: "Schema migration" -description: "Run Postgres schema migrations" +description: "Learn how to run Postgres schema migrations." --- Running schema migrations is a requirement before deploying Infisical. diff --git a/docs/self-hosting/deployment-options/docker-compose.mdx b/docs/self-hosting/deployment-options/docker-compose.mdx index 583fe1674..f947610cf 100644 --- a/docs/self-hosting/deployment-options/docker-compose.mdx +++ b/docs/self-hosting/deployment-options/docker-compose.mdx @@ -1,6 +1,6 @@ --- title: "Docker Compose" -description: "Run Infisical with Docker Compose template" +description: "Read how to run Infisical with Docker Compose template." --- Install Infisical using Docker compose. This self hosting method contains all of the required components needed to run a functional instance of Infisical. diff --git a/docs/self-hosting/deployment-options/kubernetes-helm.mdx b/docs/self-hosting/deployment-options/kubernetes-helm.mdx index 99d2e1d79..b95a3fd4d 100644 --- a/docs/self-hosting/deployment-options/kubernetes-helm.mdx +++ b/docs/self-hosting/deployment-options/kubernetes-helm.mdx @@ -1,6 +1,6 @@ --- title: "Kubernetes via Helm Chart" -description: "Use Helm chart to install Infisical on your Kubernetes cluster" +description: "Learn how to use Helm chart to install Infisical on your Kubernetes cluster." --- **Prerequisites** - You have extensive understanding of [Kubernetes](https://kubernetes.io/) diff --git a/docs/self-hosting/deployment-options/standalone-infisical.mdx b/docs/self-hosting/deployment-options/standalone-infisical.mdx index 740792578..82086230c 100644 --- a/docs/self-hosting/deployment-options/standalone-infisical.mdx +++ b/docs/self-hosting/deployment-options/standalone-infisical.mdx @@ -1,6 +1,6 @@ --- title: "Docker" -description: "Run Infisical with Docker" +description: "Learn how to run Infisical with Docker." --- Prerequisites: diff --git a/docs/self-hosting/ee.mdx b/docs/self-hosting/ee.mdx index 3ff9a794a..a72bad908 100644 --- a/docs/self-hosting/ee.mdx +++ b/docs/self-hosting/ee.mdx @@ -1,6 +1,6 @@ --- -title: "Infisical enterprise" -description: "How to activate Infisical Enterprise Edition (EE) features" +title: "Infisical Enterprise" +description: "Find out how to activate Infisical Enterprise edition (EE) features." --- While most features in Infisical are free to use, others are paid and require purchasing an enterprise license to use them. diff --git a/docs/self-hosting/faq.mdx b/docs/self-hosting/faq.mdx index 598d408ae..db98a23dc 100644 --- a/docs/self-hosting/faq.mdx +++ b/docs/self-hosting/faq.mdx @@ -1,10 +1,10 @@ --- title: "FAQ" -description: "Frequently Asked Questions about Infisical self hosting" +description: "Frequently Asked Questions about self-hosting Infisical." --- Frequently asked questions about self hosted instance of Infisical can be found on this page. -If you can't find the answer you are looking for, please create an issue on our GitHub repository or join our Slack channel for additional support. +If you can't find the answer you are looking for, please create an issue on our [GitHub repository](https://github.com/Infisical/infisical) or join our [Slack community](https://infisical.com/slack) for additional support. This issue is typically seen when you haven't set up SSL for your self hosted instance of Infisical. When SSL is not enabled, you can't receive secure cookies, preventing the session data to not be saved. diff --git a/docs/self-hosting/guides/mongo-to-postgres.mdx b/docs/self-hosting/guides/mongo-to-postgres.mdx index f8a6cca0f..b8781a19d 100644 --- a/docs/self-hosting/guides/mongo-to-postgres.mdx +++ b/docs/self-hosting/guides/mongo-to-postgres.mdx @@ -1,6 +1,6 @@ --- title: "Migrate Mongo to Postgres" -description: "How to migrate from MongoDB to PostgreSQL for Infisical" +description: "Learn how to migrate Infisical from MongoDB to PostgreSQL." --- This guide will provide step by step instructions on migrating your Infisical instance running on MongoDB to the newly released PostgreSQL version of Infisical. diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx index f8089719d..ccc4ae912 100644 --- a/docs/self-hosting/overview.mdx +++ b/docs/self-hosting/overview.mdx @@ -1,31 +1,35 @@ --- -title: "Introduction" -description: "Self-host Infisical on your own infrastructure" +title: "" +sidebarTitle: "Introduction" +description: "Learn how to self-host Infisical on your own infrastructure." --- Self-hosting Infisical lets you retain data on your own infrastructure and network. -Choose from a variety of deployment options listed below to get started. +Choose from a number of deployment options listed below to get started. - Use the fully packaged docker image to deploy Infisical anywhere + Use the fully packaged docker image to deploy Infisical anywhere. - Install Infisical using our Docker Compose template + Install Infisical using our Docker Compose template. - Use our Helm chart to Install Infisical on your Kubernetes cluster + Use our Helm chart to Install Infisical on your Kubernetes cluster. diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 000000000..ba0dabc1b --- /dev/null +++ b/docs/style.css @@ -0,0 +1,114 @@ +#navbar .max-w-8xl { + max-width: 100%; + border-bottom: 1px solid #ebebeb; + background-color: #fcfcfc; +} + +.max-w-8xl { + /* background-color: #f5f5f5; */ +} + +#sidebar { + left: 0; + padding-left: 48px; + padding-right: 30px; + border-right: 1px; + border-color: #cdd64b; + background-color: #fcfcfc; + border-right: 1px solid #ebebeb; +} + +#sidebar .relative .sticky { + opacity: 0; +} + +#sidebar li > div.mt-2 { + border-radius: 0; + padding: 5px; +} + +#sidebar li > a.mt-2 { + border-radius: 0; + padding: 5px; +} + +#sidebar li > a.leading-6 { + border-radius: 0; + padding: 0px; +} + +/* #sidebar ul > div.mt-12 { + padding-top: 30px; + position: relative; +} + +#sidebar ul > div.mt-12 h5 { + position: absolute; + left: -12px; + top: -0px; +} */ + +#header { + border-left: 1px solid #26272b; + padding-left: 16px; + padding-right: 16px; + background-color: #f5f5f5; + padding-bottom: 10px; + padding-top: 10px; +} + +#content-area .mt-8 .block{ + border-radius: 0; + border-width: 1px; + border-color: #ebebeb; +} + +#content-area div.my-4{ + border-radius: 0; + border-width: 1px; +} + +#content-area div.flex-1 { + /* text-transform: uppercase; */ + opacity: 0.8; + font-weight: 400; +} + +#content-area button { + border-radius: 0; +} + +#content-area .not-prose { + border-radius: 0; +} + +.eyebrow { + text-transform: uppercase; + font-weight: 400; + color: red; +} + +#content-container { + /* background-color: #f5f5f5; */ + margin-top: 2rem; +} + +#topbar-cta-button .group .absolute { + background-color: black; + border-radius: 0px; +} + +/* #topbar-cta-button .group .absolute:hover { + background-color: white; + border-radius: 0px; +} */ + +#topbar-cta-button .group .flex { + margin-top: 5px; + margin-bottom: 5px; + font-size: medium; +} + +.flex-1 .flex .items-center { + /* background-color: #f5f5f5; */ +} \ No newline at end of file