Getting started

Install and configure nuxt-maintainer.

Installation

npx nuxi module add nuxt-maintainer

Or install it and add the module yourself:

npm install nuxt-maintainer
nuxt.config.ts
export default defineNuxtConfig({ modules: ['nuxt-maintainer'] })

The default filesystem store is .data/nuxt-maintainer. It is appropriate for one server, or multiple servers that genuinely share that directory.

Operate the site

npx nuxt-maintainer status
npx nuxt-maintainer down --message "Back shortly" --retry 120
npx nuxt-maintainer up

The running server reads state on every request. No restart or rebuild is required.

Supported deployments

Version 1 targets SSR Node/Nitro deployments. Static generation and edge-only runtimes are outside its scope. Filesystem state is local unless all nodes share it; use Redis for independently hosted nodes.

Copyright © 2026