aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
blob: e63aee6a4b0c71c9f8dcd2b8d7bd182c182cc9ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Geldschieberbot

Geldschieberbot is a python script to bookkeep the finances of a group.
It is intended to be run on the output of signal-cli. But it should parse
other input without a lot of modification.

## Configuration

Geldschieberbot is configured with a set of Environment variables:

* GSB_GROUP_ID the signal group_id you want to serve
* GSB_STORE_PATH the directory where Geldschieberbot stores the balance and the useres
* GSB_SEND_CMD the command Geldschieberbot uses to send replies
* GSB_USER the mobile number signal-cli should receive messages with

Copy config.sh.sample to config.sh and edit it to match your environment.

## Usage

If you have your config.sh in place you can just run
`./run.sh`
and your bot should be up and serving your needs.

Happy Geldschieben!

## License

Geldschieberbot is licensed under the terms of the GNU General Public License
version 3 or later [GPL-3.0-or-later](https://www.gnu.org/licenses/#GPL).