upda/_doc/Home.md
Varakh 3f654a1229
All checks were successful
/ build (pull_request) Successful in 5m27s
feat(embedded_ui): fully integrate UI into GoLang binary
2024-10-25 08:27:58 +02:00

2.5 KiB

upda

Update Dashboard (upda). A simple application to keep track of updates from different hosts and systems.

Managing various application or OCI container image updates can be a tedious task:

  • A lot of hosts to operate with a lot of different applications being deployed
  • A lot of different OCI containers to watch for updated images
  • No convenient dashboard to see and manage all the available updates in one place

upda manages a list of updates with attributes attached to it. For new updates to arrive, upda needs to be called via a webhook call (created within upda) from other applications, such as a bash script, an application like duin or simply by using the upda-cli.

Please head over to the Usage section for a quick Getting Started once you've deployed upda.

The code is hosted here: upda and CLI application including frontend.

Features

upda manages a list of updates with attributes attached to it. For new updates to arrive, upda needs to get them from an external source. For this, upda allows to manage webhooks, which can be called with a unique URL from any other application or even a bash script so that upda retrieves these information.

upda's main features include

  • Managing Updates by changing their state (pending, ignored, approved)
  • Managing Webhooks which allow to get information into upda regarding Updates and their properties (like version) you like to track
  • Managing Actions which allow you to further process changes made to an Update (created, state changed, version changed,), basically allowing you to invoke other systems with the help of shoutrrr
  • View past invocation of Actions
  • Viewing events which allow you to see what has changed and how Updates
  • Metrics exporter via prometheus

upda is designed to be simple. Only supported authorization mechanism is basic.

What it is not

upda is NOT a scraper to watch docker registries or GitHub releases, it simply tracks and consolidates updates from different sources, but you need to feed in these information on your own, e.g., via Webhooks. If you like to watch GitHub releases, write a scraper and use upda-cli to report back to upda.