This plugin for October CMS integrates with the RealFaviconGenerator.net service to generate and manage all the necessary favicons and HTML code for your website, ensuring full compatibility across all modern browsers and platforms.
Forget about manually creating dozens of different icons. Upload a single master image and let the plugin do the heavy lifting.
Features
- Full Integration with RealFaviconGenerator.net API: Automates the creation of favicons for desktop, iOS, Android, Windows, and more.
- Intuitive Settings Page: Easily manage your favicon settings from the October CMS backend.
- Automatic Generation: Creates all required files (
favicon.ico,apple-touch-icon.png, Android icons, etc.) and thesite.webmanifestfile. - Conflict Scanner: Includes a tool to scan your theme for existing favicon tags that could cause issues.
- Simple Component: Easily integrate all the favicon HTML code into your layouts with a single component.
Credits
This plugin is powered by the excellent and free service provided by the developers of RealFaviconGenerator.net.
License
This plugin is free to use. Its use is governed by the terms of service of the RealFaviconGenerator.net API. Please refer to their website for full details.
Installation
You can install this plugin from the October CMS Marketplace or using Composer.
Via Marketplace
- Go to the Settings > System > System Updates section in the administration panel of your project.
- Search for "Real Favicon Generator" by Davox.
- Click on the plugin to install it.
Via Composer
Open your terminal, navigate to the root directory of your October CMS project, and run the following command:
php artisan plugin:install Davox.RealFavicon
Configuration and Usage
Once the plugin is installed, follow these steps to generate your favicons:
Step 1: Initial Setup
- In the administration panel, navigate to Settings > CMS > Favicon Settings.
- First, you'll need a free API key. Get your key from your RealFaviconGenerator Dashboard and paste it into the API Key field.
- Next, upload your Master Picture. For the best results, use a square PNG file of at least 512x512 pixels.
- Click Save.
Step 2: Generate Your Favicon
- After saving the API key and master picture, the "Generate favicon" button will appear.
- Click this button. You will be redirected to the
RealFaviconGenerator.netwebsite to finalize your icon set. - On their site, configure the appearance for all platforms (iOS, Android, etc.) to your liking.
- When you are done, click the "Generate and install favicon" button on their site. You will be automatically redirected back to your October CMS backend. Your favicons are now installed in the
storage/app/media/favicon/directory.
Step 3: Check for Conflicts
- After the favicon set has been generated, a new button will become active: "Scan theme for overlapping tags".
- Click this button to scan your active theme files for any pre-existing favicon tags that might cause conflicts.
- If any conflicts are found, the tool will report the exact file and line number, allowing you to safely remove the old tags manually.
Displaying the Favicon
To display the favicons on your website, you must add the faviconTags component to the <head> section of your main Twig layout.
- Open your main layout file (e.g.,
/themes/your-theme/layouts/default.htm). - Add the following line just before the closing
</head>tag:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>{{ this.page.title }}</title>
<meta name="description" content="{{ this.page.meta_description }}">
{# ... other meta tags ... #}
{# --- Add the component here --- #}
{% component 'faviconTags' %}
</head>
<body>
...
</body>
</html>
The component will automatically inject all the necessary HTML code that was generated by RealFaviconGenerator.net.
Permissions
Access to the plugin's settings page is protected by the following permission, which you can assign to administrator roles as needed:
davox.realfavicon.access_favicon_settings: Allows access to the Real Favicon Generator settings page.
-
This plugin has not been reviewed yet.
-
| 1.0.1 |
First version of Real Favicon Generator Jul 15, 2025 |
|---|