---
title: "Nuxt Module"
description: "Guides for what nuxt-convex adds on top of the Vue runtime: SSR, authenticated rendering, server routes, errors, storage, deployment and security."
canonical_url: "https://nuxt-convex.onmax.me/nuxt-module"
---
# Nuxt Module

> Guides for what nuxt-convex adds on top of the Vue runtime: SSR, authenticated rendering, server routes, errors, storage, deployment and security.

`nuxt-convex` installs the shared Vue runtime and wires it into Nuxt: server rendering with payload hydration, the request's user on the server, Nitro helpers, aliases and auto-imports.

## What the module adds

- the `convex` key in `nuxt.config.ts` ([reference](https://nuxt-convex.onmax.me/api-reference/module-configuration))
- the public `#convex`, `#convex/api`, and `#convex/advanced` aliases, plus the Optional `#convex/storage` alias when storage is enabled, and `#convex/server` in server code
- auto-imports for the composables, and the `ConvexQuery`, `ConvexPaginatedQuery` and auth components
- SSR for awaited queries, hydrated from the Nuxt payload
- a server-side token for the request's user, from Better Auth or your own `convex:token` hook
- server helpers such as `serverConvexQuery` and `requireConvexAuth`
- storage scaffolding and the Cloudflare R2 upload helper

## Guides

<card-group>
<card icon="i-lucide-server" title="SSR & Hydration" to="https://nuxt-convex.onmax.me/nuxt-module/ssr-and-hydration">

How awaited queries render on the server, hydrate, and hand off to the WebSocket.

</card>

<card icon="i-lucide-shield-check" title="Authenticated SSR" to="https://nuxt-convex.onmax.me/nuxt-module/authenticated-ssr">

Render signed-in pages with Better Auth or your own provider, and keep them out of shared caches.

</card>

<card icon="i-lucide-route" title="Server Routes" to="https://nuxt-convex.onmax.me/nuxt-module/server-routes">

Call Convex as the request's user from Nitro with `serverConvexQuery` and friends.

</card>

<card icon="i-lucide-triangle-alert" title="Error Handling" to="https://nuxt-convex.onmax.me/nuxt-module/error-handling">

Read `status` and `error`, match `ConvexError` codes, and map errors in server routes.

</card>

<card icon="i-lucide-hard-drive" title="File Storage" to="https://nuxt-convex.onmax.me/nuxt-module/file-storage">

Scaffold the storage functions and upload files with progress.

</card>

<card icon="i-lucide-cloud" title="Cloudflare R2" to="https://nuxt-convex.onmax.me/nuxt-module/cloudflare-r2">

Upload to R2 through the Convex R2 component.

</card>

<card icon="i-lucide-rocket" title="Deployment" to="https://nuxt-convex.onmax.me/nuxt-module/deployment">

Deploy Convex first, then ship to Vercel, Cloudflare Workers or Node.

</card>

<card icon="i-lucide-lock" title="Security" to="https://nuxt-convex.onmax.me/nuxt-module/security">

What stays on the server, and the checks that remain your job.

</card>
</card-group>

## Related sections

- [Getting Started](https://nuxt-convex.onmax.me/getting-started) to install the module
- [Integrations](https://nuxt-convex.onmax.me/integrations) for Better Auth and R2
- [Vue Guide](https://nuxt-convex.onmax.me/vue-guide) for the composables shared with plain Vue


## Sitemap

See the full [sitemap](https://nuxt-convex.onmax.me/sitemap.md) for all pages.
