https://github.com/victor-perez/nuxt-helmet

:construction_worker: Helmet for Nuxt
https://github.com/victor-perez/nuxt-helmet

helmet nuxt nuxt-module nuxtjs vue vuejs

Last synced: 5 days ago
JSON representation

:construction_worker: Helmet for Nuxt

• Host: GitHub
• URL: https://github.com/victor-perez/nuxt-helmet
• Owner: victor-perez
• License: mit
• Created: 2019-02-15T18:07:45.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-27T08:42:30.000Z (almost 2 years ago)
• Last Synced: 2024-12-21T17:08:12.204Z (12 days ago)
• Topics: helmet, nuxt, nuxt-module, nuxtjs, vue, vuejs
• Language: JavaScript
• Homepage:
• Size: 1.85 MB
• Stars: 191
• Watchers: 3
• Forks: 7
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Helmet for nuxt

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Circle CI][circle-ci-src]][circle-ci-href]

[![Codecov][codecov-src]][codecov-href]

[![Dependencies][david-dm-src]][david-dm-href]

[![Standard JS][standard-js-src]][standard-js-href]

[![Buy Me A Coffee][bmc-shield-src]][bmc-href]

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvictor-perez%2Fnuxt-helmet.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvictor-perez%2Fnuxt-helmet?ref=badge_shield)

> Easy [Helmet](https://helmetjs.github.io/) integration with Nuxt.js

> [Helmet](https://helmetjs.github.io/) helps you secure your Nuxt apps by setting various HTTP headers. By default [Helmet](https://helmetjs.github.io/) will set the

`X-DNS-Prefetch-Control`, `X-Frame-Options`, `Strict-Transport-Security`, `X-Download-Options`, `Expect-Ct`, `Referrer-Policy` and `X-Content-Type-Options` headers. Beside that this module will also set by default the `X-Permitted-Cross-Domain-Policies` header. 

[📖 **Release Notes**](https://github.com/victor-perez/nuxt-helmet/releases) | [📖 **Helmet Docs**](https://helmetjs.github.io/docs/)

## Setup

1. Add `nuxt-helmet` dependency with `yarn` or `npm` into your project

2. Add `nuxt-helmet` at the beginning of the  `modules` section of `nuxt.config.js`

3. Configure it:

```js

{

  modules: [

    'nuxt-helmet'

    //...other modules

 ],

 // helmet options

 // @see https://helmetjs.github.io/docs/

 helmet: {

    /*

    frameguard: false,

    ...

    */

 }

}

```

## Note

Use `csp` property provided by Nuxt.js v2.11.0 for Content Security Policy (CSP) | [📖 **Nuxt Docs**](https://nuxtjs.org/api/configuration-render/#csp)

## Development

1. Clone this repository

2. Install dependencies using `yarn install` or `npm install`

3. Start development server using `npm run dev`

## Sponsor

[![Buy Me A Coffee][bmc-src]][bmc-href]

## License

[MIT License](./LICENSE)

Copyright (c) Victor Perez 

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-helmet.svg?style=flat-square

[npm-downloads-href]: https://npmjs.com/package/nuxt-helmet

[npm-version-src]: https://img.shields.io/npm/v/nuxt-helmet/latest.svg?style=flat-square

[npm-version-href]: https://npmjs.com/package/nuxt-helmet

[circle-ci-src]: https://img.shields.io/circleci/project/github/victor-perez/nuxt-helmet.svg?style=flat-square

[circle-ci-href]: https://circleci.com/gh/victor-perez/nuxt-helmet

[codecov-src]: https://img.shields.io/codecov/c/github/victor-perez/nuxt-helmet.svg?style=flat-square

[codecov-href]: https://codecov.io/gh/victor-perez/nuxt-helmet

[david-dm-src]: https://david-dm.org/victor-perez/nuxt-helmet/status.svg?style=flat-square

[david-dm-href]: https://david-dm.org/victor-perez/nuxt-helmet

[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square

[standard-js-href]: https://standardjs.com

[bmc-src]: https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png

[bmc-href]: https://www.buymeacoffee.com/victoraperez

[bmc-shield-src]: https://img.shields.io/static/v1?message=Buy%20me%20a%20coffee&logo=buy-me-a-coffee&style=flat-square&label=Sponsor&logoColor=white&color=ff813f

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvictor-perez%2Fnuxt-helmet.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvictor-perez%2Fnuxt-helmet?ref=badge_large)