search

IDinsight / ask-a-question

Trustworthy question-answering AI plugin for chatbots in the social sector with advanced content performance analysis.
https://ask-a-question.com
BSD 3-Clause "New" or "Revised" License
28 stars 4 forks source link

[AAQ-730] Improve dev & deployment experience #360

Closed suzinyou closed 2 months ago

suzinyou commented 3 months ago

Reviewer: @lickem22 Estimate: 1 hr (30 min for testing, 30 min for guidance on resolving merge conflict)

Ticket

Fixes: https://idinsight.atlassian.net/browse/AAQ-730

Description

Goal

  1. Make it as easy as possible to get started with local set up
  2. Make it as clear as possible what needs to change for production
  3. Consolidate sources of truth for configurations

Changes

  1. Breaks down old template.env into template.common.env, template.core_backend.env, and template.litellm_proxy.env. These are to be copied as .common.env, .core_backend.env, and .litellm_proxy.env respectively
  2. Updates Makefile and docker-compose.yml to use these as sources of truth.
  3. Updates documentation
image image

Other changes

  1. Removes ON_OFF_TOPIC rail
  2. Renames USER1_... to ADMIN_... for clarity

Future Tasks (optional)

How has this been tested?

  1. Followed the instructions from start to finish in Quick setup page (localhost link: http://localhost:8080/deployment/quick-setup/)
  2. Followed Steps 2 ~ 3, both docker compose & manual methods in Setup page: http://localhost:8080/develop/setup/
  3. Review the contents of http://localhost:8080/deployment/config-options/

To-do before merge (optional)

Checklist

Fill with x for completed.

(Delete any items below that are not relevant)