docs: updates server admin console docs

This commit is contained in:
Piyush Gupta
2025-12-13 02:00:22 +05:30
parent eb2d6dcd6c
commit 2e35a0a62d
24 changed files with 111 additions and 24 deletions

View File

@@ -4,7 +4,7 @@ description: "Configure and manage server related features"
---
The Server Admin Console provides **server administrators** with the ability to
customize settings and manage users for their entire Infisical instance.
customize settings and manage configurations for their entire Infisical instance.
<Note>
The first user to setup an account on your Infisical instance is designated as
@@ -13,9 +13,9 @@ customize settings and manage users for their entire Infisical instance.
## Accessing the Server Admin Console
On the sidebar, hover over **Admin** to access the settings dropdown and press the **Server Admin Console** option.
Navigate to the Server Admin Console by clicking on the **Server Console** button in the navigation bar.
![Access Server Admin Console](/images/platform/admin-panels/access-server-admin-panel.png)
![Access Server Admin Console](/images/platform/admin-panels/server-console.png)
## General Tab
@@ -28,7 +28,7 @@ Configure general settings for your instance.
User signups are enabled by default, allowing **Anyone** with access to your instance to sign up. This can alternatively be **Disabled** to prevent any users from signing up.
### Restrict Signup Domain
### Restrict Signup by Email Domain(s)
Signup can be restricted to users matching one or more email domains, such as your organization's domain, to control who has access to your instance.
@@ -40,7 +40,9 @@ If you're using SAML/LDAP/OIDC for only one organization on your instance, you c
By default, users signing up through SAML/LDAP/OIDC will still need to verify their email address to prevent email spoofing. This requirement can be skipped by enabling the switch to trust logins through the respective method.
### Broadcast Messages
### Notices
#### Auth Consent Content
Auth consent content is displayed to users on the login page. They can be used to display important information to users, such as a maintenance message or a new feature announcement. Both HTML and Markdown formatting are supported, allowing for customized styling like below:
@@ -54,32 +56,69 @@ Auth consent content is displayed to users on the login page. They can be used t
![Auth Consent Usage](/images/platform/admin-panels/auth-consent-usage.png)
#### Page Frame Content
Page frame content is displayed as a header and footer in ALL protected pages. Like the auth consent content, both HTML and Markdown formatting are supported here as well.
![Page Frame Usage](/images/platform/admin-panels/page-frame-usage.png)
## Resource Overview Tab
View and manage resources across your Infisical instance.
![Resource Overview](/images/platform/admin-panels/admin-panel-resource-overview.png)
## Access Control Tab
Manage server admins across your Infisical instance.
![Access Control](/images/platform/admin-panels/admin-panel-access-control.png)
## Encryption Tab
Manage encryption settings for your instance.
![Encryption](/images/platform/admin-panels/admin-panel-encryption.png)
## Authentication Tab
From this tab, you can configure which login methods are enabled for your instance.
This tab allows you to configure which login methods are available to users.
![Authentication Settings](/images/platform/admin-panels/admin-panel-auths.png)
## Rate Limit Tab
## Integrations Tab
This tab allows you to set various rate limits for your Infisical instance. You do not need to redeploy when making changes to rate limits as these will be propagated automatically.
Manage integrations for your Infisical instance.
![Rate Limit Settings](/images/platform/admin-panels/admin-panel-rate-limits.png)
![Integrations](/images/platform/admin-panels/admin-panel-integrations.png)
<Note>
Note that rate limit configuration is a paid feature. Please contact
sales@infisical.com to purchase a license for its use.
</Note>
## Caching Tab
## User Management Tab
Manage caching settings for your Infisical instance.
From this tab, you can view all the users who have signed up for your instance. You can search for users using the search bar and remove them from your instance by clicking on the three dots icon on the right. Additionally, the Server Admin can grant server administrator access to other users through this menu.
![User Management](/images/platform/admin-panels/admin-panel-users.png)
![Caching](/images/platform/admin-panels/admin-panel-caching.png)
<Note>
Note that rate limit configuration is a paid feature. Please contact
sales@infisical.com to purchase a license for its use.
</Note>
## Environment Variables Tab
The Environment Variables tab allows server admins to override environment variables without direct access to the server's environment configuration. This is particularly useful for managed deployments or when you cannot directly modify environment files.
![Environment Variables Overrides Page](/images/platform/admin-panels/admin-panel-environment-variables.png)
### When to Use Environment Overrides
Use this feature when:
- You don't have direct access to modify environment variables on your server
- You want to update configuration without redeploying your instance
### How It Works
1. Navigate to the Environment Variables tab in the Server Admin Console
2. Search for specific variables using the search bar
3. Modify the values as needed
4. Click Save to apply the changes
<Warning>
Changes to environment variables can take up to 5 minutes to propagate across
all containers in your deployment.
</Warning>

View File

@@ -37,6 +37,11 @@ The Infisical GCP IAM dynamic secret allows you to generate GCP service account
<Step title="Configure Your Instance">
1. Copy the entire contents of the downloaded JSON key file.
2. Set it as a string value for the `INF_APP_CONNECTION_GCP_SERVICE_ACCOUNT_CREDENTIAL` environment variable.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
3. Restart your Infisical instance to apply the changes.
4. You can now use GCP integration with service account impersonation.
</Step>

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 488 KiB

After

Width:  |  Height:  |  Size: 325 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 167 KiB

After

Width:  |  Height:  |  Size: 264 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

View File

@@ -43,8 +43,14 @@ Infisical supports two methods for connecting to AWS.
![Access Key Step 3](/images/integrations/aws/integrations-aws-access-key-3.png)
</Step>
<Step title="Set Up Connection Keys">
1. Set the access key as **INF_APP_CONNECTION_AWS_ACCESS_KEY_ID**.
2. Set the secret key as **INF_APP_CONNECTION_AWS_SECRET_ACCESS_KEY**.
Set the following environment variables in your Infisical instance:
- `INF_APP_CONNECTION_AWS_ACCESS_KEY_ID`: The AWS access key ID.
- `INF_APP_CONNECTION_AWS_SECRET_ACCESS_KEY`: The AWS secret access key.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
</Step>
</Steps>
</Accordion>

View File

@@ -53,6 +53,10 @@ Infisical currently only supports two methods for connecting to Azure, which are
- `INF_APP_CONNECTION_AZURE_APP_CONFIGURATION_CLIENT_ID`: The **Application (Client) ID** of your Azure application.
- `INF_APP_CONNECTION_AZURE_APP_CONFIGURATION_CLIENT_SECRET`: The **Client Secret** of your Azure application.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the Azure App Configuration connection.
</Step>
</Steps>

View File

@@ -60,6 +60,10 @@ Infisical currently only supports two methods for connecting to Azure, which are
- `INF_APP_CONNECTION_AZURE_CLIENT_SECRETS_CLIENT_ID`: The **Application (Client) ID** of your Azure application.
- `INF_APP_CONNECTION_AZURE_CLIENT_SECRETS_CLIENT_SECRET`: The **Client Secret** of your Azure application.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the Azure Client Secrets connection.
</Step>
</Steps>

View File

@@ -59,7 +59,11 @@ Infisical currently supports three methods for connecting to Azure DevOps, which
- `INF_APP_CONNECTION_AZURE_DEVOPS_CLIENT_ID`: The **Application (Client) ID** of your Azure application.
- `INF_APP_CONNECTION_AZURE_DEVOPS_CLIENT_SECRET`: The **Client Secret** of your Azure application.
Once added, restart your Infisical instance and use the Azure Client Secrets connection.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the Azure DevOps connection.
</Step>
</Steps>

View File

@@ -52,6 +52,10 @@ Infisical currently only supports two methods for connecting to Azure, which are
- `INF_APP_CONNECTION_AZURE_KEY_VAULT_CLIENT_ID`: The **Application (Client) ID** of your Azure application.
- `INF_APP_CONNECTION_AZURE_KEY_VAULT_CLIENT_SECRET`: The **Client Secret** of your Azure application.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the Azure Key Vault connection.
</Step>
</Steps>

View File

@@ -29,6 +29,11 @@ Infisical supports [service account impersonation](https://cloud.google.com/iam/
<Step title="Configure Your Instance">
1. Copy the entire contents of the downloaded JSON key file.
2. Set it as a string value for the `INF_APP_CONNECTION_GCP_SERVICE_ACCOUNT_CREDENTIAL` environment variable.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
3. Restart your Infisical instance to apply the changes.
4. You can now use GCP integration with service account impersonation.
</Step>

View File

@@ -88,6 +88,10 @@ Infisical supports GitHub App installation for creating a GitHub Radar Connectio
- `INF_APP_CONNECTION_GITHUB_RADAR_APP_PRIVATE_KEY`: The **Private Key** of your GitHub application.
- `INF_APP_CONNECTION_GITHUB_RADAR_APP_WEBHOOK_SECRET`: The **Webhook Secret** of your GitHub application.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the GitHub integration via app authentication.
</Step>
</Steps>

View File

@@ -147,6 +147,10 @@ Infisical supports three methods for connecting to GitHub.
- `INF_APP_CONNECTION_GITHUB_OAUTH_CLIENT_ID`: The **Client ID** of your GitHub OAuth application.
- `INF_APP_CONNECTION_GITHUB_OAUTH_CLIENT_SECRET`: The **Client Secret** of your GitHub OAuth application.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the GitHub integration.
</Step>
</Steps>

View File

@@ -63,6 +63,10 @@ Infisical supports two methods for connecting to GitLab: **OAuth** and **Access
- `INF_APP_CONNECTION_GITLAB_OAUTH_CLIENT_ID`: The **Application ID** of your GitLab OAuth application.
- `INF_APP_CONNECTION_GITLAB_OAUTH_CLIENT_SECRET`: The **Secret** of your GitLab OAuth application.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the GitLab Connection.
</Step>
</Steps>

View File

@@ -42,6 +42,10 @@ Infisical supports two methods for connecting to Heroku: **OAuth** and **Auth To
- `INF_APP_CONNECTION_HEROKU_OAUTH_CLIENT_ID`: The **Client ID** of your Heroku API client.
- `INF_APP_CONNECTION_HEROKU_OAUTH_CLIENT_SECRET`: The **Client Secret** of your Heroku API client.
<Note>
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
</Note>
Once added, restart your Infisical instance and use the Heroku Connection.
</Step>
</Steps>

View File

@@ -783,6 +783,6 @@ If export type is set to `otlp`, you will have to configure a value for `OTEL_EX
## Environment Variable Overrides
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin).
If you can't directly access and modify environment variables, you can update them using the [Server Admin Console](/documentation/platform/admin-panel/server-admin#environment-variables-tab).
![Environment Variables Overrides Page](../../images/self-hosting/configuration/overrides/page.png)