Environment variable reference

This document provides a comprehensive reference for all externally configurable environment variables used across the Instabase platform. Variables tagged as ‘internal’ have been excluded to focus on user-configurable settings.

Usage Guidelines

  • Authentication: Configure SAML, LDAP, or OAuth based on your identity provider
  • File Storage: Choose between S3, GCS, or local storage based on your infrastructure
  • Database: Set connection parameters, SSL, and pool settings
  • Message Queuing: Configure RabbitMQ for reliable message processing
  • Monitoring: Enable stats and metrics collection for observability
  • Feature Flags: Use ENABLE_* variables to toggle functionality

Security Notes

  • Always use SSL/TLS for production deployments
  • Store sensitive values (passwords, keys) in secure secret management systems
  • Regularly rotate authentication credentials
  • Enable audit logging for compliance requirements

Authentication & SAML

ACRA_FETCHER_DEADLINE

  • Description: Configures the Fetcher app’s timeout for fetching information from ACRA.
  • Services: celery-app-tasks, fetcher

ALLOW_CONTROL_PLANE_PATH_PREFIX

  • Description: Determines whether to allow accessing UI via /control-plane. Need this to enable backwards compatibility in sandboxes and for upgrades from < 23.01.
  • Services: control-plane

ALLOWED_PROXY_ENDPOINTS

  • Description: Endpoint prefixes which can be reached through the Deployment Manager proxy in SaaS environments.
  • Services: control-plane

APIKEY

  • Description: The azure API Key for Microsoft read containers.
  • Services: ocr, ocr-msft-lite, ocr-msft-v3

AUTHENTICATION_ENABLED

  • Description: Whether authentication is enabled.
  • Services: authentication

AUTHENTICATION_PROVIDER

  • Description: The authentication provider to use (e.g., saml, ldap, oauth).
  • Services: authentication

SAML_ENTITY_ID

  • Description: The SAML entity ID for the service provider.
  • Services: saml, authentication

SAML_SSO_URL

  • Description: The SAML Single Sign-On URL.
  • Services: saml, authentication

SAML_SLO_URL

  • Description: The SAML Single Logout URL.
  • Services: saml, authentication

SAML_X509_CERT

  • Description: The X.509 certificate for SAML authentication.
  • Services: saml, authentication

SAML_PRIVATE_KEY

  • Description: The private key for SAML authentication.
  • Services: saml, authentication

SAML_IDP_METADATA_URL

  • Description: The URL to fetch SAML Identity Provider metadata.
  • Services: saml, authentication

SAML_ATTRIBUTES_MAPPING

  • Description: Mapping configuration for SAML user attributes.
  • Services: saml, authentication

SAML_GROUP_MAPPING

  • Description: Mapping configuration for SAML group attributes.
  • Services: saml, authentication

SAML_SIGNATURE_ALGORITHM

  • Description: The signature algorithm for SAML requests.
  • Services: saml, authentication

SAML_DIGEST_ALGORITHM

  • Description: The digest algorithm for SAML requests.
  • Services: saml, authentication

SAML_NAME_ID_FORMAT

  • Description: The name ID format for SAML assertions.
  • Services: saml, authentication

SAML_AUTHN_CONTEXT_CLASS_REF

  • Description: The authentication context class reference for SAML.
  • Services: saml, authentication

Control Plane & Deployment

ALERT_MANAGER_SERVICE_URL

  • Description: The URL for the Alert-Manager service for use by Deployment-Manager for status checks.
  • Services: control-plane, kubernetes

API_SERVER_HOST

  • Description: The URL of the api-service service for use by Deployment-Manager for status checks.
  • Services: control-plane, kubernetes

AUTOSCALING_ENABLED

  • Description: Whether autoscaling is enabled for services.
  • Services: control-plane, autoscaling

AUTOSCALING_MIN_REPLICAS

  • Description: The minimum number of replicas for autoscaling.
  • Services: control-plane, autoscaling

AUTOSCALING_MAX_REPLICAS

  • Description: The maximum number of replicas for autoscaling.
  • Services: control-plane, autoscaling

AUTOSCALING_TARGET_CPU_UTILIZATION

  • Description: The target CPU utilization percentage for autoscaling.
  • Services: control-plane, autoscaling

AUTOSCALING_TARGET_MEMORY_UTILIZATION

  • Description: The target memory utilization percentage for autoscaling.
  • Services: control-plane, autoscaling

DEPLOYMENT_ENVIRONMENT

  • Description: The deployment environment (dev, staging, production).
  • Services: control-plane

DEPLOYMENT_REGION

  • Description: The AWS/cloud region for deployment.
  • Services: control-plane

DEPLOYMENT_AVAILABILITY_ZONE

  • Description: The availability zone for deployment.
  • Services: control-plane

ENABLE_SCALE_DOWN_TO_ZERO_CONTROLLER

  • Description: Determines whether to enable autoscale to zero controller in Deployment Manager for autoscaled services.
  • Services: autoscaling, control-plane

ENABLE_STARTUP_LATENCY_TRACKER

  • Description: Determines whether or not to initial a kubernetes informer which tracks how long each container on pods takes to go from creation to readiness
  • Services: control-plane, autoscaling

ENABLE_TELESCOPE

  • Description: Enables Telescope in Control Plane
  • Services: control-plane

ENABLE_TELESCOPE_IMPORT

  • Description: Enables telescope’s import zip feature to view logs and stats
  • Services: control-plane

KUBERNETES_NAMESPACE

  • Description: The Kubernetes namespace for deployments.
  • Services: control-plane, kubernetes

KUBERNETES_SERVICE_ACCOUNT

  • Description: The Kubernetes service account to use.
  • Services: control-plane, kubernetes

File System & Storage

FILE_STORAGE_BACKEND

  • Description: The backend storage system to use (s3, gcs, local).
  • Services: file-system

FILE_STORAGE_S3_BUCKET

  • Description: The S3 bucket name for file storage.
  • Services: file-system, s3

FILE_STORAGE_S3_REGION

  • Description: The AWS region for S3 storage.
  • Services: file-system, s3

FILE_STORAGE_S3_ACCESS_KEY_ID

  • Description: The AWS access key ID for S3 storage.
  • Services: file-system, s3

FILE_STORAGE_S3_SECRET_ACCESS_KEY

  • Description: The AWS secret access key for S3 storage.
  • Services: file-system, s3

FILE_STORAGE_S3_ENDPOINT_URL

  • Description: Custom S3 endpoint URL for S3-compatible storage.
  • Services: file-system, s3

FILE_STORAGE_GCS_BUCKET

  • Description: The Google Cloud Storage bucket for file storage.
  • Services: file-system, gcs

FILE_STORAGE_GCS_PROJECT_ID

  • Description: The Google Cloud project ID.
  • Services: file-system, gcs

FILE_STORAGE_GCS_CREDENTIALS_PATH

  • Description: Path to Google Cloud service account credentials.
  • Services: file-system, gcs

FILE_STORAGE_LOCAL_PATH

  • Description: Local file system path for storage.
  • Services: file-system, local

FILE_STORAGE_ENCRYPTION_ENABLED

  • Description: Whether to enable encryption for stored files.
  • Services: file-system

FILE_STORAGE_COMPRESSION_ENABLED

  • Description: Whether to enable compression for stored files.
  • Services: file-system

FILE_STORAGE_MAX_FILE_SIZE

  • Description: Maximum file size allowed for uploads.
  • Services: file-system

FILE_STORAGE_RETENTION_DAYS

  • Description: Number of days to retain files before cleanup.
  • Services: file-system

ENABLE_STORAGE_MANAGER

  • Description: Feature flag to enable processing file retention rules on Instabase-managed storage (the Instabase Drive on every subspace) from Admin App > File Storage > File Retention. Retention rules still need to be configured in the app to take effect.
  • Services: apps-server, file-system, grpc-file-service

S3_USE_SIGV4

  • Description: Environment variable S3_USE_SIGV4 used in search-tservice, webapp containers.
  • Services: search-tservice, webapp

OCR & Document Processing

APIKEY

  • Description: The azure API Key for Microsoft read containers.
  • Services: ocr, ocr-msft-lite, ocr-msft-v3

OCR_SERVICE_ENDPOINT

  • Description: The endpoint URL for OCR services.
  • Services: ocr

OCR_SERVICE_TIMEOUT

  • Description: Timeout for OCR service requests in seconds.
  • Services: ocr

OCR_SERVICE_MAX_RETRIES

  • Description: Maximum number of retries for failed OCR requests.
  • Services: ocr

OCR_SERVICE_BATCH_SIZE

  • Description: Batch size for OCR processing.
  • Services: ocr

OCR_CONFIDENCE_THRESHOLD

  • Description: Minimum confidence threshold for OCR results.
  • Services: ocr

OCR_LANGUAGE_CODES

  • Description: Comma-separated list of language codes for OCR.
  • Services: ocr

OCR_ENABLE_TABLE_DETECTION

  • Description: Whether to enable table detection in OCR.
  • Services: ocr

OCR_ENABLE_FORM_DETECTION

  • Description: Whether to enable form detection in OCR.
  • Services: ocr

OCR_DPI

  • Description: DPI setting for OCR image processing.
  • Services: ocr

OCR_IMAGE_PREPROCESSING

  • Description: Whether to enable image preprocessing for OCR.
  • Services: ocr

OCR_TESS_ENABLED

  • Description: Environment variable OCR_TESS_ENABLED used in celery-app-tasks containers.
  • Services: celery-app-tasks

OCR_TESS_HOST

  • Description: Environment variable OCR_TESS_HOST used in celery-app-tasks containers.
  • Services: celery-app-tasks

OCR_TESS_PORT

  • Description: Environment variable OCR_TESS_PORT used in celery-app-tasks containers.
  • Services: celery-app-tasks

ENABLE_SMART_OBJECT_DETECTION

  • Description: Feature flag to enable the smart object detection pipeline. This flag value will only come in effect if form-recognizer is enabled.
  • Services: api-server, apps-server, celery-app-tasks, webapp

ENABLE_TEXTBOXDETECTION_SERVICE

  • Description: Enable textboxdetection-service for Extracting text bounding boxes from images.
  • Services: celery-app-tasks

TSERVICE_PDF_HOST

  • Description: Environment variable TSERVICE_PDF_HOST used in celery-app-tasks containers.
  • Services: celery-app-tasks

TSERVICE_PDF_PORT

  • Description: Environment variable TSERVICE_PDF_PORT used in celery-app-tasks containers.
  • Services: celery-app-tasks

Message Queuing (RabbitMQ)

RABBIT_MQ_HOST

  • Description: Hostname for RabbitMQ server.
  • Services: rabbit-mq

RABBIT_MQ_PORT

  • Description: Port for RabbitMQ server.
  • Services: rabbit-mq

RABBIT_MQ_USERNAME

  • Description: Username for RabbitMQ authentication.
  • Services: rabbit-mq

RABBIT_MQ_PASSWORD

  • Description: Password for RabbitMQ authentication.
  • Services: rabbit-mq

RABBIT_MQ_VHOST

  • Description: Virtual host for RabbitMQ.
  • Services: rabbit-mq

RABBIT_MQ_SSL_ENABLED

  • Description: Whether SSL is enabled for RabbitMQ connections.
  • Services: rabbit-mq

RABBIT_MQ_SSL_CERT_PATH

  • Description: Path to SSL certificate for RabbitMQ.
  • Services: rabbit-mq

RABBIT_MQ_SSL_KEY_PATH

  • Description: Path to SSL private key for RabbitMQ.
  • Services: rabbit-mq

RABBIT_MQ_SSL_CA_PATH

  • Description: Path to SSL CA certificate for RabbitMQ.
  • Services: rabbit-mq

RABBIT_MQ_CONNECTION_TIMEOUT

  • Description: Connection timeout for RabbitMQ in seconds.
  • Services: rabbit-mq

RABBIT_MQ_HEARTBEAT_INTERVAL

  • Description: Heartbeat interval for RabbitMQ connections.
  • Services: rabbit-mq

RABBIT_MQ_MAX_CONNECTIONS

  • Description: Maximum number of RabbitMQ connections.
  • Services: rabbit-mq

RABBIT_MQ_MAX_CHANNELS

  • Description: Maximum number of RabbitMQ channels per connection.
  • Services: rabbit-mq

AMQP_DISABLE_PERSISTENCE

  • Description: Configure Rabbit-MQ to disable persistence of messages in the queue. This means that messages may be lost upon restart of RabbitMQ.
  • Services: core-platform-service, grpc-file-service, job-service, rabbit-mq

AMQP_DISABLE_PUBLISH_CONFIRM

  • Description: Configure Rabbit-MQ to disable confirmation of successful publication of a message to the queue.
  • Services: core-platform-service, grpc-file-service, job-service, rabbit-mq

AMQP_ENABLE_TRACING

  • Description: Enable request tracing through messages published to RabbitMQ.
  • Services: grpc-file-service, rabbit-mq

AMQP_MAX_ATTEMPTS

  • Description: Configure the maximum number of retries the Rabbit-MQ AMQP broker will retry when publishing a message to the queue.
  • Services: core-platform-service, grpc-file-service, job-service, rabbit-mq

AMQP_MAX_WAIT_TIME_IN_MILLIS

  • Description: Configure the maximum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.
  • Services: core-platform-service, grpc-file-service, job-service, rabbit-mq

AMQP_MIN_WAIT_TIME_IN_MILLIS

  • Description: Configure the minimum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.
  • Services: core-platform-service, grpc-file-service, job-service, rabbit-mq

AMQP_PREFETCH_COUNT

  • Description: Configures how many messages the Rabbit-MQ AMQP broker should pre-fetch. If < 1 defaults to 1.
  • Services: core-platform-service, grpc-file-service, job-service, rabbit-mq, search-tservice

RABBIT_MQ_JOB_LOGS_MAX_QUEUE_LENGTH

  • Description: Environment variable RABBIT_MQ_JOB_LOGS_MAX_QUEUE_LENGTH used in celery-app-tasks, model-service, ray-head containers.
  • Services: celery-app-tasks, model-service, ray-head

Database Configuration

DATABASE_HOST

  • Description: Hostname for the database server.
  • Services: database

DATABASE_PORT

  • Description: Port for the database server.
  • Services: database

DATABASE_NAME

  • Description: Name of the database.
  • Services: database

DATABASE_USERNAME

  • Description: Username for database authentication.
  • Services: database

DATABASE_PASSWORD

  • Description: Password for database authentication.
  • Services: database

DATABASE_SSL_MODE

  • Description: SSL mode for database connections (require, prefer, disable).
  • Services: database

DATABASE_SSL_CERT_PATH

  • Description: Path to SSL certificate for database connections.
  • Services: database

DATABASE_SSL_KEY_PATH

  • Description: Path to SSL private key for database connections.
  • Services: database

DATABASE_SSL_CA_PATH

  • Description: Path to SSL CA certificate for database connections.
  • Services: database

DATABASE_CONNECTION_POOL_SIZE

  • Description: Size of the database connection pool.
  • Services: database

DATABASE_CONNECTION_POOL_MAX_OVERFLOW

  • Description: Maximum overflow for database connection pool.
  • Services: database

DATABASE_CONNECTION_TIMEOUT

  • Description: Timeout for database connections in seconds.
  • Services: database

DATABASE_QUERY_TIMEOUT

  • Description: Timeout for database queries in seconds.
  • Services: database

DATABASE_MAX_RETRIES

  • Description: Maximum number of retries for failed database operations.
  • Services: database

DATABASE_RETRY_DELAY

  • Description: Delay between database operation retries in seconds.
  • Services: database

DATABASE_BACKUP_ENABLED

  • Description: Whether database backups are enabled.
  • Services: database

DATABASE_BACKUP_SCHEDULE

  • Description: Cron schedule for database backups.
  • Services: database

DATABASE_BACKUP_RETENTION_DAYS

  • Description: Number of days to retain database backups.
  • Services: database

Monitoring & Stats

STATS_ENABLED

  • Description: Whether statistics collection is enabled.
  • Services: stats

STATS_COLLECTION_INTERVAL

  • Description: Interval for collecting statistics in seconds.
  • Services: stats

STATS_RETENTION_DAYS

  • Description: Number of days to retain statistics data.
  • Services: stats

STATS_EXPORT_ENABLED

  • Description: Whether to enable exporting statistics.
  • Services: stats

STATS_EXPORT_FORMAT

  • Description: Format for exporting statistics (json, csv, prometheus).
  • Services: stats

STATS_EXPORT_ENDPOINT

  • Description: Endpoint URL for exporting statistics.
  • Services: stats

METRICS_ENABLED

  • Description: Whether metrics collection is enabled.
  • Services: stats, observability-agent

METRICS_PORT

  • Description: Port for metrics endpoint.
  • Services: stats, observability-agent

METRICS_PATH

  • Description: Path for metrics endpoint.
  • Services: stats, observability-agent

METRICS_SCRAPE_INTERVAL

  • Description: Interval for scraping metrics.
  • Services: stats, observability-agent

PROMETHEUS_ENABLED

  • Description: Whether Prometheus integration is enabled.
  • Services: stats, prometheus

PROMETHEUS_ENDPOINT

  • Description: Prometheus server endpoint.
  • Services: stats, prometheus

PROMETHEUS_SCRAPE_INTERVAL

  • Description: Prometheus scrape interval.
  • Services: stats, prometheus

GRAFANA_ENABLED

  • Description: Whether Grafana integration is enabled.
  • Services: stats, grafana

GRAFANA_ENDPOINT

  • Description: Grafana server endpoint.
  • Services: stats, grafana

GRAFANA_API_KEY

  • Description: API key for Grafana integration.
  • Services: stats, grafana

ALERTMANAGER_BACKEND

  • Description: The URL endpoint for the Alert Manager console.
  • Services: nginx, prometheus, server-nginx, stats

ENABLE_VERBOSE_STATS_LOGS

  • Description: Enables the verbose logs for the stats exporter. Default - false
  • Services: stats

SPAN_STORAGE_TYPE

  • Description: Environment variable SPAN_STORAGE_TYPE used in jaeger containers.
  • Services: jaeger

VMAGENT_MEMBERS_COUNT

  • Description: Environment variable VMAGENT_MEMBERS_COUNT used in vmagent containers.
  • Services: vmagent

Notebook Services

NOTEBOOK_SERVER_HOST

  • Description: Hostname for the notebook server.
  • Services: notebook

NOTEBOOK_SERVER_PORT

  • Description: Port for the notebook server.
  • Services: notebook

NOTEBOOK_SERVER_BASE_URL

  • Description: Base URL for the notebook server.
  • Services: notebook

NOTEBOOK_KERNEL_TIMEOUT

  • Description: Timeout for notebook kernels in seconds.
  • Services: notebook

NOTEBOOK_MAX_KERNELS

  • Description: Maximum number of concurrent notebook kernels.
  • Services: notebook

NOTEBOOK_KERNEL_MEMORY_LIMIT

  • Description: Memory limit for notebook kernels.
  • Services: notebook

NOTEBOOK_KERNEL_CPU_LIMIT

  • Description: CPU limit for notebook kernels.
  • Services: notebook

NOTEBOOK_AUTOSAVE_INTERVAL

  • Description: Autosave interval for notebooks in seconds.
  • Services: notebook

NOTEBOOK_MAX_FILE_SIZE

  • Description: Maximum file size for notebook uploads.
  • Services: notebook

NOTEBOOK_ALLOWED_EXTENSIONS

  • Description: Comma-separated list of allowed file extensions.
  • Services: notebook

NOTEBOOK_ENABLE_EXTENSIONS

  • Description: Whether to enable notebook extensions.
  • Services: notebook

NOTEBOOK_EXTENSION_WHITELIST

  • Description: Whitelist of allowed notebook extensions.
  • Services: notebook

NOTEBOOK_TERMINAL_ENABLED

  • Description: Whether terminal access is enabled in notebooks.
  • Services: notebook

NOTEBOOK_SHUTDOWN_NO_ACTIVITY_TIMEOUT

  • Description: Timeout to shutdown inactive notebooks.
  • Services: notebook

NB_TYPE

  • Description: Environment variable NB_TYPE used in apps-server containers.
  • Services: apps-server

NB_USE_API_TOKEN

  • Description: Environment variable NB_USE_API_TOKEN used in apps-server containers.
  • Services: apps-server

NB_USE_CA_CERT_BUNDLE

  • Description: Environment variable NB_USE_CA_CERT_BUNDLE used in apps-server containers.
  • Services: apps-server

NB_VERIFY_SSL_CERTS

  • Description: Environment variable NB_VERIFY_SSL_CERTS used in apps-server containers.
  • Services: apps-server

Process Files & ETL

PROCESS_FILES_BATCH_SIZE

  • Description: Batch size for file processing operations.
  • Services: process-files

PROCESS_FILES_MAX_WORKERS

  • Description: Maximum number of worker processes for file processing.
  • Services: process-files

PROCESS_FILES_TIMEOUT

  • Description: Timeout for file processing operations.
  • Services: process-files

PROCESS_FILES_RETRY_ATTEMPTS

  • Description: Number of retry attempts for failed file processing.
  • Services: process-files

PROCESS_FILES_RETRY_DELAY

  • Description: Delay between retry attempts in seconds.
  • Services: process-files

PROCESS_FILES_TEMP_DIR

  • Description: Temporary directory for file processing.
  • Services: process-files

PROCESS_FILES_OUTPUT_FORMAT

  • Description: Output format for processed files.
  • Services: process-files

PROCESS_FILES_COMPRESSION_ENABLED

  • Description: Whether to enable compression for processed files.
  • Services: process-files

PROCESS_FILES_VALIDATION_ENABLED

  • Description: Whether to enable validation for processed files.
  • Services: process-files

PROCESS_FILES_LOGGING_LEVEL

  • Description: Logging level for file processing operations.
  • Services: process-files

ENABLE_APPLY_REFINER_CHUNKING

  • Description: Enable chunking for Apply Refiner flow step.
  • Services: celery-app-tasks, refiner

APPLY_REFINER_CHUNK_THRESHOLD_PAGES

  • Description: Defines the maximum number of pages to include in a chunk while chunking for Apply Refiner flow step.
  • Services: celery-app-tasks, refiner

ENABLE_RUN_EXTRACTION_MODEL_CHUNKING

  • Description: Enable chunking for Run Extraction Model flow step.
  • Services: celery-app-tasks, run-extraction-model

RUN_EXTRACTION_MODEL_CHUNK_THRESHOLD_PAGES

  • Description: Defines the maximum number of pages to include in a chunk while chunking for Run Extraction Model flow step.
  • Services: celery-app-tasks, run-extraction-model

ENABLE_IBDOC_V2

  • Description: Enable new ibdoc v2 structuring where ibdoc is split & stored across multiple files
  • Services: app-tasks, celery-app-tasks, map-records, model-training, process-files, reader

ENABLE_READER_PAGE

  • Description: If enabled, compact reader page proto representation is used to save app-tasks memory and network traffic.
  • Services: app-tasks, celery-app-tasks, process-files

gRPC Services

GRPC_SERVER_HOST

  • Description: Hostname for gRPC server.
  • Services: grpc

GRPC_SERVER_PORT

  • Description: Port for gRPC server.
  • Services: grpc

GRPC_MAX_MESSAGE_SIZE

  • Description: Maximum message size for gRPC.
  • Services: grpc

GRPC_MAX_CONNECTIONS

  • Description: Maximum number of gRPC connections.
  • Services: grpc

GRPC_CONNECTION_TIMEOUT

  • Description: Connection timeout for gRPC in seconds.
  • Services: grpc

GRPC_SSL_ENABLED

  • Description: Whether SSL is enabled for gRPC.
  • Services: grpc

GRPC_SSL_CERT_PATH

  • Description: Path to SSL certificate for gRPC.
  • Services: grpc

GRPC_SSL_KEY_PATH

  • Description: Path to SSL private key for gRPC.
  • Services: grpc

GRPC_SSL_CA_PATH

  • Description: Path to SSL CA certificate for gRPC.
  • Services: grpc

GRPC_KEEPALIVE_TIME

  • Description: Keepalive time for gRPC connections.
  • Services: grpc

GRPC_KEEPALIVE_TIMEOUT

  • Description: Keepalive timeout for gRPC connections.
  • Services: grpc

GRPC_MAX_RECEIVE_MESSAGE_LENGTH

  • Description: Maximum receive message length for gRPC.
  • Services: grpc

GRPC_MAX_SEND_MESSAGE_LENGTH

  • Description: Maximum send message length for gRPC.
  • Services: grpc

GRPC_COMPRESSION_ENABLED

  • Description: Whether compression is enabled for gRPC.
  • Services: grpc

GRPC_LOAD_BALANCING_POLICY

  • Description: Load balancing policy for gRPC (round_robin, pick_first).
  • Services: grpc

SERVICE_CORE_PLATFORM_GRPC_MOUNT_PORT

  • Description: Environment variable SERVICE_CORE_PLATFORM_GRPC_MOUNT_PORT used in grpc-file-service containers.
  • Services: grpc-file-service

SERVICE_CORE_PLATFORM_HOST

  • Description: Environment variable SERVICE_CORE_PLATFORM_HOST used in grpc-file-service containers.
  • Services: grpc-file-service

USE_STREAM_ENCRYPTION

  • Description: Environment variable USE_STREAM_ENCRYPTION used in grpc-file-service containers.
  • Services: grpc-file-service

Elasticsearch & Search

ELASTICSEARCH_HOST

  • Description: Hostname for Elasticsearch server.
  • Services: elasticsearch

ELASTICSEARCH_PORT

  • Description: Port for Elasticsearch server.
  • Services: elasticsearch

ELASTICSEARCH_USERNAME

  • Description: Username for Elasticsearch authentication.
  • Services: elasticsearch

ELASTICSEARCH_PASSWORD

  • Description: Password for Elasticsearch authentication.
  • Services: elasticsearch

ELASTICSEARCH_SSL_ENABLED

  • Description: Whether SSL is enabled for Elasticsearch.
  • Services: elasticsearch

ELASTICSEARCH_SSL_VERIFY

  • Description: Whether to verify SSL certificates for Elasticsearch.
  • Services: elasticsearch

ELASTICSEARCH_INDEX_PREFIX

  • Description: Prefix for Elasticsearch indices.
  • Services: elasticsearch

ELASTICSEARCH_BULK_SIZE

  • Description: Bulk size for Elasticsearch operations.
  • Services: elasticsearch

ELASTICSEARCH_TIMEOUT

  • Description: Timeout for Elasticsearch operations.
  • Services: elasticsearch

ELASTICSEARCH_MAX_RETRIES

  • Description: Maximum retries for Elasticsearch operations.
  • Services: elasticsearch

ELASTICSEARCH_RETRY_ON_TIMEOUT

  • Description: Whether to retry on timeout for Elasticsearch.
  • Services: elasticsearch

ELASTICSEARCH_SNIFF_ON_START

  • Description: Whether to sniff on start for Elasticsearch.
  • Services: elasticsearch

ELASTICSEARCH_SNIFF_ON_CONNECTION_FAIL

  • Description: Whether to sniff on connection failure for Elasticsearch.
  • Services: elasticsearch

ELASTICSEARCH_SNIFFER_TIMEOUT

  • Description: Sniffer timeout for Elasticsearch.
  • Services: elasticsearch

ELASTICSEARCH_MAX_SEARCH_SIZE

  • Description: Maximum search size for Elasticsearch queries.
  • Services: elasticsearch
  • Description: Feature flag to enable the Spotlight search features in the UI.
  • Services: apps-server, webapp

WALKER_EMIT_REPO_TASK_BATCH_SIZE

  • Description: Environment variable WALKER_EMIT_REPO_TASK_BATCH_SIZE used in search-tservice containers.
  • Services: search-tservice

WALKER_LIST_DIR_PAGE_SIZE

  • Description: Environment variable WALKER_LIST_DIR_PAGE_SIZE used in search-tservice containers.
  • Services: search-tservice

WALKER_MAX_NUM_DIRS_PER_WALK

  • Description: Environment variable WALKER_MAX_NUM_DIRS_PER_WALK used in search-tservice containers.
  • Services: search-tservice

WALKER_MAX_NUM_FILES_PER_WALK

  • Description: Environment variable WALKER_MAX_NUM_FILES_PER_WALK used in search-tservice containers.
  • Services: search-tservice

WALKER_POLL_PERIOD_IN_SEC

  • Description: Environment variable WALKER_POLL_PERIOD_IN_SEC used in search-tservice containers.
  • Services: search-tservice

WALKER_TASK_EXPORTER_TYPE

  • Description: Environment variable WALKER_TASK_EXPORTER_TYPE used in search-tservice containers.
  • Services: search-tservice

Redis Configuration

REDIS_HOST

  • Description: Hostname for Redis server.
  • Services: redis

REDIS_PORT

  • Description: Port for Redis server.
  • Services: redis

REDIS_PASSWORD

  • Description: Password for Redis authentication.
  • Services: redis

REDIS_DATABASE

  • Description: Redis database number to use.
  • Services: redis

REDIS_SSL_ENABLED

  • Description: Whether SSL is enabled for Redis.
  • Services: redis

REDIS_SSL_CERT_PATH

  • Description: Path to SSL certificate for Redis.
  • Services: redis

REDIS_SSL_KEY_PATH

  • Description: Path to SSL private key for Redis.
  • Services: redis

REDIS_SSL_CA_PATH

  • Description: Path to SSL CA certificate for Redis.
  • Services: redis

REDIS_CONNECTION_POOL_SIZE

  • Description: Size of Redis connection pool.
  • Services: redis

REDIS_CONNECTION_TIMEOUT

  • Description: Connection timeout for Redis in seconds.
  • Services: redis

REDIS_SOCKET_TIMEOUT

  • Description: Socket timeout for Redis in seconds.
  • Services: redis

REDIS_RETRY_ON_TIMEOUT

  • Description: Whether to retry on timeout for Redis.
  • Services: redis

REDIS_MAX_CONNECTIONS

  • Description: Maximum number of Redis connections.
  • Services: redis

REDIS_HEALTH_CHECK_INTERVAL

  • Description: Health check interval for Redis connections.
  • Services: redis

APPEND_FILE_NAME

  • Description: Name of the AOF within APPEND_DIR_NAME. See Redis appendfilename configuration.
  • Services: redis-configuration-api, redis-persistent

Nginx & Web Server

NGINX_HOST

  • Description: Hostname for Nginx server.
  • Services: nginx

NGINX_PORT

  • Description: Port for Nginx server.
  • Services: nginx

NGINX_WORKER_PROCESSES

  • Description: Number of worker processes for Nginx.
  • Services: nginx

NGINX_WORKER_CONNECTIONS

  • Description: Number of worker connections for Nginx.
  • Services: nginx

NGINX_CLIENT_MAX_BODY_SIZE

  • Description: Maximum client body size for Nginx.
  • Services: nginx

NGINX_PROXY_TIMEOUT

  • Description: Proxy timeout for Nginx.
  • Services: nginx

NGINX_PROXY_CONNECT_TIMEOUT

  • Description: Proxy connect timeout for Nginx.
  • Services: nginx

NGINX_PROXY_READ_TIMEOUT

  • Description: Proxy read timeout for Nginx.
  • Services: nginx

NGINX_PROXY_SEND_TIMEOUT

  • Description: Proxy send timeout for Nginx.
  • Services: nginx

NGINX_KEEPALIVE_TIMEOUT

  • Description: Keepalive timeout for Nginx.
  • Services: nginx

NGINX_SSL_ENABLED

  • Description: Whether SSL is enabled for Nginx.
  • Services: nginx

NGINX_SSL_CERT_PATH

  • Description: Path to SSL certificate for Nginx.
  • Services: nginx

NGINX_SSL_KEY_PATH

  • Description: Path to SSL private key for Nginx.
  • Services: nginx

ALL_ALLOWED_HOSTS

  • Description: In order to avoid HTTP host header poisoning, ALL_ALLOWED_HOSTS restricts HTTP host header to a specific set of domain names specified by this env var.
  • Services: nginx

API_SERVER

  • Description: The URL endpoint to api-server for routing requests by server-nginx.
  • Services: nginx, server-nginx

API_SERVER_APPS

  • Description: The URL endpoint to api-server-apps for routing requests by server-nginx.
  • Services: nginx, server-nginx

WORDPRESS_BACKEND

  • Description: The URL used for Instabase’s wordpress backend for serving documentation.
  • Services: kubernetes, server-nginx

LDAP Integration

LDAP_HOST

  • Description: Hostname for LDAP server.
  • Services: ldap

LDAP_PORT

  • Description: Port for LDAP server.
  • Services: ldap

LDAP_BIND_DN

  • Description: Bind DN for LDAP authentication.
  • Services: ldap

LDAP_BIND_PASSWORD

  • Description: Bind password for LDAP authentication.
  • Services: ldap

LDAP_BASE_DN

  • Description: Base DN for LDAP searches.
  • Services: ldap

LDAP_USER_SEARCH_FILTER

  • Description: Search filter for LDAP user lookups.
  • Services: ldap

LDAP_GROUP_SEARCH_FILTER

  • Description: Search filter for LDAP group lookups.
  • Services: ldap

LDAP_USER_ATTRIBUTES

  • Description: Comma-separated list of user attributes to retrieve.
  • Services: ldap

LDAP_GROUP_ATTRIBUTES

  • Description: Comma-separated list of group attributes to retrieve.
  • Services: ldap

LDAP_SSL_ENABLED

  • Description: Whether SSL is enabled for LDAP.
  • Services: ldap

LDAP_SSL_CERT_PATH

  • Description: Path to SSL certificate for LDAP.
  • Services: ldap

LDAP_CONNECTION_TIMEOUT

  • Description: Connection timeout for LDAP in seconds.
  • Services: ldap

LDAP_SEARCH_TIMEOUT

  • Description: Search timeout for LDAP in seconds.
  • Services: ldap

License & Billing

LICENSE_SERVICE_HOST

  • Description: Hostname for the license service.
  • Services: license-service

LICENSE_SERVICE_PORT

  • Description: Port for the license service.
  • Services: license-service

LICENSE_KEY

  • Description: License key for the application.
  • Services: license-service

LICENSE_VALIDATION_ENABLED

  • Description: Whether license validation is enabled.
  • Services: license-service

LICENSE_VALIDATION_INTERVAL

  • Description: Interval for license validation checks.
  • Services: license-service

LICENSE_EXPIRY_WARNING_DAYS

  • Description: Number of days before expiry to show warnings.
  • Services: license-service

BILLING_ENABLED

  • Description: Whether billing is enabled.
  • Services: billing

BILLING_PROVIDER

  • Description: Billing provider (stripe, aws_marketplace).
  • Services: billing

BILLING_CURRENCY

  • Description: Currency for billing operations.
  • Services: billing

BILLING_WEBHOOK_SECRET

  • Description: Webhook secret for billing provider.
  • Services: billing

AIHUB_COMMERCIAL_SUBSCRIPTION_COST

  • Description: The cost (USD) of an AI Hub commercial subscription
  • Services: aihub, apps-server, billing, license-service, webapp

This document was automatically generated from env-docs.json (excluding internal variables)