Environment variables

     

Overview

This page includes a comprehensive list of environment variables that can be used to configure Weaviate in a Docker or a Kubernetes deployment.

List of environment variables

General

Variable	Description	Type	Example Value
ENABLE_MODULES	Which modules to enable in the setup?	string - comma-separated list	text2vec-openai,generative-openai
DEFAULT_VECTORIZER_MODULE	Default vectorizer module - will be overridden by any class-level value defined in the schema	string	text2vec-contextionary
AUTOSCHEMA_ENABLED	Whether to infer the schema where necessary with the autoschema (default: true)	string - true/false	true
QUERY_MAXIMUM_RESULTS	Sets the maximum total number of objects that can be retrieved.	string - number	10000
QUERY_DEFAULTS_LIMIT	Sets the default number of objects to be returned in a query.	string - number	25
GOMEMLIMIT	Set the memory limit for the Go runtime. This should match your available memory. The Go runtime tries to make sure that long-lived and temporary memory allocations do not exceed this value by making the Gargabe Collector more aggressive as the memory usage approaches the limit. Learn more about GOMEMLIMIT.	string - memory limit in SI uints	4096MiB
GODEBUG	Controls debugging variables within the runtime. See official Go docs.	string - comma-separated list of name=val pairs	gctrace=1
LOG_LEVEL	Sets the Weaviate logging level. Default: InfoLevel. General operational entries. debug: Very verbose logging. trace: Even finer-grained informational events.	string
LOG_FORMAT	Set the Weaviate logging format Default: Outputs log data to json. e.g.: {"action":"startup","level":"debug","msg":"finished initializing modules","time":"2023-04-12T05:07:43Z"} text: Outputs log data to a string. e.g. time="2023-04-12T04:54:23Z" level=debug msg="finished initializing modules" action=startup	string
ORIGIN	Set the http(s) origin for Weaviate	string - HTTP origin	https://my-weaviate-deployment.com
PERSISTENCE_DATA_PATH	Where should Weaviate Standalone store its data?	string - file path	/var/lib/weaviate
DISK_USE_WARNING_PERCENTAGE	If disk usage is higher than the given percentage a warning will be logged by all shards on the affected node's disk. See Disk Pressure Warnings and Limits for details.	string - number	80
DISK_USE_READONLY_PERCENTAGE	If disk usage is higher than the given percentage all shards on the affected node will be marked as READONLY, meaning all future write requests will fail. See Disk Pressure Warnings and Limits for details.	string - number	90
REINDEX_SET_TO_ROARINGSET_AT_STARTUP	Allow Weaviate to perform a one-off re-indexing to use Roaring Bitmaps. Available in versions 1.18 and higher.	string - true/false	true
PROMETHEUS_MONITORING_ENABLED	If set, Weaviate will collect metrics in a Prometheus-compatible format	string - true/false	false
BACKUP_*	Various configuration variables for backup provider modules. They are outlined in detail on the Backups page.

Module-specific

Variable	Description	Type	Example Value
CONTEXTIONARY_URL	Service-Discovery for the contextionary container	string - URL	http://contextionary
TRANSFORMERS_INFERENCE_API	The endpoint where to reach the transformers module if enabled	string	http://t2v-transformers:8080
CLIP_INFERENCE_API	The endpoint where to reach the clip module if enabled	string	http://multi2vec-clip:8000
IMAGE_INFERENCE_API	The endpoint where to reach the img2vec-neural module if enabled	string	http://localhost:8000

Authentication & Authorization

Variable	Description	Type	Example Value
AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED	Allow users to interact with weaviate without auth	string - true/false	true
AUTHENTICATION_APIKEY_ENABLED	Enable API key-based authentication	string - true/false	false
AUTHENTICATION_APIKEY_ALLOWED_KEYS	Allowed API keys. Each key corresponds to a specific user identity below.	string - comma-separated list	jane-secret-key,ian-secret-key
AUTHENTICATION_APIKEY_USERS	API key-based identities. Each identity corresponds to a specific key above.	string - comma-separated list	jane@doe.com,ian-smith
AUTHENTICATION_OIDC_ENABLED	Enable OIDC-based authentication	string - true/false	false
AUTHENTICATION_OIDC_ISSUER	OIDC Token Issuer	string - URL	https://myissuer.com
AUTHENTICATION_OIDC_CLIENT_ID	OIDC Client ID	string	my-client-id
AUTHENTICATION_OIDC_USERNAME_CLAIM	OIDC Username Claim	string	email
AUTHENTICATION_OIDC_GROUPS_CLAIM	OIDC Groups Claim	string	groups
AUTHORIZATION_ADMINLIST_ENABLED	Enable AdminList Authorization mode	string - true/false	true
AUTHORIZATION_ADMINLIST_USERS	Users with admin permission	string - comma-separated list	jane@example.com,john@example.com
AUTHORIZATION_ADMINLIST_READONLY_USERS	Users with read-only permission	string - comma-separated list	alice@example.com,dave@example.com

Multi-node setups

Variable	Description	Type	Example Value
CLUSTER_HOSTNAME	Hostname of a node	string	node1
CLUSTER_GOSSIP_BIND_PORT	Port for exchanging network state information.	string - number	7102
CLUSTER_DATA_BIND_PORT	Port for exchanging data.	string - number	7103
CLUSTER_JOIN	The service name of the "founding" member node in a cluster setup	string	weaviate-node-1:7100

More Resources

If you can't find the answer to your question here, please look at the:

1. Frequently Asked Questions. Or,
2. Knowledge base of old issues. Or,
3. For questions: Stackoverflow. Or,
4. For more involved discussion: Weaviate Community Forum. Or,
5. We also have a Slack channel.