added missing envs for documentation

This commit is contained in:
Sheen Capadngan
2023-05-17 22:24:04 +08:00
parent 1ccec486cc
commit fac8affe78
2 changed files with 19 additions and 1 deletions

View File

@@ -14,3 +14,5 @@ You wil need to configure the following [environment variables](https://infisica
- `CLIENT_ID_GOOGLE`: OAuth 2.0 Client ID obtained from the credentials page
- `CLIENT_SECRET_GOOGLE`: OAuth 2.0 Client Secret obtained from the credentials page
- `JWT_PROVIDER_AUTH_SECRET`: Secret Key for signing OAuth 2.0 access token
- `JWT_PROVIDER_AUTH_LIFETIME`: Lifetime for OAuth 2.0 access token

View File

@@ -69,7 +69,7 @@ Other environment variables are listed below to increase the functionality of yo
Name label to be used in From field (e.g. Team)
</ParamField>
</Tab>
<Tab title="Integrations">
<Tab title="Secret Integrations">
To sync secret to third party services, provide value for the related services
<ParamField query="CLIENT_ID_HEROKU" type="string" default="none" optional>
@@ -108,6 +108,18 @@ Other environment variables are listed below to increase the functionality of yo
OAuth2 slug for Netlify integration
</ParamField>
</Tab>
<Tab title="Auth Integrations">
To integrate with external auth providers, provide value for the related keys
<ParamField query="JWT_PROVIDER_AUTH_SECRET" type="string" required>
Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16`
</ParamField>
<ParamField query="CLIENT_ID_GOOGLE" type="string" default="none" optional>
OAuth2 client ID for Google auth integration
</ParamField>
<ParamField query="CLIENT_SECRET_GOOGLE" type="string" default="none" optional>
OAuth2 client secret for Google auth integration
</ParamField>
</Tab>
<Tab title="Others">
#### JWT
<ParamField query="JWT_SIGNUP_LIFETIME" type="string" default="15m" optional>
@@ -126,6 +138,10 @@ Other environment variables are listed below to increase the functionality of yo
JWT token lifetime expressed in seconds or a string describing a time span
</ParamField>
<ParamField query="JWT_PROVIDER_AUTH_LIFETIME" type="string" default="5m" optional>
JWT token lifetime expressed in seconds or a string describing a time span
</ParamField>
<ParamField query="MONGO_USERNAME" type="string" default="none" optional></ParamField>
<ParamField query="MONGO_PASSWORD" type="string" default="none" optional></ParamField>