Installation

officialJCReyes edited this page Oct 10, 2018 · 58 revisions

Windows

  1. Download the latest windows.zip @ https://github.com/tidusjar/Ombi/releases/latest for stable or use https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop/artifacts for develop.
  2. Right click > Properties > Unblock
  3. Extract the zip to your preferred directory. DO NOT place in the "Program Files" or "ProgramData" folders as the Ombi database will be locked.
  4. Run Ombi.exe

To Install as a Service

  1. Download the latest windows.zip @ https://github.com/tidusjar/Ombi/releases/latest for stable or use https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop/artifacts for develop.
  2. Right click > Properties > Unblock
  3. Extract the zip to your preferred directory. DO NOT place in the "Program Files" or "ProgramData" folders as the Ombi database will be locked.
  4. Use NSSM to manage Ombi. Extract either the 32-/64-bit version to C:\Windows\system32. Open command prompt as an Administrator and type nssm install Ombi. Use one of the following settings depending on whether you want to keep or change the default port.

Standard Setup

Be sure to adjust directories to your Ombi install location

Path: C:\Tools\Ombi\Ombi.exe
Start directory: C:\Tools\Ombi
Ombi NSSM with Port

Standard Setup with different port number

Be sure to adjust directories to your Ombi install location

Path: C:\Tools\Ombi\Ombi.exe
Start directory: C:\Tools\Ombi
Arguments: --host "http://*:PORTNUMBER"
Ombi NSSM with Port

Run with Windows Task Scheduler

Allows automatic updating on windows: updater currently broken.

Running Ombi as a Scheduled Task

Linux systems

Apt repo (The easy way, only Debian based distros)

  • This repo is maintained by @louis-lau. Go bug him on discord if you have problems specifically with the repo. Don't open an issue here.
  • Note that as of now only systemd is supported, not upstart. That means Debian jessie and up, and Ubuntu 15.04 and up.
  • Builds should be in the repo within 15 minutes after releasing on GitHub (stable) or AppVeyor (develop).
  • Yes, I used a funny domain.
  1. Add the apt repository to the apt sources list:

    • If you would like stable releases execute:
    echo "deb [arch=amd64,armhf] http://repo.ombi.turd.me/stable/ jessie main" | sudo tee "/etc/apt/sources.list.d/ombi.list"
    
    • If you would like development releases execute this instead:
    echo "deb [arch=amd64,armhf] http://repo.ombi.turd.me/develop/ jessie main" | sudo tee "/etc/apt/sources.list.d/ombi.list"
    
  2. This repo is signed. This means packages get validated before installation. So, to safely download and install Ombi packages the Ombi key needs to be installed:

    wget -qO - https://repo.ombi.turd.me/pubkey.txt | sudo apt-key add -
    
  3. Now update the package list and install Ombi:

    sudo apt update && sudo apt install ombi
    
  • If no errors are shown, Ombi has been installed successfully and will automatically start at boot time.
    Ombi should now be reachable on http://your-ip-address:5000

  • Packages in this repo use systemd, you can use the systemctl or the service command to start, stop, and restart Ombi.

  • If there's ever an update to Ombi:

    • It will get installed along with all other updates if you:
    sudo apt update && sudo apt upgrade
    
    • Or you only want to upgrade Ombi:
    sudo apt update && sudo apt install ombi
    
  • If you ever want to switch branches, you can edit /etc/apt/sources.list.d/ombi.list. Replace stable with develop, or the other way around.

Ubuntu / Automated PlexGuide Installer

NOTE: PlexGuide Installs Docker on your Machine

  1. Install PlexGuide from https://plexguide.com - GITHUB on a Clean UB16/UB18 machine
  2. Select "Program Suite Installer"
  3. Type ombi or ombi4k
  4. Ombi will install in under 15 seconds
  5. Follow screen instructions on how to access (example ombi - ombi.domain.com, ipv4:3579, domain:3579)

Manual install (The less easy way, all distros)

  1. mkdir /opt/Ombi
  2. cd into that directory cd /opt/Ombi
  3. Download the latest linux.tar.gz @ https://github.com/tidusjar/Ombi/releases/latest for stable and use https://ci.appveyor.com/project/tidusjar/requestplex/branch/develop/artifacts for develop.
  4. With the newly downloaded linux.tar.gz file in /opt/Ombi run tar xzf linux.tar.gz
  5. In the /opt/Ombi directory make the Ombi file an executable: chmod +x Ombi
  6. Install libicu-dev if it isn't already installed: sudo apt install libicu-dev
  7. Install libunwind8 if it isn't already installed: sudo apt install libunwind8
  8. Install 'libcurl4-openssl-dev' if it isn't already installed: sudo apt install libcurl4-openssl-dev
  9. In the /opt/Ombi directory run Ombi ./Ombi
  10. Verify correct Locale settings as this can prevent Ombi from talking to Plex in some LXC container installs: env | grep LANG should return LANG=en_US.UTF-8 env | grep LC_ALL should return LC_ALL=en_US.UTF-8. You can also try the locale command. In some systems, setting LC_ALL is all that is necessary. If you need to update your locale, you can do so as follows:
$ sudo locale-gen "en_US.UTF-8"
Generating locales...
  en_US.UTF-8... done
Generation complete.

$ sudo dpkg-reconfigure locales
Generating locales...
  en_US.UTF-8... up-to-date
Generation complete.

If you decide to run Ombi as a different user, other than root, in accordance with the below warning; you need to chown the Ombi folder to the user you change the systemd service to. sudo chown -R ombi:nogroup /opt/Ombi

Run as systemd service (Ubuntu 15.04+)

Warning: you should create your own user to run Ombi. Using root is not ideal. Recommended settings are:

  • User: ombi
  • Group: nogroup (built-in non-privileged group)
  1. sudo nano /etc/systemd/system/ombi.service
  2. Paste the following:
    [Unit]
    Description=Ombi - PMS Requests System
    After=network-online.target
    
    [Service]
    User=root
    Group=root
    WorkingDirectory=/opt/Ombi/
    ExecStart=/opt/Ombi/Ombi
    Type=simple
    TimeoutStopSec=30
    Restart=on-failure
    RestartSec=5
    
    [Install]
    WantedBy=multi-user.target
    
  3. Press Ctrl+X then y to save (assuming you're using nano).
  4. sudo systemctl daemon-reload
  5. sudo systemctl start ombi
  6. to enable Ombi to run on startup: sudo systemctl enable ombi.service
  7. to ensure service is running: sudo systemctl status ombi

Run as upstart service (Ubuntu Pre-15.04)

Warning: you should create your own user to run Ombi. Using root is not ideal. Recommended settings are:

  • User: ombi
  1. sudo nano /etc/init.d/ombi
  2. Paste the following:
    #!/bin/sh
    ### BEGIN INIT INFO
    # Provides:          ombi
    # Required-Start:    $local_fs $remote_fs $network
    # Required-Stop:     $local_fs $remote_fs $network
    # Default-Start:     2 3 4 5
    # Default-Stop:      0 1 6
    # Short-Description: Ombi
    # Description:       A personal media assitant. A simple way for shared media users to request and download content
    ### END INIT INFO
    
    . /lib/lsb/init-functions
    ################################################################################
    # Update these variables to reflect your system
    ################################################################################
    DAEMON_PWD="/opt/Ombi"
    DAEMON_USER="root"
    DAEMON_NAME="ombi"
    DAEMON_LOG="/var/log/${DAEMON_NAME}.log"
    DAEMON_PATH="${DAEMON_PWD}/Ombi"
    DAEMON_OPTS="--host http://*:5000 --storage ${DAEMON_PWD}"
    DAEMON_DESC=$(get_lsb_header_val $0 "Short-Description")
    DAEMON_PID="/var/run/${DAEMON_NAME}.pid"
    DAEMON_NICE=0
    
    [ -r "/etc/default/${DAEMON_NAME}" ] && . "/etc/default/${DAEMON_NAME}"
    
    do_start() {
      local result
    
      pidofproc -p "${DAEMON_PID}" "${DAEMON_PATH}" > /dev/null
      if [ $? -eq 0 ]; then
        log_warning_msg "${DAEMON_NAME} is already started"
        result=0
      else
        log_daemon_msg "Starting ${DAEMON_NAME}"
        touch "${DAEMON_LOG}"
        chown $DAEMON_USER "${DAEMON_LOG}"
        chmod u+rw "${DAEMON_LOG}"
        if [ -z "${DAEMON_USER}" ]; then
          start-stop-daemon --start --quiet --oknodo --background \
            --nicelevel $DAEMON_NICE \
            --chdir "${DAEMON_PWD}" \
            --pidfile "${DAEMON_PID}" --make-pidfile \
            --startas /bin/bash -- -c "exec ${DAEMON_PATH} ${DAEMON_OPTS} >> ${DAEMON_LOG} 2>&1"
          result=$?
        else
          start-stop-daemon --start --quiet --oknodo --background \
            --nicelevel $DAEMON_NICE \
            --chdir "${DAEMON_PWD}" \
            --pidfile "${DAEMON_PID}" --make-pidfile \
            --chuid "${DAEMON_USER}" \
            --startas /bin/bash -- -c "exec ${DAEMON_PATH} ${DAEMON_OPTS} >> ${DAEMON_LOG} 2>&1"
          result=$?
        fi
        log_end_msg $result
      fi
      return $result
    }
    
    do_stop() {
      local result
    
      pidofproc -p "${DAEMON_PID}" "${DAEMON_PATH}" > /dev/null
      if [ $? -ne 0 ]; then
        log_warning_msg "${DAEMON_NAME} is not started"
        result=0
      else
        log_daemon_msg "Stopping ${DAEMON_NAME}"
        killproc -p "${DAEMON_PID}" "${DAEMON_PATH}"
        result=$?
        log_end_msg $result
        rm "${DAEMON_PID}"
      fi
      return $result
    }
    
    do_restart() {
      local result
      do_stop
      result=$?
      if [ $result = 0 ]; then
        do_start
        result=$?
      fi
      return $result
    }
    
    do_status() {
      local result
      status_of_proc -p "${DAEMON_PID}" "${DAEMON_PATH}" "${DAEMON_NAME}"
      result=$?
      return $result
    }
    
    do_usage() {
      echo $"Usage: $0 {start | stop | restart | status}"
      exit 1
    }
    
    case "$1" in
    start)   do_start;   exit $? ;;
    stop)    do_stop;    exit $? ;;
    restart) do_restart; exit $? ;;
    status)  do_status;  exit $? ;;
    *)       do_usage;   exit  1 ;;
    esac
  3. Press Ctrl+X then y to save (assuming you're using nano).
  4. sudo chmod +x /etc/init.d/ombi (this makes the above script executable)
  5. sudo update-rc.d ombi defaults (this tells the system when to start the service based on run-level)
  6. sudo service ombi start (this starts the service)
  7. to ensure service is running: sudo service ombi status

MacOS

  1. Download the latest osx.zip
  2. Extract to a directory
  3. Set working directory to where you extracted
  4. Run Ombi ./Ombi
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.