Skip to content

πŸ”Ž πŸ“ˆ πŸ“Š A helper utility to generate a csv export for the spigot-anti-piracy-backend

License

Notifications You must be signed in to change notification settings

timbru31/spigot-anti-piracy-csv-exporter

Repository files navigation

spigot-anti-piracy-csv-exporter

Run a security audit Linting

dependency Status Code Climate Known Vulnerabilities

Commitizen friendly License npm

A helper utility to generate a csv export for the spigot-anti-piracy-backend

Description

The helper application reduces the logfile of spigot-anti-piracy-backend to a CSV with unique user IDs and a count of different ips in order to determine which user could have leaked the resources.

Installation

This has been tested with Node.js v18 LTS.

Normal Installation

$ npm install -g spigot-anti-piracy-csv-exporter

(Optionally without the global flag)

Development Installation

$ git clone https://github.com/timbru31/spigot-anti-piracy-csv-exporter.git
$ cd spigot-anti-piracy-csv-exporter
$ npm install

Usage

You need to specify thr path for the logfile. It defaults to request.log in the current directory if omitted.

Just use

$ npm run start

Configuration via environment variables

Environment Variable Default Description
CSV_FILE ./users.csv Output CSV file
LOG_FILE ./request.log Log file of requests

Development

To run the linter use

$ npm run lint

The code is linted using ESLint. Keep the warnings to zero. πŸ˜„

Please follow the commitizen style when making new commits!


Built by (c) Tim Brust and contributors. Released under the MIT license.