Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/cedricbonhomme/freshermeat

An open source software directory and release tracker.
https://github.com/cedricbonhomme/freshermeat

cve cve-search freshmeat release-tracking software-directory

Last synced: 3 months ago
JSON representation

An open source software directory and release tracker.

Lists

README

        

# Freshermeat

## Presentation

[Freshermeat](https://sr.ht/~cedric/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](https://open-source-security-software.net/api/v2);
- management of organizations.

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

## Deployment

### Requirements

```bash
$ sudo apt install postgresql npm
```

### Configure and install the application

```bash
$ git clone https://git.sr.ht/~cedric/freshermeat
$ cd freshermeat/
$ poetry install
$ poetry shell

(freshermeat) $ npm install

(freshermeat) $ export FLASK_APP=runserver.py
(freshermeat) $ export APPLICATION_SETTINGS=development.py

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

(freshermeat) $ flask run
* Serving Flask app 'runserver.py'
* Debug mode: off
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
```

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

```bash
$ FLASK_APP=runserver.py poetry run flask fetch_cves
```

### Release tracking

```bash
$ FLASK_APP=runserver.py poetry run flask fetch_releases
```

### Retrieving news about projects

```bash
$ FLASK_APP=runserver.py poetry run flask fetch_news
```

## Contributing

Patches and questions? Send to my [public
inbox](https://lists.sr.ht/~cedric/public-inbox):
[`~cedric/[email protected]`](mailto:~cedric/[email protected]).
Thanks!

## License

This software is licensed under
[GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html)

Copyright (C) 2017-2024 [Cédric Bonhomme](https://www.cedricbonhomme.org)