Umbrel 09/15/2023

install_umbrel.sh

#!/usr/bin/env bash
set -euo pipefail

export DEBIAN_FRONTEND=noninteractive
needrestart_conf_dir="/etc/needrestart/conf.d" 
needrestart_conf_file="${needrestart_conf_dir}/temp-disable-for-umbrel-install.conf"
sudo mkdir -p "${needrestart_conf_dir}"
echo "# Restart services (l)ist only, (i)nteractive or (a)utomatically.
\$nrconf{restart} = 'l';
# Disable hints on pending kernel upgrades.
\$nrconf{kernelhints} = 0; " | sudo tee "${needrestart_conf_file}" > /dev/null
trap "sudo rm -f ${needrestart_conf_file}" EXIT

# Default options
PRINT_DOCKER_WARNING="true"
UPDATE_APT="true"
INSTALL_APT_DEPS="true"
INSTALL_AVAHI="true"
INSTALL_YQ="true"
INSTALL_DOCKER="true"
INSTALL_DOCKER_COMPOSE="true"
INSTALL_START_SCRIPT="true"
INSTALL_UMBREL="true"
UMBREL_VERSION="release"
UMBREL_REPO="getumbrel/umbrel"
UMBREL_INSTALL_PATH="$HOME/umbrel"

# Parse arguments
arguments=${@:-}

if [[ "${arguments}" = *"--no-docker-warning"* ]]
then
  PRINT_DOCKER_WARNING="false"
fi

if [[ "${arguments}" = *"--no-install-avahi"* ]]
then
  INSTALL_AVAHI="false"
fi

if [[ "${arguments}" = *"--no-install-yq"* ]]
then
  INSTALL_YQ="false"
fi

if [[ "${arguments}" = *"--no-install-docker"* ]]
then
  INSTALL_DOCKER="false"
fi

if [[ "${arguments}" = *"--no-install-compose"* ]]
then
  INSTALL_DOCKER_COMPOSE="false"
fi

if [[ "${arguments}" = *"--no-install-start-script"* ]]
then
  INSTALL_START_SCRIPT="false"
fi

if [[ "${arguments}" = *"--no-install-umbrel"* ]]
then
  INSTALL_UMBREL="false"
fi

if [[ "${arguments}" = *"--no-install-deps"* ]]
then
  UPDATE_APT="false"
  INSTALL_APT_DEPS="false"
  INSTALL_AVAHI="false"
  INSTALL_YQ="false"
  INSTALL_DOCKER="false"
  INSTALL_DOCKER_COMPOSE="false"
  INSTALL_UMBREL="true"
fi

if [[ "${arguments}" = *"--version"* ]]
then
  UMBREL_VERSION="$(echo "${arguments}" | sed 's/.*--version \([^ ]*\).*/\1/')"
fi

if [[ "${arguments}" = *"--install-path"* ]]
then
  UMBREL_INSTALL_PATH="$(echo "${arguments}" | sed 's/.*--install-path \([^ ]*\).*/\1/')"
fi

get_umbrel_version() {
  version="${UMBREL_VERSION}"
  if [[ "${version}" = "release" ]]
  then
    version=$(curl --silent https://api.github.com/repos/${UMBREL_REPO}/releases/latest | sed -n 's/.*"tag_name": "\([^"]*\).*/\1/p')
  fi

  echo $version
}

update_apt() {
  sudo apt-get update --yes
}

install_apt_deps() {
  sudo apt-get install --yes fswatch jq rsync curl git gettext-base python3 gnupg
}

install_avahi() {
  sudo apt-get install --yes avahi-daemon avahi-discover libnss-mdns
}

install_yq() {
  # Define checksums for yq (4.24.5)
  declare -A yq_sha256
  yq_sha256["arm64"]="8879e61c0b3b70908160535ea358ec67989ac4435435510e1fcb2eda5d74a0e9"
  yq_sha256["amd64"]="c93a696e13d3076e473c3a43c06fdb98fafd30dc2f43bc771c4917531961c760"

  yq_version="v4.24.5"
  system_arch=$(dpkg --print-architecture)
  yq_binary="yq_linux_${system_arch}"

  # Download yq from GitHub
  yq_temp_file="/tmp/yq"
  curl -L "https://github.com/mikefarah/yq/releases/download/${yq_version}/${yq_binary}" -o "${yq_temp_file}"

  # Check file matches checksum
  if [[ "$(sha256sum "${yq_temp_file}" | awk '{ print $1 }')" == "${yq_sha256[$system_arch]}" ]]; then
    sudo mv "${yq_temp_file}" /usr/bin/yq
    sudo chmod +x /usr/bin/yq

    echo "yq installed successfully..."
  else
    echo "yq install failed. sha256sum mismatch"
    exit 1
  fi
}

install_docker() {
  # Install Docker
  sudo apt-get install --yes docker.io
}

install_docker_compose() {
  sudo apt-get install --yes docker-compose
}

get_arch() {
  machine_arch="$(uname --machine)"
  if [[ "${machine_arch}" = "x86_64" ]]
  then
    binary_arch="amd64"
  elif [[ "${machine_arch}" = "aarch64" ]]
  then
    binary_arch="arm64"
  else
    echo "Unsupported architecture: ${machine_arch}"
    exit 1
  fi

  echo "${binary_arch}"
}

install_umbrel() {
  version=$(get_umbrel_version)
  binary_arch=$(get_arch)
  curl --location "https://api.github.com/repos/${UMBREL_REPO}/tarball/${version}" | \
    tar --extract --gzip --strip-components=1 --directory="${UMBREL_INSTALL_PATH}"

  binary_url="https://github.com/${UMBREL_REPO}/releases/download/${version}/umbreld-${version}-${binary_arch}.tar.gz"
  curl --fail --location "${binary_url}" | tar --extract --gzip --directory="${UMBREL_INSTALL_PATH}/bin"
}

install_systemd_service() {
echo "
[Unit]
Wants=network-online.target
After=network-online.target
Wants=docker.service
After=docker.service

# This prevents us hitting restart rate limits and ensures we keep restarting
# indefinitely.
StartLimitInterval=0

[Service]
Type=forking
TimeoutStartSec=infinity
TimeoutStopSec=16min
ExecStart=${UMBREL_INSTALL_PATH}/scripts/start
ExecStop=${UMBREL_INSTALL_PATH}/scripts/stop
User=root
Group=root
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=umbrel startup
RemainAfterExit=yes
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target" | sudo tee "/etc/systemd/system/umbrel-startup.service"
  sudo chmod 644 "/etc/systemd/system/umbrel-startup.service"
  sudo systemctl enable "umbrel-startup.service"
}

main() {
  if [[ "${INSTALL_UMBREL}" = "true" ]]
  then
    echo "About to install Umbrel in \"${UMBREL_INSTALL_PATH}\"."
    echo "If you would like to install somewhere else you can specify a custom location with:"
    echo
    echo "  curl -L https://umbrel.sh | bash -s -- --install-path /some/path"
    echo
    echo "Waiting for 10 seconds..."
    echo
    echo "You may press Ctrl+C now to abort the install."
    echo
    sleep 10
  fi

  if [[ "${PRINT_DOCKER_WARNING}" = "true" ]] && [[ "${INSTALL_DOCKER}" = "true" ]] && command -v docker >/dev/null 2>&1
  then

cat << 'EOF'
It looks like you already have Docker installed. Umbrel requires a predictable version of Docker so this script will install Docker via apt.

If you would like to disable this behaviour you can abort this install and run again with --no-install-docker or --no-install-compose.

You can pass flags to the installer like this:

  curl -L https://umbrel.sh | bash -s -- --no-install-docker --no-install-compose

Waiting for 30 seconds...

You may press Ctrl+C now to abort the install.

EOF
    sleep 30
  fi

  if [[ "${INSTALL_UMBREL}" = "true" ]]
  then
    mkdir -p "${UMBREL_INSTALL_PATH}"
    if [[ "$(ls --almost-all "${UMBREL_INSTALL_PATH}")" ]]
    then
      echo "Error: Umbrel install path \"${UMBREL_INSTALL_PATH}\" already contains files"
      echo "You can install Umbrel in a custom location with:"
      echo
      echo "  curl -L https://umbrel.sh | bash -s -- --install-path /some/path"
      exit 1
    fi
  fi

  if [[ "${UPDATE_APT}" = "true" ]]
  then
    update_apt
  fi

  if [[ "${INSTALL_APT_DEPS}" = "true" ]]
  then
    install_apt_deps
  fi

  if [[ "${INSTALL_AVAHI}" = "true" ]]
  then
    install_avahi
  fi

  if [[ "${INSTALL_YQ}" = "true" ]]
  then
    install_yq
  fi

  if [[ "${INSTALL_DOCKER}" = "true" ]]
  then
    install_docker
  fi

  if [[ "${INSTALL_DOCKER_COMPOSE}" = "true" ]]
  then
    install_docker_compose
  fi

  if [[ "${INSTALL_UMBREL}" = "true" ]]
  then
    install_umbrel

    if [[ "${INSTALL_START_SCRIPT}" = "true" ]]
    then
      install_systemd_service
    fi

    # Do the initial start outside of systemd so we get logs
    sudo ${UMBREL_INSTALL_PATH}/scripts/start

    if [[ "${INSTALL_START_SCRIPT}" = "true" ]]
    then
      # Kick off the systemd service again so it's in sync
      sudo systemctl start "umbrel-startup.service"
    fi

  echo
  echo "Umbrel has been sucessfully installed!"
  fi
}

main

SHA256SUM

e1da1d315a7e142661b541a681c4914fcbe9f0d797de7fe863b93c2bc49318f2  install_umbrel.sh

SHA256SUM.asc

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQTu6V+C6sJ+NhkLM745awx6wXMsoQUCZQT1ZgAKCRA5awx6wXMs
oY+/AQDTFN1HH6ODVwJcp9qIVlyn9IXlJ690AFPlteFOdXl77gD/Zt9vtPyULhnt
zarMjF+MKUcEiZUy9WB2gpOwL4K0MwM=
=+A+4
-----END PGP SIGNATURE-----

Download the files

# 1. Installation script
curl -L https://gist.githubusercontent.com/jaonoctus/cfabf3a27b55f082b1e6ecf2da832ab3/raw/91415536d7c08848c77d2ffcc1c69e485c172b38/install_umbrel.sh > install_umbrel.sh

# 2. Checksum
curl -L https://gist.githubusercontent.com/jaonoctus/cfabf3a27b55f082b1e6ecf2da832ab3/raw/91415536d7c08848c77d2ffcc1c69e485c172b38/SHA256SUM > SHA256SUM

# 3. Signatures
curl -L https://gist.githubusercontent.com/jaonoctus/cfabf3a27b55f082b1e6ecf2da832ab3/raw/ad8bca43d1f7a6b0f5d63e6bd6ce68fdf084ee4d/SHA256SUM.asc > SHA256SUM.asc

Verify if the checksum was not modified

# If you don't have my key already, then run this first
gpg --keyserver keyserver.ubuntu.com --recv-keys 396B0C7AC1732CA1

gpg --verify SHA256SUM.asc

# expected output:
# gpg: assuming signed data in 'SHA256SUM'
# gpg: Signature made Fri Sep 15 21:23:02 2023 -03
# gpg:                using EDDSA key EEE95F82EAC27E36190B33BE396B0C7AC1732CA1
# gpg: Good signature from "João Dias (jaonoctus) <jaonoctus@protonmail.com>"
# Primary key fingerprint: 6B45 7D06 0ACE 363C 9D67  D8E6 782C 165A 293D 6E18

Verify if the content was not modified

sha256sum --check SHA256SUM

# expected output:
# install_umbrel.sh: OK

install_umbrel.sh: FAILED

So if I get this response when verifying, can you help me with the next steps to fix it? Thanks!

install_umbrel.sh: FAILED

So if I get this response when verifying, can you help me with the next steps to fix it? Thanks!

@jjaassoonnbb means that the bash script that you downloaded was not verified by me. I just tried and i got OK instead of FAILED.

You can always run from https://umbrel.com as well

It returns an error after install. Here are all the results of the command:
https://pastebin.com/dtW8nYz3

@Magnusretrotech https://community.umbrel.com/t/how-to-update-to-umbrelos-1-0/15575#for-linux-users-on-umbrelos-05-4

Ahh ok. Thank you!