QuivrHQ/quivr
1
1
Fork 0
mirror of https://github.com/QuivrHQ/quivr.git synced 2024-12-15 01:21:48 +03:00
Code Issues Packages Projects Releases Wiki Activity
9e18514c37
quivr/.env.example

79 lines
2.6 KiB
Plaintext
Raw Normal View History

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
Patch 1 (#2388) # Description Two small comment changes in the .env file. One to reposition the main file comment to the top of the file and the other to add a comment to the OpenAI config line per https://github.com/QuivrHQ/quivr/issues/2384 ## Checklist before requesting a review - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [na] I have commented hard-to-understand areas
2024-03-30 04:55:42 +03:00
# This file is used to configure the Quivr stack. It is used by the `docker-compose.yml` file to configure the stack.
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
Patch 1 (#2388) # Description Two small comment changes in the .env file. One to reposition the main file comment to the top of the file and the other to add a comment to the OpenAI config line per https://github.com/QuivrHQ/quivr/issues/2384 ## Checklist before requesting a review - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [na] I have commented hard-to-understand areas
2024-03-30 04:55:42 +03:00
# OPENAI. Update this to use your API key. To skip OpenAI integration use a fake key, for example: tk-aabbccddAABBCCDDEeFfGgHhIiJKLmnopjklMNOPqQqQqQqQ
refacto(backend): poetry package manager and chat route refactoring (#2684) # Description - Added package manager - Added precommit checks - Rewrote dependency injection of Services and Repositories - Integrate async SQL alchemy engine - Migrate Chat repository to SQLModel - Migrated ChatHistory repository to SQLModel - User SQLModel - Unit test methodology with db rollback - Unit tests ChatRepository - Test ChatService get_history - Brain entity SQL Model - Promp SQLModel - Rewrite chat/{chat_id}/question route - updated docker files and docker compose in dev and production Added `quivr_core` subpackages: - Refactored KnowledgebrainQa - Added Rag service to interface with non-rag dependencies --------- Co-authored-by: aminediro <aminediro@github.com>
2024-06-26 10:58:55 +03:00
OPENAI_API_KEY=CHANGE_ME
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
Patch 1 (#2388) # Description Two small comment changes in the .env file. One to reposition the main file comment to the top of the file and the other to add a comment to the OpenAI config line per https://github.com/QuivrHQ/quivr/issues/2384 ## Checklist before requesting a review - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [na] I have commented hard-to-understand areas
2024-03-30 04:55:42 +03:00
# LOCAL
feat: 🎸 supabase migrated to supabase cli
2024-01-07 18:50:38 +03:00
# OLLAMA_API_BASE_URL=http://host.docker.internal:11434 # Uncomment to activate ollama. This is the local url for the ollama api
feat: 🎸 local all local in 60 seconds
2023-12-02 17:43:05 +03:00
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
########
# FRONTEND
########
NEXT_PUBLIC_ENV=local
NEXT_PUBLIC_BACKEND_URL=http://localhost:5050
feat: 🎸 supabase migrated to supabase cli
2024-01-07 18:50:38 +03:00
NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0
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
NEXT_PUBLIC_CMS_URL=https://cms.quivr.app
NEXT_PUBLIC_FRONTEND_URL=http://localhost:*
fix(front): Add NEXT_PUBLIC_AUTH_MODES to .env.example (#2570) This pull request adds the `NEXT_PUBLIC_AUTH_MODES` variable to the `.env.example` file. This variable allows the application to specify the authentication modes that are supported.
2024-05-10 10:17:19 +03:00
NEXT_PUBLIC_AUTH_MODES=password
feat: quivr core 0.1 (#2970) # Description # Testing backend ## Docker setup 1. Copy `.env.example` to `.env`. Some env variables were added : EMBEDDING_DIM 2. Apply supabase migratrions : ```sh supabase stop supabase db reset supabase start ``` 3. Start backend containers ``` make dev ``` ## Local setup You can also run backend without docker. 1. Install [`rye`](https://rye.astral.sh/guide/installation/). Choose the managed python version and set the version to 3.11 2. Run the following: ``` cd quivr/backend rye sync ``` 3. Source `.venv` virtual env : `source .venv/bin/activate` 4. Run the backend, make sure you are running redis and supabase API: ``` LOG_LEVEL=debug uvicorn quivr_api.main:app --log-level debug --reload --host 0.0.0.0 --port 5050 --workers 1 ``` Worker: ``` LOG_LEVEL=debug celery -A quivr_worker.celery_worker worker -l info -E --concurrency 1 ``` Notifier: ``` LOG_LEVEL=debug python worker/quivr_worker/celery_monitor.py ``` --------- Co-authored-by: chloedia <chloedaems0@gmail.com> Co-authored-by: aminediro <aminedirhoussi1@gmail.com> Co-authored-by: Antoine Dewez <44063631+Zewed@users.noreply.github.com> Co-authored-by: Chloé Daems <73901882+chloedia@users.noreply.github.com> Co-authored-by: Zewed <dewez.antoine2@gmail.com>
2024-09-02 11:20:53 +03:00
NEXT_PUBLIC_SHOW_TOKENS=false
feat: Add NEXT_PUBLIC_PROJECT_NAME environment variable (#3070) The `.env.example` and `Dockerfile` have been modified to include the `NEXT_PUBLIC_PROJECT_NAME` environment variable. This variable is used in the frontend code to display the project name dynamically.
2024-08-22 22:50:10 +03:00
#NEXT_PUBLIC_PROJECT_NAME=<project-name>
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
########
# BACKEND
########
feat: quivr api send notification (#2865) # Description - Quivr notification service. listens to celery events and updates knowledge status. - Process file notification will wait for retried tasks
2024-07-15 16:37:42 +03:00
LOG_LEVEL=INFO
feat: 🎸 supabase migrated to supabase cli
2024-01-07 18:50:38 +03:00
SUPABASE_URL=http://host.docker.internal:54321
SUPABASE_SERVICE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU
Update .env.example and backend/models/settings.py
2024-04-29 11:36:10 +03:00
PG_DATABASE_URL=postgresql://postgres:postgres@host.docker.internal:54322/postgres
refacto(backend): poetry package manager and chat route refactoring (#2684) # Description - Added package manager - Added precommit checks - Rewrote dependency injection of Services and Repositories - Integrate async SQL alchemy engine - Migrate Chat repository to SQLModel - Migrated ChatHistory repository to SQLModel - User SQLModel - Unit test methodology with db rollback - Unit tests ChatRepository - Test ChatService get_history - Brain entity SQL Model - Promp SQLModel - Rewrite chat/{chat_id}/question route - updated docker files and docker compose in dev and production Added `quivr_core` subpackages: - Refactored KnowledgebrainQa - Added Rag service to interface with non-rag dependencies --------- Co-authored-by: aminediro <aminediro@github.com>
2024-06-26 10:58:55 +03:00
PG_DATABASE_ASYNC_URL=postgresql+asyncpg://postgres:postgres@host.docker.internal:54322/postgres
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
ANTHROPIC_API_KEY=null
feat: 🎸 supabase migrated to supabase cli
2024-01-07 18:50:38 +03:00
JWT_SECRET_KEY=super-secret-jwt-token-with-at-least-32-characters-long
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
AUTHENTICATE=true
feat: 🎸 telemetry (#2169) # 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):
2024-02-08 07:44:37 +03:00
TELEMETRY_ENABLED=true
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
CELERY_BROKER_URL=redis://redis:6379/0
feat: 🎸 supabase migrated to supabase cli
2024-01-07 18:50:38 +03:00
CELEBRY_BROKER_QUEUE_NAME=quivr-preview.fifo
feat(assistants): Add PDF generation functionality and nice emails (#2436) This pull request adds PDF generation functionality and improves the formatting of emails. It includes a new module for generating PDFs using the fpdf2 library and updates the email templates to use markdown formatting for better readability. <!-- ELLIPSIS_HIDDEN --> ---- | <a href="https://ellipsis.dev" target="_blank"><img src="https://avatars.githubusercontent.com/u/80834858?s=400&u=31e596315b0d8f7465b3ee670f25cea677299c96&v=4" alt="Ellipsis" width="30px" height="30px"/></a> | :rocket: This PR description was created by [Ellipsis](https://www.ellipsis.dev) for commit ccecff77a5de9d8a975807862390efa5dbcfe8df. | |--------|--------| ### Summary: This PR introduces PDF generation functionality, improves email formatting, sanitizes filenames, updates various files and dependencies, and updates `docker-compose.dev.yml`. **Key points**: - Added PDF generation functionality using the `fpdf2` library - Improved email formatting - Sanitized filenames using the `unidecode` library - Updated `backend/modules/assistant/ito/ito.py` to generate PDFs and sanitize filenames - Added `pdf_generator.py` in `backend/modules/assistant/ito/utils/` for PDF generation - Updated `Pipfile` and `Pipfile.lock` in `backend/modules/assistant/ito/utils/` to include `unidecode` - Updated `requirements.txt` with new dependencies - Updated `docker-compose.dev.yml` ---- Generated with :heart: by [ellipsis.dev](https://www.ellipsis.dev) <!-- ELLIPSIS_HIDDEN -->
2024-04-17 16:00:31 +03:00
QUIVR_DOMAIN=http://localhost:3000/
Feat/auth-playground (#2605) # 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):
2024-05-21 23:20:35 +03:00
BACKEND_URL=http://localhost:5050
feat: quivr core 0.1 (#2970) # Description # Testing backend ## Docker setup 1. Copy `.env.example` to `.env`. Some env variables were added : EMBEDDING_DIM 2. Apply supabase migratrions : ```sh supabase stop supabase db reset supabase start ``` 3. Start backend containers ``` make dev ``` ## Local setup You can also run backend without docker. 1. Install [`rye`](https://rye.astral.sh/guide/installation/). Choose the managed python version and set the version to 3.11 2. Run the following: ``` cd quivr/backend rye sync ``` 3. Source `.venv` virtual env : `source .venv/bin/activate` 4. Run the backend, make sure you are running redis and supabase API: ``` LOG_LEVEL=debug uvicorn quivr_api.main:app --log-level debug --reload --host 0.0.0.0 --port 5050 --workers 1 ``` Worker: ``` LOG_LEVEL=debug celery -A quivr_worker.celery_worker worker -l info -E --concurrency 1 ``` Notifier: ``` LOG_LEVEL=debug python worker/quivr_worker/celery_monitor.py ``` --------- Co-authored-by: chloedia <chloedaems0@gmail.com> Co-authored-by: aminediro <aminedirhoussi1@gmail.com> Co-authored-by: Antoine Dewez <44063631+Zewed@users.noreply.github.com> Co-authored-by: Chloé Daems <73901882+chloedia@users.noreply.github.com> Co-authored-by: Zewed <dewez.antoine2@gmail.com>
2024-09-02 11:20:53 +03:00
EMBEDDING_DIM=1536
feat(reranker): Add flashrank and contextual compression retriever (#2480) This pull request adds the flashrank and contextual compression retriever to the codebase. The flashrank reranker model is used for compression, and the contextual compression retriever combines the base compressor and base retriever to improve document retrieval.
2024-04-24 20:44:31 +03:00
#COHERE_API_KEY=CHANGE_ME
chore(env): add deactivate stripe env variable (#2986) # 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):
2024-08-09 01:40:44 +03:00
DEACTIVATE_STRIPE=true
feat(reranker): Add flashrank and contextual compression retriever (#2480) This pull request adds the flashrank and contextual compression retriever to the codebase. The flashrank reranker model is used for compression, and the contextual compression retriever combines the base compressor and base retriever to improve document retrieval.
2024-04-24 20:44:31 +03:00
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>
feat(smtp&share): implemented smtp support and fixed share brain (#3049) completes ENT-53 & fixes ENT-52
2024-08-22 12:20:21 +03:00
# SMTP
QUIVR_SMTP_SERVER=smtp.example.com
QUIVR_SMTP_PORT=587
QUIVR_SMTP_USERNAME=username
QUIVR_SMTP_PASSWORD=password
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
CRAWL_DEPTH=1
PREMIUM_MAX_BRAIN_NUMBER=30
PREMIUM_MAX_BRAIN_SIZE=10000000
PREMIUM_DAILY_CHAT_CREDIT=100
feat(brave-search): Update GPT4Brain tools and add WebSearchTool (#2576) # 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):
2024-05-10 13:22:15 +03:00
# BRAVE SEARCH API KEY
Update BRAVE_SEARCH_API_KEY in .env.example
2024-05-11 17:56:54 +03:00
BRAVE_SEARCH_API_KEY=CHANGE_ME
Feat/auth-playground (#2605) # 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):
2024-05-21 23:20:35 +03:00
# GOOGLE DRIVE
GOOGLE_CLIENT_ID=your-client-id
GOOGLE_CLIENT_SECRET=your-client-secret
GOOGLE_PROJECT_ID=your-project-id
GOOGLE_AUTH_URI=https://accounts.google.com/o/oauth2/auth
GOOGLE_TOKEN_URI=https://oauth2.googleapis.com/token
GOOGLE_AUTH_PROVIDER_CERT_URL=https://www.googleapis.com/oauth2/v1/certs
GOOGLE_REDIRECT_URI=http://localhost
# SHAREPOINT
SHAREPOINT_CLIENT_ID=your-client-id
Reference in New Issue Copy Permalink