Skip to content

Commit

Permalink
Add a disclaimer for the feed version and used gvmd version
Browse files Browse the repository at this point in the history
The current greenbone-feed-sync requires a specific gvmd version to work
correctly out of the box.
  • Loading branch information
bjoernricks committed Feb 10, 2025
1 parent b66179a commit 372ca48
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ configurable and can be adjusted easily for downloading different feed versions.

Versions prior to 25.0.0 used [calendar versioning](https://calver.org/).

> [!IMPORTANT]
> `greenbone-feed-syc` >= 25.0.0 requires [gvmd 25.0.0](https://github.com/greenbone/gvmd/releases/tag/v25.0.0)
> to work out of the box. If a version of gvmd < 24.0.0 is used, the feed version
> has to be set to 22.04 via the [config file, the `GREENBONE_FEED_SYNC_FEED_VERSION`
> environment variable or the `--feed-version` CLI argument](#feed-version).
> For example run `greenbone-feed-sync --feed-version 22.04`.
> Versions of gvmd between 24.0.0 and 25.0.0 have issues with the feed loading
> and require manual interventions. Alternatively you can downgrade
> `greenbone-feed-sync` to a release < 25.0.0.
### Requirements

Python 3.9 and later is supported.
Expand Down

0 comments on commit 372ca48

Please sign in to comment.