---
title: "Modules"
description: "Weaviate's functionality can be customized by using modules. This page explains how to enable and configure modules."
url: https://docs.weaviate.io/weaviate/configuration/modules
---

# Modules

Weaviate's functionality can be customized by using [modules](https://docs.weaviate.io/weaviate/concepts/modules). This page explains how to enable and configure modules.

## Instance-level configuration

At the instance (i.e. Weaviate cluster) level, you can:

- Enable modules
- Configure module-specific variables (e.g. API keys), where applicable

This can be done by setting the appropriate [environment variables](https://docs.weaviate.io/deploy/configuration/env-vars) as shown below.

> [!TIP]
>
> **What about WCD?**
>
> Weaviate Cloud (WCD) instances come with modules pre-configured. See [this page](https://docs.weaviate.io/cloud/manage-clusters/status#enabled-modules) for details.

### Enable individual modules

You can enable modules by specifying the list of modules in the `ENABLE_MODULES` variable. For example, this code enables the `text2vec-transformers` module.

```yaml
services:
  weaviate:
    environment:
      ENABLE_MODULES: 'text2vec-transformers'
```

To enable multiple modules, add them in a comma-separated list.

This example code enables the `'text2vec-huggingface`, `generative-cohere`, and `qna-openai` modules.

```yaml
services:
  weaviate:
    environment:
      ENABLE_MODULES: 'text2vec-huggingface,generative-cohere,qna-openai'
```

### Enable all API-based modules

All API-based model integrations are available by default starting with Weaviate `v1.33`. For older versions, you can enable all API-based modules by setting the `ENABLE_API_BASED_MODULES` variable to `true`. This will enable all API-based [model integrations](https://docs.weaviate.io/weaviate/model-providers), such as those for Anthropic, Cohere, OpenAI and so on by enabling the relevant modules. These modules are lightweight, so enabling them all will not significantly increase resource usage.

```yaml
services:
  weaviate:
    environment:
      ENABLE_API_BASED_MODULES: 'true'
```

The list of API-based modules can be found on the [model provider integrations page](https://docs.weaviate.io/weaviate/model-providers#api-based). You can also inspect the [source code](https://github.com/weaviate/weaviate/blob/main/adapters/handlers/rest/configure_api.go) where the list is defined.

Enabling individual modules can be combined with the API-based modules. For example, since API-based modules are enabled by default from `v1.33`, the example below enables the Ollama modules and the `backup-s3` module alongside them.

```yaml
services:
  weaviate:
    environment:
      ENABLE_MODULES: 'text2vec-ollama,generative-ollama,backup-s3'
```

To opt out of the API-based modules from `v1.33` onwards, set `API_BASED_MODULES_DISABLED` to `true`. The older `ENABLE_API_BASED_MODULES` variable is no longer read.

Note that enabling multiple vectorizer (e.g. `text2vec`, `multi2vec`) modules will disable the [`Explore` functionality](https://docs.weaviate.io/weaviate/api/graphql/explore). If you need to use `Explore`, you should only enable one vectorizer module.

### Module-specific variables

You may need to specify additional environment variables to configure each module where applicable. For example, the `backup-s3` module requires the backup S3 bucket to be set via `BACKUP_S3_BUCKET`, and the `text2vec-contextionary` module requires the inference API location via `TRANSFORMERS_INFERENCE_API`.

Refer to the individual [module documentation](https://docs.weaviate.io/weaviate/modules) for more details.

## Vectorizer modules

The [vectorization integration](https://docs.weaviate.io/weaviate/model-providers) enable Weaviate to vectorize data at import, and to perform [`near<Media>`](https://docs.weaviate.io/weaviate/search/similarity) searches such as `nearText` or `nearImage`.

> [!NOTE]
>
> **List of available vectorizer integrations**
>
> Can be found [in this section](https://docs.weaviate.io/weaviate/model-providers).

### Enable vectorizer modules

You can enable vectorizer modules by adding them to the `ENABLE_MODULES` environment variable. For example, this code enables the `text2vec-cohere`, `text2vec-huggingface`, and `text2vec-openai` vectorizer modules.

```yaml
services:
  weaviate:
    environment:
      ENABLE_MODULES: 'text2vec-cohere,text2vec-huggingface,text2vec-openai'
```

### Default vectorizer module

> [!NOTE]
>
> **Deprecated in `v1.40`**

Weaviate ignores `DEFAULT_VECTORIZER_MODULE`, so set the `vectorizer` in each collection definition. See [Vector configuration defaults](https://docs.weaviate.io/deploy/migration#vector-config-defaults).

## Generative model integrations

The [generative model integrations](https://docs.weaviate.io/weaviate/model-providers) enable [retrieval augmented generation](https://docs.weaviate.io/weaviate/search/generative) functions.

### Enable a generative module

You can enable generative modules by adding the desired module to the `ENABLE_MODULES` environment variable. For example, this code enables the `generative-cohere` module and the `text2vec-huggingface` vectorizer module.

```yaml
services:
  weaviate:
    environment:
      ENABLE_MODULES: 'text2vec-huggingface,generative-cohere'
```

> [!TIP]
>
> **`generative` module selection unrelated to `text2vec` module selection**
>
> Your choice of the `text2vec` module does not restrict your choice of `generative` module, or vice versa.

## Tenant offload modules

Tenants can be offloaded to cold storage to reduce memory and disk usage, and onloaded back when needed.

See the [dedicated page on tenant offloading](https://docs.weaviate.io/deploy/configuration/tenant-offloading) for more information on how to configure Weaviate for tenant offloading. For information on how to offload and onload tenants, see [How-to: manage tenant states](https://docs.weaviate.io/weaviate/manage-collections/tenant-states).

## Custom modules

See [here](https://docs.weaviate.io/weaviate/modules/custom-modules) how you can create and use your own modules.

## Usage modules

The [usage module](https://docs.weaviate.io/weaviate/modules/usage-modules) collects and uploads usage analytics to GCS or S3.

## Related pages

- [Concepts: Modules](https://docs.weaviate.io/weaviate/concepts/modules)
- [References: Modules](https://docs.weaviate.io/weaviate/modules)
