# Runitor

Runitor is a command-line tool that runs a specified command and reports success or failure to a Healthchecks-compatible endpoint based on the process exit code. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/236/runitor

## Description

Runitor is a command-line tool that runs a specified command and reports success or failure to a Healthchecks-compatible endpoint based on the process exit code. It lets self-hosters monitor short-lived jobs, scheduled tasks, and internal services that do not expose a built-in health endpoint. Use it when you want simple command completion pings instead of writing a custom wrapper.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

64/100 (Good), based on 4 of 5 factors.
- Maintained: 72 (last commit 53 days ago)
- Popular: 51 (362 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 92 (no serious findings, CI, tests, OpenSSF Scorecard 7.9/10)

## Links

- Docker Hub: https://hub.docker.com/r/runitor/runitor
- Unraid: https://ca.unraid.net/apps/runitor-0eqb4ch1c4ncw5?q=Runitor
- Official website: https://healthchecks.io
- Documentation: https://pkg.go.dev/bdd.fi/x/runitor#readme-usage

## Common questions

### How do I install Runitor so cron can find the command?

Install it with Go 1.19 or newer using the latest runitor command module. Go places the binary in $GOPATH/bin or $HOME/go/bin, so add that directory to PATH or use the full binary path in cron.

### What Healthchecks values must Runitor receive before starting a command?

Provide the API base URL and the check handle, such as the UUID, pingKey, or slug. Without those, Runitor has no endpoint to send the start and end pings.

### How does Runitor decide whether the monitored command succeeded?

It runs the supplied command and captures its output. It reports successful or failed execution to Healthchecks based on the process exit code.

### Can Runitor be used to monitor internal web servers from cron?

A self-hoster suggested using it in cron jobs to monitor web servers. Runitor sends success or failure to Healthchecks, which can cover internal services.

## Alternatives

- C (programming language)
- C#
- C++
- Crystal (programming language): Programming language with Ruby-like syntax that compiles to efficient native code.
- Dart: Dart is a general-purpose, strongly typed programming language that compiles to native machine code, JavaScript, or WebAssembly.
- Java: Java is a general-purpose computer programming language that is concurrent, class-based, object-oriented, and specifically designed to have…
- Lua: Lua is a powerful, fast, lightweight, embeddable scripting language.
- Nim (programming language): Nim is a statically typed, imperative programming language with a powerful macro system that tries to give the programmer ultimate power wi…
- Perl: Perl is a high-level, general-purpose, interpreted, dynamic programming language used for system administration, web development, network p…
- Python: This container needs special attention.
- Rust
- Swift (programming language)

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