Setup

Getting set up

Requirements

Default specs are 2vCPU, 3GB RAM and a 100GB disk. You can add more vCPU’s and RAM to your liking. For detailed hardware specs, have a look here.

Setup steps

NOTE: Read all of these steps and any associated information before starting...

First Run

1. Install VirtualBox or use your own favorite hypervisor

   • Running Proxmox? Find instructions and import options here
   • If you are running VirtualBox on an Ubuntu 18.04 host, see this page for an automated option.
     Otherwise, follow the steps below.

2. Download OpenFLIXR VM image/disk

   • For VirtualBox / VMWare (And Proxmox)
   • For Parallels Desktop
   • For KVM / unRAID
   • For Hyper-V

3. Import it into your hypervisor

4. Power on your VM

5. Connect to OpenFLIXR via either your VM console or SSH (default username & password is openflixr)

6. Once connected, run the following in the OpenFLIXR terminal:

   bash -c "$(curl -fsSL https://raw.githubusercontent.com/cyberlooper/OpenFLIXR2.FirstRun/master/run_me.sh)"

   This will:

   • Get everything set up and ready for the upgrade process, then start it.
   • Run the process in a Screen session from the time that it starts the DNS checks. This means that once the DNS checks start you can disconnect and it will keep running! However, you will need to log in again after each reboot to continue the process.
   • Make sure the system has been running for 10 minutes.
   • Make sure the system isn't running any processes that need to finish and will wait for them all to be finished before moving on.
   • Do some fixes
   • Do some basic DNS checking
   • Prepare for upgrade
   • Run the Upgrade
   • Do final fixes and clean-ups

   IMPORTANT NOTES

   1. Once you start, don't interrupt the process. Fortunately, once the process hits "Putting some fixes in place..." it will be running in a Screen session. This will allow you to disconnect and keep the process running, so no need to worry if you lose connection to you OF VM! As long as the VM stays on and connected to the internet, everything should be fine.
   2. You may see some warnings or errors on-screen or in logs. In most cases, these are handled gracefully and needed for the script to detect what it needs to fix. Unless the script stops with an ERROR or FATAL message, it should be fine.
   3. DO NOT get impatient. At times it will look like nothing is happening, especially when the upgrade process begins, but it is working. Just wait. In my testing, this process from start to finish takes about 1.5 hours to 4 hours, but your time may differ depending on your system specs. Just wait. Go watch a movie, play a game, spend time with your family, whatever you need to do to keep yourself from being impatient.
   4. Your system will reboot automatically as needed. Log in again and it should run the script again automatically for you and continue with the next steps of the process.
   5. Once completed, you will see a banner that says "OpenFLIXR should now be ready for use!!". Only then should you continue to the next step.

7. Go to http://x.x.x.x/setup where you should see the web-based terminal

   1. If you don't see the web-based terminal, DO NOT continue. Your system is not ready.
   2. If you do see the web-based terminal, continue through Setup/Configure below

Setup/Configure

1. Start the setup by running sudo setupopenflixr
   • This script will walk you through steps to get you mostly up-and-running.
   • 
     If you completed the "First Run" steps before the above latest commit your setup may be out of date. If it doesn't prompt you to update, run sudo setupopenflixr -u to update.
2. Once completed, come back here and complete the items in Post-setup steps below.

Post-setup steps

Once you have completed the setup, you will need to do the following:

• Mount your media folders
• Configure applications
  • IMPORTANT NOTE: Many applications have the option to turn on SSL. DO NOT enable SSL in any application unless you know what you are doing. Enabling SSL in an application can cause it to become inaccessible.
  • Plex

Issues & Troubleshooting

I try to run the setup and get "command not found"

Run the following and it should work again

sudo chmod +x /usr/local/bin/setupopenflixr
sudo chmod +x /usr/bin/setupopenflixr

If you have already completed the first setup, then do the following:

1. Run the setup
2. Select "Configuration"
3. Select "Various Fixes" This will add commands to the post-update script to make sure it doesn't happen again.

Setup fails when it tries to configure Let's Encrypt

This could be for a couple of reasons.
Make sure that

• {YOUR_DOMAIN} and www.{YOUR_DOMAIN} are both A records pointing to your Public IP address
• Ports 80 and 443 are forwarded to OpenFLIXR

Once you have made sure that is done, do the following (this assumes you have completed the first setup):

1. Run the setup
2. Select "Configuration"
3. Select "Configure Access"
   If that fails for any reason, the setup will collect logs to help troubleshoot fixing the issue.

I run the setup and get jq: command not found

jq didn't get installed like it was supposed to. To fix this run

sudo setupopenflixr -i

If that fails for some reason

1. Report it
2. Then run

   sudo apt-get -y update
   apt-get -y install jq

Once jq is installed, run the setup again.

I get "Unsupported Ubuntu Version."... when I run sudo setupopenflixr

If you are getting "Unsupported Ubuntu Version. This setup can only be run for OpenFLIXR running Ubuntu 18.04" when you run sudo setupopenflixr, make sure that you have followed the instructions above. If you have, then do the following:

1. Run

   sudo bash /opt/update/updates/openflixr/updateto29manual.sh

2. Once that completes, run the setup again.

Log submitting

If there are any issues with the script that cause it to error while running, it will let you know and ask to submit the logs for you or direct you to this section.

You can submit logs at any point by running

sudo setupopenflixr -l

NOTE: Logs can only be submitted once per version.

If the automatic submission doesn't work, you will need to manually provide logs for troubleshooting. To do this, run the following then send /tmp/setup_logs.tar.gz to MattyLightCU on Discord so that he can look into the issue.

tar -czvf /tmp/setup_logs.tar.gz /var/log/openflixr_setup.*