SurfSense---Backend
SurfSense---Backend
Aplicación Docker from grtgbln's Repository
Visión general
This is the backend container.
Requisitos
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
Argumentos en tiempo de ejecución
- Interfaz web
http://[IP]:[PORT:8000]/- Red
bridge- Privilegiado
- false
Configuración de plantillas
Container Port: 8000
- Objetivo
- 8000
- Por defecto
- 3001
- Valor
- 3001
URL of the PostgreSQL database, including port and credentials
- Objetivo
- DATABASE_URL
- Por defecto
- postgresql+asyncpg://USERNAME:PASSWORD@IP_ADDRESS:5432/surfsense
- Valor
- postgresql+asyncpg://USERNAME:PASSWORD@IP_ADDRESS:5432/surfsense
JWT Secret key for authentication (should be a secure random string)
- Objetivo
- SECRET_KEY
URL of the frontend service, including port
- Objetivo
- NEXT_FRONTEND_URL
- Por defecto
- http://MY_IP_ADDRESS:3000
- Valor
- http://MY_IP_ADDRESS:3000
Authentication type (Google OAuth or local email/password)
- Objetivo
- AUTH_TYPE
- Por defecto
- LOCAL|GOOGLE
Google OAuth Client ID. Required if AUTH_TYPE is set to GOOGLE.
- Objetivo
- GOOGLE_OAUTH_CLIENT_ID
Google OAuth Client Secret. Required if AUTH_TYPE is set to GOOGLE.
- Objetivo
- GOOGLE_OAUTH_CLIENT_SECRET
Redirect URI for Google Calendar OAuth. Must match the one set in Google Cloud Console.
- Objetivo
- GOOGLE_CALENDAR_REDIRECT_URI
- Por defecto
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/calendar/connector/callback
- Valor
- 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.
- Objetivo
- GOOGLE_GMAIL_REDIRECT_URI
- Por defecto
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/gmail/connector/callback
- Valor
- http://MY_IP_ADDRESS:8000/api/v1/auth/google/gmail/connector/callback
AirTable OAuth Client ID. Required if using AirTable connector.
- Objetivo
- AIRTABLE_CLIENT_ID
AirTable OAuth Client Secret. Required if using AirTable connector.
- Objetivo
- AIRTABLE_CLIENT_SECRET
Redirect URI for AirTable OAuth. Must match the one set in AirTable developer console.
- Objetivo
- AIRTABLE_REDIRECT_URI
- Por defecto
- http://MY_IP_ADDRESS:8000/api/v1/auth/airtable/connector/callback
- Valor
- 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)
- Objetivo
- EMBEDDING_MODEL
- Por defecto
- mixedbread-ai/mxbai-embed-large-v1
- Valor
- mixedbread-ai/mxbai-embed-large-v1
Name of the reranker model (e.g., ms-marco-MiniLM-L-12-v2)
- Objetivo
- RERANKERS_MODEL_NAME
- Por defecto
- ms-marco-MiniLM-L-12-v2
- Valor
- ms-marco-MiniLM-L-12-v2
Type of reranker model (e.g., flashrank)
- Objetivo
- RERANKERS_MODEL_TYPE
- Por defecto
- flashrank
- Valor
- 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
- Objetivo
- TTS_SERVICE
- Por defecto
- openai/tts-1
- Valor
- openai/tts-1
Base URL for the Text To Speech API. Optional, leave empty to use default.
- Objetivo
- TTS_SERVICE_API_BASE
API Key for the Text To Speech API provider. Required if the provider needs authentication.
- Objetivo
- 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
- Objetivo
- STT_SERVICE
- Por defecto
- openai/whisper-1
- Valor
- openai/whisper-1
Local Whisper model size to use if STT_SERVICE is set to local.
- Objetivo
- LOCAL_STT_MODEL
- Por defecto
- base|tiny|small|medium|large-v3
Base URL for the Speech To Text API. Optional, leave empty to use default.
- Objetivo
- STT_SERVICE_API_BASE
API Key for the Speech To Text API provider. Required if the provider needs authentication.
- Objetivo
- STT_SERVICE_API_KEY
API key for Firecrawl service for web crawling
- Objetivo
- FIRECRAWL_API_KEY
Document parsing service
- Objetivo
- ETL_SERVICE
- Por defecto
- UNSTRUCTURED|LLAMACLOUD|DOCLING
API key for Unstructured.io service for document parsing. Required if ETL Service is set to UNSTRUCTURED
- Objetivo
- UNSTRUCTURED_API_KEY
API key for LlamaCloud service for document parsing. Required if ETL Service is set to LLAMACLOUD
- Objetivo
- LLAMA_CLOUD_API_KEY
URL of the Redis instance used as Celery broker, including port
- Objetivo
- CELERY_BROKER_URL
- Por defecto
- redis://MY_IP_ADDRESS:6379/0
- Valor
- redis://MY_IP_ADDRESS:6379/0
URL of the Redis instance used as Celery result backend, including port. Must match CELERY_BROKER_URL
- Objetivo
- CELERY_RESULT_BACKEND
- Por defecto
- redis://MY_IP_ADDRESS:6379/0
- Valor
- redis://MY_IP_ADDRESS:6379/0
Electric database user
- Objetivo
- ELECTRIC_DB_USER
- Por defecto
- electric
- Valor
- electric
Electric database password
- Objetivo
- ELECTRIC_DB_PASSWORD
- Por defecto
- electric_password
- Valor
- electric_password
Path to store app data. Must match Worker
- Objetivo
- /app
- Por defecto
- /mnt/user/appdata/surfsense/backend/data
- Valor
- /mnt/user/appdata/surfsense/backend/data
Path to store temporary data. Must be shared between containers.
- Objetivo
- /tmp
- Por defecto
- /mnt/user/appdata/surfsense/shared/tmp
- Valor
- /mnt/user/appdata/surfsense/shared/tmp
Enable LangSmith tracing.
- Objetivo
- LANGSMITH_TRACING
- Por defecto
- false
- Valor
- false
LangSmith API endpoint. Default is https://api.smith.langchain.com, change only if you know what you're doing.
- Objetivo
- LANGSMITH_ENDPOINT
- Por defecto
- https://api.smith.langchain.com
- Valor
- https://api.smith.langchain.com
LangSmith project name.
- Objetivo
- LANGSMITH_PROJECT
API key for LangSmith tracing. Required if LANGSMITH_TRACING is enabled.
- Objetivo
- LANGSMITH_API_KEY
Uvicorn host address. Not recommended to change.
- Objetivo
- UVICORN_HOST
- Por defecto
- 0.0.0.0
- Valor
- 0.0.0.0
Uvicorn port. Not recommended to change.
- Objetivo
- UVICORN_PORT
- Por defecto
- 8000
- Valor
- 8000
Uvicorn log level. Not recommended to change.
- Objetivo
- UVICORN_LOG_LEVEL
- Por defecto
- info
- Valor
- info
Uvicorn loop type. Default is asyncio, change only if you know what you're doing.
- Objetivo
- UVICORN_LOOP
- Por defecto
- asyncio
- Valor
- asyncio
Internal Python path for the application. Not recommended to change.
- Objetivo
- PYTHONPATH
- Por defecto
- /app
- Valor
- /app
Unstructured library patched loop. Default is 1, change only if you know what you're doing.
- Objetivo
- UNSTRUCTURED_HAS_PATCHED_LOOP
- Por defecto
- 1
- Valor
- 1
Not recommended to change.
- Objetivo
- LANGCHAIN_TRACING_V2
- Por defecto
- false
- Valor
- false
Detalles
ghcr.io/modsetter/surfsense_backend:latestEjecute SurfSense---Backend en Unraid.
SurfSense---Backend se encuentra en Community Apps para Unraid OS. Explore Unraid para crear un servidor doméstico flexible, un NAS o un laboratorio doméstico.