Skip to main content

Releases

ReleasesSoftware

Displays a list of the current version of the given repositories with the given version regex.

The releases widget enables you to track a list of repositories and see their respective latest release. It also supports importing releases from your local docker containers.

Screenshots​

releases fullreleases collapsiblereleases no details

Supported Providers​

GitHub, Docker Hub, GitLab, NPM, Codeberg, GitHub Container Registry, Quay, and LinuxServer.io are configured per repository in the widget.

For GitHub Container Registry, use owner/package identifiers such as homarr-labs/homarr. Full image references such as ghcr.io/homarr-labs/homarr:latest are also accepted.

Adding the widget​

You can find how to add the widget on the Widgets documentation page.

Configuration​

NameDescriptionValuesDefault value
New Release WithinThe time period in which a new release is marked as new.Any timespan in format '12h', '3d', '2w', '6M', '1y'.1w
Stale Release WithinThe time period in which a release is marked as stale.Any timespan in format '12h', '3d', '2w', '6M', '1y'.6M
Show Only HighlightedShow only new or stale releases. As per the above.yes / nono
Show DetailsShow the row below the repository with stats about the repository.yes / noyes
Show only iconHides the repository name or identifieryes / nono
Top ReleasesThe max number of latest releases to show. Zero means no limit.Any positive integer or zero to disable the limit.0
RepositoriesThe repositories to show releases for.Repositories[]None

Repositories

NameDescriptionValuesDefault value
ProviderProvider to fetch the repository or package releases from.Select from the available providers.-
IdentifierThe identifier of the repository or package, e.g. "homarr-labs/homarr".Any valid provider identifier. GHCR also accepts full image refs like "ghcr.io/owner/package:tag".-
Provider URLBase URL for the provider.Any valid URL.Provider default
NameDisplay name of the repository.String-
Icon URLURL to the icon of the repository.String-
Version RegexThe regex to extract the version from the release tag.Version RegexNone

Version Regex

NameDescriptionValuesDefault value
PrefixThe prefix to match before the version.String
PrecisionThe precision of the version
  • None
  • #
  • #.#
  • #.#.#
  • #.#.#.#
  • #.#.#.#.#
None
SuffixThe suffix to match after the version.String
note

The version filter is used to match the version tag of the release. It is a combination of the prefix, precision and suffix.

Setting the Prefix to v, precision to 2 and the Suffix to -alpha, will match v1.0-alpha but not v1.0-beta.
Setting the Prefix to v, precision to 3, will match v5.2.0 but not v1.0.2-alpha or Beta v5.2.1.