Skip to content

An AI-powered search engine with a generative UI

Merge pull request #397 from miurla/update-env-example

Yoshiki Miurab74b7bc9d4a4
diff --cc .env.local.example
index ce0b399d,175ab933..c4eb0e8e
--- a/.env.local.example
+++ b/.env.local.example
@@@ -4,73 -6,79 +6,79 @@@
# OpenAI API key retrieved here: https://platform.openai.com/api-keys
OPENAI_API_KEY=[YOUR_OPENAI_API_KEY]
- # Tavily API Key retrieved here: https://app.tavily.com/home
- TAVILY_API_KEY=[YOUR_TAVILY_API_KEY]
+ # Search Configuration
+ TAVILY_API_KEY=[YOUR_TAVILY_API_KEY] # Get your API key at: https://app.tavily.com/home
- # Redis Configuration
- USE_LOCAL_REDIS=false
- LOCAL_REDIS_URL=redis://localhost:6379 # or redis://redis:6379 if you're using docker compose
+ ###############################################################################
+ # Optional Features
+ # Enable these features by uncommenting and configuring the settings below
+ ###############################################################################
- # Upstash Redis URL and Token retrieved here: https://console.upstash.com/redis
- UPSTASH_REDIS_REST_URL=[YOUR_UPSTASH_REDIS_REST_URL]
- UPSTASH_REDIS_REST_TOKEN=[YOUR_UPSTASH_REDIS_REST_TOKEN]
+ #------------------------------------------------------------------------------
+ # Chat History Storage
+ # Enable persistent chat history across sessions
+ #------------------------------------------------------------------------------
+ # NEXT_PUBLIC_ENABLE_SAVE_CHAT_HISTORY=true # enable chat history storage
- # SearXNG Configuration
- SEARXNG_API_URL=http://localhost:8080 # Replace with your local SearXNG API URL or docker http://searxng:8080
- SEARCH_API=tavily # use searxng, tavily or exa
- SEARXNG_SECRET="" # generate a secret key e.g. openssl rand -base64 32
- SEARXNG_PORT=8080 # default port
- SEARXNG_BIND_ADDRESS=0.0.0.0 # default address
- SEARXNG_IMAGE_PROXY=true # enable image proxy
- SEARXNG_LIMITER=false # can be enabled to limit the number of requests per IP address
- SEARXNG_DEFAULT_DEPTH=basic # Set to 'basic' or 'advanced', only affects SearXNG searches
- SEARXNG_MAX_RESULTS=50 # Maximum number of results to return from SearXNG
- SEARXNG_ENGINES=google,bing,duckduckgo,wikipedia # Search engines to use
- SEARXNG_TIME_RANGE=None # Time range for search results: day, week, month, year, or None (for all time)
- SEARXNG_SAFESEARCH=0 # Safe search setting: 0 (off), 1 (moderate), 2 (strict)
+ # Redis Configuration (Required if NEXT_PUBLIC_ENABLE_SAVE_CHAT_HISTORY=true)
+ # Choose between local Redis or Upstash Redis
+ # OPTION 1: Local Redis
+ # USE_LOCAL_REDIS=false # use local Redis
+ # LOCAL_REDIS_URL=redis://localhost:6379 # local Redis URL (if USE_LOCAL_REDIS=true)
- #NEXT_PUBLIC_BASE_URL=http://localhost:3000
-
- # Optional
- # The settings below can be used optionally as needed.
+ # OPTION 2: Upstash Redis (Recommended for production)
+ # UPSTASH_REDIS_REST_URL=[YOUR_UPSTASH_REDIS_REST_URL] # Upstash Redis REST URL (if USE_LOCAL_REDIS=false)
+ # UPSTASH_REDIS_REST_TOKEN=[YOUR_UPSTASH_REDIS_REST_TOKEN] # Upstash Redis REST Token (if USE_LOCAL_REDIS=false)
+ #------------------------------------------------------------------------------
# Additional AI Providers
- # Uncomment and configure the API keys below to enable other AI providers.
- # Each provider requires its own API key and configuration.
-
- # Google Generative AI API key retrieved here: https://aistudio.google.com/app/apikey
+ # Enable alternative AI models by configuring these providers
+ #------------------------------------------------------------------------------
+ # Google Generative AI
# GOOGLE_GENERATIVE_AI_API_KEY=[YOUR_GOOGLE_GENERATIVE_AI_API_KEY]
- # Anthropic API key retrieved here: https://console.anthropic.com/settings/keys
+ # Anthropic (Claude)
# ANTHROPIC_API_KEY=[YOUR_ANTHROPIC_API_KEY]
- # Groq API key retrieved here: https://console.groq.com/keys
+ # Groq
# GROQ_API_KEY=[YOUR_GROQ_API_KEY]
- # If you want to use Ollama, set the base URL here.
+ # Ollama (Local AI)
# OLLAMA_BASE_URL=http://localhost:11434
- # Azure OpenAI API key retrieved here: https://oai.azure.com/resource/deployments/
+ # Azure OpenAI
# AZURE_API_KEY=
- # The resource name is used in the assembled URL: https://{resourceName}.openai.azure.com/openai/deployments/{modelId}{path}.
# AZURE_RESOURCE_NAME=
- # The deployment name is the name of the Azure OpenAI deployment you want to use.
# NEXT_PUBLIC_AZURE_DEPLOYMENT_NAME=
-
# OpenAI Compatible Model
- # Note: Only models with tool-use capabilities can be used
- # NEXT_PUBLIC_OPENAI_COMPATIBLE_MODEL=[YOUR_OPENAI_COMPATIBLE_MODEL]
- # OPENAI_COMPATIBLE_API_KEY=[YOUR_OPENAI_COMPATIBLE_API_KEY]
- # OPENAI_COMPATIBLE_API_BASE_URL=[YOUR_OPENAI_COMPATIBLE_API_BASE_URL]
-
- # enable the share feature
- # If you enable this feature, separate account management implementation is required.
- # ENABLE_SHARE=true
-
- # enable the video search tool
- # Serper API Key retrieved here: https://serper.dev/api-key
- # SERPER_API_KEY=[YOUR_SERPER_API_KEY]
-
- # If you want to use Jina instead of Tavily for retrieve tool, enable the following variables.
- # JINA_API_KEY=[YOUR_JINA_API_KEY]
+ # NEXT_PUBLIC_OPENAI_COMPATIBLE_MODEL=
+ # OPENAI_COMPATIBLE_API_KEY=
+ # OPENAI_COMPATIBLE_API_BASE_URL=
+
+ #------------------------------------------------------------------------------
+ # Alternative Search Providers
+ # Configure different search backends (default: Tavily)
+ #------------------------------------------------------------------------------
+ # SEARCH_API=searxng # Available options: tavily, searxng, exa
+
+ # SearXNG Configuration (Required if SEARCH_API=searxng)
-# SEARXNG_API_URL=http://localhost:8080
++# SEARXNG_API_URL=http://localhost:8080 # Replace with your local SearXNG API URL or docker http://searxng:8080
+ # SEARXNG_SECRET="" # generate a secret key e.g. openssl rand -base64 32
+ # SEARXNG_PORT=8080
+ # SEARXNG_BIND_ADDRESS=0.0.0.0
+ # SEARXNG_IMAGE_PROXY=true
+ # SEARXNG_LIMITER=false
+ # SEARXNG_DEFAULT_DEPTH=basic
+ # SEARXNG_MAX_RESULTS=50
+ # SEARXNG_ENGINES=google,bing,duckduckgo,wikipedia
+ # SEARXNG_TIME_RANGE=None
+ # SEARXNG_SAFESEARCH=0
+
+ #------------------------------------------------------------------------------
+ # Additional Features
+ # Enable extra functionality as needed
+ #------------------------------------------------------------------------------
+ # NEXT_PUBLIC_ENABLE_SHARE=true # Enable sharing of chat conversations
+ # SERPER_API_KEY=[YOUR_SERPER_API_KEY] # Enable video search capability
+ # JINA_API_KEY=[YOUR_JINA_API_KEY] # Alternative to Tavily for retrieve tool