Wiki > whisparr

A random port number between 10000 and 32767 is needed and will be used to access Whisparr. The port number 18729 has automatically been generated and will be used throughout this article, but can be changed if needed.

Installing Whisparr

Connect to your slot using SSH

1. Create ~/whisparr/whisparr.yml

    mkdir -p ~/whisparr && touch ~/whisparr/whisparr.yml
   

2. Open the file with nano ~/whisparr/whisparr.yml and add the text in this text box to the file

    services:
      whisparr:
        container_name: whisparr
        image: ghcr.io/hotio/whisparr
        network_mode: host
        environment:
          - PUID=0
          - PGID=0
          - UMASK=002
          - TZ=UTC
        volumes:
          - /home/user/whisparr:/config
          - /home/user:/home/user
        pull_policy: always
        restart: unless-stopped
   

   Save the file by pressing Ctrl+S then exit nano with Ctrl+X

3. Run the Whisparr container briefly

    podman-compose -f ~/whisparr/whisparr.yml up
   

   Wait until you see "Press Ctrl+C to shut down"

   Press Ctrl+C

4. Edit the port used by Whisparr

    sed -i 's/6969/18729/' ~/whisparr/config.xml
   

5. Start Whisparr

    podman-compose -f ~/whisparr/whisparr.yml up -d
   

After returning to your shell prompt, Whisparr will be accessible at http://server.whatbox.ca:18729 (it may take several seconds to start responding) You must add authentication immediately when prompted - select "Forms" and fill in a username and password.

Updating Whisparr

To update Whisparr, run this command to restart into the latest version: podman-compose -f ~/whisparr/whisparr.yml down && podman-compose -f ~/whisparr/whisparr.yml up -d

Automatically Restart (Whisparr)

Below are steps to take to have your Whisparr instance automatically restart if it crashes, or if the server is rebooted.

1. Make a file to be used for the script. touch ~/whisparr_restart.cron

2. Edit the file and enter the text below. nano -w ~/whisparr_restart.cron

    #!/bin/bash
    # Simple check: is a container named "whisparr" currently running?
    if podman ps --format "{{.Names}}" | grep -q "^whisparr$"
    then
        echo "whisparr is running."
    else 
        echo "whisparr is not running, starting whisparr"
        # change to the folder with your compose file and start it in detached mode
        cd ~/whisparr/ || exit
        podman-compose -f ~/whisparr/whisparr.yml up -d
    fi
    exit
   

3. Save the file with Ctrl+x and the y and Enter to accept overwriting.

4. Make the script executable. chmod +x ~/whisparr_restart.cron

5. Open your crontab. EDITOR=nano crontab -e

6. Enter the following text

    @reboot /home/user/whisparr_restart.cron >/dev/null 2>&1
    */5 * * * * /home/user/whisparr_restart.cron >/dev/null 2>&1
   

7. Save the crontab with Ctrl+x and the y and Enter to accept overwriting.