# ProjectZomboidReporter-API

ProjectZomboidReporter-API is a self-hosted databases app. Backend API that reads Project Zomboid server statistics from a SQL database and serves them to the Zomboid Server Stats Reporter. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2501/projectzomboidreporter-api

## Description

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.

## Health score

17/100 (Low), based on 4 of 5 factors.
- Maintained: 0 (last commit 1657 days ago)
- Popular: 28 (24 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 20 (1 serious finding, 6 minor, CI)

## Security check

1 serious finding: Uses certifi 2026.7.22, which has a known critical vulnerability.
Automated checks on commit c4c20b2, 16 Nov 2026. Not an audit.

## Links

- Docker Hub: https://hub.docker.com/r/chrisashtear/zomboid-reporter-backend/
- Official website: https://pz-wiki-modding.github.io/PZ-API-Docs/
- GitHub: https://github.com/ChrisAshtear/Zomboid-Server-Stats-Reporter
- Unraid: https://ca.unraid.net/apps/projectzomboidreporter-api-195e4v70zrmren?q=ProjectZomboidReporter-API

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/2501/projectzomboidreporter-api), the self-hosted and open-source app directory.
