Skip to content

cedricbonhomme/freshermeat

Repository files navigation

Freshermeat

Presentation

Freshermeat is an open source software directory and release tracker. Main functionalities are the following:

  • tracking of software releases, vulnerabilities (CVE) and news;
  • subscribe to releases of a project or an organization via an ATOM feed;
  • JSON-based API in order to manages projects, releases, CVEs, etc. and documented with Swagger;
  • management of organizations.

Freshermeat instance for tracking security-oriented projects: https://open-source-security-software.net

Deployment

Requirements

$ sudo apt install postgresql npm

Configure and install the application

$ git clone https://github.com/cedricbonhomme/freshermeat
$ cd freshermeat/
$ poetry install
$ poetry shell

(freshermeat) $ npm install

(freshermeat) $ export APPLICATION_SETTINGS=development.py

(freshermeat) $ flask db_create
(freshermeat) $ flask db_init
(freshermeat) $ flask create_admin --login <login> --password <password>
(freshermeat) $ flask import_osi_approved_licenses

(freshermeat) $ flask run --debug
 * Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on http://127.0.0.1:5000
Press CTRL+C to quit
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 315-271-316

You can configure the application in instance/development.py or create your own file and export it in the variable APPLICATION_SETTINGS.

Workers

Workers are located in the folder freshermeat/workers/ and can be launched periodically with cron.

Retrieving CVEs

$ poetry run flask fetch_cves

Release tracking

$ poetry run flask fetch_releases

Retrieving news about projects

$ poetry run flask fetch_news

License

This software is licensed under GNU Affero General Public License version 3

Copyright (C) 2017-2024 Cédric Bonhomme

Contact

Cédric Bonhomme