diff --git a/docs/documentation/platform/folder.mdx b/docs/documentation/platform/folder.mdx new file mode 100644 index 0000000000..716cb4e46a --- /dev/null +++ b/docs/documentation/platform/folder.mdx @@ -0,0 +1,46 @@ +--- +title: "Folder" +description: "How Infisical structures secrets into folders" +--- + +Folders can be used to group secrets into multiple levels, which can help organize secrets in monorepos or microservice-based architectures. For example, you could create a folder for each environment, such as production, staging, and development. + +Within each environment folder, you could create subfolders for different types of secrets, such as database credentials, API keys, and SSH keys. This can help to keep your secrets organized and easy to find. + +## Dashboard + +![dashboard with folders](../../images/dashboard-folders.png) + +Only alphabets, numbers, and dashes are allowed in folder names. You can create a folder for each environment from the dashboard. + +![dashboard add folders](../../images/dashboard-add-folder.png) + +To create a nested folder or access the secrets of a folder, click on an existing folder to open it. You will then be able to modify the secrets of that folder and create new folders inside it. + +## Dashboard Secret Overview + +The overview screen provides a comprehensive view of all your secrets and folders, organized by environment. + +![dashboard secret overview with folders](../../images/dashboard-folder-overview.png) + +When you click on a folder, the overview will be updated to show only the secrets and folders in that folder. This makes it easy to find the information you need, no matter how deeply nested it is. + +## Integrations + +You can easily scope injected secrets to a folder during integrations by providing the secret path option. + +![integrations scoped with folders](../../images/integration-folders.png) + +For more information on integrations, [refer infisical integration](/integrations/overview) + +## Service Tokens + +You can scope the secrets that can be read and written using an Infisical token by providing the secret path option when creating the token. + +![folder scoped service token](../../images/project-folder-token.png) + +For more information, [refer infisical token section.](./token) + +## Point-In-Time Recovery + +For more information on how PIT recovery works on folders, [please refer to this section.](./pit-recovery) diff --git a/docs/documentation/platform/pit-recovery.mdx b/docs/documentation/platform/pit-recovery.mdx index eeba72d604..f741de8bbe 100644 --- a/docs/documentation/platform/pit-recovery.mdx +++ b/docs/documentation/platform/pit-recovery.mdx @@ -22,3 +22,9 @@ Environment variables can be rolled back to any point in time via the "Rollback Rolling back environment variables to a past snapshot creates a new commit and snapshot at the top of the stack and updates secret versions. + +## Folders + +Any folder operation, such as creating, updating, or deleting a folder, will create a new commit. + +When you roll back the contents of a folder, the folder will be restored to its latest snapshot. The nested folders will also be restored to their respective latest versions. diff --git a/docs/documentation/platform/token.mdx b/docs/documentation/platform/token.mdx index caeb1641d8..1fecb2fef1 100644 --- a/docs/documentation/platform/token.mdx +++ b/docs/documentation/platform/token.mdx @@ -10,7 +10,7 @@ An Infisical Token is useful for: It's also useful for CI/CD environments and integrations such as [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose). -To generate the the token, head over to your project settings as shown below. +To generate the the token, head over to your project settings as shown below. On creating a service token you can scope it to a path to limit the access. ![token add](../../images/project-token-add.png) diff --git a/docs/images/dashboard-add-folder.png b/docs/images/dashboard-add-folder.png new file mode 100644 index 0000000000..6040dcc3ff Binary files /dev/null and b/docs/images/dashboard-add-folder.png differ diff --git a/docs/images/dashboard-folder-overview.png b/docs/images/dashboard-folder-overview.png new file mode 100644 index 0000000000..265f732fea Binary files /dev/null and b/docs/images/dashboard-folder-overview.png differ diff --git a/docs/images/dashboard-folders.png b/docs/images/dashboard-folders.png new file mode 100644 index 0000000000..d3e92482f9 Binary files /dev/null and b/docs/images/dashboard-folders.png differ diff --git a/docs/images/integration-folders.png b/docs/images/integration-folders.png new file mode 100644 index 0000000000..ea3af8b01d Binary files /dev/null and b/docs/images/integration-folders.png differ diff --git a/docs/images/project-folder-token.png b/docs/images/project-folder-token.png new file mode 100644 index 0000000000..4fda56d275 Binary files /dev/null and b/docs/images/project-folder-token.png differ diff --git a/docs/images/project-token-add.png b/docs/images/project-token-add.png index cd17b3027c..f282399e6d 100644 Binary files a/docs/images/project-token-add.png and b/docs/images/project-token-add.png differ diff --git a/docs/images/project-token-added.png b/docs/images/project-token-added.png index 302a862803..fb47f35250 100644 Binary files a/docs/images/project-token-added.png and b/docs/images/project-token-added.png differ diff --git a/docs/mint.json b/docs/mint.json index b4412dfe29..458ff795cd 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -22,10 +22,7 @@ } }, "api": { - "baseUrl": [ - "https://app.infisical.com", - "http://localhost:8080" - ], + "baseUrl": ["https://app.infisical.com", "http://localhost:8080"], "auth": { "method": "key", "name": "X-API-KEY" @@ -112,6 +109,7 @@ "pages": [ "documentation/platform/organization", "documentation/platform/project", + "documentation/platform/folder", "documentation/platform/pit-recovery", "documentation/platform/secret-versioning", "documentation/platform/audit-logs", @@ -227,9 +225,7 @@ }, { "group": "Overview", - "pages": [ - "sdks/overview" - ] + "pages": ["sdks/overview"] }, { "group": "SDKs", @@ -304,9 +300,7 @@ }, { "group": "Service Tokens", - "pages": [ - "api-reference/endpoints/service-tokens/get" - ] + "pages": ["api-reference/endpoints/service-tokens/get"] } ] }, @@ -320,9 +314,7 @@ }, { "group": "Overview", - "pages": [ - "changelog/overview" - ] + "pages": ["changelog/overview"] }, { "group": "Contributing",