No description

401 commits 2 branches 68 tags 2.5 MiB

Go 89.4%
JavaScript 6.2%
Shell 2.4%
Dockerfile 2%

Find a file

Sven Fischer e436391602 git ignore scripts except startup.sh		2025年10月06日 21:53:16 +02:00
example	update example picture	2024年06月18日 21:14:48 +02:00
tmpl	add chart.umd.js.map	2024年10月30日 21:45:13 +01:00
.gitignore	git ignore scripts except startup.sh	2025年10月06日 21:53:16 +02:00
.goreleaser.yaml	update goreleaser config	2025年02月12日 22:57:58 +01:00
article-stats.go	improve performance by increase article number limit for API call	2024年10月28日 22:33:36 +01:00
chart-png.go	update dependencies	2025年04月09日 20:42:26 +02:00
constants.go	improve performance by increase article number limit for API call	2024年10月28日 22:33:36 +01:00
data-checks.go	rename debug flags	2024年06月18日 20:34:25 +02:00
data-checks_test.go	add test if data set is valid	2019年12月15日 22:44:44 +01:00
Dockerfile	Add Dockerfile	2025年10月06日 17:33:16 +02:00
flags.go	fix version output log message	2024年06月18日 20:38:20 +02:00
go.mod	update dependencies	2025年09月14日 23:51:47 +02:00
go.sum	update dependencies	2025年09月14日 23:51:47 +02:00
helper.go	rename debug flags	2024年06月18日 20:34:25 +02:00
html.go	use more constants	2024年06月18日 21:47:23 +02:00
io.go	add log messages	2024年06月19日 18:49:38 +02:00
LICENSE	add LICENSE	2016年09月28日 17:38:10 +02:00
main.go	add log messages	2024年06月19日 18:49:38 +02:00
output.go	use more constants	2024年06月18日 21:47:23 +02:00
README.md	update readme	2025年10月06日 21:51:21 +02:00
startup.sh	Add Dockerfile	2025年10月06日 17:33:16 +02:00
types.go	update dependencies	2025年04月09日 20:42:26 +02:00

README.md

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

Example chart

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月02日T15:04:05Z07:00 (default "2020年12月10日T21: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