# sails-hook-maintenance-mode

> Sails JS hook to supply a simple maintenance mode for sites.

Latest version **0.2.0** (published 2017-10-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install sails-hook-maintenance-mode
pnpm add sails-hook-maintenance-mode
yarn add sails-hook-maintenance-mode
bun add sails-hook-maintenance-mode
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-10-02 |
| First published | 2016-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Scott Gress |
| Maintainers | sgress454 |

## Links

- npm: https://www.npmjs.com/package/sails-hook-maintenance-mode
- Repository: https://github.com/sgress454/sails-hook-maintenance-mode
- Issues: https://github.com/sgress454/sails-hook-maintenance-mode/issues
- npm.io page: https://npm.io/package/sails-hook-maintenance-mode

## Dependencies (1)

- [@sailshq/lodash](https://npm.io/package/@sailshq/lodash.md) ^3.10.2

## Recent versions

- 0.2.0 (latest) — 2017-10-02
- 0.1.0 — 2016-02-03

## README

# sails-hook-maintenance-mode

[Sails JS](http://sailsjs.org) hook to provide a simple "maintenance mode" for an app, toggleable with an environment variable.  In maintenance mode, all requests receive an "under maintenance" page or message in response.

### Installation

`npm install sails-hook-maintenance-mode`

### Usage

To lift an app in maintenance mode, set the MAINTENANCE_MODE environment variable to "true".

```
MAINTENANCE_MODE=true sails lift
```

### Configuration

By default, configuration lives in `sails.config['maintenance-mode']`.  The configuration key (`maintenance-mode`) can be changed by setting `sails.config.hooks['sails-hook-maintenance-mode'].configKey`.

Parameter      | Type                | Default | Details
-------------- | ------------------- | ------- | :---------------------------------:
envVar        | ((string)) | `MAINTENANCE_MODE` | Environment variable to check
view | ((string)) | _none_ | View to display in maintenance mode.  If not provided, the hook will use the `views/maintenance.ejs` view if your app has one.  Otherwise, it will show a default maintenance page.  Set to `false` to display text or JSON instead of a view (see `text_message` and `json_message` options)
viewLocals | ((dictionary)) | `{}` | Locals and options to use with your maintenance view.  You can use this to change up the message per environment, or to provide a different layout.
whitelistUrls | ((array)) | _none_ | Array of strings or regular expressions to match a requested URL against.  If the URL matches anything in the whitelist, it will bypass maintenance mode and be allowed to proceed.  Useful for keeping certain sections of a site (like a contact page or FAQ) live.
status | ((number)) | 503 (service unavailable) | Status code to respond with in maintenance mode.
jsonMessage | ((json)) | _none_ | If `view` is set to `false` and `json_message` is provided, the [`res.json`](http://sailsjs.org/documentation/reference/response-res/res-json) method will be used with that value for the response in maintenance mode.
textMessage | ((string)) | _none_ | If `view` is set to `false` and `text_message` is provided (and `json_message` is _not_ provided), the [`res.send`](http://sailsjs.org/documentation/reference/response-res/res-send) method will be used with that value for the response in maintenance mode.
backdoorOnParam    | ((string)) | _none_ | Parameter which can be used to unlock maintenance mode for a single session.  Use this to test updates to the site while the rest of the world still sees the maintenance page.
backdoorOffParam    | ((string)) | _none_ | Parameter which can be used to re-instate maintenance mode for a session after the `backdoor_on_param` has been used.

#### Example

```javascript
// [your-sails-app]/config/env/production.js
module.exports = {
  'maintenance-mode': {
    envVar: 'MAINTENANCE',
    view: false,
    textMessage: "Site currently under maintenance, please try again later."
    backdoorOnParam: 'open_sesame',
    backdoorOffParam: 'close_sesame',
    status: 200
  }
};

```

---
_Source: https://npm.io/package/sails-hook-maintenance-mode · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._