awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

revamp core docs

Browse Source
This commit is contained in:
Maidul Islam
2023-07-12 01:23:28 -04:00
parent 07d25cb673
commit 0a9adf33c8
8 changed files with 181 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/documentation/platform/folder.mdx
View File

@@ -1,48 +1,30 @@
---
title: "Folder"
description: "How Infisical structures secrets into folders"
title: "Folders"
description: "Organize your secrets with 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.
Folders provide a powerful and intuitive way to structure your secrets.
They offer a streamlined and intuitive system to keep your secrets organized and easily accessible, which becomes increasingly important as your collection of secrets grow.
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.
With folders in Infisical, you can now create a hierarchy of folders to organize your secrets, mirroring your application's architecture or any logical grouping that suits your needs.
Whether you follow a microservices architecture or work with monorepos, folders make it simpler to locate, manage and collaborate between teams.
## Dashboard
![dashboard with folders](../../images/dashboard-folders.png)
## Creating a folder
Only alphabets, numbers, and dashes are allowed in folder names. You can create a folder for each environment from the dashboard.
To create a folder, head over to the environment where you'd like to create the folder. Once there, click the `Add folder` button as shown below.
If you wish to create nested folders, simply click into the folder of choice and click `Add folder` button again.
![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.
<Info>
Folder names can only contain alphabets, numbers, and dashes
</Info>
## Dashboard Secret Overview
## Compare folders across environments
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.
You can provide the folder path as glob if you want to have access to multiple folders and the tokens do support multi-environment.
![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)
When you click on a folder, the overview will be updated to show only the secrets and folders in that folder. This allows you to compare secrets across environment regardless of how deeply nested your folders are.