mirror of
https://github.com/RaspAP/raspap-webgui.git
synced 2024-11-25 00:50:29 +00:00
322 lines
11 KiB
Bash
Executable file
322 lines
11 KiB
Bash
Executable file
#!/bin/bash
|
|
#
|
|
# RaspAP Quick Installer - Installs and updates RaspAP
|
|
# Author: @billz <billzimmerman@gmail.com>
|
|
# Author URI: https://github.com/billz
|
|
# Project URI: https://github.com/RaspAP/
|
|
# License: GNU General Public License v3.0
|
|
# License URI: https://github.com/RaspAP/raspap-webgui/blob/master/LICENSE
|
|
#
|
|
# Usage: raspbian.sh [options]
|
|
#
|
|
# See below for options and usage examples.
|
|
#
|
|
# GNU GENERAL PUBLIC LICENSE
|
|
# This program is free software: you may copy, redistribute and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, under version 3 of the License. You are not
|
|
# obligated to bundle the LICENSE file with your RaspAP projects as long as
|
|
# you leave these references intact in the header comments of your source files.
|
|
#
|
|
# NOTE
|
|
# Depending on options passed to the installer, ONE of the following
|
|
# additional shell scripts will be downloaded and sourced:
|
|
#
|
|
# https://raw.githubusercontent.com/raspap/raspap-webgui/master/installers/common.sh
|
|
# - or -
|
|
# https://raw.githubusercontent.com/raspap/raspap-webgui/master/installers/mkcert.sh
|
|
# - or -
|
|
# https://raw.githubusercontent.com/raspap/raspap-webgui/master/installers/minwrite.sh
|
|
# - or -
|
|
# https://raw.githubusercontent.com/raspap/raspap-webgui/master/installers/uninstall.sh
|
|
|
|
function _usage() {
|
|
cat << EOF
|
|
Usage: raspbian.sh [options]
|
|
|
|
Installs an instance of RaspAP or a helper component.
|
|
|
|
OPTIONS:
|
|
-y, --yes, --assume-yes Assumes "yes" as an answer to all prompts
|
|
-c, --cert, --certificate Installs an SSL certificate for lighttpd
|
|
-o, --openvpn <flag> Used with -y, --yes, sets OpenVPN install option (0=no install)
|
|
-s, --rest, --restapi <flag> Used with -y, --yes, sets RestAPI install option (0=no install)
|
|
-a, --adblock <flag> Used with -y, --yes, sets Adblock install option (0=no install)
|
|
-w, --wireguard <flag> Used with -y, --yes, sets WireGuard install option (0=no install)
|
|
-e, --provider <value> Used with -y, --yes, sets the VPN provider install option
|
|
-g, --tcp-bbr <value> Used with -y, --yes, sets the TCP BBR congestion control algorithm option
|
|
-r, --repo, --repository <name> Overrides the default GitHub repo (RaspAP/raspap-webgui)
|
|
-b, --branch <name> Overrides the default git branch (latest release)
|
|
-t, --token <accesstoken> Specify a GitHub token to access a private repository
|
|
-n, --name <username> Specify a GitHub username to access a private repository
|
|
-u, --upgrade Upgrades an existing installation to the latest release version
|
|
-d, --update Updates an existing installation to the latest release version
|
|
-p, --path <path> Used with -d, --update, sets the existing install path
|
|
-i, --insiders Installs from the Insiders Edition (RaspAP/raspap-insiders)
|
|
-m, --minwrite Configures a microSD card for minimum write operation
|
|
-v, --version Outputs release info and exits
|
|
-n, --uninstall Loads and executes the uninstaller
|
|
-h, --help Outputs usage notes and exits
|
|
|
|
Examples:
|
|
Run locally specifying GitHub repo and branch:
|
|
raspbian.sh --repo foo/bar --branch my/branch
|
|
|
|
Run locally requesting release info:
|
|
raspbian.sh --version
|
|
|
|
Invoke installer remotely, run non-interactively with option flags:
|
|
curl -sL https://install.raspap.com | bash -s -- --yes --wireguard 1 --adblock 0
|
|
|
|
Invoke remotely, uprgrade an existing install to the Insiders Edition:
|
|
curl -sL https://install.raspap.com | bash -s -- --upgrade --insiders --name <name> --token <token>
|
|
|
|
Invoke remotely, perform an unattended update to the latest release version:
|
|
curl -sL https://install.raspap.com | bash -s -- --yes --update --path /var/www/html
|
|
|
|
EOF
|
|
exit
|
|
}
|
|
|
|
set -eo pipefail
|
|
|
|
function _main() {
|
|
# set defaults
|
|
repo="RaspAP/raspap-webgui" # override with -r, --repo option
|
|
repo_common="$repo"
|
|
_parse_params "$@"
|
|
_setup_colors
|
|
_log_output
|
|
_load_installer
|
|
}
|
|
|
|
function _parse_params() {
|
|
# default option values
|
|
assume_yes=0
|
|
upgrade=0
|
|
update=0
|
|
ovpn_option=1
|
|
restapi_option=1
|
|
adblock_option=1
|
|
wg_option=1
|
|
insiders=0
|
|
minwrite=0
|
|
acctoken=""
|
|
path=""
|
|
|
|
while :; do
|
|
case "${1-}" in
|
|
-y|--yes|--assume-yes)
|
|
assume_yes=1
|
|
apt_option="-y"
|
|
;;
|
|
-o|--openvpn)
|
|
ovpn_option="$2"
|
|
shift
|
|
;;
|
|
-s|--rest|--restapi)
|
|
restapi_option="$2"
|
|
shift
|
|
;;
|
|
-a|--adblock)
|
|
adblock_option="$2"
|
|
shift
|
|
;;
|
|
-w|--wireguard)
|
|
wg_option="$2"
|
|
shift
|
|
;;
|
|
-e|--provider)
|
|
pv_option="$2"
|
|
shift
|
|
;;
|
|
-g|--tcp-bbr)
|
|
bbr_option="$2"
|
|
shift
|
|
;;
|
|
-c|--cert|--certificate)
|
|
install_cert=1
|
|
;;
|
|
-r|--repo|--repository)
|
|
repo="$2"
|
|
repo_common="$repo"
|
|
shift
|
|
;;
|
|
-b|--branch)
|
|
branch="$2"
|
|
shift
|
|
;;
|
|
-h|--help)
|
|
_usage
|
|
;;
|
|
-u|--upgrade)
|
|
upgrade=1
|
|
;;
|
|
-i|--insiders)
|
|
insiders=1
|
|
;;
|
|
-m|--minwrite)
|
|
minwrite=1
|
|
;;
|
|
-t|--token)
|
|
acctoken="$2"
|
|
shift
|
|
;;
|
|
-n|--name)
|
|
username="$2"
|
|
shift
|
|
;;
|
|
-d|--update)
|
|
update=1
|
|
;;
|
|
-p|--path)
|
|
path="$2"
|
|
shift
|
|
;;
|
|
-v|--version)
|
|
_version
|
|
;;
|
|
-n|--uninstall)
|
|
uninstall=1
|
|
;;
|
|
-*|--*)
|
|
echo "Unknown option: $1"
|
|
_usage
|
|
exit 1
|
|
;;
|
|
*)
|
|
break
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
}
|
|
|
|
function _setup_colors() {
|
|
ANSI_RED="\033[0;31m"
|
|
ANSI_GREEN="\033[0;32m"
|
|
ANSI_YELLOW="\033[0;33m"
|
|
ANSI_RASPBERRY="\033[0;35m"
|
|
ANSI_ERROR="\033[1;37;41m"
|
|
ANSI_RESET="\033[m"
|
|
}
|
|
|
|
function _log_output() {
|
|
readonly LOGFILE_PATH="/tmp"
|
|
if [ -f "$LOGFILE_PATH/raspap_install.log" ]; then
|
|
sudo rm "$LOGFILE_PATH/raspap_install.log"
|
|
fi
|
|
exec > >(tee -i $LOGFILE_PATH/raspap_install.log)
|
|
exec 2>&1
|
|
}
|
|
|
|
function _version() {
|
|
_get_release
|
|
echo -e "RaspAP v${RASPAP_RELEASE} - Simple wireless AP setup & management for Debian-based devices"
|
|
exit
|
|
}
|
|
|
|
# Outputs a welcome message
|
|
function _display_welcome() {
|
|
echo -e "${ANSI_RASPBERRY}\n"
|
|
echo -e " 888888ba .d888888 888888ba"
|
|
echo -e " 88 8b d8 88 88 8b"
|
|
echo -e "a88aaaa8P' .d8888b. .d8888b. 88d888b. 88aaaaa88a a88aaaa8P"
|
|
echo -e " 88 8b. 88 88 Y8ooooo. 88 88 88 88 88"
|
|
echo -e " 88 88 88. .88 88 88. .88 88 88 88"
|
|
echo -e " dP dP 88888P8 88888P 88Y888P 88 88 dP"
|
|
echo -e " 88"
|
|
echo -e " dP version ${RASPAP_RELEASE}"
|
|
echo -e "${ANSI_GREEN}"
|
|
echo -e "The Quick Installer will guide you through a few easy steps${ANSI_RESET}\n\n"
|
|
}
|
|
|
|
# Fetch latest release from GitHub or RaspAP Installer API
|
|
function _get_release() {
|
|
readonly RASPAP_LATEST=$(curl -s "https://api.github.com/repos/$repo/releases/latest" | grep -Po '"tag_name": "\K.*?(?=")' )
|
|
if [ "$insiders" == 1 ]; then
|
|
repo="RaspAP/raspap-insiders"
|
|
repo_common="RaspAP/raspap-webgui"
|
|
readonly RASPAP_INSIDERS_LATEST=$(curl -s "https://api.raspap.com/repos/RaspAP/raspap-insiders/releases/latest/" | grep -Po '"tag_name": "\K.*?(?=")' )
|
|
readonly RASPAP_RELEASE="${RASPAP_INSIDERS_LATEST} Insiders"
|
|
else
|
|
readonly RASPAP_RELEASE="${RASPAP_LATEST}"
|
|
fi
|
|
}
|
|
|
|
# Outputs a RaspAP Install log line
|
|
function _install_log() {
|
|
echo -e "${ANSI_GREEN}RaspAP ${component}: $1${ANSI_RESET}"
|
|
}
|
|
|
|
# Outputs a RaspAP divider
|
|
function _install_divider() {
|
|
echo -e "\033[1;32m***************************************************************$*\033[m"
|
|
}
|
|
|
|
# Outputs a RaspAP status indicator
|
|
function _install_status() {
|
|
case $1 in
|
|
0)
|
|
echo -e "[$ANSI_GREEN \U2713 ok $ANSI_RESET] $2"
|
|
;;
|
|
1)
|
|
echo -e "[$ANSI_RED \U2718 error $ANSI_RESET] $ANSI_ERROR $2 $ANSI_RESET"
|
|
;;
|
|
2)
|
|
echo -e "[$ANSI_YELLOW \U26A0 warning $ANSI_RESET] $2"
|
|
;;
|
|
3)
|
|
echo -e "[$ANSI_RASPBERRY ! important $ANSI_RESET] $2"
|
|
esac
|
|
}
|
|
|
|
function _update_system_packages() {
|
|
_install_log "Updating sources"
|
|
sudo apt-get update || _install_status 1 "Unable to update package list"
|
|
}
|
|
|
|
# Fetch required installer functions
|
|
function _load_installer() {
|
|
# fetch latest release tag
|
|
_get_release
|
|
|
|
# assign default branch if not defined with -b, --branch option
|
|
if [ -z ${branch} ]; then
|
|
branch=$RASPAP_LATEST
|
|
fi
|
|
UPDATE_URL="https://raw.githubusercontent.com/$repo_common/$branch/"
|
|
|
|
if [ "${install_cert:-}" = 1 ]; then
|
|
source="mkcert"
|
|
component="mkcert"
|
|
wget "${header[@]}" -q ${UPDATE_URL}installers/${source}.sh -O /tmp/raspap_${source}.sh
|
|
source /tmp/raspap_${source}.sh && rm -f /tmp/raspap_${source}.sh
|
|
_install_certificate || _install_status 1 "Unable to install certificate"
|
|
elif [ "${minwrite}" = 1 ]; then
|
|
source="minwrite"
|
|
component="Minwrite"
|
|
wget "${header[@]}" -q ${UPDATE_URL}installers/${source}.sh -O /tmp/raspap_${source}.sh
|
|
source /tmp/raspap_${source}.sh && rm -f /tmp/raspap_${source}.sh
|
|
_install_minwrite || _install_status 1 "Unable to execute minimal write install"
|
|
elif [ "${uninstall}" = 1 ]; then
|
|
source="uninstall"
|
|
component="Uninstall"
|
|
wget "${header[@]}" -q ${UPDATE_URL}installers/${source}.sh -O /tmp/raspap_${source}.sh
|
|
source /tmp/raspap_${source}.sh && rm -f /tmp/raspap_${source}.sh
|
|
_remove_raspap || _install_status 1 "Unable to uninstall RaspAP"
|
|
else
|
|
source="common"
|
|
component="Install"
|
|
wget "${header[@]}" -q ${UPDATE_URL}installers/${source}.sh -O /tmp/raspap_${source}.sh
|
|
source /tmp/raspap_${source}.sh && rm -f /tmp/raspap_${source}.sh
|
|
if [ "$update" == 1 ]; then
|
|
_update_raspap || _install_status 1 "Unable to update RaspAP"
|
|
else
|
|
_install_raspap || _install_status 1 "Unable to install RaspAP"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
_main "$@"
|
|
|