Merge pull request #2366 from ThallesP/patch-1

docs: add mention of SITE_URL as being required
This commit is contained in:
Maidul Islam
2024-09-05 16:06:49 -04:00
committed by GitHub
3 changed files with 7 additions and 4 deletions

View File

@@ -20,7 +20,7 @@ Used to configure platform-specific security and operational settings
-base64 32`
</ParamField>
<ParamField query="SITE_URL" type="string" default="none" optional>
<ParamField query="SITE_URL" type="string" default="none" required>
Must be an absolute URL including the protocol (e.g.
https://app.infisical.com).
</ParamField>

View File

@@ -41,7 +41,7 @@ description: "Learn how to use Helm chart to install Infisical on your Kubernete
To deploy this Helm chart, a Kubernetes secret named `infisical-secrets` must be present in the same namespace where the chart is being deployed.
For a minimal installation of Infisical, you need to configure `ENCRYPTION_KEY`, `AUTH_SECRET`, `DB_CONNECTION_URI`, and `REDIS_URL`. [Learn more about configuration settings](/self-hosting/configuration/envars).
For a minimal installation of Infisical, you need to configure `ENCRYPTION_KEY`, `AUTH_SECRET`, `DB_CONNECTION_URI`, `SITE_URL`, and `REDIS_URL`. [Learn more about configuration settings](/self-hosting/configuration/envars).
<Tabs>
@@ -56,6 +56,7 @@ description: "Learn how to use Helm chart to install Infisical on your Kubernete
stringData:
AUTH_SECRET: <>
ENCRYPTION_KEY: <>
SITE_URL: <>
```
</Tab>
<Tab title="Production deployment">
@@ -71,6 +72,7 @@ description: "Learn how to use Helm chart to install Infisical on your Kubernete
ENCRYPTION_KEY: <>
REDIS_URL: <>
DB_CONNECTION_URI: <>
SITE_URL: <>
```
</Tab>
</Tabs>

View File

@@ -28,7 +28,7 @@ The following guide provides a detailed step-by-step walkthrough on how you can
</Step>
<Step title="Start Infisical">
For a minimal installation of Infisical, you must configure `ENCRYPTION_KEY`, `AUTH_SECRET`, `DB_CONNECTION_URI`, and `REDIS_URL`. [View all available configurations](/self-hosting/configuration/envars).
For a minimal installation of Infisical, you must configure `ENCRYPTION_KEY`, `AUTH_SECRET`, `DB_CONNECTION_URI`, `SITE_URL`, and `REDIS_URL`. [View all available configurations](/self-hosting/configuration/envars).
We recommend using Cloud-based Platform as a Service (PaaS) solutions for PostgreSQL and Redis to ensure high availability.
@@ -43,6 +43,7 @@ The following guide provides a detailed step-by-step walkthrough on how you can
-e AUTH_SECRET="q6LRi7c717a3DQ8JUxlWYkZpMhG4+RHLoFUVt3Bvo2U=" \
-e DB_CONNECTION_URI="<>" \
-e REDIS_URL="<>" \
-e SITE_URL="<>" \
infisical/infisical:<version>
```
@@ -59,4 +60,4 @@ The following guide provides a detailed step-by-step walkthrough on how you can
### Additional discussion
It's important to note that the above is a basic example of deploying Infisical using Docker.
In practice, for production deployments, you may want to use container orchestration platforms such as AWS ECS, Google Cloud Run, or Kubernetes.
These platforms offer additional features like scalability, load balancing, and automated deployment, making them suitable for handling production-level traffic and providing high availability.
These platforms offer additional features like scalability, load balancing, and automated deployment, making them suitable for handling production-level traffic and providing high availability.