SurfSense---Backend
Docker 应用程序 from grtgbln's Repository
概述
This is the backend container.
要求
Requires separate SurfSense - Frontend, SurfSense - Worker, pgAdmin4, pgvector, electric and Redis containers. See documentation: https://github.com/MODSetter/SurfSense/blob/main/DOCKER_SETUP.md#deployment-options
运行时参数
- 网络用户界面
http://[IP]:[PORT:8000]/- 网络
bridge- 特权
- false
模板配置
Container Port: 8000
- 目标
- 8000
- 默认值
- 3001
- 价值
- 3001
URL of the PostgreSQL database, including port and credentials
- 目标
- DATABASE_URL
- 默认值
- postgresql+asyncpg://USERNAME:PASSWORD@IP_ADDRESS:5432/surfsense
- 价值
- postgresql+asyncpg://USERNAME:PASSWORD@IP_ADDRESS:5432/surfsense
JWT Secret key for authentication (should be a secure random string)
- 目标
- SECRET_KEY
URL of the frontend service, including port
- 目标
- NEXT_FRONTEND_URL
- 默认值
- http://MY_IP_ADDRESS:3000
- 价值
- http://MY_IP_ADDRESS:3000
Authentication type (Google OAuth or local email/password)
- 目标
- AUTH_TYPE
- 默认值
- LOCAL|GOOGLE
Google OAuth Client ID. Required if AUTH_TYPE is set to GOOGLE.
- 目标
- GOOGLE_OAUTH_CLIENT_ID
Google OAuth Client Secret. Required if AUTH_TYPE is set to GOOGLE.
- 目标
- GOOGLE_OAUTH_CLIENT_SECRET
Redirect URI for Google Calendar OAuth. Must match the one set in Google Cloud Console.
- 目标
- GOOGLE_CALENDAR_REDIRECT_URI
- 默认值
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/calendar/connector/callback
- 价值
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/calendar/connector/callback
Redirect URI for Google Gmail OAuth. Must match the one set in Google Cloud Console.
- 目标
- GOOGLE_GMAIL_REDIRECT_URI
- 默认值
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/gmail/connector/callback
- 价值
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/gmail/connector/callback
AirTable OAuth Client ID. Required if using AirTable connector.
- 目标
- AIRTABLE_CLIENT_ID
AirTable OAuth Client Secret. Required if using AirTable connector.
- 目标
- AIRTABLE_CLIENT_SECRET
Redirect URI for AirTable OAuth. Must match the one set in AirTable developer console.
- 目标
- AIRTABLE_REDIRECT_URI
- 默认值
- http://MY_IP_ADDRESS:8000/api/v1/auth/airtable/connector/callback
- 价值
- http://MY_IP_ADDRESS:8000/api/v1/auth/airtable/connector/callback
Name of the embedding model (e.g., openai://text-embedding-ada-002, anthropic://claude-v1, mixedbread-ai/mxbai-embed-large-v1)
- 目标
- EMBEDDING_MODEL
- 默认值
- mixedbread-ai/mxbai-embed-large-v1
- 价值
- mixedbread-ai/mxbai-embed-large-v1
Name of the reranker model (e.g., ms-marco-MiniLM-L-12-v2)
- 目标
- RERANKERS_MODEL_NAME
- 默认值
- ms-marco-MiniLM-L-12-v2
- 价值
- ms-marco-MiniLM-L-12-v2
Type of reranker model (e.g., flashrank)
- 目标
- RERANKERS_MODEL_TYPE
- 默认值
- flashrank
- 价值
- flashrank
Text-to-Speech API provider for Podcasts (e.g., openai/tts-1, azure/neural, vertex_ai/). See documentation: https://docs.litellm.ai/docs/text_to_speech#supported-providers
- 目标
- TTS_SERVICE
- 默认值
- openai/tts-1
- 价值
- openai/tts-1
Base URL for the Text To Speech API. Optional, leave empty to use default.
- 目标
- TTS_SERVICE_API_BASE
API Key for the Text To Speech API provider. Required if the provider needs authentication.
- 目标
- TTS_SERVICE_API_KEY
Speech-to-Text API provider for Podcasts (e.g., openai/whisper-1, local). See documentation: https://docs.litellm.ai/docs/audio_transcription#supported-providers
- 目标
- STT_SERVICE
- 默认值
- openai/whisper-1
- 价值
- openai/whisper-1
Local Whisper model size to use if STT_SERVICE is set to local.
- 目标
- LOCAL_STT_MODEL
- 默认值
- base|tiny|small|medium|large-v3
Base URL for the Speech To Text API. Optional, leave empty to use default.
- 目标
- STT_SERVICE_API_BASE
API Key for the Speech To Text API provider. Required if the provider needs authentication.
- 目标
- STT_SERVICE_API_KEY
API key for Firecrawl service for web crawling
- 目标
- FIRECRAWL_API_KEY
Document parsing service
- 目标
- ETL_SERVICE
- 默认值
- UNSTRUCTURED|LLAMACLOUD|DOCLING
API key for Unstructured.io service for document parsing. Required if ETL Service is set to UNSTRUCTURED
- 目标
- UNSTRUCTURED_API_KEY
API key for LlamaCloud service for document parsing. Required if ETL Service is set to LLAMACLOUD
- 目标
- LLAMA_CLOUD_API_KEY
URL of the Redis instance used as Celery broker, including port
- 目标
- CELERY_BROKER_URL
- 默认值
- redis://MY_IP_ADDRESS:6379/0
- 价值
- redis://MY_IP_ADDRESS:6379/0
URL of the Redis instance used as Celery result backend, including port. Must match CELERY_BROKER_URL
- 目标
- CELERY_RESULT_BACKEND
- 默认值
- redis://MY_IP_ADDRESS:6379/0
- 价值
- redis://MY_IP_ADDRESS:6379/0
Electric database user
- 目标
- ELECTRIC_DB_USER
- 默认值
- electric
- 价值
- electric
Electric database password
- 目标
- ELECTRIC_DB_PASSWORD
- 默认值
- electric_password
- 价值
- electric_password
Path to store app data. Must match Worker
- 目标
- /app
- 默认值
- /mnt/user/appdata/surfsense/backend/data
- 价值
- /mnt/user/appdata/surfsense/backend/data
Path to store temporary data. Must be shared between containers.
- 目标
- /tmp
- 默认值
- /mnt/user/appdata/surfsense/shared/tmp
- 价值
- /mnt/user/appdata/surfsense/shared/tmp
Enable LangSmith tracing.
- 目标
- LANGSMITH_TRACING
- 默认值
- false
- 价值
- false
LangSmith API endpoint. Default is https://api.smith.langchain.com, change only if you know what you're doing.
- 目标
- LANGSMITH_ENDPOINT
- 默认值
- https://api.smith.langchain.com
- 价值
- https://api.smith.langchain.com
LangSmith project name.
- 目标
- LANGSMITH_PROJECT
API key for LangSmith tracing. Required if LANGSMITH_TRACING is enabled.
- 目标
- LANGSMITH_API_KEY
Uvicorn host address. Not recommended to change.
- 目标
- UVICORN_HOST
- 默认值
- 0.0.0.0
- 价值
- 0.0.0.0
Uvicorn port. Not recommended to change.
- 目标
- UVICORN_PORT
- 默认值
- 8000
- 价值
- 8000
Uvicorn log level. Not recommended to change.
- 目标
- UVICORN_LOG_LEVEL
- 默认值
- info
- 价值
- info
Uvicorn loop type. Default is asyncio, change only if you know what you're doing.
- 目标
- UVICORN_LOOP
- 默认值
- asyncio
- 价值
- asyncio
Internal Python path for the application. Not recommended to change.
- 目标
- PYTHONPATH
- 默认值
- /app
- 价值
- /app
Unstructured library patched loop. Default is 1, change only if you know what you're doing.
- 目标
- UNSTRUCTURED_HAS_PATCHED_LOOP
- 默认值
- 1
- 价值
- 1
Not recommended to change.
- 目标
- LANGCHAIN_TRACING_V2
- 默认值
- false
- 价值
- false
详细信息
ghcr.io/modsetter/surfsense_backend:latest在Unraid 上运行 SurfSense---Backend 。
SurfSense---Backend 已被列入Unraid OS 的社区应用程序。探索Unraid ,构建灵活的家庭服务器、NAS 或家庭实验室。