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 | Which modules to enable in the setup? | string - comma-separated list | text2vec-openai,generative-openai |
DEFAULT | Default vectorizer module - will be overridden by any class-level value defined in the schema | string | text2vec-contextionary |
AUTOSCHEMA | Whether to infer the schema where necessary with the autoschema (default: true ) | string - true/false | true |
QUERY | Sets the maximum total number of objects that can be retrieved. | string - number | 10000 |
QUERY | 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, such as 10-20% of your total memory for Weaviate. 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 | Where should Weaviate Standalone store its data? | string - file path | /var/lib/weaviate |
PERSISTENCE | Function used to access disk data in virtual memory | string | mmap (default) or pread |
DISK_USE | 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 | 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 |
ASYNC | (Experimental as of v1.22 .) If set, Weaviate creates vector indexes asynchronously to the object creation process. This can be useful for importing large amounts of data. (default: false ) | string - true/false | false |
REINDEX | 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 | If set, Weaviate will collect metrics in a Prometheus-compatible format | string - true/false | false |
PROMETHEUS | If set, Weaviate will group metrics for the same class across all shards. | string - true/false | true |
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 | Service-Discovery for the contextionary container | string - URL | http://contextionary |
TRANSFORMERS | The endpoint where to reach the transformers module if enabled | string | http://t2v-transformers:8080 |
CLIP | The endpoint where to reach the clip module if enabled | string | http://multi2vec-clip:8000 |
IMAGE | The endpoint where to reach the img2vec-neural module if enabled | string | http://localhost:8000 |
Authentication & Authorization
Variable | Description | Type | Example Value |
---|---|---|---|
AUTHENTICATION | Allow users to interact with weaviate without auth | string - true/false | true |
AUTHENTICATION | Enable API key-based authentication | string - true/false | false |
AUTHENTICATION | Allowed API keys. Each key corresponds to a specific user identity below. | string - comma-separated list | jane-secret-key,ian-secret-key |
AUTHENTICATION | API key-based identities. Each identity corresponds to a specific key above. | string - comma-separated list | jane@doe.com,ian-smith |
AUTHENTICATION | Enable OIDC-based authentication | string - true/false | false |
AUTHENTICATION | OIDC Token Issuer | string - URL | https://myissuer.com |
AUTHENTICATION | OIDC Client ID | string | my-client-id |
AUTHENTICATION | OIDC Username Claim | string | email |
AUTHENTICATION | OIDC Groups Claim | string | groups |
AUTHORIZATION | Enable AdminList Authorization mode | string - true/false | true |
AUTHORIZATION | Users with admin permission | string - comma-separated list | jane |
AUTHORIZATION | Users with read-only permission | string - comma-separated list | alice |
Multi-node setups
Variable | Description | Type | Example Value |
---|---|---|---|
CLUSTER | Hostname of a node | string | node1 |
CLUSTER | Port for exchanging network state information. | string - number | 7102 |
CLUSTER | Port for exchanging data. | string - number | 7103 |
CLUSTER | The service name of the "founding" member node in a cluster setup | string | weaviate-node-1:7100 |