Whatbox Logo
Login for certain variables to be updated with your slot's information

Wiki > Overseerr

"Overseerr is a free and open source software application for managing requests for your media library. It integrates with your existing services, such as Sonarr, Radarr, and Plex!"

Installation

  1. Connect to your slot through SSH

  2. Download the latest release of Overseerr

     git clone --branch develop https://github.com/sct/overseerr.git
    
  3. Enter Overseerr's directory

     cd ~/overseerr/
    
  4. Change the build settings. The CPU limit will allow Overseerr to build correctly on our servers, especially when your slot is already running other programs.

     sed -i 's/256000,/256000, cpus: 8/' next.config.js
    
  5. Install and build Overseerr. This will take a long time; Overseerr has many dependencies.

     yarn install --network-timeout 1000000; yarn run build
    
  6. Start Overseerr

     PORT=10001 screen -dmS overseerr yarn --cwd ~/overseerr/ start
    

Overseerr will take a few seconds to start. Access http://server.whatbox.ca:10001 and finish the setup procedure.

Updating

  1. Connect to your slot through SSH

  2. Shut down Overseerr

     pkill -f overseerr
    
  3. Enter Overseerr's directory

     cd ~/overseerr/
    
  4. Change the Git branch to the latest release and pull latest commits

     git reset --hard ; git fetch ; git checkout develop; git pull
    
  5. Change the build settings. The CPU limit will allow Overseerr to build correctly on our servers, especially when your slot is already running other programs.

     sed -i 's/256000,/256000, cpus: 8/' next.config.js
    
  6. Remove old Overseerr node modules.

     rm -r ~/overseerr/node_modules
    
  7. Install and build Overseerr. This may take a long time; Overseerr has many dependencies.

     yarn install --network-timeout 1000000; yarn run build
    
  8. Start Overseerr

     PORT=10001 screen -dmS overseerr yarn --cwd ~/overseerr/ start
    

Automatically Restart

  1. Make a file to be used for the script. touch ~/overseerr_restart.cron
  2. Edit the file and enter the text below. nano -w ~/overseerr_restart.cron
#!/bin/bash
if pgrep -fx "node /usr/bin/yarn --cwd /home/user/overseerr/ start" > /dev/null
then
    echo "Overseerr is running."
else 
    echo "Overseerr is not running, starting overseerr"
    PORT=10001 screen -dmS overseerr yarn --cwd /home/user/overseerr/ start
fi
exit
  1. Save the file with Ctrl+x and the "y" and Enter to accept overwriting.
  2. Make the script executable. chmod +x ~/overseerr_restart.cron
  3. Open your crontab. EDITOR=nano crontab -e
  4. Enter the following text
@reboot /home/user/overseerr_restart.cron >/dev/null 2>&1
*/5 * * * * /home/user/overseerr_restart.cron >/dev/null 2>&1
  1. Save the crontab with Ctrl+x and the "y" and Enter to accept overwriting.

Notes

Use 127.0.0.1 as the address for connecting other apps if the app is running on the same server.

You may need to use IPv4 addresses for Sonarr. You can find your IPv4 address on your Slot Info page.

If Overseerr fails to build, stop rclone processes on your slot and try again.