wallabag-stats

wallabag-stats

Draws a chart for unread and total articles in your wallabag instance.

Chart is only created when there at least two data sets, in which unread and total are both different compared with their previous value. Otherwise, if the delta is zero, the go-chart lib does not print a chart.

Example

Install

Copy example/config.json along with your wallabag-stats binary and change it according to your wallabag instance.

Updates via Cron

You can install a cronjob to fetch the stats data from your wallabag and let the graph being printed on changes. E.g. a user cronjob line by editing your cronjob file via cronjob -e:

* * * * * cd /home/$USER/opt/wallabag-stats/ && ./wallabag-stats && cp -r output/ /var/www

wallabag-stats -h

Usage of ./wallabag-stats:
  -article-stats-start-date string
    	date when the article stats shall start, it has to be provided as string with the RFC3339 format 2006-01-02T15:04:05Z07:00 (default "2020-12-10T21:00:00+01:00")
  -config string
    	file name of config JSON file (default "config.json")
  -d	debug mode
  -data string
    	file name of data JSON file (default "data.json")
  -data-only
    	collect data only, do not generate any charts
  -dd
    	more debug mode
  -ddd
    	even more debug mode
  -f	force regeneration of charts and html even if no new data is present
  -v	print version
  -validate
    	get through every data item and sort invalid data entries out

Docker and Docker Compose

You can run the wallabag-stats within a Docker container. For that, use the provided Dockerfile. If you deployed your wallabag instance with Docker Compose, you can integrate the wallabag-stats in your compose.yaml file. Adjust the environment variables accordingly:

services:
  ...
  stats:
    build: .
    ports:
      - 8000:80
    environment:
      - UPDATE_INTERVAL=30 # Update interval in minutes
      - WALLABAG_URL=https://CHANGE_ME
      - WALLABAG_CLIENT_ID=CHANGE_ME
      - WALLABAG_CLIENT_SECRET=CHANGE_ME
      - WALLABAG_USER_NAME=CHANGE_ME
      - WALLABAG_USER_PASSWORD=CHANGE_ME

Go Report Card