1
0
Fork 0
mirror of https://github.com/homarr-labs/dashboard-icons.git synced 2025-06-23 04:58:28 +02:00
dashboard-icons/README.md
Thomas Camlong bfe293f090
feat: Add website ()
Co-authored-by: Bjorn Lammers <bjorn@lammers.media>
2025-04-16 16:18:20 +02:00

4.5 KiB
Raw Blame History

Warning

The repository has been migrated from walkxcode to homarr-labs as I no longer have the capacity to maintain it. The Homarr team will now handle management and maintenance, ensuring that functionality remains unchanged. The project will always be usable outside of Homarr and no breaking changes will be introduced.
Bjorn

The license and guidelines have been updated, so please review them. To help with maintenance, contact us at homarr-labs@proton.me.

jsDelivr hits (GitHub) jsDelivr hits (GitHub)

https://icons.homarr.dev

Dashboard Icons

Your definitive source for dashboard icons.
View icons →

Table of Contents

Icon Requests

If youd like to add a new icon, please review our Contribution Guidelines and then submit a request using our issue templates.

Supported Dashboards

Dashboard Icons integrate seamlessly with several popular dashboards, including:

Usage and Details

You can use icons directly from GitHub or through the lightning-fast jsDelivr CDN. The structure of a direct link is as follows:

https://<Base URL>/<Format>/<Name>.<Format>

For example, the WEBP version of the Nextcloud Calendar icon is available at:

https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/webp/nextcloud-calendar.webp

Base URL

We recommend using jsDelivr:

  • https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons

Alternatively, you can reference the repository directly:

  • https://raw.githubusercontent.com/homarr-labs/dashboard-icons/refs/heads/main

Icon Name

Icons follow kebab-case formatting (all lowercase words separated by hyphens). For example, "Nextcloud Calendar" becomes nextcloud-calendar.

Formats

Icons are available in these formats:

  • SVG
  • PNG
  • WEBP

All icons are generated from the base SVG file. For more details, see the Contribution Guidelines.

Dark/Light Variants

Some icons may have very light or dark colors, which might reduce visibility on certain backgrounds. In such cases, a -light or -dark suffix is appended—for instance, "2fauth" becomes 2fauth-light.

More specifics are available in the Contribution Guidelines.

Downloading Icons

  1. Browse & Download:
    Visit https://icons.homarr.dev to easily view and download icons.

  2. Using the Browser:
    On the icons page (ICONS.md), right-click any icon link and select "Save link as".
    Note: Loading the icons page displays every icon in the repository, which may lead to high data usage, slow performance, or even browser crashes on less powerful devices. For faster access, use the direct links or download icons individually.

  3. Using the Terminal:
    Download icons via curl or wget by using the following structure:

    curl -O https://<Base URL>/<Format>/<Name>.<Format>
    

    or

    wget https://<Base URL>/<Format>/<Name>.<Format>
    

Disclaimer

Unless stated otherwise, all images and assets in this repository—including product names, trademarks, and registered trademarks—belong to their respective owners and are used solely for identification purposes. Their inclusion does not imply endorsement.

For more details, please review the LICENSE. If you have any questions or concerns, contact us at homarr-labs@proton.me.