Fetch the favicon of any website.
bash
cargo install favicon-rover
Fetch the favicon for a site using the cli tool
```bash
favicon-rover https://crates.io # output the crates favicon to stdout
favicon-rover https://crates.io --out favicon.png # output to favicon.png
favicon-rover https://crates.io --size 256 # set the size to 256px
favicon-rover https://crates.io --type webp # set the format to webp
favicon-rover https://crates.io -o favicons/cratesio -s 50 -t webp # all options
favicon-rover --help # show help information ```
Start the web server to expose an API that will fetch favicons
```bash
favicon-rover serve # start with default options
favicon-rover serve --port 8080 # run on port 8080
favicon-rover serve --host 12.34.56.78 # specify a host
favicon-rover serve --origin https://example.com # only allow requests from example.com
favicon-rover serve -p 1234 --host 0.0.0.0 -o https://example1.com -o /.example2.com$/ # all options
favicon-rover serve --help # show help information ```
h
/{site url}/{size}
site url is any valid url to a page that you want the favicon for. Must be URL encoded.
size is an integer in pixels to set the returned image. It's optional, and if not included then the best available size will be returned.
By default, any origin is allowed to request from this API. To lock it down, use the --origin command line options to specify any amount of origins. If an origin starts and ends with / it will be treated as a regexp. For example favicon-rover serve -o http://example1.com -o /\.example2\.com$/ will accept any request from "http://example1.com" or from a subdomain of "example2.com".
Run cargo run to test the binary. You can test the serve command with cargo run -- serve.
Run cargo build to build in release mode.
If you have any feedback or find a website that favicon rover can't correctly find the favicon for, create an issue. Contributions are welcome.
Created by Stevent (2023) and licensed under MIT