Storage and Redis

Configure local and distributed maintenance state.

With no configuration, the module creates a Nitro filesystem mount at .data/nuxt-maintainer.

export default defineNuxtConfig({
  modules: ['nuxt-maintainer'],
  maintainer: { storage: { keyPrefix: 'my-service' } },
})

For multiple nodes, install the optional ioredis@^5 peer and reuse a Nitro Redis mount:

export default defineNuxtConfig({
  modules: ['nuxt-maintainer'],
  nitro: {
    storage: {
      sharedMaintenance: {
        driver: 'redis',
        url: process.env.REDIS_URL,
        base: 'my-app',
      },
    },
  },
  maintainer: {
    storage: { mount: 'sharedMaintenance', keyPrefix: 'nuxt-maintainer' },
  },
})

The server and CLI resolve the same mount. If the app owns an unrelated Redis client, expose the same endpoint as a Nitro mount. Credentials are never copied into records or responses.

Version 1 CLI mutations support filesystem and Redis only. Runtime reads fail open with rate-limited logging; CLI operations fail non-zero. The storage boundary remains open to future LibSQL, PostgreSQL, and D1 adapters.

Copyright © 2026