SurfSense---Backend

SurfSense---Backend

Docker 应用程序 from grtgbln's Repository

概述

Open Source Alternative to NotebookLM / Perplexity / Glean, connected to external sources such as search engines (Tavily, Linkup), Slack, Linear, Notion, YouTube, GitHub, Discord and more.
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

模板配置

API PortPorttcp

Container Port: 8000

目标
8000
默认值
3001
价值
3001
Database - URLVariable

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
Secret KeyVariable

JWT Secret key for authentication (should be a secure random string)

目标
SECRET_KEY
Frontend URLVariable

URL of the frontend service, including port

目标
NEXT_FRONTEND_URL
默认值
http://MY_IP_ADDRESS:3000
价值
http://MY_IP_ADDRESS:3000
Authentication - TypeVariable

Authentication type (Google OAuth or local email/password)

目标
AUTH_TYPE
默认值
LOCAL|GOOGLE
Authentication - Google Client IDVariable

Google OAuth Client ID. Required if AUTH_TYPE is set to GOOGLE.

目标
GOOGLE_OAUTH_CLIENT_ID
Authentication - Google Client SecretVariable

Google OAuth Client Secret. Required if AUTH_TYPE is set to GOOGLE.

目标
GOOGLE_OAUTH_CLIENT_SECRET
Google - Calendar Redirect URIVariable

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
Google - Gmail Redirect URIVariable

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 - Client IDVariable

AirTable OAuth Client ID. Required if using AirTable connector.

目标
AIRTABLE_CLIENT_ID
AirTable - Client SecretVariable

AirTable OAuth Client Secret. Required if using AirTable connector.

目标
AIRTABLE_CLIENT_SECRET
AirTable - Redirect URIVariable

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
Models - Embedder ModelVariable

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
Models - Reranker ModelVariable

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
Models - Reranker Model TypeVariable

Type of reranker model (e.g., flashrank)

目标
RERANKERS_MODEL_TYPE
默认值
flashrank
价值
flashrank
LiteLLM - Text To Speech ServiceVariable

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
LiteLLM - Text To Speech API BaseVariable

Base URL for the Text To Speech API. Optional, leave empty to use default.

目标
TTS_SERVICE_API_BASE
LiteLLM - Text To Speech API KeyVariable

API Key for the Text To Speech API provider. Required if the provider needs authentication.

目标
TTS_SERVICE_API_KEY
LiteLLM - Speech To Text ServiceVariable

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
LiteLLM - Speech To Text Local ModelVariable

Local Whisper model size to use if STT_SERVICE is set to local.

目标
LOCAL_STT_MODEL
默认值
base|tiny|small|medium|large-v3
LiteLLM - Speech To Text API BaseVariable

Base URL for the Speech To Text API. Optional, leave empty to use default.

目标
STT_SERVICE_API_BASE
LiteLLM - Speech To Text API KeyVariable

API Key for the Speech To Text API provider. Required if the provider needs authentication.

目标
STT_SERVICE_API_KEY
Firecrawl - API KeyVariable

API key for Firecrawl service for web crawling

目标
FIRECRAWL_API_KEY
ETL ServiceVariable

Document parsing service

目标
ETL_SERVICE
默认值
UNSTRUCTURED|LLAMACLOUD|DOCLING
Unstructured - API KeyVariable

API key for Unstructured.io service for document parsing. Required if ETL Service is set to UNSTRUCTURED

目标
UNSTRUCTURED_API_KEY
LlamaCloud - API KeyVariable

API key for LlamaCloud service for document parsing. Required if ETL Service is set to LLAMACLOUD

目标
LLAMA_CLOUD_API_KEY
Redis - URLVariable

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
Redis - Results URLVariable

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 - UserVariable

Electric database user

目标
ELECTRIC_DB_USER
默认值
electric
价值
electric
Electric - PasswordVariable

Electric database password

目标
ELECTRIC_DB_PASSWORD
默认值
electric_password
价值
electric_password
App DataPath

Path to store app data. Must match Worker

目标
/app
默认值
/mnt/user/appdata/surfsense/backend/data
价值
/mnt/user/appdata/surfsense/backend/data
Temp DataPath

Path to store temporary data. Must be shared between containers.

目标
/tmp
默认值
/mnt/user/appdata/surfsense/shared/tmp
价值
/mnt/user/appdata/surfsense/shared/tmp
LangSmith - TracingVariable

Enable LangSmith tracing.

目标
LANGSMITH_TRACING
默认值
false
价值
false
LangSmith - EndpointVariable

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 NameVariable

LangSmith project name.

目标
LANGSMITH_PROJECT
LangSmith - API KeyVariable

API key for LangSmith tracing. Required if LANGSMITH_TRACING is enabled.

目标
LANGSMITH_API_KEY
Uvicorn - HostVariable

Uvicorn host address. Not recommended to change.

目标
UVICORN_HOST
默认值
0.0.0.0
价值
0.0.0.0
Uvicorn - PortVariable

Uvicorn port. Not recommended to change.

目标
UVICORN_PORT
默认值
8000
价值
8000
Uvicorn - Log LevelVariable

Uvicorn log level. Not recommended to change.

目标
UVICORN_LOG_LEVEL
默认值
info
价值
info
Uvicorn - LoopVariable

Uvicorn loop type. Default is asyncio, change only if you know what you're doing.

目标
UVICORN_LOOP
默认值
asyncio
价值
asyncio
Internal Python PathVariable

Internal Python path for the application. Not recommended to change.

目标
PYTHONPATH
默认值
/app
价值
/app
Unstructured Has Patched LoopVariable

Unstructured library patched loop. Default is 1, change only if you know what you're doing.

目标
UNSTRUCTURED_HAS_PATCHED_LOOP
默认值
1
价值
1
LangChain - Tracing V2Variable

Not recommended to change.

目标
LANGCHAIN_TRACING_V2
默认值
false
价值
false

详细信息

存储库
ghcr.io/modsetter/surfsense_backend:latest
最后更新2026-05-31
初见2025-06-05

在Unraid 上运行 SurfSense---Backend 。

SurfSense---Backend 已被列入Unraid OS 的社区应用程序。探索Unraid ,构建灵活的家庭服务器、NAS 或家庭实验室。