Checkmate icon indicating copy to clipboard operation
Checkmate copied to clipboard

Homepage Widget

Open dalenledingham opened this issue 4 months ago • 18 comments

Is your feature request related to a problem? Please describe. Homepage is a self-hosted, customizable application that can be used to create a personalized dashboard. Its main feature is its widgets, which allow for summaries of different parts of another application or service. Checkmate does not have an official widget for Homepage, and creating one would be very helpful for those of us that use both of these services.

Describe the solution you'd like An official Checkmate widget for Homepage similar to other offerings found here: https://gethomepage.dev/widgets/ Some ideas for the "fields" that could be supported are "uptime" to show how many services tracked in the Uptime tab are currently up, "infrastructure" to show how many servers tracked in the Infrastructure tab are currently up, and "incidents" to show the number of open incidents.

Describe alternatives you've considered You can still link your Checkmate instance to Homepage as a bookmark, but it won't show any of the fields outlined above.

Additional context Here is an example of an existing widget for Komodo, a docker container management app:

Image

dalenledingham avatar Aug 15 '25 02:08 dalenledingham

Hi @dalenledingham , from what I understand about the ask is that you want a homepage in checkmate which gives teh summary of the other pages so that you can have all the information in page. Let me know if I am wrong.

  1. What is "Homepage"? It's a tool that provides a dashboard of all your applications and services. You can find it at https://gethomepage.dev.
  2. What is a "Widget"? Homepage uses "widgets" to show summaries of information from other applications directly on the dashboard. For example, a widget for a download client might show the number of active downloads.

Owaiseimdad avatar Aug 15 '25 06:08 Owaiseimdad

Hi @dalenledingham , from what I understand about the ask is that you want a homepage in checkmate which gives teh summary of the other pages so that you can have all the information in page. Let me know if I am wrong.

In fact it's vice-versa. Homepage will include Checkmate widget so anyone using both of them will have Checkmate as a widget on Homepage.

gorkem-bwl avatar Aug 15 '25 07:08 gorkem-bwl

Imho this should have been a request on the gethomepage.dev Repo, It's free for anyone to make a PR there. It just needs an API with an API_TOKEN

Here you can find the information on creating the widget: https://gethomepage.dev/widgets/authoring/tutorial/

Houbsi avatar Aug 15 '25 09:08 Houbsi

Imho this should have been a request on the gethomepage.dev Repo, It's free for anyone to make a PR there. It just needs an API with an API_TOKEN

Here you can find the information on creating the widget: https://gethomepage.dev/widgets/authoring/tutorial/

You are right, however doesn't harm if it stays here as well - someone actively using both platforms (and who reads this) can send a PR to Homepage.

gorkem-bwl avatar Aug 15 '25 12:08 gorkem-bwl

Hi @gorkem-bwl,

I’d be happy to take this on. I’ll start working on the widget integration later today. Could you please assign me to this issue?

Thanks!

Tafadzwa-Chiwozva avatar Aug 18 '25 21:08 Tafadzwa-Chiwozva

Hi @gorkem-bwl,

I’d be happy to take this on. I’ll start working on the widget integration later today. Could you please assign me to this issue?

Sure, thanks. Assigned :)

gorkem-bwl avatar Aug 18 '25 21:08 gorkem-bwl

Cool feautre, looking forward to seeing this!

ajhollid avatar Aug 18 '25 21:08 ajhollid

@Tafadzwa-Chiwozva let me know if you are still interested in this!

gorkem-bwl avatar Sep 12 '25 02:09 gorkem-bwl

Hi Görkem,

Thanks so much for following up on this. After reviewing it again, I don’t think I’ll be able to take this on right now. My schedule has become more packed than expected, and I wouldn’t want to commit without being sure I could give it the attention it deserves.

I appreciate you reaching out though, and I’ll keep an eye on the project’s progress—it looks like it’s shaping up nicely.

Best,

Tafadzwa

On Thu, Sep 11, 2025 at 22:18 Gorkem Cetin (BWL) @.***> wrote:

gorkem-bwl left a comment (bluewave-labs/Checkmate#2792) https://github.com/bluewave-labs/Checkmate/issues/2792#issuecomment-3283408876

@Tafadzwa-Chiwozva https://github.com/Tafadzwa-Chiwozva let me know if you are still interested in this!

— Reply to this email directly, view it on GitHub https://github.com/bluewave-labs/Checkmate/issues/2792#issuecomment-3283408876, or unsubscribe https://github.com/notifications/unsubscribe-auth/BPSRVWBBA6GLQESJGD5EJ5D3SIUNVAVCNFSM6AAAAACD6OFFQCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTEOBTGQYDQOBXGY . You are receiving this because you were mentioned.Message ID: @.***>

Tafadzwa-Chiwozva avatar Sep 16 '25 23:09 Tafadzwa-Chiwozva

No worries.

gorkem-bwl avatar Sep 16 '25 23:09 gorkem-bwl

Hello, I'm one of the students from IMT Atlantique (we contacted you on discord). I 'm interested to work on this issue, is someone already working on it ? If not i'll gladly take the chance.

CHOUKI Mouad, student at IMT Atlantique.

MomoWorlData avatar Nov 05 '25 13:11 MomoWorlData

@gorkem-bwl I have reviewed the feature request for the official Checkmate widget for Homepage and propose the following minimal approach to implement this:

1. API Development

  • Create lightweight REST API endpoints in Checkmate to expose summary data:
  • Number of services currently up (Uptime tab)
  • Number of servers currently up (Infrastructure tab)
  • Number of open incidents

Provide this as a simple JSON response, e.g.,

json { "uptime": 12, "infrastructure": 5, "incidents": 2 }

2. Widget Implementation

  • Develop a simple Homepage widget (React-based) that fetches this API data.
  • Display the three key metrics with clear labels in the widget UI.
  • Enable easy configuration of the Checkmate instance URL in the widget settings.

3. Testing and Documentation

  • Test the widget with sample Checkmate instances for accuracy and UI correctness.
  • Add documentation for users on configuring the widget in Homepage.
  • This minimal solution focuses first on core functionality and can be expanded later with more features or customization.

I am happy to start working on this and open a PR for review. Please let me know any suggestions or additional requirements.

Armaansaxena avatar Nov 09 '25 11:11 Armaansaxena

@Armaansaxena sure, let's see how it goes. Just a note that we dont have API key auth right now, so it's possible to show status pages on Homepage and that's basically it. Later we can add it and user can add anything to Homepage.

gorkem-bwl avatar Nov 09 '25 13:11 gorkem-bwl

@gorkem-bwl Can I work on this issue ?

MomoWorlData avatar Nov 18 '25 11:11 MomoWorlData

Hi @MomoWorlData thanks for the interest! I am currently working on this implementation. I plan to open a PR for it soon.

Armaansaxena avatar Nov 18 '25 16:11 Armaansaxena

Hi @gorkem-bwl I wanted to let you know that I am currently unable to complete this feature due to my busy schedule. Anyone interested is welcome to take it forward. Thank you for understanding!

Armaansaxena avatar Nov 20 '25 11:11 Armaansaxena

No worries Armaan. That happens. it's important to get back on time, and thanks for this!

gorkem-bwl avatar Nov 20 '25 13:11 gorkem-bwl

Hello @gorkem-bwl now the issue is free I would like to take it, I'm free for it

MomoWorlData avatar Nov 25 '25 10:11 MomoWorlData