This project is designed for exporting data from Scarf Gateway for "file" packages.

Example package configuration in Scarf to be compatible with this project

Template Path: /YazFi/{branch}/{downloadtype}/{filename}
Host Url: https://raw.githubusercontent.com/jackyaz/YazFi/{branch}/{filename}

Scarf Gateway data for the current day will be retrieved for all of your packages, running at 5 past and 35 past every hour.

Included is an example Grafana dashboard to visualise the captured data.

This fork assumes you have InfluxDB and Grafana deployed already.

Tested on Ubuntu with Docker and Python 3.9.

A Docker image for this app is available on Docker Hub

docker run -d \
  --name=scarfgatewaystats \
  -e API_TOKEN="aaabbbccc" \
  -e EXCLUDED_PACKAGES="mypackagename,otherpackage" \
  -e INFLUXDB_VERSION="1.8" \
  -e INFLUXDB_USERNAME="user" \
  -e INFLUXDB_PASSWORD="password" \
  -e INFLUXDB_APITOKEN="xxxyyyzzz" \
  -e INFLUXDB_HOST="influxdb" \
  -e INFLUXDB_PORT="8086" \
  -e INFLUXDB_DB="scarf" \
  -v /path/to/data:/scarfgatewaystats/CSVs \
  --restart unless-stopped \
  jackyaz.io/jackyaz/scarfgatewaystats

The Docker images supports some parameters. These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -v /apps/scarfgatewaystats:/scarfgatewaystats/CSVs would map /apps/scarfgatewaystats on the Docker host to /scarfgatewaystats/CSVs inside the container.

When creating the container, ensure you provide a value for all environment variables as appropriate.

You should create an InfluxDB database scarf. The Grafana dashboard can be imported to visualise the data either via the provided json file or using the dashboard id xxxxx.