ProjectZomboidReporter-API

Backend API that reads Project Zomboid server statistics from a SQL database and serves them to the Zomboid Server Stats Reporter.

  • Databases
  • Monitoring & Logging
  • Other
  • Tools & Utilities
Backend API that reads Project Zomboid server statistics from a SQL database and serves them to the Zomboid Server Stats Reporter. It is the data layer of a self-hosted stats dashboard for dedicated Project Zomboid servers, used together with the suite's ingester and reporter components.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

17/100 Low

Maintained
0last commit 1657 days ago
Popular
2824 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data
Security check
201 serious finding, 6 minor, CI

Based on 4 of 5 factors.

Availability: platform listings confirmed today, links checked 25 days ago

GitHub stars
24
Open issues
3
Last commit
2022-05-08
Activity
stale

Checked 13 days ago - source: GitHub (ChrisAshtear/Zomboid-Server-Stats-Reporter)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is not supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • SQL database port The API reads your Project Zomboid stats from a SQL database. If your database is not running on the default port, set the port value when configuring the API. source

Fetched 39 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

How do I add ProjectZomboidReporter-API on Unraid?

Find it in the Unraid Community Apps store and install it from your server.

What permission change is required for the docker-compose server folder?

Run chmod 777 -R ./z on the server folder created by docker-compose so the services can write to it.

Why might the reporter not complete after setup?

It will not complete successfully until someone has been in game and map_t.bin has been created. That file can take about five minutes to appear after playing fresh.

How does Nginx expose the frontend and backend?

Nginx combines the frontend and backend into one site. The frontend is served at the root, and the backend is accessed through the /api path.

Is the Discord bot required to use the reporter?

No, the Discord bot is optional. If you use it, you must provide your own bot token.

Answers sourced from ca.unraid.net, github.com

Community

Collected 53 days ago - public community threads