InsightHub/required_environment_variables.txt at main · QuiddityAI/InsightHub · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# Create a .env file in the root of this repo with the following variables:

# (The first two sections are required, it is also advised to add at least
# one LLM provider API key (check default model), the rest is optional)

# --------------------- Required: General -------------------------

# specify docker-compose files to use (see Readme):
COMPOSE_FILE=docker-compose.yaml

# used to decide for local embedding server or remote provider in some cases:
GPU_IS_AVAILABLE=False

# --------------------- Required: General: Default Users and Passwords -------------------------

# change the default superuser credentials:
DJANGO_SUPERUSER_USERNAME=
DJANGO_SUPERUSER_EMAIL=
DJANGO_SUPERUSER_PASSWORD=

BACKEND_AUTHENTICATION_SECRET= # generate any random secret

POSTGRES_PASSWORD= # generate any random password
OPENSEARCH_INITIAL_ADMIN_PASSWORD= # specify a default username for the database connection

# if your are not using localhost and still want to show all organization
# (regardless of their 'domains' setting), add your domain here (comma separated):
HOSTNAMES_THAT_SHOW_ALL_ORGANIZATIONS=www.example.org:55140,www.other-example.com

# --------------------- Data Storage -------------------------

# optionally, store data in local folder instead of /data:
# Add this to the docker compose ovveride file:
# services:
#  backend:
#    volumes:
#      - "${DATA_PATH:-/data}:/data"
# And this env variable:
DATA_PATH=./data

# --------------------- Network Setup: HTTPS -------------------------

COMPOSE_PROFILES=  # add https_proxy to also start the SWAG reverse proxy
SERVER_URL= #e.g. something.absclust.com
SSL_CERT_EMAIL= #email to notify about SSL certificate expiration

# --------------------- Network Setup: Optional Port Exposure -------------------------

#optionally, set IP where the containers should be available (e.g. 127.0.0.1 or 0.0.0.0) and
#  port that is exposed outside the docker network:

WEBSERVER_EXPOSED_IP_V4=0.0.0.0
WEBSERVER_EXPOSED_IP_V6=[::]
WEBSERVER_STAGING_EXPOSED_IP_V4=127.0.0.1
WEBSERVER_STAGING_EXPOSED_IP_V6=[::]

QDRANT_EXPOSED_IP=127.0.0.1
QDRANT_EXPOSED_PORT=6333

POSTGRES_EXPOSED_PORT=5432

OPENSEARCH_DASHBOARD_EXPOSED_IP=127.0.0.1
OPENSEARCH_DASHBOARD_EXPOSED_PORT=5601

# --------------------- Network Setup: Other -------------------------

# Add any additional trusted origins for CSRF protection, separated by commas:
# Example: https://example.com,https://subdomain.example.com
CSRF_TRUSTED_ORIGINS=https://example.com,https://subdomain.example.com

# --------------------- Notifications -------------------------

# For Telegram notifier to work, following env vars must be set:
TELEGRAM_TOKEN=
TELEGRAM_CHAT_ID=

# for e-mail notifications e.g. on new items added to collections:
NOTIFICATION_EMAIL_ADDRESS=
NOTIFICATION_EMAIL_SMTP_HOST=smtp.gmail.com
NOTIFICATION_EMAIL_SMTP_PORT=465
NOTIFICATION_EMAIL_SMTP_USER=
NOTIFICATION_EMAIL_SMTP_PASSWORD=

# --------------------- API Keys -------------------------

# for website scraping with "UseScraper.com":
USE_SCRAPER_API_KEY=

# for LLM models using LLMonkey library:
LLMONKEY_OPENAI_API_KEY=
LLMONKEY_GROQ_API_KEY=
LLMONKEY_DEEPINFRA_API_KEY=
LLMONKEY_COHERE_API_KEY=
LLMONKEY_IONOS_API_KEY=
LLMONKEY_MISTRAL_API_KEY=
LLMONKEY_AZURE_OPENAI_URL=
LLMONKEY_AZURE_INFERENCE_URL=
LLMONKEY_AZURE_API_KEY=

BING_SEARCH_V7_SUBSCRIPTION_KEY=?
BING_SEARCH_V7_ENDPOINT=?

SEMANTIC_SCHOLAR_API_KEY=?
# to enable reranking with Cohere:
# will fallback to no reranking if not set
COHERE_API_KEY=?