-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from datakind/maint/documentation_updates
Documentation improvements for first ship
- Loading branch information
Showing
5 changed files
with
162 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,29 +23,19 @@ DOMAIN_SERVER=http://localhost:3080 | |
|
|
||
| NO_INDEX=true | ||
|
|
||
| Connection string for where the data DB resides. Can be remove or local DB (Remote) | ||
| #POSTGRES_DATA_HOST=postgres-prototypes.postgres.database.azure.com | ||
| #POSTGRES_DATA_PORT=5432 | ||
| #POSTGRES_DATA_DB=hdexpert-alpha | ||
| #POSTGRES_DATA_USER=bots_rule3 | ||
| #POSTGRES_DATA_PASSWORD=96__Mou9!2Yl | ||
|
|
||
| # Only used in deployment | ||
| REMOTE_DB_CONN_STRING=postgresql://<LOGIN GOES HERE>:<PASWORD HERE>@<HOST>:<PORT>/<DATABASE> | ||
|
|
||
| # =========== Local Docker containers START ========== | ||
| POSTGRES_DATA_HOST=postgres-prototypes.postgres.database.azure.com | ||
| POSTGRES_DATA_HOST=datadb | ||
| POSTGRES_DATA_PORT=5432 | ||
| POSTGRES_DATA_DB=hdexpert-alpha | ||
| POSTGRES_DATA_USER= | ||
| POSTGRES_DATA_PASSWORD= | ||
| POSTGRES_DATA_DB=data | ||
| POSTGRES_DATA_USER=postgres | ||
| POSTGRES_DATA_PASSWORD=password123 | ||
| DATA_DB_CONN_STRING=postgresql://${POSTGRES_DATA_USER}:${POSTGRES_DATA_PASSWORD}@${POSTGRES_DATA_HOST}:${POSTGRES_DATA_PORT}/${POSTGRES_DATA_DB} | ||
|
|
||
| POSTGRES_RECIPE_HOST=recipedb | ||
| POSTGRES_RECIPE_PORT=5432 | ||
| POSTGRES_RECIPE_DB=recipes | ||
| POSTGRES_RECIPE_USER= | ||
| POSTGRES_RECIPE_PASSWORD= | ||
| POSTGRES_RECIPE_DB=recipe | ||
| POSTGRES_RECIPE_USER=postgres | ||
| POSTGRES_RECIPE_PASSWORD=password123 | ||
| RECIPE_DB_CONN_STRING=postgresql://${POSTGRES_RECIPE_USER}:${POSTGRES_RECIPE_PASSWORD}@${POSTGRES_RECIPE_HOST}:${POSTGRES_RECIPE_PORT}/${POSTGRES_RECIPE_DB} | ||
| # =========== Local Docker containers END ========== | ||
|
|
||
|
|
@@ -56,23 +46,32 @@ CONFIG_PATH="/app/librechat.yaml" | |
| #==================================================# | ||
| RECIPES_OPENAI_API_TYPE=azure | ||
| RECIPES_OPENAI_API_KEY= | ||
| RECIPES_OPENAI_API_ENDPOINT= | ||
| RECIPES_OPENAI_API_ENDPOINT=https://<eg Azure openai component name>.openai.azure.com/ | ||
| RECIPES_OPENAI_API_VERSION=2024-02-15-preview | ||
| RECIPES_BASE_URL= | ||
| RECIPES_BASE_URL=${RECIPES_OPENAI_API_ENDPOINT} | ||
| RECIPES_MODEL=gpt-4-turbo | ||
| RECIPES_OPENAI_TEXT_COMPLETION_DEPLOYMENT_NAME=text-embedding-ada-002 | ||
|
|
||
|
|
||
| #==================================================# | ||
| # Needed for displaying images # | ||
| #==================================================# | ||
| # Replace with actual hostname if configring for deployment | ||
| IMAGE_HOST=http://localhost:3080/images | ||
|
|
||
| #==================================================# | ||
| # Deployment to Azure # | ||
| # (Only needed if deploying to Azure) # | ||
| #==================================================# | ||
| AZURE_CONTAINER_REGISTRY= | ||
| AZURE_CONTAINER_REGISTRY_USERNAME= | ||
| AZURE_CONTAINER_REGISTRY_USERNAME=d | ||
|
|
||
| #==================================================# | ||
| # API Settings # | ||
| #==================================================# | ||
| # To get this go to https://stage.hapi-humdata-org.ahconu.org/docs#/, | ||
| # select the the encode_identifier endpoint, click the 'Try it out' button, | ||
| # Enter a name and you email and click send. The response will have your token. | ||
| HAPI_API_TOKEN= | ||
|
|
||
| #===============# | ||
| # JSON Logging # | ||
|
|
@@ -92,8 +91,8 @@ DEBUG_CONSOLE=false | |
| # Permissions # | ||
| #=============# | ||
|
|
||
| #UID=1000 | ||
| #GID=1000 | ||
| UID=1000 | ||
| GID=1000 | ||
|
|
||
| #===============# | ||
| # Configuration # | ||
|
|
@@ -106,9 +105,7 @@ DEBUG_CONSOLE=false | |
| # Endpoints # | ||
| #===================================================# | ||
|
|
||
| # ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,google,gptPlugins,anthropic | ||
|
|
||
| PROXY= | ||
| # See ui/recipes-chat/librechat.yaml | ||
|
|
||
| #===================================# | ||
| # Known Endpoints - librechat.yaml # | ||
|
|
@@ -138,21 +135,6 @@ ANTHROPIC_API_KEY= | |
|
|
||
| AZURE_API_KEY_ENV= | ||
|
|
||
| # Note: these variables are DEPRECATED | ||
| # Use the `librechat.yaml` configuration for `azureOpenAI` instead | ||
| # You may also continue to use them if you opt out of using the `librechat.yaml` configuration | ||
|
|
||
| #AZURE_OPENAI_DEFAULT_MODEL=gpt-3.5-turbo # Deprecated | ||
| #AZURE_OPENAI_MODELS=gpt-35-turbo,gpt-4 | ||
| # AZURE_USE_MODEL_AS_DEPLOYMENT_NAME=TRUE | ||
| # AZURE_API_KEY= # Deprecated | ||
| #AZURE_OPENAI_API_INSTANCE_NAME=DK-DS-Team | ||
| #AZURE_OPENAI_API_DEPLOYMENT_NAME=gpt-4 | ||
| #AZURE_OPENAI_API_VERSION=2023-07-01-preview | ||
| # AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME= # Deprecated | ||
| # AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME= # Deprecated | ||
| #PLUGINS_USE_AZURE="true" # Deprecated | ||
|
|
||
| #============# | ||
| # BingAI # | ||
| #============# | ||
|
|
@@ -172,8 +154,7 @@ GOOGLE_KEY=user_provided | |
| # OpenAI # | ||
| #============# | ||
|
|
||
| OPENAI_API_KEY=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 | ||
| # OPENAI_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k | ||
| OPENAI_API_KEY= | ||
|
|
||
| DEBUG_OPENAI=false | ||
|
|
||
|
|
@@ -193,14 +174,16 @@ DEBUG_OPENAI=false | |
| # Assistants API # | ||
| #====================# | ||
|
|
||
| # This can be your Azure, or Open AI key | ||
| ASSISTANTS_API_KEY= | ||
|
|
||
| # Needed when updating an assistant, see assistants/openai_assistants. Leave blank to create new | ||
| # Needed when creating/updating an assistant using assistants/openai_assistants/create_update_assistant.py. | ||
| ASSISTANTS_API_TYPE=azure | ||
| # Leave blank to create new assistant, otherwise put assistant ID here to update existing | ||
| ASSISTANTS_ID= | ||
| ASSISTANTS_BASE_URL= | ||
| ASSISTANTS_API_VERSION= | ||
| ASSISTANTS_MODEL= | ||
| ASSISTANTS_BASE_URL=https://<eg your Azure openai component name>.openai.azure.com/ | ||
| ASSISTANTS_API_VERSION=2024-02-15-preview | ||
| ASSISTANTS_MODEL=gpt-4-turbo | ||
| ASSISTANTS_BOT_NAME= | ||
|
|
||
| #============# | ||
|
|
@@ -222,14 +205,14 @@ CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb | |
|
|
||
| # Azure AI Search | ||
| #----------------- | ||
| AZURE_AI_SEARCH_SERVICE_ENDPOINT= | ||
| AZURE_AI_SEARCH_INDEX_NAME= | ||
| AZURE_AI_SEARCH_API_KEY= | ||
| # AZURE_AI_SEARCH_SERVICE_ENDPOINT= | ||
| # AZURE_AI_SEARCH_INDEX_NAME= | ||
| # AZURE_AI_SEARCH_API_KEY= | ||
|
|
||
| AZURE_AI_SEARCH_API_VERSION= | ||
| AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE= | ||
| AZURE_AI_SEARCH_SEARCH_OPTION_TOP= | ||
| AZURE_AI_SEARCH_SEARCH_OPTION_SELECT= | ||
| # AZURE_AI_SEARCH_API_VERSION= | ||
| # AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE= | ||
| # AZURE_AI_SEARCH_SEARCH_OPTION_TOP= | ||
| # AZURE_AI_SEARCH_SEARCH_OPTION_SELECT= | ||
|
|
||
| # DALL·E | ||
| #---------------- | ||
|
|
@@ -250,32 +233,32 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT= | |
|
|
||
| #----------------- | ||
| GOOGLE_API_KEY= | ||
| GOOGLE_CSE_ID= | ||
| #GOOGLE_API_KEY= | ||
| #GOOGLE_CSE_ID= | ||
|
|
||
| # SerpAPI | ||
| #----------------- | ||
| SERPAPI_API_KEY= | ||
| #SERPAPI_API_KEY= | ||
|
|
||
| # Stable Diffusion | ||
| #----------------- | ||
| SD_WEBUI_URL=http://host.docker.internal:7860 | ||
|
|
||
| # Tavily | ||
| #----------------- | ||
| TAVILY_API_KEY= | ||
| #TAVILY_API_KEY= | ||
|
|
||
| # Traversaal | ||
| #----------------- | ||
| TRAVERSAAL_API_KEY= | ||
| #TRAVERSAAL_API_KEY= | ||
|
|
||
| # WolframAlpha | ||
| #----------------- | ||
| WOLFRAM_APP_ID= | ||
| #WOLFRAM_APP_ID= | ||
|
|
||
| # Zapier | ||
| #----------------- | ||
| ZAPIER_NLA_API_KEY= | ||
| #ZAPIER_NLA_API_KEY= | ||
|
|
||
| #==================================================# | ||
| # Search # | ||
|
|
@@ -295,7 +278,7 @@ MEILI_MASTER_KEY=DrhYf7zENyR6AlUCKmnz0eYASOQdl6zxH7s7MKFSfFCt | |
| #========================# | ||
|
|
||
| OPENAI_MODERATION=false | ||
| OPENAI_MODERATION_API_KEY= | ||
| #OPENAI_MODERATION_API_KEY= | ||
| # OPENAI_MODERATION_REVERSE_PROXY= | ||
|
|
||
| BAN_VIOLATIONS=true | ||
|
|
@@ -341,78 +324,78 @@ ALLOW_REGISTRATION=true | |
| ALLOW_SOCIAL_LOGIN=false | ||
| ALLOW_SOCIAL_REGISTRATION=false | ||
|
|
||
| SESSION_EXPIRY=1000 * 60 * 15 | ||
| REFRESH_TOKEN_EXPIRY=(1000 * 60 * 60 * 24) * 7 | ||
| SESSION_EXPIRY=10000 * 60 * 15 | ||
| REFRESH_TOKEN_EXPIRY=(10000 * 60 * 60 * 24) * 7 | ||
|
|
||
| JWT_SECRET=16f8c0ef4a5d391b26034086c628469d3f9f497f08163ab9b40137092f2909ef | ||
| JWT_REFRESH_SECRET=eaa5191f2914e30b9387fd84e254e4ba6fc51b4654968a9b0803b456a54b8418 | ||
|
|
||
| # Discord | ||
| DISCORD_CLIENT_ID= | ||
| DISCORD_CLIENT_SECRET= | ||
| DISCORD_CALLBACK_URL=/oauth/discord/callback | ||
| #DISCORD_CLIENT_ID= | ||
| #DISCORD_CLIENT_SECRET= | ||
| #DISCORD_CALLBACK_URL=/oauth/discord/callback | ||
|
|
||
| FACEBOOK_CLIENT_ID= | ||
| FACEBOOK_CLIENT_SECRET= | ||
| FACEBOOK_CALLBACK_URL=/oauth/facebook/callback | ||
| # FACEBOOK_CLIENT_ID= | ||
| # FACEBOOK_CLIENT_SECRET= | ||
| # FACEBOOK_CALLBACK_URL=/oauth/facebook/callback | ||
|
|
||
| # GitHub | ||
| GITHUB_CLIENT_ID= | ||
| GITHUB_CLIENT_SECRET= | ||
| GITHUB_CALLBACK_URL=/oauth/github/callback | ||
| # GITHUB_CLIENT_ID= | ||
| # GITHUB_CLIENT_SECRET= | ||
| # GITHUB_CALLBACK_URL=/oauth/github/callback | ||
|
|
||
| GOOGLE_CLIENT_ID= | ||
| GOOGLE_CLIENT_SECRET= | ||
| GOOGLE_CALLBACK_URL=/oauth/google/callback | ||
| # GOOGLE_CLIENT_ID= | ||
| # GOOGLE_CLIENT_SECRET= | ||
| # GOOGLE_CALLBACK_URL=/oauth/google/callback | ||
|
|
||
| # OpenID | ||
| OPENID_CLIENT_ID= | ||
| OPENID_CLIENT_SECRET= | ||
| OPENID_ISSUER= | ||
| OPENID_SESSION_SECRET= | ||
| OPENID_SCOPE="openid profile email" | ||
| OPENID_CALLBACK_URL=/oauth/openid/callback | ||
| OPENID_REQUIRED_ROLE= | ||
| OPENID_REQUIRED_ROLE_TOKEN_KIND= | ||
| OPENID_REQUIRED_ROLE_PARAMETER_PATH= | ||
|
|
||
| OPENID_BUTTON_LABEL= | ||
| OPENID_IMAGE_URL= | ||
| # OPENID_CLIENT_ID= | ||
| # OPENID_CLIENT_SECRET= | ||
| # OPENID_ISSUER= | ||
| # OPENID_SESSION_SECRET= | ||
| # OPENID_SCOPE="openid profile email" | ||
| # OPENID_CALLBACK_URL=/oauth/openid/callback | ||
| # OPENID_REQUIRED_ROLE= | ||
| # OPENID_REQUIRED_ROLE_TOKEN_KIND= | ||
| # OPENID_REQUIRED_ROLE_PARAMETER_PATH= | ||
|
|
||
| # OPENID_BUTTON_LABEL= | ||
| # OPENID_IMAGE_URL= | ||
|
|
||
| #========================# | ||
| # Email Password Reset # | ||
| #========================# | ||
|
|
||
| EMAIL_SERVICE= | ||
| EMAIL_HOST= | ||
| EMAIL_PORT=25 | ||
| EMAIL_ENCRYPTION= | ||
| EMAIL_ENCRYPTION_HOSTNAME= | ||
| EMAIL_ALLOW_SELFSIGNED= | ||
| EMAIL_USERNAME= | ||
| EMAIL_PASSWORD= | ||
| EMAIL_FROM_NAME= | ||
| EMAIL_FROM=[email protected] | ||
| # EMAIL_SERVICE= | ||
| # EMAIL_HOST= | ||
| # EMAIL_PORT=25 | ||
| # EMAIL_ENCRYPTION= | ||
| # EMAIL_ENCRYPTION_HOSTNAME= | ||
| # EMAIL_ALLOW_SELFSIGNED= | ||
| # EMAIL_USERNAME= | ||
| # EMAIL_PASSWORD= | ||
| # EMAIL_FROM_NAME= | ||
| # [email protected] | ||
|
|
||
| #========================# | ||
| # Firebase CDN # | ||
| #========================# | ||
|
|
||
| FIREBASE_API_KEY= | ||
| FIREBASE_AUTH_DOMAIN= | ||
| FIREBASE_PROJECT_ID= | ||
| FIREBASE_STORAGE_BUCKET= | ||
| FIREBASE_MESSAGING_SENDER_ID= | ||
| FIREBASE_APP_ID= | ||
| # FIREBASE_API_KEY= | ||
| # FIREBASE_AUTH_DOMAIN= | ||
| # FIREBASE_PROJECT_ID= | ||
| # FIREBASE_STORAGE_BUCKET= | ||
| # FIREBASE_MESSAGING_SENDER_ID= | ||
| # FIREBASE_APP_ID= | ||
|
|
||
| #===================================================# | ||
| # UI # | ||
| #===================================================# | ||
|
|
||
| APP_TITLE=LibreChat | ||
| # CUSTOM_FOOTER="My custom footer" | ||
| APP_TITLE=Humanitarian AI Assistant | ||
| CUSTOM_FOOTER=Humanitarian AI Assistant | ||
| HELP_AND_FAQ_URL=https://www.datakind.org/privacy-policy/ | ||
|
|
||
| # SHOW_BIRTHDAY_ICON=true | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.