diff --git a/.dockerignore b/.dockerignore index f04f41d98c40..e07e90e6a9e6 100644 --- a/.dockerignore +++ b/.dockerignore @@ -8,3 +8,4 @@ scripts docs .github *.md +.env.example diff --git a/.env.example b/.env.example new file mode 100644 index 000000000000..7fe16e78031d --- /dev/null +++ b/.env.example @@ -0,0 +1,42 @@ +# add a access code to lock your lobe-chat application, it should be a six length string +ACCESS_CODE=lobe66 + +# only choose one from OpenAI Service and Azure OpenAI Service + +######################################## +############ OpenAI Service ############ +######################################## + +# you openai api key +OPENAI_API_KEY=sk-xxxxxxxxx + +# use a proxy to connect to the OpenAI API +# OPENAI_PROXY_URL=https://api.openai.com/v1 + +######################################## +######### Azure OpenAI Service ######### +######################################## +# you can learn azure OpenAI Service on https://learn.microsoft.com/en-us/azure/ai-services/openai/overview + +# use Azure OpenAI Service by uncomment the following line +# USE_AZURE_OPENAI=1 + +# The API key you applied for on the Azure OpenAI account page, which can be found in the "Keys and Endpoints" section. +# AZURE_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + +# The endpoint you applied for on the Azure OpenAI account page, which can be found in the "Keys and Endpoints" section. +# OPENAI_PROXY_URL=https://docs-test-001.openai.azure.com + +# Azure's API version, follows the YYYY-MM-DD format +# AZURE_API_VERSION=2023-08-01-preview + +######################################## +############ Market Service ############ +######################################## + +# The LobeChat plugins market index url +# PLUGINS_INDEX_URL=https://chat-plugins.lobehub.com + +# The LobeChat agents market index url +# AGENTS_INDEX_URL=https://chat-agents.lobehub.com +