This is a favicon service:
Websites used to have a
favicon.ico, or not. With the introduction of the
apple-touch-icon.png finding “the icon” for a website became more complicated. This service finds and — if necessary — generates icons for web sites.
This endpoint always returns an icon image for the given site — it redirects to an official icon if possible or creates and returns a fallback image if needed.Parameter Example Description Default url http://yelp.com required size 32..50..100 Desired size range (min..perfect..max) If no image of size perfect..max nor perfect..min can be found a fallback icon will be generated. required formats png,ico Comma-separated list of accepted image formats: png, ico, gif
png,ico,giffallback_icon_url HTTP image URL If provided, a redirect to this image will be returned in case no suitable icon could be found. This overrides the default fallback image behaviour. fallback_icon_color ff0000 If provided, letter icons will be colored with the hex value provided, rather than be grey, when no color can be found for any icon. https://besticon-demo.herokuapp.com/icon?url=yelp.com&size=32..50..120 https://besticon-demo.herokuapp.com/icon?url=yelp.com&size=64..64..120 https://besticon-demo.herokuapp.com/icon?url=yelp.com size missing https://besticon-demo.herokuapp.com/icon?url=httpbin.org/status/404&size=32..64..120 https://besticon-demo.herokuapp.com/icon?url=httpbin.org/status/404&size=32..64..120&fallback_icon_color=ff0000 https://besticon-demo.herokuapp.com/icon?url=фминобрнауки.рф&size=32..64..120
This endpoint returns all icons for a given site.Parameter Example Description Default url http://yelp.com required formats png,ico Comma-separated list of accepted image formats: png, ico, gif
I tried hard to make this useful but please note there are some known limitations:
Feel free to file other bugs - and offer your help - at https://github.com/mat/besticon/issues.
Simple options to host this service are, for example:
A docker image is available at https://hub.docker.com/r/matthiasluedtke/iconserver/, generated from the Dockerfile in this repo. I try to keep it updated for every release.
Note that this docker image is not used to run https://besticon-demo.herokuapp.com and therefore not well tested.
Binaries for some operating systems can be downloaded from https://github.com/mat/besticon/releases/latest
If you have Go installed on your system you can use
go get to fetch the source code and build the server:
$ go get -u github.com/mat/besticon/...
If you want to build executables for a different target operating system you can add the
GOARCH environment variables:
$ GOOS=linux GOARCH=amd64 go get -u github.com/mat/besticon/...
To start the server on default port 8080 just do
To use a different port use
$ PORT=80 iconserver
To listen on a different address (say localhost) use
$ ADDRESS=127.0.0.1 iconserver
Now when you open http://localhost:8080/icons?url=instagram.com you should see something like
There is not a lot to configure but these environment variables existVariable Description Default Value
PORTHTTP server port 8080
CACHE_SIZE_MBSize for the groupcache 32
HTTP_USER_AGENTUser-Agent for HTTP requests iPhone user agent string
HTTP_CLIENT_TIMEOUTTimeout used for HTTP requests. Supports units like ms, s, m. 5s
HTTP_MAX_AGE_DURATIONCache duration for all dynamically generated HTTP responses. Supports units like ms, s, m. 720h (30 days)
POPULAR_SITESComma-separated list of domains used on /popular page
downloadto proxy downloads through besticon or
redirectto let browser to download instead. (example at #40)
redirecthttp://github.com/PuerkitoBio/goquery BSD style http://github.com/andybalholm/cascadia CSS selectors License http://github.com/golang/groupcache Apache License 2.0 http://github.com/golang/protobuf License http://github.com/golang/freetype FreeType License http://golang.org/x/image supplementary image libraries BSD style http://golang.org/x/net BSD style http://golang.org/x/text BSD style Noto Sans font used for the generated icons SIL Open Font License 1.1 The icon License
MIT License (MIT)
Copyright (c) 2015-2020 Matthias Lüdtke, Hamburg - https://github.com/mat
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
If you find this useful and want to donate... you would make my day :-)