mirror of
https://github.com/BreizhHardware/Jellystat.git
synced 2026-01-18 16:27:20 +01:00
71c5e0c9dac890317fb925460427baca402ccc5b
Jellystat is a free and open source Statistics App for Jellyfin! (This project is still in development - expect some weirdness)
Current Features
- Session Monitoring and logging
- Statistics for all Libraries and Users
- Watch History
- User Overview and activity
- Watch statisitcs
- Backup and restore Data
- Auto sync library items
- Jellyfin Statistics Plugin Integration
Required Development
- Responsive UI
- Code Optimizations
- Security Testing
- More Validations and Error Handling
- Multi-Server support
- More to come
Getting Started with Development
- Clone the project from git
- set your env variables before strating the server (Variable names as per the docker compose file).
- Run
npm installto install necessary packages - Run
npm run start-serverto only run the backend nodejs server - Run
npm run startto only run the frontend React UI - Run
npm run start-appto run both backend and frontend at the same time
When contributing please ensure to log a pull request on the unstable branch
Launching Jellystat using Docker
Check out our dockerhub to run Jellystat: https://hub.docker.com/r/cyfershepard/jellystat
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using the prefix FILE__
As an example:
jellystat:
environment:
FILE__MYVAR: /run/secrets/MYSECRETFILE
Will set the environment variable MYVAR based on the contents of the /run/secrets/MYSECRETFILE file. see docker secrets for more info.
Screenshots
Support
- Bug reports and feature requests can be submitted via GitHub Issues.
- Join us in our Discord
API Documentation
To-do
Languages
JavaScript
95.5%
CSS
4%
Shell
0.2%
HTML
0.2%