Homepage dashboard widget for cup

[agrmohit]

Using the Custom API widget, I created a config that works for cup for Homepage dashboard.

Here is the docker compose used.

services:
  cup:
    image: ghcr.io/sergi0g/cup
    container_name: cup
    command: -c /config/cup.json serve -p 8000
    volumes:
      - ./config/cup.json:/config/cup.json
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 8000:8000
    restart: unless-stopped
    labels:
      homepage.group: Network
      homepage.name: Cup
      homepage.icon: /icons/cup-with-straw.png
      homepage.href: http://myserver:8000
      homepage.ping: http://myserver:8000
      homepage.description: Checks for container updates
      homepage.widget.type: customapi
      homepage.widget.url: http://myserver:8000/json
      homepage.widget.mappings[0].label: Monitoring
      homepage.widget.mappings[0].field.metrics: monitored_images
      homepage.widget.mappings[0].format: number
      homepage.widget.mappings[1].label: Up to date
      homepage.widget.mappings[1].field.metrics: up_to_date
      homepage.widget.mappings[1].format: number
      homepage.widget.mappings[2].label: Updates
      homepage.widget.mappings[2].field.metrics: update_available
      homepage.widget.mappings[2].format: number

[remussamoila]

Great, thank you!

Please allow me to show my custom reinterpretation of your widget:
widget:
type: customapi
url: http://<SERVER_IP>:9000/json
refreshInterval: 10000 # optional - in milliseconds, defaults to 10s
method: GET
mappings:
- field:
metrics: monitored_images
label: Monitored images
format: number # optional - defaults to text
- field:
metrics: up_to_date
label: Up to date
format: number # optional - defaults to text
- field:
metrics: update_available
label: Available updates
format: number # optional - defaults to text
- field:
metrics: unknown
label: Unknown
format: number # optional - defaults to text

[boralyl]

Thanks @agrmohit ! If you are using version >= 3.0.0 the json api endpoint has changed from http://myserver:8000/json to http://myserver:8000/api/v3/json. It also contains some more data if you wanted to customize the widget more. https://cup.sergi0g.dev/docs/integrations#json-data

[sergi0g]

Hi @boralyl! The docs have already been updated to use the v3 api endpoint. If you have a version of the widget that takes advantage of extra data and would like to share it with others, please let me know and I'll add it to the docs too!

[boralyl]

@sergi0g Thanks, I did end up seeing that after reading the docs. I landed here first when I did a Google search and then started reading the docs.