> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/get-convex/rate-limiter/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install and configure the Convex Rate Limiter component

## Install the Package

Install the `@convex-dev/rate-limiter` package using your preferred package manager:

<CodeGroup>
  ```bash npm theme={null}
  npm install @convex-dev/rate-limiter
  ```

  ```bash yarn theme={null}
  yarn add @convex-dev/rate-limiter
  ```

  ```bash pnpm theme={null}
  pnpm add @convex-dev/rate-limiter
  ```
</CodeGroup>

## Configure Convex

Create a `convex.config.ts` file in your app's `convex/` folder and register the rate limiter component by calling `use`:

```typescript convex/convex.config.ts theme={null}
import { defineApp } from "convex/server";
import rateLimiter from "@convex-dev/rate-limiter/convex.config.js";

const app = defineApp();
app.use(rateLimiter);

export default app;
```

<Note>
  The `convex.config.ts` file is where you configure all Convex components. If you already have this file, simply add the `app.use(rateLimiter)` line.
</Note>

## Version Requirements

The rate limiter component has the following peer dependencies:

* **Convex**: `^1.24.8` or higher (required)
* **React**: `^18.2.0` or `^19.0.0` (optional, only needed if using the React hook)

<Warning>
  Make sure your Convex version is at least 1.24.8. Earlier versions are not compatible with this component.
</Warning>

## Verify Installation

After installation, run your Convex development server:

```bash theme={null}
npx convex dev
```

The component will be automatically compiled and available for use in your Convex functions.

## Next Steps

<Card title="Quickstart" icon="rocket" href="/quickstart">
  Follow the quickstart guide to define and use your first rate limit
</Card>