https://github.com/firstandthird/hapi-favicon

Return something for those annoying favicon.ico requests
https://github.com/firstandthird/hapi-favicon

hapi-plugin hapi-v17

Last synced: 14 days ago
JSON representation

Return something for those annoying favicon.ico requests

• Host: GitHub
• URL: https://github.com/firstandthird/hapi-favicon
• Owner: firstandthird
• License: mit
• Created: 2015-09-30T17:15:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-03-17T18:29:20.000Z (almost 4 years ago)
• Last Synced: 2025-01-06T17:55:01.727Z (27 days ago)
• Topics: hapi-plugin, hapi-v17
• Language: JavaScript
• Size: 11.7 KB
• Stars: 6
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hapi-favicon

A simple [hapi](https://hapi.dev/) plugin that serves the favicon.ico route

for you.  This is the icon that will appear in browser tabs.

## Installation

```

npm install hapi-favicon

```

## Basic Icons

Just register the plugin with your hapi server:

```js

 await server.register({

   plugin: require('hapi-favicon'),

   options: {

     path: '/path/to/standard/icons/standard.ico'

   }

 });

```

where _path_ is the local file path to your favicon image.  This will register a route with hapi at

the standard _/favicon.ico_ route that returns your icon with the _image/x-icon_ mime header type. Leaving _path_ blank will just serve a blank image.

## Apple Touch Icons

You can tell hapi-favicon to also serve Apple touch icons for Apple-specific devices, in addition to the standard .ico icons:   

```js

 await server.register({

   plugin: require('hapi-favicon'),

   options: {

     path: '/path/to/standard/icons/standard.ico',

     appleTouch: '/path/to/apple/icons/'

   }

);

```

This will register a route at _'/apple-touch-icon{size?}.png'_ that serves the corresponding PNG icon from the _/path/to/apple/icons_ folder.  Sizes supported are the Apple-standard dimensions: 57x57, 60x60, 72x72, 76x76, 114x114, 120x120, 144x144, 152x152.  If the client requests dimensions other than these standard dimensions, the plugin will default to the next-lowest size.  For example if you request _/apple-touch-icon65x65.png_, you will get the _apple-touch-icon60x60.png_ icon instead.

Setting the _appleTouch_ icon to _true_ instead of a file path will result in the _'/apple-touch-icon{size?}.png'_ route serving an empty _image/x-icon_ for all requested image sizes.

## Auth option

If you want your favicon.ico route to be protected by your hapi [auth](https://hapi.dev/api/?v=20.1.0#-routeoptionsauth) scheme, you can specify the auth config like so:

```js

await server.register({

  plugin: require('hapi-favicon'),

  options: {

    path: '/path/to/standard/icons/standard.ico',

    auth: {

      strategy: 'cookie',

      mode: 'try'

    }

  }

);

```

This only applies to the favicon.ico route, Apple touch icons will be publicly available.