Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
adriantpaez committed Jan 5, 2021
1 parent 5c69634 commit 07bf421
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# master-cut
# Maste Cut

Master Cut is a tool for manage CUT and UNCUT the user quota. Each Quota Scraper service notify to Master Cut if an user over quota.

## Table of Contents

- [Maste Cut](#maste-cut)
- [Table of Contents](#table-of-contents)
- [Configuration](#configuration)

## Configuration

Master Cut recive requests from diferent Quota Scraper services, and each one is part of a group. For example, group `Trabajadores` have two Quota Scraper services, one per server, and shares the CUT file. So we need to tell to Master Cut what groups exists, and CUT file and script. For that, we use JSON configuration like that:

```json
{
"groups": [
{
"name": "trabajadores",
"file": "trabajadores.cut",
"script": "trabajadores.sh"
}
]
}
```

Configuration path is set with argument `--conf`.

0 comments on commit 07bf421

Please sign in to comment.