clarify-langflow-auth
This commit is contained in:
parent
e9a295361d
commit
add8e57164
2 changed files with 24 additions and 3 deletions
|
|
@ -48,15 +48,28 @@ To install OpenRAG with Docker Compose, do the following:
|
|||
touch .env
|
||||
```
|
||||
|
||||
4. The Docker Compose files are populated with the values from your .env. The following values must be set:
|
||||
4. The Docker Compose files are populated with the values from your `.env` file. The following values must be set:
|
||||
|
||||
```bash
|
||||
OPENSEARCH_PASSWORD=your_secure_password
|
||||
OPENAI_API_KEY=your_openai_api_key
|
||||
LANGFLOW_SUPERUSER=admin
|
||||
LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password
|
||||
LANGFLOW_SECRET_KEY=your_secret_key
|
||||
```
|
||||
|
||||
`OPENSEARCH_PASSWORD` is automatically generated when using the TUI, but for a Docker Compose installation, you must set it manually. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password).
|
||||
|
||||
The `OPENAI_API_KEY` is found in your OpenAI account.
|
||||
|
||||
`LANGFLOW_SECRET_KEY` is automatically generated when using the TUI, and Langflow will also auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key).
|
||||
|
||||
Optional values:
|
||||
|
||||
```bash
|
||||
LANGFLOW_SUPERUSER=admin
|
||||
LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password
|
||||
```
|
||||
|
||||
`LANGFLOW_SUPERUSER` defaults to `admin`. You can omit it or set it to a different username. `LANGFLOW_SUPERUSER_PASSWORD` is optional. If omitted, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required. If set, Langflow requires password authentication.
|
||||
|
||||
For more information on configuring OpenRAG with environment variables, see [Environment variables](/reference/configuration).
|
||||
|
||||
|
|
|
|||
|
|
@ -106,6 +106,10 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
|
|||
|
||||
1. To install OpenRAG with **Basic Setup**, click **Basic Setup** or press <kbd>1</kbd>.
|
||||
2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow.
|
||||
|
||||
The OpenSearch password is required. The Langflow admin password is optional.
|
||||
If no Langflow admin password is generated, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required.
|
||||
|
||||
3. Paste your OpenAI API key in the OpenAI API key field.
|
||||
4. Click **Save Configuration**.
|
||||
Your passwords are saved in the `.env` file used to start OpenRAG.
|
||||
|
|
@ -123,6 +127,10 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
|
|||
|
||||
1. To install OpenRAG with **Advanced Setup**, click **Advanced Setup** or press <kbd>2</kbd>.
|
||||
2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow.
|
||||
|
||||
The OpenSearch password is required. The Langflow admin password is optional.
|
||||
If no Langflow admin password is generated, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required.
|
||||
|
||||
3. Paste your OpenAI API key in the OpenAI API key field.
|
||||
4. Add your client and secret values for Google or Microsoft OAuth.
|
||||
These values can be found with your OAuth provider.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue