supervisor.sh is a process supervisor inspired by Supervisord written in Bash. It's a lightweight pure Bash solution, providing basic functionality to supervise processes (called jobs). The configuration is done in a YAML configuration file. By default, all jobs are automatically started and in case of an error (exit code > 0) restarted.

For environments like Docker container, where minimal overhead is desired, the dependency on yq can be removed by converting the YAML configuration to Bash.

Without the explicit start command, supervisor.sh runs in the foreground. It can be stopped by:

1. Pressing CTRL-C, which is equivalent to the SIGINT signal.
2. Running supervisor.sh stop in another session.

To run the supervisor in daemon mode, use supervisor.sh start.

• Bash >= 5.1
• yq - a lightweight and portable command-line YAML processor
• The following core utilities: cat mkdir readlink rm setsid sleep tail

The yq dependency can be removed. See below.

SV_VERSION=latest

# Supervisor
curl -sSLf -o /usr/bin/supervisor.sh "https://raw.githubusercontent.com/casperklein/supervisor.sh/refs/tags/$SV_VERSION/supervisor.sh"
chmod +x /usr/bin/supervisor.sh

# Bash completion (optional)
curl -sSLf -o /etc/bash_completion.d/supervisor.sh "https://raw.githubusercontent.com/casperklein/supervisor.sh/refs/tags/$SV_VERSION/supervisor-completion.bash"

Usage:
  supervisor.sh [OPTION] [COMMAND]

Configuration file:
  By default, the configuration is read from '/etc/supervisor.yaml'.
  If 'yq' is not available, '/etc/supervisor.yaml.sh' will be used instead.
  Provide '--config' to specify a custom configuration file.

Options:
  -c, --config     Specify configuration file, e.g. 'supervisor.sh -c /path/config.yaml'.
  -h, --help       Show this help.
  -n, --no-color   Disable color usage.
  -v, --version    Show version.

Commands:
  start            Start supervisor.sh as daemon.
  start <job>      Start job.
  stop             Stop supervisor.sh.
  stop  <job>      Stop job.
  restart          Restart daemon.
  restart <job>    Restart job.
  status           Show process states.
  fix              Fix unclean shutdown.
  log              Show continuously the supervisor.sh log (only for daemon mode)
  logs             Show continuously the supervisor.sh log + job logs.
  convert          Convert the YAML configuration file to Bash. This allows the
                   usage without the 'yq' dependency.

If no command is provided, supervisor.sh will start in foreground.

By default, the configuration is read from /etc/supervisor.yaml. You can specify another location with the --config option.

supervisor:
  logfile: "/var/log/supervisor.log"
  sigterm_grace_period: 10
  keep_running: "off"
  color: "\e[0;34m" # blue text color

jobs:
  - name: "job1-restart"
    command: "echo 'Job 1: I will fail in 4 seconds. But supervisor will restart me 3 times.'; sleep 4; exit 1"
    autostart: "on"
    restart: "error"

  - name: "job2-no-restart"
    command: "echo 'Job 2: No restart for me on failure in 3 seconds.'; sleep 3; exit 1"
    restart: "off"

  - name: "job3-no-autostart"
    command: "echo 'Job 3: I was started manually'"
    autostart: "off"
    logfile: "/var/log/job4.log"

  - name: "job4-required"
    command: "echo 'Job 4: I am required. When I stop in 20 seconds, supervisor will stop too.'; sleep 20"
    restart: "off"
    required: "yes"

  - name: "job5-ignore-SIGTERM"
    command: "trap true SIGTERM; echo 'Job 5: I will ignore SIGTERM.'; while :; do sleep 1d; done"

If you have bash-completion installed, simply copy supervisor-completion.bash to /etc/bash_completion.d/.

Otherwise, you can source supervisor-completion.bash in your .bashrc.

If you want to remove the yq dependency, you can convert the YAML configuration to Bash. This conversion must be done in an environment where yq is available.

supervisor.sh -c /etc/supervisor.yaml convert

# Now you can use supervisor.sh without the 'yq' dependency
supervisor.sh -c /etc/supervisor.yaml.sh <command>

docker run --rm -v "${PWD}":/workdir -u root --entrypoint /bin/sh mikefarah/yq -c "apk add bash; bash -c './supervisor.sh -c supervisor.yaml convert'"

• Pi-hole for Home Assistant
• docker-smokeping