selbekk / app-favicon

An Enonic XP app for adding favicons to your site

Add a favicon to your Enonic site

Need to add favicons to your Enonic XP site? This is the app for you!

Note: Requires Enonic v6.4.1

How to use

The application is available through the Enonic Market. This means starting to use this application is easier than the first few levels of Candy Crush.

Step 1: Install application

Head over to the Applications section of your Enonic XP installation. Click "Install", and then select the "Enonic Market" tab. Find "Favicon", and click the install button.

Bam, the application is now installed.

Step 3: Apply the application to your site

In the content manager, select your site and click edit. Search for Favicon in the Applications search box, and select it.

Step 4: Upload your favicon image

Finally, upload your favicon image. Click the edit application on your site config page, and either choose an existing image or upload a new one.

We suggest it's a large square .png image (at least 512 * 512 px), but JPG is also probably fine.

Step 5: Set a cache time-to-live for your favicon (optional)

The generated favicons are cached using enonics lib-cache, and with the time-to-live input you can change how long the data should be kept in the cache.

Open open source

If you want to contribute, please create a pull request. If it's approved, you'll get full contributor access, as well as your name on the contributors list. We trust you!

app-favicon's Issues

Upgrade to version 7

Is it possible to upgrade the application to support enonic XP 7?

Absolute paths

It would be nice to have the option of getting absolute rather than relative paths when using the favicon app. For instance when a site is providing a decorator with menus, footers etc to be used on another domain...

Favicons get black background on iOS

Ref this article, transparent sections of favicons turns black on iOS when you save a website to the home screen.

Perhaps we could create the apple touch icons as JPGs instead, so that the background would default to the more sensible white.

Discussion: Add own favicon upload?

I've actually had this on my never ending todo-list for a while. So very pleased to see you did such an excellent job with this.

A few suggestions I had for the app I would make might benefit your app. Do as you please with my ideas, they're mostly just me trying to discuss and weigh pros and cons about them. What do you think?

favicon.ico is a special format, it's perhaps not an image that should be scaled even as that often screws it up. You can ofc use .png and most modern browsers will use that. But I've found loads and loads programs with legacy code still use the .ico file, and only that. Even loads of crawlers out there only assumes people have a favicon.ico file on root. What this does is it adds loads of 404 on my server for that .ico file on root. So my point here is that it might be valuable to still serve favicon.ico (from root with a url filter) and because of it's tiny scale - let user control it separately (if they want, ofc).

What do you think?

Discussion: Add manifest files for mobiles

I don't know much about the details of this, but what I've gathered is that mobiles can now use an XML format file (or two, not sure) to specify more details about favicons and behavior.

Is this something that should be added to this app or is it completely out of scope? Seen some activity in the forums about struggles here. See here for more details:
https://discuss.enonic.com/t/how-to-set-up-favicons/361