Merge pull request #2509 from akhilmhdh/docs/admin-panel
docs: added docs for infisical admin panels
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "Organization Admin Console"
|
||||
description: "Manage your Infisical organization from our organization admin console."
|
||||
---
|
||||
|
||||
The Organization Admin Console provides a user-friendly interface for Infisical organization admins to manage organization-related configurations.
|
||||
|
||||
## Accessing the Organization Admin Console
|
||||
|
||||
Only organization admins have access to the Organization Admin Console.
|
||||
|
||||

|
||||
|
||||
1. Click on the profile icon in the left sidebar.
|
||||
2. From the dropdown menu, select `Organization Admin Console`.
|
||||
|
||||
## Projects Section
|
||||
|
||||

|
||||
|
||||
The Projects Section lists all projects created within your organization, including those you do not have membership in. You can easily search for a project by name using the search bar.
|
||||
|
||||
### Accessing a Project in Your Organization
|
||||
|
||||
If you want to access a project in which you are not a member but are an organization admin, follow these steps:
|
||||
|
||||

|
||||
|
||||
1. Click on the three-dot icon next to the project you wish to access.
|
||||
2. Click on the **Access** button.
|
||||
|
||||
This will grant you admin permissions for the selected project and generate an audit log of your access, ensuring transparency regarding admin privileges.
|
||||
25
docs/documentation/platform/admin-panel/overview.mdx
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
description: "Learn about Infisical's Admin Panel."
|
||||
---
|
||||
|
||||
The Infisical Admin Panel allows you to configure and manage various resources within your organization and server.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Server Admin Panel"
|
||||
href="./server-admin"
|
||||
icon="user-tie"
|
||||
color="#000000"
|
||||
>
|
||||
Configure and manage your server settings effectively.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
title="Organization Admin Console"
|
||||
href="./org-admin-console"
|
||||
icon="sitemap"
|
||||
color="#000000"
|
||||
>
|
||||
Manage settings specific to your organization.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
70
docs/documentation/platform/admin-panel/server-admin.mdx
Normal file
@@ -0,0 +1,70 @@
|
||||
---
|
||||
title: "Server Admin Panel"
|
||||
description: "Manage your Infisical server from the Server Admin Panel."
|
||||
---
|
||||
|
||||
The Server Admin Panel provides a user interface for Infisical server administrators to configure various parameters as needed. This includes configuring rate limits, managing allowed signups, and more.
|
||||
|
||||
## Accessing the Server Admin Panel
|
||||
|
||||
The first user who created the account in Infisical is designated as the server administrator. You can access the admin panel by navigating as follows:
|
||||
|
||||

|
||||
|
||||
1. Click on the profile icon in the left sidebar.
|
||||
2. From the dropdown menu, select `Server Admin Panel`.
|
||||
|
||||
## General Section
|
||||
|
||||

|
||||
|
||||
### Allow User Signups
|
||||
|
||||
This setting controls whether users can sign up for your Infisical instance. The options are:
|
||||
|
||||
1. **Anyone**: Any user with access to your instance can sign up.
|
||||
2. **Disabled**: No one will be able to sign up.
|
||||
|
||||
### Restrict Signup Domain
|
||||
|
||||
This setting allows only users with specific email domains (such as your organization's domain) to sign up.
|
||||
|
||||
### Default Organization
|
||||
|
||||
Use this setting if you want all users accessing your Infisical instance to log in through your configured SAML/LDAP provider. This prevents users from manually entering their organization slug during authentication and redirects them to the SAML/LDAP authentication page.
|
||||
|
||||
### Trust Emails
|
||||
|
||||
By default, Infisical does not trust emails logged in via SAML/LDAP/OIDC due to the potential for email spoofing. Users must verify their email addresses before proceeding. You can disable this validation if you are running an Infisical instance within your organization and trust incoming emails from your members.
|
||||
|
||||
## Authentication Section
|
||||
|
||||

|
||||
|
||||
This section allows you to configure various login and signup methods for your instance.
|
||||
|
||||
## Rate Limit Section
|
||||
|
||||

|
||||
|
||||
Configure the rate limits for your Infisical instance across various endpoints. You do not need to redeploy when making changes to rate limits; they will be automatically synchronized to all instances.
|
||||
|
||||
<Info>
|
||||
Note that rate limit configuration is a paid feature. Please contact sales@infisical.com to purchase a license for its use.
|
||||
</Info>
|
||||
|
||||
## User Management Section
|
||||
|
||||

|
||||
|
||||
The User Management section lists all users who have signed up for your instance. You can search for users using the search bar.
|
||||
|
||||
To delete a user from Infisical:
|
||||
|
||||
1. Search for the user.
|
||||
2. Click the cross button next to the user.
|
||||
3. Confirm the warning popup.
|
||||
|
||||
<Info>
|
||||
Note that user management configuration is a paid feature. Please contact sales@infisical.com to purchase a license for its use.
|
||||
</Info>
|
||||
BIN
docs/images/platform/admin-panels/access-org-admin-console.png
Normal file
|
After Width: | Height: | Size: 151 KiB |
BIN
docs/images/platform/admin-panels/access-server-admin-panel.png
Normal file
|
After Width: | Height: | Size: 151 KiB |
BIN
docs/images/platform/admin-panels/admin-panel-auths.png
Normal file
|
After Width: | Height: | Size: 115 KiB |
BIN
docs/images/platform/admin-panels/admin-panel-general.png
Normal file
|
After Width: | Height: | Size: 167 KiB |
BIN
docs/images/platform/admin-panels/admin-panel-integration.png
Normal file
|
After Width: | Height: | Size: 118 KiB |
BIN
docs/images/platform/admin-panels/admin-panel-rate-limits.png
Normal file
|
After Width: | Height: | Size: 122 KiB |
BIN
docs/images/platform/admin-panels/admin-panel-users.png
Normal file
|
After Width: | Height: | Size: 151 KiB |
BIN
docs/images/platform/admin-panels/org-admin-console-access.png
Normal file
|
After Width: | Height: | Size: 155 KiB |
BIN
docs/images/platform/admin-panels/org-admin-console-projects.png
Normal file
|
After Width: | Height: | Size: 126 KiB |
@@ -187,6 +187,14 @@
|
||||
"documentation/platform/workflow-integrations/slack-integration"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Admin Panel",
|
||||
"pages": [
|
||||
"documentation/platform/admin-panel/overview",
|
||||
"documentation/platform/admin-panel/server-admin",
|
||||
"documentation/platform/admin-panel/org-admin-console"
|
||||
]
|
||||
},
|
||||
"documentation/platform/secret-sharing"
|
||||
]
|
||||
},
|
||||
|
||||