Website icons,
safely.

One request turns any site's icon into a clean, compact SVG. It is sanitized or traced in a sandbox, fitted to its box, and cached, so your users never touch the site.

Inbox

    Icons and palettes come live from this server's API. Take the controls to try it yourself.

    api

    Try any domain.

    One GET per site, no key, CORS open. The SVG comes back with the colours to put around it, for light and dark themes. Everything below is this server answering live.

    GET / /
    Plate
    Try
     
    light
    Open
    dark
    Open
    mono
    Open
     

    Behaviour

    • Sources in order: the owner's BIMI logo, the theSVG catalog, the site itself.
    • Subdomains, query strings, a trailing slash or .svg get a cacheable 301 to the registrable domain.
    • No real icon? You still get 200 with a generated one, and the headers say why.
    • A badge without /light or /dark follows the viewer's system theme by itself.
    • Machine-readable docs: openapi.json and llms.txt. The full contract is in docs/API.md.

    Palette headers

    • X-Icon-Fillbleed to draw it edge to edge, inset to pad it on the plate
    • X-Icon-*-Platea badge fill that keeps the icon visible, never one that swallows a cut-out logo
    • X-Icon-*-Textthe brand colour at 4.5:1 on the theme background
    • X-Icon-*-Monothe colour for the mono mask, at least 3:1, on its Mono-Plate
    safety

    Built to be attacked.

    Every byte from a site is hostile until it has been rebuilt by us.

    Sandboxed parsing

    HTML, manifests and images are handled in a throw-away seccomp process with no files, network or exec.

    parser exploitsdecompression bombs

    Clean SVG only

    An allowlist writer emits paths and gradients. Scripts and embedded images cannot be expressed, and the only CSS is the server's own theme switch.

    script injectiontracking pixels

    No SSRF

    Public addresses over https on port 443 only, no links or redirects to raw IPs, and every foreign host vetted before connecting.

    metadata endpointsinternal networks

    No read receipts

    Per-recipient subdomains collapse to the site. Users' IPs never reach it and are never logged.

    per-recipient tracking

    Vetted domains

    Blocklists, domain age via RDAP and a filtering DNS resolver. Blocked sites get a warning icon.

    phishingfresh malware domains

    Fair under load

    Per-subnet limits and a round-robin queue keep honest clients served during a flood.

    floodsnoisy neighbours
    performance

    Small enough for a thin client.

    wrk on the same machine as the service, asking for random cached icons from random client subnets with rate limiting on. No socket errors and no non-2xx responses in any run.

    Celeron N3160 thin client

    4 × 1.6 GHz · 3.5 GB · 8 GB eMMC

    10 843rps
    6.2 msp99
    2.0of 4 cores
    63 MBmemory

    The CPU gave out first, and half of it went to the kernel moving packets rather than to favicons.

    Apple M3 Pro laptop

    12 cores · 36 GB

    170 395rps
    0.29 msp99
    3.5of 12 cores
    47 MBmemory

    wrk and favicons shared the six performance cores; the service itself was not short of CPU.

    self-host

    Two containers, no network for the renderer.

    One docker compose up -d. The API fetches and caches; the renderer decodes untrusted images in seccomp-confined workers with no network, a read-only root and no capabilities. The image is about 9 MB.

    docker-compose.yml
    loading…
    1

    Save the file and run docker compose up -d.

    2

    Ask it for an icon: http://localhost:8080/color/github.com. Want this page too? Build with --features site.

    3

    Point a CDN at it. Icons are cacheable for 30 days, so the server sees about one request per icon per month.

    4

    Check the sandbox on your kernel: docker run --rm favicons/favicons sandbox-selftest net must exit with 159.

    TLS with Let's Encrypt, S3, GCS or Azure caches, blocklists and every option: config.example.toml.

    config.example.toml
    loading…

    Mount it with ./favicons.toml:/etc/favicons.toml:ro and set FAVICONS_CONFIG=/etc/favicons.toml. Any key also works as an environment variable, e.g. FAVICONS_POLICY__MIN_DOMAIN_AGE_DAYS=7.