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: about 1 year ago
JSON representation
An open source software directory and release tracker.
- Host: GitHub
- URL: https://github.com/cedricbonhomme/freshermeat
- Owner: cedricbonhomme
- License: agpl-3.0
- Created: 2017-10-01T21:07:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T20:10:35.000Z (almost 2 years ago)
- Last Synced: 2024-08-16T21:28:06.501Z (almost 2 years ago)
- Topics: cve, cve-search, freshmeat, release-tracking, software-directory
- Language: Python
- Homepage: https://open-source-security-software.net
- Size: 14.9 MB
- Stars: 21
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
- Security: SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Freshermeat
## Presentation
[Freshermeat](https://github.com/cedricbonhomme/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://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 --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
```bash
$ poetry run flask fetch_cves
```
### Release tracking
```bash
$ poetry run flask fetch_releases
```
### Retrieving news about projects
```bash
$ poetry run flask fetch_news
```
## 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)
## Contact
[Cédric Bonhomme](https://www.cedricbonhomme.org)