aboutsummaryrefslogtreecommitdiff
path: root/Docker
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2023-11-05 23:33:20 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2023-11-05 23:33:20 +0100
commitd4f659f915de7db9351977a562bb61500653394c (patch)
tree4ba52a2e7ce7ba74dfcd16b3e6010dfb9d7cbad4 /Docker
parent487c74090061a6f9aeedc4042a788e46145ac51e (diff)
Try automatic update of Docker description
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5819
Diffstat (limited to 'Docker')
-rw-r--r--Docker/README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/Docker/README.md b/Docker/README.md
index 39885b0e3..82f483409 100644
--- a/Docker/README.md
+++ b/Docker/README.md
@@ -1,9 +1,17 @@
-![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/freshrss/freshrss.svg)
![Docker Pulls](https://img.shields.io/docker/pulls/freshrss/freshrss.svg)
+[![Liberapay donations](https://img.shields.io/liberapay/receives/FreshRSS.svg?logo=liberapay)](https://liberapay.com/FreshRSS/donate)
# Deploy FreshRSS with Docker
-Our official images are available on [Docker Hub](https://hub.docker.com/r/freshrss/freshrss/).
+FreshRSS is a self-hosted RSS feed aggregator.
+
+* Official website: [freshrss.org](https://freshrss.org/)
+* Official Docker images: [hub.docker.com/r/freshrss/freshrss](https://hub.docker.com/r/freshrss/freshrss/)
+* Repository: [`github.com/FreshRSS/FreshRSS`](https://github.com/FreshRSS/FreshRSS/)
+* Documentation: [`freshrss.github.io/FreshRSS`](https://freshrss.github.io/FreshRSS/)
+* License: [GNU AGPL 3](https://www.gnu.org/licenses/agpl-3.0.html)
+
+![FreshRSS logo](../docs/img/FreshRSS-logo.png)
## Install Docker
@@ -67,7 +75,6 @@ The [tags](https://hub.docker.com/r/freshrss/freshrss/tags) correspond to FreshR
* `:latest` (default) is the [latest stable release](https://github.com/FreshRSS/FreshRSS/releases/latest)
* `:edge` is the rolling release, same than our [git `edge` branch](https://github.com/FreshRSS/FreshRSS/tree/edge)
* `:x.y.z` tags correspond to [specific FreshRSS releases](https://github.com/FreshRSS/FreshRSS/releases), allowing you to target a precise version for deployment
-* `:x.y` tags are tied to a specific major version and minor version number. For example, `:1.23` will automatically receive updates for any `1.23.x` releases, but will not update to `1.24.x`
* `:x` tags track the latest release within a major version series. For instance, `:1` will update to include any `1.x` releases, but will exclude versions beyond `2.x`
* `*-alpine` use Linux Alpine as base-image instead of Debian
* Our Docker images are designed with multi-architecture support, accommodating a variety of Linux platforms including `linux/arm/v7`, `linux/arm64`, and `linux/amd64`.