This repo serves as a content delivery network to override certain website favicons that are either difficult to see, or may implement measures which disallow grabbing the favicon from their website. It is to be used in combination with the self-hosted Searxico Favicon Worker.
If a user attempts to locate a favicon for a particular website, this repository will be the first place that is checked. It will attempt to find an icon here and return it. If an icon does not exist for a particular domain in this repository; the favicon worker will then proceed forward with checking the domain itself for a current favicon.
If you wish to host your own version of this repository to store icons, fork this repository, add your own icons, and then push a new repository from your Github account.
After you have created the new repository, open the source code within /src/index.js from the Worker Repository and change the following line to your new repository URL:
const serviceBackup = 'https://raw.githubusercontent.com/Aetherinox/searxico-cdn/main';A working demo can be tried at the below address:
https://searxico.aetherinox.workers.dev/get/{DOMAIN}/{ICON_SIZE}
https://searxico.aetherinox.workers.dev/get/reddit.com/64
If you have attempted to grab an icon for a certain website that is either difficult to see, or will not properly capture; you may submit an override icon to this repo. However, ensure the following:
- Submissions MUST be in
.icoicon format - Must include the following sizes:
- 64 x 64
- 48 x 48
- 32 x 32
- 24 x 24
- 20 x 20
- 16 x 16
- All sizes need to be combined into a single
.icofile - Each icon should not exceed
100kb - Icon should be placed in a parent folder which starts with the first letter of the service
- Ex:
/r/reddit.com.icofor Reddit - If you are providing a favicon for a subdomain, the folder name should start with the first letter of the subdomain, not the base domain.
- Ex:
/f/forum.libriv.ox.org.ico
- Ex:
- Domains with dashes should be labeled with the same character.
- Ex:
/r/random-website.com.ico
- Ex:
- Anything after the TLD (top-level domain : .com, .org, .net, etc.) is ignored.
- Ex: https://subdomain.my-domain-example.com/example/page/file.html should have a favicon in
/s/subdomain.my-domain-example.com.ico
- Ex: https://subdomain.my-domain-example.com/example/page/file.html should have a favicon in
- Ex:
If you need an easy solution for converting icons to .ico with the proper sizes, you can install:
This repo supports fetching icons for locally hosted web-apps. However, keep in mind that some applications conflict and may share the same port.
In order to fetch the icon, you will need to change conflicting web-app ports to the same port specified below:
| App | Default Port | Repo Port |
|---|---|---|
| Duplicacy | 3875 | 3875 |
| Duplicati | 8200 | 8200 |
| FileBrowser | 22534 | 22534 |
| Gitea | 3000 | 3000 |
| Gogs | 3000 | 3002 |
| Jackett | 9117 | 9117 |
| Linkwarden | 3000 | 3003 |
| Netdata | 19999 | 19999 |
| OpenGist | 6157 | 6157 |
| Portainer | 9443 | 9443 |
| Prowlarr | 9696 | 9696 |
| qBittorrent | 8081 | 8081 |
| ShellInABox | 4200 | 4200 |
| Sonarr | 8989 | 8989 |
| Swizzin | 8333 | 8333 |
| Syncthing | 8384 | 8384 |
| TheLounge | 9000 | 9000 |
| Uptime Kuma | 3001 | 3001 |
| Webmin | 10000 | 10000 |
All trademarks, logos and brand names are the property of their respective owners. All company, product and service names used in this repository are for identification purposes only. Use of these names, trademarks and brands does not imply endorsement.
We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:
Want to help but can't write code?
- Review active questions by our community and answer the ones you know.
The following people have helped get this project going:
