Container Port: 8000

Ziel

8000

Standard

3001

Wert

3001

URL of the PostgreSQL database, including port and credentials

Ziel

DATABASE_URL

Standard

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

Wert

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

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

Ziel

SECRET_KEY

URL of the frontend service, including port

Ziel

NEXT_FRONTEND_URL

Standard

http://MY_IP_ADDRESS:3000

Wert

http://MY_IP_ADDRESS:3000

Authentication type (Google OAuth or local email/password)

Ziel

AUTH_TYPE

Standard

LOCAL|GOOGLE

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

Ziel

GOOGLE_OAUTH_CLIENT_ID

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

Ziel

GOOGLE_OAUTH_CLIENT_SECRET

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

Ziel

GOOGLE_CALENDAR_REDIRECT_URI

Standard

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

Wert

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.

Ziel

GOOGLE_GMAIL_REDIRECT_URI

Standard

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

Wert

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

AirTable OAuth Client ID. Required if using AirTable connector.

Ziel

AIRTABLE_CLIENT_ID

AirTable OAuth Client Secret. Required if using AirTable connector.

Ziel

AIRTABLE_CLIENT_SECRET

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

Ziel

AIRTABLE_REDIRECT_URI

Standard

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

Wert

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)

Ziel

EMBEDDING_MODEL

Standard

mixedbread-ai/mxbai-embed-large-v1

Wert

mixedbread-ai/mxbai-embed-large-v1

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

Ziel

RERANKERS_MODEL_NAME

Standard

ms-marco-MiniLM-L-12-v2

Wert

ms-marco-MiniLM-L-12-v2

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

Ziel

RERANKERS_MODEL_TYPE

Standard

flashrank

Wert

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

Ziel

TTS_SERVICE

Standard

openai/tts-1

Wert

openai/tts-1

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

Ziel

TTS_SERVICE_API_BASE

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

Ziel

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

Ziel

STT_SERVICE

Standard

openai/whisper-1

Wert

openai/whisper-1

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

Ziel

LOCAL_STT_MODEL

Standard

base|tiny|small|medium|large-v3

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

Ziel

STT_SERVICE_API_BASE

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

Ziel

STT_SERVICE_API_KEY

API key for Firecrawl service for web crawling

Ziel

FIRECRAWL_API_KEY

Document parsing service

Ziel

ETL_SERVICE

Standard

UNSTRUCTURED|LLAMACLOUD|DOCLING

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

Ziel

UNSTRUCTURED_API_KEY

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

Ziel

LLAMA_CLOUD_API_KEY

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

Ziel

CELERY_BROKER_URL

Standard

redis://MY_IP_ADDRESS:6379/0

Wert

redis://MY_IP_ADDRESS:6379/0

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

Ziel

CELERY_RESULT_BACKEND

Standard

redis://MY_IP_ADDRESS:6379/0

Wert

redis://MY_IP_ADDRESS:6379/0

Electric database user

Ziel

ELECTRIC_DB_USER

Standard

electric

Wert

electric

Electric database password

Ziel

ELECTRIC_DB_PASSWORD

Standard

electric_password

Wert

electric_password

Path to store app data. Must match Worker

Ziel

/app

Standard

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

Wert

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

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

Ziel

/tmp

Standard

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

Wert

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

Enable LangSmith tracing.

Ziel

LANGSMITH_TRACING

Standard

false

Wert

false

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

Ziel

LANGSMITH_ENDPOINT

Standard

https://api.smith.langchain.com

Wert

https://api.smith.langchain.com

LangSmith project name.

Ziel

LANGSMITH_PROJECT

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

Ziel

LANGSMITH_API_KEY

Uvicorn host address. Not recommended to change.

Ziel

UVICORN_HOST

Standard

0.0.0.0

Wert

0.0.0.0

Uvicorn port. Not recommended to change.

Ziel

UVICORN_PORT

Standard

8000

Wert

8000

Uvicorn log level. Not recommended to change.

Ziel

UVICORN_LOG_LEVEL

Standard

info

Wert

info

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

Ziel

UVICORN_LOOP

Standard

asyncio

Wert

asyncio

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

Ziel

PYTHONPATH

Standard

/app

Wert

/app

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

Ziel

UNSTRUCTURED_HAS_PATCHED_LOOP

Standard

1

Wert

1

Not recommended to change.

Ziel

LANGCHAIN_TRACING_V2

Standard

false

Wert

false