Container Port: 8000

Cible

8000

Défaut

3001

Valeur

3001

URL of the PostgreSQL database, including port and credentials

Cible

DATABASE_URL

Défaut

postgresql+asyncpg://USERNAME:PASSWORD@IP_ADDRESS:5432/surfsense

Valeur

postgresql+asyncpg://USERNAME:PASSWORD@IP_ADDRESS:5432/surfsense

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

Cible

SECRET_KEY

URL of the frontend service, including port

Cible

NEXT_FRONTEND_URL

Défaut

http://MY_IP_ADDRESS:3000

Valeur

http://MY_IP_ADDRESS:3000

Authentication type (Google OAuth or local email/password)

Cible

AUTH_TYPE

Défaut

LOCAL|GOOGLE

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

Cible

GOOGLE_OAUTH_CLIENT_ID

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

Cible

GOOGLE_OAUTH_CLIENT_SECRET

Redirect URI for Google Calendar OAuth. Must match the one set in Google Cloud Console.

Cible

GOOGLE_CALENDAR_REDIRECT_URI

Défaut

http://MY_IP_ADDRESS:8000/api/v1/auth/google/calendar/connector/callback

Valeur

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.

Cible

GOOGLE_GMAIL_REDIRECT_URI

Défaut

http://MY_IP_ADDRESS:8000/api/v1/auth/google/gmail/connector/callback

Valeur

http://MY_IP_ADDRESS:8000/api/v1/auth/google/gmail/connector/callback

AirTable OAuth Client ID. Required if using AirTable connector.

Cible

AIRTABLE_CLIENT_ID

AirTable OAuth Client Secret. Required if using AirTable connector.

Cible

AIRTABLE_CLIENT_SECRET

Redirect URI for AirTable OAuth. Must match the one set in AirTable developer console.

Cible

AIRTABLE_REDIRECT_URI

Défaut

http://MY_IP_ADDRESS:8000/api/v1/auth/airtable/connector/callback

Valeur

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)

Cible

EMBEDDING_MODEL

Défaut

mixedbread-ai/mxbai-embed-large-v1

Valeur

mixedbread-ai/mxbai-embed-large-v1

Name of the reranker model (e.g., ms-marco-MiniLM-L-12-v2)

Cible

RERANKERS_MODEL_NAME

Défaut

ms-marco-MiniLM-L-12-v2

Valeur

ms-marco-MiniLM-L-12-v2

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

Cible

RERANKERS_MODEL_TYPE

Défaut

flashrank

Valeur

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

Cible

TTS_SERVICE

Défaut

openai/tts-1

Valeur

openai/tts-1

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

Cible

TTS_SERVICE_API_BASE

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

Cible

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

Cible

STT_SERVICE

Défaut

openai/whisper-1

Valeur

openai/whisper-1

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

Cible

LOCAL_STT_MODEL

Défaut

base|tiny|small|medium|large-v3

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

Cible

STT_SERVICE_API_BASE

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

Cible

STT_SERVICE_API_KEY

API key for Firecrawl service for web crawling

Cible

FIRECRAWL_API_KEY

Document parsing service

Cible

ETL_SERVICE

Défaut

UNSTRUCTURED|LLAMACLOUD|DOCLING

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

Cible

UNSTRUCTURED_API_KEY

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

Cible

LLAMA_CLOUD_API_KEY

URL of the Redis instance used as Celery broker, including port

Cible

CELERY_BROKER_URL

Défaut

redis://MY_IP_ADDRESS:6379/0

Valeur

redis://MY_IP_ADDRESS:6379/0

URL of the Redis instance used as Celery result backend, including port. Must match CELERY_BROKER_URL

Cible

CELERY_RESULT_BACKEND

Défaut

redis://MY_IP_ADDRESS:6379/0

Valeur

redis://MY_IP_ADDRESS:6379/0

Electric database user

Cible

ELECTRIC_DB_USER

Défaut

electric

Valeur

electric

Electric database password

Cible

ELECTRIC_DB_PASSWORD

Défaut

electric_password

Valeur

electric_password

Path to store app data. Must match Worker

Cible

/app

Défaut

/mnt/user/appdata/surfsense/backend/data

Valeur

/mnt/user/appdata/surfsense/backend/data

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

Cible

/tmp

Défaut

/mnt/user/appdata/surfsense/shared/tmp

Valeur

/mnt/user/appdata/surfsense/shared/tmp

Enable LangSmith tracing.

Cible

LANGSMITH_TRACING

Défaut

false

Valeur

false

LangSmith API endpoint. Default is https://api.smith.langchain.com, change only if you know what you're doing.

Cible

LANGSMITH_ENDPOINT

Défaut

https://api.smith.langchain.com

Valeur

https://api.smith.langchain.com

LangSmith project name.

Cible

LANGSMITH_PROJECT

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

Cible

LANGSMITH_API_KEY

Uvicorn host address. Not recommended to change.

Cible

UVICORN_HOST

Défaut

0.0.0.0

Valeur

0.0.0.0

Uvicorn port. Not recommended to change.

Cible

UVICORN_PORT

Défaut

8000

Valeur

8000

Uvicorn log level. Not recommended to change.

Cible

UVICORN_LOG_LEVEL

Défaut

info

Valeur

info

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

Cible

UVICORN_LOOP

Défaut

asyncio

Valeur

asyncio

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

Cible

PYTHONPATH

Défaut

/app

Valeur

/app

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

Cible

UNSTRUCTURED_HAS_PATCHED_LOOP

Défaut

1

Valeur

1

Not recommended to change.

Cible

LANGCHAIN_TRACING_V2

Défaut

false

Valeur

false