github/infisical
1
0
Fork 0
mirror of https://github.com/Infisical/infisical.git synced 2026-01-08 15:13:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: updated doc

Browse Source
This commit is contained in:
=
2025-05-21 20:01:13 +05:30
parent 3ac3710273
commit bb2a70b986
1 changed files with 73 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
docs/self-hosting/configuration/envars.mdx
View File

@@ -32,14 +32,16 @@ Used to configure platform-specific security and operational settings
<ParamField query="HOST" type="string" default="localhost" optional>
Specifies the network interface Infisical will bind to when accepting incoming connections.
By default, Infisical binds to `localhost`, which restricts access to connections from the same machine.
By default, Infisical binds to `localhost`, which restricts access to connections from the same machine.
To make the application accessible externally (e.g., for self-hosted deployments), set this to `0.0.0.0`, which tells the server to listen on all network interfaces.
To make the application accessible externally (e.g., for self-hosted deployments), set this to `0.0.0.0`, which tells the server to listen on all network interfaces.
Example values:
- `localhost` (default, same as `127.0.0.1`)
- `0.0.0.0` (all interfaces, accessible externally)
- `192.168.1.100` (specific interface IP)
Example values:
- `localhost` (default, same as `127.0.0.1`)
- `0.0.0.0` (all interfaces, accessible externally)
- `192.168.1.100` (specific interface IP)
</ParamField>
<ParamField query="TELEMETRY_ENABLED" type="string" default="true" optional>
@@ -86,8 +88,9 @@ The platform utilizes Postgres to persist all of its data and Redis for caching
### PostgreSQL
<Info>
Please note that the database user you create must be granted all privileges on the Infisical database.
This includes the ability to create new schemas, create, update, delete, modify tables and indexes, etc.
Please note that the database user you create must be granted all privileges
on the Infisical database. This includes the ability to create new schemas,
create, update, delete, modify tables and indexes, etc.
</Info>
<ParamField query="DB_CONNECTION_URI" type="string" default="" required>
@@ -95,9 +98,8 @@ The platform utilizes Postgres to persist all of its data and Redis for caching
</ParamField>
<ParamField query="DB_ROOT_CERT" type="string" default="" optional>
Configure the SSL certificate for securing a Postgres connection by first encoding it in base64.
Use the command below to encode your certificate:
`echo "<certificate>" | base64`
Configure the SSL certificate for securing a Postgres connection by first
encoding it in base64. Use the command below to encode your certificate:
</ParamField>
<ParamField query="DB_READ_REPLICAS" type="string" default="" optional>
@@ -122,9 +124,42 @@ DB_READ_REPLICAS=[{"DB_CONNECTION_URI":""}]
### Redis
<ParamField query="REDIS_URL" type="string" default="none" required>
Redis connection string.
</ParamField>
<Info>Redis is required for smooth operation of Infisical.</Info>
<Tabs>
<Tab title="Standalone Node">
<ParamField query="REDIS_URL" type="string" default="none" required>
Redis connection string.
</ParamField>
</Tab>
<Tab title="Redis Sentinel">
<ParamField
query="REDIS_SENTINEL_HOSTS"
type="string"
default="none"
required
>
Comma-separated list of Sentinel host:port pairs. ```
192.168.65.254:26379,192.168.65.254:26380 ```
</ParamField>
<ParamField
query="REDIS_SENTINEL_MASTER_NAME"
type="string"
default="mymaster"
>
The name of the Redis master set monitored by Sentinel
</ParamField>
<ParamField query="REDIS_SENTINEL_ENABLE_TLS" type="bool" default="false">
Whether to use TLS/SSL for Redis Sentinel connection
</ParamField>
<ParamField query="REDIS_SENTINEL_USERNAME" type="string" default="none">
Authentication username for Redis Sentinel
</ParamField>
<ParamField query="REDIS_SENTINEL_PASSWORD" type="string" default="none">
Authentication password for Redis Sentinel
</ParamField>
</Tab>
</Tabs>
## Email Service
@@ -222,7 +257,7 @@ SMTP_FROM_NAME=Infisical
This will be used to verify the email you are sending from.
![Create SES identity](../../images/self-hosting/configuration/email/ses-create-identity.png)
<Info>
If you AWS SES is under sandbox mode, you will only be able to send emails to verified identies.
If you AWS SES is under sandbox mode, you will only be able to send emails to verified identies.
</Info>
</Step>
<Step title="Create an account and configure AWS SES">
@@ -388,9 +423,9 @@ SMTP_FROM_NAME=Infisical
</Info>
</Accordion>
<Accordion title="SMTP2Go">
<Accordion title="SMTP2Go">
1. Create an account and configure [SMTP2Go](https://www.smtp2go.com/) to send emails.
2. Turn on SMTP authentication
2. Turn on SMTP authentication
```
SMTP_HOST=mail.smtp2go.com
SMTP_PORT=You can use one of the following ports: 2525, 80, 25, 8025, or 587
@@ -401,7 +436,7 @@ SMTP_FROM_NAME=Infisical
```
{" "}
<Note>
<Note>
Optional (for TLS/SSL):
TLS: Available on the same ports (2525, 80, 25, 8025, or 587)
@@ -632,13 +667,27 @@ To help you sync secrets from Infisical to services such as Github and Gitlab, I
The App ID of your GitHub App.
</ParamField>
<ParamField query="SECRET_SCANNING_GIT_APP_SLUG" type="string" default="none" optional>
The slug of your GitHub App.
</ParamField>
{" "}
<ParamField query="SECRET_SCANNING_PRIVATE_KEY" type="string" default="none" optional>
A private key for your GitHub App.
</ParamField>
<ParamField
query="SECRET_SCANNING_GIT_APP_SLUG"
type="string"
default="none"
optional
>
The slug of your GitHub App.
</ParamField>
{" "}
<ParamField
query="SECRET_SCANNING_PRIVATE_KEY"
type="string"
default="none"
optional
>
A private key for your GitHub App.
</ParamField>
<ParamField query="SECRET_SCANNING_WEBHOOK_SECRET" type="string" default="none" optional>
The webhook secret of your GitHub App.