# ServiceControl

ServiceControl is a Particular platform tool for teams running NServiceBus distributed systems, recording message throughput, errors, audit trails, sagas, heartbeats, and custom checks for monitoring, debugging, and. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1212/servicecontrol

## Description

ServiceControl is a Particular platform tool for teams running NServiceBus distributed systems, recording message throughput, errors, audit trails, sagas, heartbeats, and custom checks for monitoring, debugging, and auditing with ServicePulse and ServiceInsight.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

59/100 (Fair), based on 4 of 4 factors.
- Maintained: 100 (last commit 17 days ago)
- Popular: 36 (60 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 20 (16 GB minimum RAM, runs on ARM)

## Links

- GitHub: https://github.com/Particular/ServiceControl
- Docker Hub: https://hub.docker.com/r/particular/servicecontrol
- Unraid: https://ca.unraid.net/apps/servicecontrol-0cntbx10y0yr6p?q=ServiceControl
- Official website: https://docs.particular.net
- Documentation: https://docs.particular.net/servicecontrol/ravendb/containers

## Common questions

### What values must I set when creating a ServiceControl instance?

Set the install, database, and log folders, the main port 44334, the maintenance port 44335, transport details, and the error queue. Without these values it has nowhere to store data, cannot talk to the queue, and may not be reachable on expected ports.

### What authentication fields are required before starting an authenticated ServiceControl instance?

Provide the OpenID Connect authority URL and related fields, such as audience and ServicePulse client ID. If required fields are blank, the instance fails to start with an authority-required error.

### Why might ServiceControl stop unexpectedly?

Instances stop when essential dependencies, such as the message transport, are unavailable for too long. On Windows, the ServiceControl service is configured for automatic restart.

### Are GitHub Container Registry images tagged with release tags such as latest?

No, GHCR images are tagged only with the exact version. Use the exact version tag when pulling and check the package listing if unsure what versions are available.

### Do ServiceControl hosting scenarios require HTTPS and authentication?

Yes, the hosting and security guide assumes HTTPS and authentication are required for ServiceControl, ServiceControl.Audit, and ServiceControl.Monitoring instances.

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