Skip to content

Commit 2cfc3e7

Browse files
ajhaiajhai
committed
Update docs
1 parent f39d36a commit 2cfc3e7

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

‎web/docs/getting-started/config.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ title: Configuration
55

66
You can configure the LLMStack installation by editing the `.env` file in the root directory of the installation. The `.env` file is a simple text file with key-value pairs. You can edit the file using any text editor. Following is the list of available configuration options:
77

8-
| Key | Description | Default Value |
9-
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
10-
| `SECRET_KEY` | Secret key for your installation. This is the key used for signing data. **_Make sure this is changed_** | Hardcoded random string. |
11-
| `CIPHER_KEY_SALT` | Salt used to encrypt user keys and other sensitive data | `salt` |
12-
| `DATABASE_PASSWORD` | Password for the database user. This is used when setting up the initial db user and for connecting to the database later | `llmstack` |
13-
| `POSTGRES_VOLUME` | Path to the directory where the database data will be stored. By default, data is stored in `/tmp` which is ephemeral. Make sure to change this to a persistent directory if you want to persist the data. | `/tmp/postgres_llmstack` |
14-
| `REDIS_VOLUME` | Path to the directory where the redis data will be stored. By default, data is stored in `/tmp` which is ephemeral. Make sure to change this to a persistent directory if you want to persist the data. | `/tmp/redis_llmstack` |
15-
| `WEAVIATE_VOLUME` | Path to the directory where the weaviate data will be stored. By default, data is stored in `/tmp` which is ephemeral. Make sure to change this to a persistent directory if you want to persist the data. | `/tmp/weaviate_llmstack` |
16-
| `LLMSTACK_PORT` | Port on which the LLMStack web server will listen. | `3000` |
17-
| `LOG_LEVEL` | Log level for the LLMStack web server. | `ERROR` |
18-
| `ALLOWED_HOSTS` | Comma separated list of allowed hosts for the LLMStack API server server. | `localhost` |
8+
| Key | Description | Default Value |
9+
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
10+
| `SECRET_KEY` | Secret key for your installation. This is the key used for signing data. **_Make sure this is changed_** | Hardcoded random string. |
11+
| `CIPHER_KEY_SALT` | Salt used to encrypt user keys and other sensitive data | `salt` |
12+
| `DATABASE_PASSWORD` | Password for the database user. This is used when setting up the initial db user and for connecting to the database later | `llmstack` |
13+
| `POSTGRES_VOLUME` | Path to the directory where the database data will be stored. By default, data is stored in `/tmp` which is ephemeral. Make sure to change this to a persistent directory if you want to persist the data. | `/tmp/postgres_llmstack` |
14+
| `REDIS_VOLUME` | Path to the directory where the redis data will be stored. By default, data is stored in `/tmp` which is ephemeral. Make sure to change this to a persistent directory if you want to persist the data. | `/tmp/redis_llmstack` |
15+
| `WEAVIATE_VOLUME` | Path to the directory where the weaviate data will be stored. By default, data is stored in `/tmp` which is ephemeral. Make sure to change this to a persistent directory if you want to persist the data. | `/tmp/weaviate_llmstack` |
16+
| `LLMSTACK_PORT` | Port on which the LLMStack web server will listen. | `3000` |
17+
| `LOG_LEVEL` | Log level for the LLMStack web server. | `ERROR` |
18+
| `ALLOWED_HOSTS` | Comma separated list of allowed hosts for the LLMStack API server server. If you are running LLMStack on a non localhost domain, you need to add allowed hosts | `localhost` |
19+
| `CSRF_TRUSTED_ORIGINS` | Comma separated list of trusted origins. If you are running LLMStack on a non localhost domain, you need to add the domain to this list. | `http://127.0.0.1:{LLMSTACK_PORT},http://localhost:{LLMSTACK_PORT}` |
1920

2021
## Default Platform Keys
2122

‎web/docs/getting-started/intro.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ LLMStack comes with a default admin account whose credentials are `admin` and `p
4646
/>
4747

4848
:::note
49-
If you are deploying LLMStack on a server, make sure to update `ALLOWED_HOSTS` in `.env` file to include the hostname of your server. Refer to the [configuration](config.md) section for more information.
49+
If you are deploying LLMStack on a server, make sure to update `ALLOWED_HOSTS` and `CSRF_TRUSTED_ORIGINS` in `.env` file to include the hostname of your server. Refer to the [configuration](config.md) section for more information.
5050
:::
5151

5252
Instead of downloading the release, you can also clone the repository and run the above commands in the cloned repository.
@@ -86,3 +86,7 @@ Datasources are used to provide context to LLMs to build applications that can p
8686
### Variables
8787

8888
Variables are used in LLMStack to provide dynamic values to the processors. For example, you can use variables to provide the name of the user to the processors. Variables are provided in the form `{{name}}` where `name` is the variable name. In App editor, data from previous processors/steps is available as variables and can be used in subsequent processors/steps.
89+
90+
:::tip
91+
If you have questions, suggestions or need help, feel free to join our [Discord server](https://discord.gg/3JsEzSXspJ) or start a discussion on our [Github Discussions](https://github.com/trypromptly/LLMStack/discussions) page.
92+
:::

0 commit comments

Comments
 (0)