env.example

################################################################################
## Configuration file for SWIRL Docker install. Values labeled 'CHANGE ME' should
## be considered for changing. Values labeled REQUIRED must be set.

################################################################################
## REQUIRED (from all categories)
# Add SWIRL license string between single quotes.
SWIRL_LICENSE=''
# Set to the desired SWIRL admin password.
ADMIN_PASSWORD=""
# Set to the desired SQL password of the SWIRL SQL user.
SQL_PASSWORD=""
# Set to the desired SQL username of the SWIRL SQL user.
SQL_USER=""


################################################################################
# IMAGE VERSIONS
CERTBOT_VERSION=
NGINX_VERSION=
POSTGRES_VERSION=16
REDIS_VERSION=8
SWIRL_VERSION=v4_4_1_1
SWIRL_PATH="swirlai/release-swirl-search-enterprise"
TIKA_VERSION=v4_4_1_1
TTM_VERSION=v4_4_1_1
MCP_VERSION=v1_0_6


################################################################################
# INGRESS
# CHANGE ME :  Set to true if using your own certs.
USE_CERT=false
# CHANGE ME : Set to true if you want to others to be able to access SWIRL through the Web.
USE_NGINX=false
# CHANGE ME : Set to true to enable TLS and ACME cert management. Usually set to the same value as USE_NGINX above.
USE_TLS=false
# CHANGE ME : Email for Certbot ACME registration. Change if using a different Certbot account.
CERTBOT_EMAIL=admin@swirl.today

################################################################################
# Certbot testing knobs (leave unset for production)
# CERTBOT_STAGING=true
# CERTBOT_RENEW_TEST=true
# CERTBOT_RENEW_INTERVAL_SECONDS=300

################################################################################
# SQL DATABASE
# CHANGE ME : Set to false if using an external Postgres DB. Usually true until full production deployment.
USE_LOCAL_POSTGRES=true
# CHANGE ME : To external SQL host if necessary.
SQL_HOST="postgres"
# CHANGE ME : To external SQL port if necessary.
SQL_PORT="5432"
# CHANGE ME : To a different SQL SSL mode if necessary.
SQL_SSLMODE="prefer"
SQL_DATABASE="swirl"
SQL_ENGINE="django.db.backends.postgresql"
# Number of seconds a database connection can be reused for; default is 0, which means no reuse
# SWIRL_SQL_CONN_MAX_AGE=
## Connection Pooling, only use in production with PG Bouncer.
PGBOUNCER_PRODUCTION=""


################################################################################
# SWIRL
## General
# CHANGE ME : To change the SWIRL admin email.
ADMIN_USER_EMAIL="admin@swirl.today"
# CHANGE ME : The SWIRL_FQDN will be automatically added to this list, add additional hosts if necessary.
ALLOWED_HOSTS="localhost,127.0.0.1,swirl,"
# CHANGE ME : Change to correct protocol and to SWIRL's fully qualified domain name and port (if different from standard).
CSRF_TRUSTED_ORIGINS="http://localhost:8000"
# CHANGE ME : Set to fully qualified domain name of SWIRL.
SWIRL_FQDN="localhost"
# CHANGE ME Optional: Bind SWIRL to a specific host port for local development.
#  For cloud / reverse proxy (eg. NGINX) deployments, you can leave this commented out.
# SWIRL_PORT="8000"
# CHANGE ME - Change to https if using TLS.
PROTOCOL="http"

## TIMEOUTS
# Time in seconds that SWIRL waits for all results; default is 20
# SEARCH_TIMEOUT=
# HTTP-level timeouts in seconds for SearchProviders; defaults are 3 and 10 respectively
# SWIRL_SEARCH_HTTP_CONNECT_TIMEOUT=
# SWIRL_SEARCH_HTTP_READ_TIMEOUT=

## OAUTH2
# Custom redirect after OAuth2 completes successfully
# Uncomment and add the Authenticator's `idp` value and the full custom URL
# REDIRECT_OVERRIDE_<idp>='<custom-url>'

## OIDC
# Uncomment and set the following to use Google authentication.
# GOOGLE_AUTH_CLIENT_ID=""
# Uncomment and set the following to use Microsoft authentication.
# MS_AUTH_CLIENT_ID=""
# MS_TENANT_ID=""

## TIME ZONES
# Uncomment and set the following to adjust the time zone used for Django and Celery logs/scheduling.
# Must be a valid IANA timezone name.
# Examples:
#   UTC
#   Europe/London
#   Asia/Tokyo
# Default for both: America/New_York
#
# TIME_ZONE=UTC
# CELERY_TIMEZONE=UTC

## MACOS SPECIFIC
# Uncomment these for a lower-resourced MacOS Docker for local development.
# SWIRL_INTERACTIVE_CONCURRENCY=1
# SWIRL_PAGEFETCH_CONCURRENCY=1
# SWIRL_MAINTENANCE_CONCURRENCY=1
# SWIRL_SEARCH_CONCURRENCY=5


################################################################################
# ADVANCED
# Change when limiting PII in the database.
SWIRL_EXPLAIN="True"
# Set to true to extract visitor IP addresses while enforcing AXES.
AXES_CLIENT_IP_CALLABLE=""
# Change to load older versions of Elastic search packages.
SWIRL_ES_VERSION="8"
# Control some internal processing of SSL communication.
IN_PRODUCTION="False"
# Set to true when deploying in an Azure Gov Environment.
AZ_GOV_COMPATIBLE=false
# Turn debugging on in specific SWIRL modules.
SWIRL_LOG_DEBUG=""
# Controls whether the token remembered and used with search providers that share the same Authenticator.
SHOULD_USE_TOKEN_FROM_OAUTH="True"
# Service identifier
SWIRL_SVC="swirl"

## RAG
SWIRL_RAG_CHAT_INTERACTION_APPROACH="ChatGAIGuided"
SWIRL_RAG_DISTRIBUTION_STRATEGY="RoundRobin"
SWIRL_TEXT_SUMMARIZATION_URL="http://ttm:7029"
TIKA_SERVER_ENDPOINT="http://tika:9998"

## REDIS and CACHES
CACHE_REDIS_URL="redis://redis-cache:6379/1"
CELERY_BROKER_URL="redis://redis-broker:6379/0"
CELERY_RESULT_BACKEND="redis://redis-broker:6379/0"
PAGE_CACHE_REDIS_URL="redis://redis-cache:6379/7"
SEARCH_RESULT_STORE_REDIS_URL="redis://redis-broker:6379/2"
SEARCH_RESULTS_STORE_TIMEOUT="300"

## CELERY WORKER QUEUES
# SWIRL_SEARCH_POOL=prefork
# SWIRL_SEARCH_CONCURRENCY=12
# SWIRL_PAGEFETCH_POOL=threads
# SWIRL_PAGEFETCH_CONCURRENCY=32
# Enable if switching the pagefetch pool to gevent
# SWIRL_USE_PG_GREEN=true
# SWIRL_INTERACTIVE_POOL=prefork
# SWIRL_INTERACTIVE_CONCURRENCY=2
# SWIRL_MAINTENANCE_POOL=threads
# SWIRL_MAINTENANCE_CONCURRENCY=4
# SWIRL_HEALTH_POOL=prefork
# SWIRL_HEALTH_CONCURRENCY=1

## FLOWER - Optional Celery monitoring UI
# SWIRL_FLOWER=true
# FLOWER_USER=admin
# FLOWER_PASSWORD=changeme
# Enable to change Flower's default port
# FLOWER_PORT=5555

## spaCy
# Uncomment to customize spaCy's embedding cache size; default is 2000
# SWIRL_SPACY_EMBEDDINGS_CACHE_MAXSIZE=
# Language loader options (EN / JA / DE ); default is `en`
# SWIRL_DEFAULT_LANGUAGE=''


################################################################################
# SECRETS
## MCP Endpoint Authentication
# CHANGE ME : To the user name that the MCP server will use to login to SWIRL, if using MCP
SWIRL_MCP_USERNAME=""
# CHANGE ME : To the password that the MCP server will use to login to SWIRL, if using MCP
SWIRL_MCP_PASSWORD=""
## User in SWIRL to which MCP requests will be authenticated.
SWIRL_API_USERNAME=""
SWIRL_API_PASSWORD=""
# CHANGE ME
GOOGLE_CREDENTIALS=""
# CHANGE ME : File location of credentials used for Google Big Query access.
GOOGLE_APPLICATION_CREDENTIALS=""

################################################################################
# DEPRECATED
GOOGLE_CREDENTIALS=""
LOGIN_REDIRECT_URL=""
LOGOUT_REDIRECT_URL=""
MICROSOFT_CLIENT_ID=""
MICROSOFT_CLIENT_SECRET=""
MICROSOFT_REDIRECT_URI=""
MCP_ENABLED=false
MCP_PORT="9000"
MCP_SWIRL_BASE_URL="0.0.0.0"
MCP_SWIRL_BASE_PATH="/api/swirl"
MCP_TIMEOUT="30"
OIDC_AUTHENTICATION_CALLBACK_URL=""
OIDC_OP_AUTHORIZATION_ENDPOINT=""
OIDC_OP_JWKS_ENDPOINT=""
OIDC_OP_TOKEN_ENDPOINT=""
OIDC_OP_USER_ENDPOINT=""
OIDC_RP_CLIENT_ID=""
OIDC_RP_CLIENT_SECRET=""
OIDC_RP_SIGN_ALGO=""
OIDC_STORE_ACCESS_TOKEN=""
OIDC_STORE_ID_TOKEN=""
OIDC_USERNAME_ALGO=""