chris
/
firefly-exporter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

basic readme

This commit is contained in:
chris 2020-10-25 17:57:50 +01:00
parent 36afbd6555
commit c752cf6a9c
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# Budget Exporter
Export Firefly-iii budget data for prometheus consumption.
## Usage
Install `Flask` and `requests` in your python environment:
pip install -r requirements.txt
Create a personal access token in your firefly installation:
Go to
[https://your-firefly-installation/profile](https://your-firefly-installation/profile)
, create a token and copy the (very long) string.
Put your personal access token and your API host in your environment:
export FIREFLY_PERSONAL_ACCESS_TOKEN="abcd.....1234"
export FIREFLY_API_HOST="https://your-firefly-installation"
Run the exporter:
FLASK_APP=exporter.py python -m flask run -h 127.0.0.1 -p 5000
Now scrape `/metrics` on port localhost:5000.