install.sh

#!/bin/bash
#
# Script for automatic setup of telesight program and the streaming program
#
# Currently supports Ubuntu and Debian OS, running on other OS is not currently supported
#
# Copyright (C) 2020-2021 Zhongkai Liu <jpzrcodek@gmail.com>
# Based on
#   https://github.com/jacksonliam/mjpg-streamer
#   https://github.com/FFmpeg/FFmpeg
#

function fresh_raspi_checklist() {
  echo
  read -rp "Is this a fresh installed Raspberry Pi? > (y/n) " FRESH_PI

  if [[ $FRESH_PI == "Y" || $FRESH_PI == "y" ]]; then
    echo "Plase take care of following items before proceeding and run this script again ..."
    echo
    echo "[] Run ' sudo nano /etc/default/keyboard ' and update 'XKBLAYOUT' to 'us' (if you are using US keyboard layout)"
    echo "[] If this device does not have wired ethernet access, configure the wireless Internet connection. (See guide in extras directory)"
    echo "[] Verify valid Internet access by running ' ping www.google.com -c 5 '"
  fi
  echo
}

function set_hostname() {
  OLD_HOSTNAME=$(hostname)
  echo
  echo "Currently this device hostname is $OLD_HOSTNAME"
  echo "Change your device hostname to make sure it is easily identifiable in a multi-camera setup."
  read -rp "Would you like to change this host's hostname? (y/n) > " UPDATE_HOSTNAME

  if [[ $UPDATE_HOSTNAME == "Y" || $UPDATE_HOSTNAME == "y" ]]; then
    if ! bash "$(dirname "$0")"/set_hostname.sh; then
      exit 1
    fi
  fi

  echo
}

function installPackages() {
  # install prerequisite packages
  echo
  echo "Be ready to be prompted for sudo access to install packages..."
  sudo apt-get update
  sudo apt-get upgrade -y
  sudo apt-get install -y cmake gcc g++ golang haproxy
  if [[ $IS_STREAMING == "y" || $IS_STREAMING == "Y" ]]; then
    sudo apt-get install -y ffmpeg libjpeg8-dev
  fi
  echo
}

function build_streamer() {
  # build the source for streaming
  if [[ ! -d $STREAMER_ROOT ]]; then
    git clone https://github.com/OnTitansShoulder/mjpg-streamer.git streamer-tmp
    mv streamer-tmp/mjpg-streamer-experimental "$STREAMER_ROOT"
    rm -rf streamer-tmp
  fi

  cd "$STREAMER_ROOT" || ( echo "cd failed" && exit 1 )
  make
  sudo make install
  cd "$CWD" || ( echo "cd failed" && exit 1 )
  [[ -x $(which mjpg_streamer) ]] || ( echo "Failed to build/install mjpg_streamer" && exit 1 )
}

function build_telesight() {
  # build the source for telesight
  cd "$CWD" || ( echo "cd failed" && exit 1 )
  go build
  sudo mv telesight /usr/local/bin/
  [[ -x $(which telesight) ]] || ( echo "Failed to install telesight" && exit 1 )
}

function generate_telesight_service() {
  # generate the services files
  id -u telesight >> /dev/null || sudo useradd telesight
  TELESIGHT_RUN_ROOT=/var/telesight
  sudo mkdir -p $TELESIGHT_RUN_ROOT "$TELESIGHT_RUN_ROOT/frames" $TELESIGHT_RUN_ROOT/videos $TELESIGHT_RUN_ROOT/templates
  sudo cp "$CWD"/templates/*.gtpl "$TELESIGHT_RUN_ROOT/templates/"
  sudo chown -R telesight:telesight $TELESIGHT_RUN_ROOT
  sudo chmod -R 0755 $TELESIGHT_RUN_ROOT
  cat > telesight.service <<EOF
[Unit]
Description=camera streaming portal and video viewing/recording service
ConditionPathExists=$TELESIGHT_RUN_ROOT

[Service]
User=root
Restart=always
RestartSec=5
WatchdogSec=21600
Nice=0
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=telesight

ExecStart=$TELESIGHT_BIN -m $PRIMARY_HOST -b $TELESIGHT_RUN_ROOT $STREAM_FLAG -r

[Install]
WantedBy=multi-user.target
EOF

  cat > telesight.conf <<EOF
:programname, startswith, "telesight" {
  /var/log/telesight.log
  stop
}
EOF

  sudo chmod 644 telesight.service telesight.conf
  sudo cp telesight.conf /etc/rsyslog.d/
  sudo cp telesight.service /lib/systemd/system/
  sudo systemctl enable telesight
  sudo systemctl restart telesight rsyslog
}

function generate_streamer_service() {
  getSupportedVideoFormat

  TELESIGHT_RUN_ROOT=/var/telesight
  sudo mkdir -p $TELESIGHT_RUN_ROOT
  sudo cp "$STREAMER_ROOT"/*.so $TELESIGHT_RUN_ROOT
  sudo cp -r "$STREAMER_ROOT/www" "$TELESIGHT_RUN_ROOT/"
  sudo chown -R telesight:telesight $TELESIGHT_RUN_ROOT
  sudo chmod -R 0755 $TELESIGHT_RUN_ROOT
  cat > mjpg_streamer.service <<EOF
[Unit]
Description=webcam streaming service
ConditionPathExists=$TELESIGHT_RUN_ROOT

[Service]
User=root
Restart=always
RestartSec=5
WatchdogSec=21600
Nice=0
WorkingDirectory=$TELESIGHT_RUN_ROOT
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=mjpg_streamer

ExecStart=$STREAMER_BIN -i 'input_uvc.so -r $RESOLUTION -f 10 $FORMAT_FLAG' -o 'output_http.so'

[Install]
WantedBy=multi-user.target
EOF

  cat > mjpg_streamer.conf <<EOF
:programname, startswith, "mjpg_streamer" {
  /var/log/mjpg_streamer.log
  stop
}
EOF

  sudo chmod 644 mjpg_streamer.service mjpg_streamer.conf
  sudo cp mjpg_streamer.conf /etc/rsyslog.d/
  sudo cp mjpg_streamer.service /lib/systemd/system/
  sudo systemctl enable mjpg_streamer
  sudo systemctl restart mjpg_streamer rsyslog
}

function getSupportedVideoFormat() {
  VIDEO_FORMATS=$(ffmpeg -f v4l2 -list_formats all -i /dev/video0 2>&1 | grep 'v4l2')
  if [[ -n $(echo "$VIDEO_FORMATS" | grep 'mjpeg') ]]; then
    SUPPORT_MJPG=true
    MJPG_RESOLUTIONS=$(echo "$VIDEO_FORMATS" | grep 'mjpeg' | rev | cut -d':' -f 1 | rev | awk '{$1=$1;print}')
    getResolution "$MJPG_RESOLUTIONS"
    MJPG_RESOLUTION=$RESOLUTION
  fi
  if [[ -n $(echo "$VIDEO_FORMATS" | grep 'yuyv') ]]; then
    SUPPORT_YUV=true
    YUV_RESOLUTIONS=$(echo "$VIDEO_FORMATS" | grep 'yuyv' | rev | cut -d':' -f 1 | rev | awk '{$1=$1;print}')
    getResolution "$YUV_RESOLUTIONS"
    YUV_RESOLUTION=$RESOLUTION
  fi
  if [[ $SUPPORT_MJPG == 'true' ]]; then
    FORMAT_FLAG=
    RESOLUTION=$MJPG_RESOLUTION
  elif [[ $SUPPORT_YUV == 'true' ]]; then
    FORMAT_FLAG="-y yuv"
    RESOLUTION=$YUV_RESOLUTION
  else
    echo "No supported video format found from the cam /dev/video0" && exit 1
  fi
}

function getResolution() {
  RESOLUTIONS=$1
  if [[ -n $(echo "$RESOLUTIONS" | grep '640x360') ]]; then
    RESOLUTION='640x360'
  elif [[ -n $(echo "$RESOLUTIONS" | grep '640x480') ]]; then
    RESOLUTION='640x480'
  else
    RESOLUTION=$(echo "$RESOLUTIONS" | cut -d' ' -f 1)
  fi
}

function update_haproxy_config() {
  haproxy_bin=$(which haproxy)
  if [[ -z "$haproxy_bin" ]]; then
    echo "haproxy is not installed!" && exit 1
  fi
  # setup haproxy to route the traffic
  # if there is a telesight.bak file, this is the second time running this function
  # restore the backup to avoid double writing things
  if [[ -e /etc/haproxy/haproxy.cfg.telesight.bak ]]; then
    sudo cp /etc/haproxy/haproxy.cfg{.telesight.bak,}
  else
    sudo cp /etc/haproxy/haproxy.cfg{,.telesight.bak}
  fi

  haproxy_major_version=$(dpkg -s haproxy | grep -e "Version" | cut -d' ' -f2 | cut -d'.' -f1)

  # now add the routing for the frontend UI
  sudo tee -a /etc/haproxy/haproxy.cfg <<EOF
frontend public
        bind :::80 v4v6
        option forwardfor except 127.0.0.1
        use_backend telesight if { path_beg /telesight/ }
EOF

  # add routing to webcam if streaming is enabled
  if [[ $IS_STREAMING == "y" || $IS_STREAMING == "Y" ]]; then
    sudo tee -a /etc/haproxy/haproxy.cfg <<EOF
        use_backend webcam if { path_beg /webcam/ }
EOF
  fi

  # add routing backend to telesight and replace-uri config (version-specific syntax)
  if [[ $haproxy_major_version -lt 2 ]]; then
    sudo tee -a /etc/haproxy/haproxy.cfg <<EOF

backend telesight
        reqrep ^([^\ :]*)\ /telesight/(.*)     \1\ /\2
        server telesight  127.0.0.1:8089
EOF
  else
    sudo tee -a /etc/haproxy/haproxy.cfg <<EOF

backend telesight
        http-request replace-uri ^/telesight/(.*) /\1
        server telesight  127.0.0.1:8089
EOF
  fi

  # add routing backend to webcam stream and replace-uri config (version-specific syntax)
  if [[ $IS_STREAMING == "y" || $IS_STREAMING == "Y" ]]; then

    if [[ $haproxy_major_version -lt 2 ]]; then
      sudo tee -a /etc/haproxy/haproxy.cfg <<EOF
backend webcam
        reqrep ^([^\ :]*)\ /webcam/(.*)     \1\ /\2
        server webcam1  127.0.0.1:8080
EOF
    else
      sudo tee -a /etc/haproxy/haproxy.cfg <<EOF
backend webcam
        http-request replace-uri ^/webcam/(.*) /\1
        server webcam1  127.0.0.1:8080
EOF
    fi

  fi

  # now start the routing service
  sudo systemctl restart haproxy
}

# print prerequist checklist if necessary
fresh_raspi_checklist

# check if we are changing hostname
set_hostname

# collect necessary info upfront
read -rp "Is this the first time running this script on this host (y/n) > " IS_FRESH_INSTALL

echo
echo "======[NOTE][IMPORTANT]======"
echo "If you are setting up a multi-host system, you need to choose one host as the primary which serves as the UI."
echo "Note that the primary host can also act as a camera host."
echo "============================="
echo

echo "Now enter the primary machine's IP address "
read -rp "or press enter to use current machine as primary > " PRIMARY_HOST
CURRENT_HOST=$(hostname -I | awk '{print $1}')
[[ -n $PRIMARY_HOST ]] || PRIMARY_HOST=$CURRENT_HOST

if [[ -z $PRIMARY_HOST ]]; then
  echo "Unable to get the device LAN IP address. Please check your network settings."
  exit 1
fi

echo
echo "======[NOTE][IMPORTANT]======"
echo "Please note down this IP address: $PRIMARY_HOST which will be used as the primary host for your setup."
echo "When you are setting up other camera hosts, be sure to enter this IP address for the primary machine prompt."
echo "============================="
echo

read -rp "Does this instance have a webcam and will be serving a camera stream (y/n) > " IS_STREAMING
if [[ $IS_STREAMING == "y" || $IS_STREAMING == "Y" ]]; then
  STREAM_FLAG="-s"

  read -rp "Have you plugged in your webcam to this device? If not it is a good time to do so now. Press enter to procceed > "
fi


CWD=$(pwd)
STREAMER_ROOT="$CWD/mjpg-streamer"
if [[ $IS_FRESH_INSTALL == "y" || $IS_FRESH_INSTALL == "Y" ]]; then
  installPackages
  if [[ $IS_STREAMING == "y" || $IS_STREAMING == "Y" ]]; then
    build_streamer
  fi
  build_telesight
fi

# double check telesight is built and installed
TELESIGHT_BIN=$(which telesight)
[[ -x $TELESIGHT_BIN ]] || ( echo "telesight is not available! Be sure to run make build and check for any errors, or run make install again and choose fresh install." && exit 1 )

if [[ $IS_STREAMING == "y" || $IS_STREAMING == "Y" ]]; then
  # double check mjpg_streamer is built and installed
  STREAMER_BIN=$(which mjpg_streamer)
  [[ -x $STREAMER_BIN ]] || ( echo "Failed to install mjpg_streamer" && exit 1 )

  # generate the mjpg_streamer service configuration
  generate_streamer_service
fi

# generate the telesight service configuration
generate_telesight_service

# configure haproxy to route traffic
update_haproxy_config

echo
echo "All done! Now visit http://$PRIMARY_HOST/telesight/stream/ to checkout the streamer service!"
echo "Once you setup all camera hosts, install VPN on the primary host to enable remote camera access."
echo