Installing Overseerr

About this article

This article covers the installation of Overseerr within the QuickBox environment. If you are unsure about what Overseerr is, or if you are not sure it fits your needs, please refer to the Overseerr Quick Reference article for links and more about what Overseerr aims to achieve.

Install Overseerr from the Dashboard

1. Login to your Dashboard at https://SERVERIP(or)DOMAIN/login.php
2. Navigate to your Apps Dashboard and click on the Application Management tab.
3. Click on the Install button for Overseerr.
4. You’re done! Once the install completes the page will reload with the relevant entries on your Dashboard.

Install Overseerr from CLI

1. Login to your server via ssh.
2. Once logged into your server type sudo su - or sudo -i followed by hitting enter on your keyboard. This properly elevates your bash environment for running qb commands.
3. Once your bash is elevated you can now type qb install overseerr -u USERNAME
   • Already have an Overseerr domain setup on your DNS? Great! Run the install with the domain flag: qb install overseerr -u USERNAME -d OVERSEERR.DOMAIN.COM.
   • If you have installed Overseerr before having an available subdomain, see the steps below for an easy command to install your certificate, as well as make all the necessary adjustments for access. No complicated editing of files is needed!
4. You’re done! On completion the relevant information for ports and access link will be posted.

After installing Overseerr

Overseerr currently does not have base url support for routing through the nginx reverse and therefore will default to access on it’s assigned port. Should you have the ability to create your own subdomain for overseerr within your DNS, we have included a handy nginx template that you can edit to securely pass your overseerr to your assigned subdomain (example; requests.somedomain.com). This has been made easier with the included -d flag to enter your Overseerr subdomain.

Setup subdomain access for Overseerr

Once you have Overseerr installed and would like to access it over your controlled subdomain, you can edit the given nginx template to make this possible. The below explains the steps needed to get the job done!

With v3, ensure you have completed step 1 below. Then you can run:

qb install lecert -d some.overseerr.domain -o no-dash -o overseerr

This command will install your certificate and have the necessary nginx reverse created. If you installed Overseerr with the -d (domain) flag, you will not need to utilize this command.

1. Create your subdomain via an A Record at your DNS. The A record will utilize the same IP as your server. Name this record whatever you like (example; requests.somedomain.com)
2. With your subdomain created and ready, you will now want to generate an SSL certificate for the subdomain using the lecert command shown above.
3. If you have followed the above steps, you should now have a working and securely accessible over the subdomain Overseerr!

By default, QuickBox does not force the forward to https. This is so we can ensure that domains routing via CloudFlare have the proper access for Let’s Encrypt to stage and update the certificate on the servers IP. You can easily force this by opening your Overseerr reverse and making a simple edit:

1. Open your Overseerr nginx reverse located at /etc/nginx/sites-enabled/USERNAME.overseerr.conf
2. Uncomment the following line:

   #return 301 https://$server_name$request_uri;

   … so it would now look as:

   return 301 https://$server_name$request_uri;

3. Save and close the file.
4. Issue a restart to nginx and php8.1-fpm (for good measure) with service nginx restart && service php8.1-fpm restart
5. That’s it! You’re now forcing the https redirect on your Overseerr domain.