quivr/.env.example

#### QUIVR Configuration


OPENAI_API_KEY=CHANGE_ME 
CREATE_FIRST_USER=true # set to false if you want to create the first user manually by default it will create a user with the following credentials:
# login: admin@quivr.app
# password: admin

#LOCAL
#OLLAMA_API_BASE_URL=http://host.docker.internal:11434 # Uncomment to activate ollama. This is the local url for the ollama api


# This file is used to configure the Quivr stack. It is used by the `docker-compose.yml` file to configure the stack.

########
# FRONTEND
########

NEXT_PUBLIC_ENV=local
NEXT_PUBLIC_BACKEND_URL=http://localhost:5050
NEXT_PUBLIC_SUPABASE_URL=http://localhost:8000
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE
NEXT_PUBLIC_CMS_URL=https://cms.quivr.app
NEXT_PUBLIC_FRONTEND_URL=http://localhost:*


########
# BACKEND
########

SUPABASE_URL=http://kong:8000
SUPABASE_SERVICE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q
PG_DATABASE_URL=notimplementedyet
ANTHROPIC_API_KEY=null
JWT_SECRET_KEY=your-super-secret-jwt-token-with-at-least-32-characters-long
AUTHENTICATE=true
GOOGLE_APPLICATION_CREDENTIALS=<ignore-me>
GOOGLE_CLOUD_PROJECT=<ignore-me>
CELERY_BROKER_URL=redis://redis:6379/0
CELERY_BROKER_QUEUE_NAME=quivr-preview.fifo


#RESEND
RESEND_API_KEY=<change-me>
RESEND_EMAIL_ADDRESS=onboarding@resend.dev
RESEND_CONTACT_SALES_FROM=contact_sales@resend.dev
RESEND_CONTACT_SALES_TO=<change-me>

CRAWL_DEPTH=1


PREMIUM_MAX_BRAIN_NUMBER=30
PREMIUM_MAX_BRAIN_SIZE=10000000
PREMIUM_DAILY_CHAT_CREDIT=100


###### SUPABASE CONFIGURATION ######

############
# Secrets
# YOU MUST CHANGE THESE BEFORE GOING INTO PRODUCTION
############

POSTGRES_PASSWORD=your-super-secret-and-long-postgres-password
JWT_SECRET=your-super-secret-jwt-token-with-at-least-32-characters-long
ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE
SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q
DASHBOARD_USERNAME=admin
DASHBOARD_PASSWORD=admin

############
# Database - You can change these to any PostgreSQL database that has logical replication enabled.
############

POSTGRES_HOST=db
POSTGRES_DB=postgres
POSTGRES_PORT=5432
# default user is postgres

############
# API Proxy - Configuration for the Kong Reverse proxy.
############

KONG_HTTP_PORT=8000
KONG_HTTPS_PORT=8443


############
# API - Configuration for PostgREST.
############

PGRST_DB_SCHEMAS=public,storage,graphql_public


############
# Auth - Configuration for the GoTrue authentication server.
############

## General
SITE_URL=http://localhost:3001
ADDITIONAL_REDIRECT_URLS=
JWT_EXPIRY=3600
DISABLE_SIGNUP=false
API_EXTERNAL_URL=http://localhost:8000

## Mailer Config
MAILER_URLPATHS_CONFIRMATION="/auth/v1/verify"
MAILER_URLPATHS_INVITE="/auth/v1/verify"
MAILER_URLPATHS_RECOVERY="/auth/v1/verify"
MAILER_URLPATHS_EMAIL_CHANGE="/auth/v1/verify"

## Email auth
ENABLE_EMAIL_SIGNUP=true
ENABLE_EMAIL_AUTOCONFIRM=false
SMTP_ADMIN_EMAIL=admin@example.com
SMTP_HOST=supabase-mail
SMTP_PORT=2500
SMTP_USER=fake_mail_user
SMTP_PASS=fake_mail_password
SMTP_SENDER_NAME=fake_sender

## Phone auth
ENABLE_PHONE_SIGNUP=true
ENABLE_PHONE_AUTOCONFIRM=true


############
# Studio - Configuration for the Dashboard
############

STUDIO_DEFAULT_ORGANIZATION=Default Organization
STUDIO_DEFAULT_PROJECT=Default Project

STUDIO_PORT=3001
# replace if you intend to use Studio outside of localhost
SUPABASE_PUBLIC_URL=http://localhost:8000

# Enable webp support
IMGPROXY_ENABLE_WEBP_DETECTION=true

############
# Functions - Configuration for Functions
############
# NOTE: VERIFY_JWT applies to all functions. Per-function VERIFY_JWT is not supported yet.
FUNCTIONS_VERIFY_JWT=false

############
# Logs - Configuration for Logflare
# Please refer to https://supabase.com/docs/reference/self-hosting-analytics/introduction
############

LOGFLARE_LOGGER_BACKEND_API_KEY=your-super-secret-and-long-logflare-key

# Change vector.toml sinks to reflect this change
LOGFLARE_API_KEY=your-super-secret-and-long-logflare-key

# Docker socket location - this value will differ depending on your OS
DOCKER_SOCKET_LOCATION=/var/run/docker.sock

# Google Cloud Project details
GOOGLE_PROJECT_ID=GOOGLE_PROJECT_ID
GOOGLE_PROJECT_NUMBER=GOOGLE_PROJECT_NUMBER
feat(install): it now takes 30 seconds to install Quivr (#1780) # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): 2023-12-02 02:26:06 +03:00			`#### QUIVR Configuration`


			`OPENAI_API_KEY=CHANGE_ME`
feat: 🎸 install (#1784) now made easy # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): 2023-12-02 16:50:57 +03:00			`CREATE_FIRST_USER=true # set to false if you want to create the first user manually by default it will create a user with the following credentials:`
			`# login: admin@quivr.app`
			`# password: admin`
feat(install): it now takes 30 seconds to install Quivr (#1780) # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): 2023-12-02 02:26:06 +03:00
feat: 🎸 local all local in 60 seconds 2023-12-02 17:43:05 +03:00			`#LOCAL`
			`#OLLAMA_API_BASE_URL=http://host.docker.internal:11434 # Uncomment to activate ollama. This is the local url for the ollama api`

feat(install): it now takes 30 seconds to install Quivr (#1780) # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): 2023-12-02 02:26:06 +03:00


			# This file is used to configure the Quivr stack. It is used by the `docker-compose.yml` file to configure the stack.

			`########`
			`# FRONTEND`
			`########`

			`NEXT_PUBLIC_ENV=local`
			`NEXT_PUBLIC_BACKEND_URL=http://localhost:5050`
			`NEXT_PUBLIC_SUPABASE_URL=http://localhost:8000`
			`NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE`
			`NEXT_PUBLIC_CMS_URL=https://cms.quivr.app`
			`NEXT_PUBLIC_FRONTEND_URL=http://localhost:*`



			`########`
			`# BACKEND`
			`########`

			`SUPABASE_URL=http://kong:8000`
			`SUPABASE_SERVICE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q`
			`PG_DATABASE_URL=notimplementedyet`
			`ANTHROPIC_API_KEY=null`
			`JWT_SECRET_KEY=your-super-secret-jwt-token-with-at-least-32-characters-long`
			`AUTHENTICATE=true`
			`GOOGLE_APPLICATION_CREDENTIALS=<ignore-me>`
			`GOOGLE_CLOUD_PROJECT=<ignore-me>`
			`CELERY_BROKER_URL=redis://redis:6379/0`
fix: celery config typo (#1776) # Description There was a typo on one of the celery's config variables. The `CELEBRY_BROKER_QUEUE_NAME` variable has been replaced by `CELERY_BROKER_QUEUE_NAME` ## Checklist before requesting a review Please delete options that are not relevant. - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code 2023-12-05 11:40:40 +03:00			`CELERY_BROKER_QUEUE_NAME=quivr-preview.fifo`
feat(install): it now takes 30 seconds to install Quivr (#1780) # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): 2023-12-02 02:26:06 +03:00

			`#RESEND`
			`RESEND_API_KEY=<change-me>`
			`RESEND_EMAIL_ADDRESS=onboarding@resend.dev`
			`RESEND_CONTACT_SALES_FROM=contact_sales@resend.dev`
			`RESEND_CONTACT_SALES_TO=<change-me>`

			`CRAWL_DEPTH=1`


			`PREMIUM_MAX_BRAIN_NUMBER=30`
			`PREMIUM_MAX_BRAIN_SIZE=10000000`
			`PREMIUM_DAILY_CHAT_CREDIT=100`



			`###### SUPABASE CONFIGURATION ######`

			`############`
			`# Secrets`
			`# YOU MUST CHANGE THESE BEFORE GOING INTO PRODUCTION`
			`############`

			`POSTGRES_PASSWORD=your-super-secret-and-long-postgres-password`
			`JWT_SECRET=your-super-secret-jwt-token-with-at-least-32-characters-long`
			`ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE`
			`SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q`
			`DASHBOARD_USERNAME=admin`
			`DASHBOARD_PASSWORD=admin`

			`############`
			`# Database - You can change these to any PostgreSQL database that has logical replication enabled.`
			`############`

			`POSTGRES_HOST=db`
			`POSTGRES_DB=postgres`
			`POSTGRES_PORT=5432`
			`# default user is postgres`

			`############`
			`# API Proxy - Configuration for the Kong Reverse proxy.`
			`############`

			`KONG_HTTP_PORT=8000`
			`KONG_HTTPS_PORT=8443`


			`############`
			`# API - Configuration for PostgREST.`
			`############`

			`PGRST_DB_SCHEMAS=public,storage,graphql_public`


			`############`
			`# Auth - Configuration for the GoTrue authentication server.`
			`############`

			`## General`
			`SITE_URL=http://localhost:3001`
			`ADDITIONAL_REDIRECT_URLS=`
			`JWT_EXPIRY=3600`
			`DISABLE_SIGNUP=false`
			`API_EXTERNAL_URL=http://localhost:8000`

			`## Mailer Config`
			`MAILER_URLPATHS_CONFIRMATION="/auth/v1/verify"`
			`MAILER_URLPATHS_INVITE="/auth/v1/verify"`
			`MAILER_URLPATHS_RECOVERY="/auth/v1/verify"`
			`MAILER_URLPATHS_EMAIL_CHANGE="/auth/v1/verify"`

			`## Email auth`
			`ENABLE_EMAIL_SIGNUP=true`
			`ENABLE_EMAIL_AUTOCONFIRM=false`
			`SMTP_ADMIN_EMAIL=admin@example.com`
			`SMTP_HOST=supabase-mail`
			`SMTP_PORT=2500`
			`SMTP_USER=fake_mail_user`
			`SMTP_PASS=fake_mail_password`
			`SMTP_SENDER_NAME=fake_sender`

			`## Phone auth`
			`ENABLE_PHONE_SIGNUP=true`
			`ENABLE_PHONE_AUTOCONFIRM=true`


			`############`
			`# Studio - Configuration for the Dashboard`
			`############`

			`STUDIO_DEFAULT_ORGANIZATION=Default Organization`
			`STUDIO_DEFAULT_PROJECT=Default Project`

			`STUDIO_PORT=3001`
			`# replace if you intend to use Studio outside of localhost`
			`SUPABASE_PUBLIC_URL=http://localhost:8000`

			`# Enable webp support`
			`IMGPROXY_ENABLE_WEBP_DETECTION=true`

			`############`
			`# Functions - Configuration for Functions`
			`############`
			`# NOTE: VERIFY_JWT applies to all functions. Per-function VERIFY_JWT is not supported yet.`
			`FUNCTIONS_VERIFY_JWT=false`

			`############`
			`# Logs - Configuration for Logflare`
			`# Please refer to https://supabase.com/docs/reference/self-hosting-analytics/introduction`
			`############`

			`LOGFLARE_LOGGER_BACKEND_API_KEY=your-super-secret-and-long-logflare-key`

			`# Change vector.toml sinks to reflect this change`
			`LOGFLARE_API_KEY=your-super-secret-and-long-logflare-key`

			`# Docker socket location - this value will differ depending on your OS`
			`DOCKER_SOCKET_LOCATION=/var/run/docker.sock`

			`# Google Cloud Project details`
			`GOOGLE_PROJECT_ID=GOOGLE_PROJECT_ID`
			`GOOGLE_PROJECT_NUMBER=GOOGLE_PROJECT_NUMBER`