This module allows users to edit the "favicon" (browser tab icon) of the site via the global settings of the site. As such, it pairs well with the Apostrophe palette and multisite modules.

Installation

To install the module, use the command line to run this command in an Apostrophe project's root directory:

npm install @apostrophecms/favicon

Usage

Configure the @apostrophecms/favicon module in the app.js file:

require('apostrophe')({
  shortName: 'my-project',
  modules: {
    '@apostrophecms/favicon': {}
  }
});

You do not have to do anything else. You can access the global settings of the site via the "Gear" button in the upper right. Once there, select the "Favicon" tab and choose your preferred image. Note that a square portion of the image is automatically cropped if you do not use the cropping interface manually.

There are no special requirements for images uploaded for this purpose, however you may wish to use a PNG file in order to achieve transparency effects.

Browsers vary in terms of how quickly you will see the new favicon image, but a page refresh usually suffices.