← Directory

ServiceControl-DB

ServiceControl DB is the RavenDB database that provides persistent storage for the Particular ServiceControl error and audit instances.

  • Tools & Utilities
ServiceControl DB is the RavenDB database that provides persistent storage for the Particular ServiceControl error and audit instances. It records and stores message flow data so operators can trace, replay, and audit messages flowing through an NServiceBus-based distributed system. It is intended for developers and homelab administrators running distributed .NET applications who need reliable error handling and complete audit trails. Use it as the data backend for a ServiceControl deployment to gain durable, queryable visibility into every message.

Platform availability

Available on 1 of 9 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)

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.

56/100 Fair

Maintained
100last commit 5 days ago
Popular
2211 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
2016 GB minimum RAM, runs on ARM

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

GitHub stars
11
Open issues
4
Last commit
2026-10-08
Latest release
11.0.1
Activity
declining

Checked 4 days ago - source: GitHub (Particular/NServiceBus.RavenDB)

Resources & Compatibility

Minimum requirements: 16 GB RAM, 4 CPU core(s). ARM (e.g. Raspberry Pi) is supported.

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

First-install notes

  • Set required authentication values first If authentication is enabled, fill in required login-service settings such as the OpenID Connect authority URL before starting ServiceControl. If you leave these blank, ServiceControl will not start and will report a missing authentication setting. source
  • Choose where data and logs will live When creating the instance, specify folders for the program files, database, and logs, plus the ports and message broker connection details. If these are missing or wrong, ServiceControl cannot store its data, connect to the broker, or let other tools talk to it. source
  • Set up reverse proxy files if using one If you put ServiceControl behind an NGINX reverse proxy, keep the nginx config and local certificate files in the .local folder and start the compose proxy. Without those files and the running proxy, HTTPS traffic through the proxy will not work. source

Fetched 14 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What RavenDB license value is needed for the CI workflow and Docker Compose setup?

A RavenDB development license is required. For CI, supply it as the one-line JSON secret RAVENDB_LICENSE. For Docker Compose, set the LICENSE variable or use an .env file.

Which environment variables point the NServiceBus.RavenDB tests at RavenDB endpoints?

Use CommaSeparatedRavenClusterUrls with comma-separated cluster URLs for cluster-wide transaction tests. Use RavenSingleNodeUrl with a single-node URL for non-cluster tests.

Which local Docker ports expose the single-node and cluster leader RavenDB instances?

The single-node RavenDB server is reachable on localhost port 8080. The cluster leader is reachable on localhost port 8081.

What files are required for an NGINX reverse proxy in front of ServiceControl?

Keep the nginx config and local certificate files in the .local folder and start the compose proxy. Without those files and the running proxy, HTTPS traffic through the proxy will not work.

What authentication setting must be completed before starting ServiceControl when authentication is enabled?

Fill in required login-service settings such as the OpenID Connect authority URL before starting ServiceControl. If these values are blank, ServiceControl will not start and will report a missing authentication setting.

Answers sourced from github.com, github.com, github.com

Community

Collected 13 days ago - public community threads