-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Donation Links
Plugin developers who have had their plugin Verified by Homebridge can display a Donate button next to their plugin when displayed in the Homebridge UI:
When clicked, a modal is displayed showing the donation options you have defined:
For your plugin to display a Donate link, it must:
- published to the npm registry
- be Verified by Homebridge
As more users install their plugins through the Homebridge UI, they are less likely to visit the projects GitHub page where the ways to support a developer would typically be displayed. Adding donation links directly in the Homebridge UI ensures users know how to support Homebridge developers if they wish to do so.
The donation links use the existing, optional, package.json funding attribute.
In your plugins package.json add the "funding" attribute in one of the following ways ("type" can be anything):
"funding": {
"type" : "github",
"url" : "https://github.com/sponsors/my-account"
}"funding": {
"type" : "paypal",
"url" : "https://paypal.me/my-account"
}"funding": {
"type" : "patreon",
"url" : "https://www.patreon.com/my-account"
}"funding": [
{
"type" : "github",
"url" : "https://github.com/sponsors/my-account"
},
{
"type" : "patreon",
"url" : "https://www.patreon.com/my-account"
}
]Platform icons are determined by the funding type attribute.
- PayPal -
paypal - GitHub Sponsors -
github - Patreon -
patreon - Ko-Fi -
kofiorko-fi
All other types will display a generic link icon.
- Raspberry Pi
- Debian, Ubuntu
- CentOS, Fedora, Red Hat
- Arch, Manjaro
- macOS
- Windows 10 / 11 (Hyper-V)
- Docker
- Virtual Machine
- Synology DSM 7
- Other Platforms
- Basic Troubleshooting
- Backup and Restore
- Child Bridges
- Config File
- Connect To HomeKit
- FFmpeg for Homebridge
- HomeKit Glossary of Terms
- iOS Homemanager App
- mDNS Options
- Remote Access
- Useful Links
- Basic Troubleshooting
- Config Options
- Enabling Accessory Control
- Enabling UI with Docker
- Homebridge Service Command
- Manual Configuration
- Reverse Proxy: Apache
- Reverse Proxy: Nginx and SSL
- Standalone Mode
- Swap From Standalone To Service Mode
- Developer Docs
- API Reference
- Plugin Templates
- Other Links (Internal)
- Other Links (External)