mirror of
https://github.com/axllent/mailpit.git
synced 2025-08-13 20:04:49 +02:00
Merge branch 'feature/installer' into develop
This commit is contained in:
Ralph Slooten
266
install.sh
266
install.sh
@@ -1,108 +1,214 @@
|
|||||||
#!/usr/bin/env bash
|
#!/bin/sh
|
||||||
|
|
||||||
GH_REPO="axllent/mailpit"
|
# This script will install the latest release of Mailpit.
|
||||||
TIMEOUT=90
|
|
||||||
INSTALL_PATH="${INSTALL_PATH:-/usr/local/bin}"
|
|
||||||
|
|
||||||
set -e
|
# Check dependencies is installed
|
||||||
|
for cmd in curl tar; do
|
||||||
|
if ! command -v "$cmd" >/dev/null 2>&1; then
|
||||||
|
echo "Then $cmd command is required but not installed."
|
||||||
|
echo "Please install $cmd and try again."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
VERSION=$(curl --silent --fail --location --max-time "${TIMEOUT}" "https://api.github.com/repos/${GH_REPO}/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
|
# Check if the OS is supported.
|
||||||
if [ $? -ne 0 ]; then
|
OS=
|
||||||
echo -ne "\nThere was an error trying to check what is the latest version of Mailpit.\nPlease try again later.\n"
|
case "$(uname -s)" in
|
||||||
exit 1
|
Linux) OS="linux" ;;
|
||||||
fi
|
Darwin) OS="Darwin" ;;
|
||||||
|
|
||||||
# detect the platform
|
|
||||||
OS="$(uname)"
|
|
||||||
case $OS in
|
|
||||||
Linux)
|
|
||||||
OS='linux'
|
|
||||||
;;
|
|
||||||
FreeBSD)
|
|
||||||
OS='freebsd'
|
|
||||||
echo 'OS not supported'
|
|
||||||
exit 2
|
|
||||||
;;
|
|
||||||
NetBSD)
|
|
||||||
OS='netbsd'
|
|
||||||
echo 'OS not supported'
|
|
||||||
exit 2
|
|
||||||
;;
|
|
||||||
OpenBSD)
|
|
||||||
OS='openbsd'
|
|
||||||
echo 'OS not supported'
|
|
||||||
exit 2
|
|
||||||
;;
|
|
||||||
Darwin)
|
|
||||||
OS='darwin'
|
|
||||||
;;
|
|
||||||
SunOS)
|
|
||||||
OS='solaris'
|
|
||||||
echo 'OS not supported'
|
|
||||||
exit 2
|
|
||||||
;;
|
|
||||||
*)
|
*)
|
||||||
echo 'OS not supported'
|
echo "OS not supported."
|
||||||
exit 2
|
exit 2
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
# detect the arch
|
# Detect the architecture of the OS.
|
||||||
OS_type="$(uname -m)"
|
OS_ARCH=
|
||||||
case "$OS_type" in
|
case "$(uname -m)" in
|
||||||
x86_64 | amd64)
|
x86_64 | amd64)
|
||||||
OS_type='amd64'
|
OS_ARCH="amd64"
|
||||||
;;
|
;;
|
||||||
i?86 | x86)
|
i?86 | x86)
|
||||||
OS_type='386'
|
OS_ARCH="386"
|
||||||
;;
|
;;
|
||||||
aarch64 | arm64)
|
aarch64 | arm64)
|
||||||
OS_type='arm64'
|
OS_ARCH="arm64"
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
echo 'OS type not supported'
|
echo "OS architecture not supported."
|
||||||
exit 2
|
exit 2
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
GH_REPO_BIN="mailpit-${OS}-${OS_type}.tar.gz"
|
GH_REPO="axllent/mailpit"
|
||||||
|
INSTALL_PATH="${INSTALL_PATH:-/usr/local/bin}"
|
||||||
|
TIMEOUT=90
|
||||||
|
# This is used to authenticate with the GitHub API. (Fix the public rate limiting issue)
|
||||||
|
# Try the GITHUB_TOKEN environment variable is set globally.
|
||||||
|
GITHUB_API_TOKEN="${GITHUB_TOKEN:-}"
|
||||||
|
|
||||||
#create tmp directory and move to it with macOS compatibility fallback
|
# Update the default values if the user has set.
|
||||||
tmp_dir=$(mktemp -d 2>/dev/null || mktemp -d -t 'mailpit-install.XXXXXXXXXX')
|
while [ $# -gt 0 ]; do
|
||||||
cd "$tmp_dir"
|
case $1 in
|
||||||
|
--install-path)
|
||||||
|
shift
|
||||||
|
case "$1" in
|
||||||
|
*/*)
|
||||||
|
# Remove trailing slashes from the path.
|
||||||
|
INSTALL_PATH="$(echo "$1" | sed 's#/\+$##')"
|
||||||
|
[ -z "$INSTALL_PATH" ] && INSTALL_PATH="/"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
--auth | --auth-token | --github-token | --token)
|
||||||
|
shift
|
||||||
|
case "$1" in
|
||||||
|
gh*)
|
||||||
|
GITHUB_API_TOKEN="$1"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
*) ;;
|
||||||
|
esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
|
||||||
echo "Downloading Mailpit $VERSION"
|
# Description of the sort parameters for curl command.
|
||||||
LINK="https://github.com/${GH_REPO}/releases/download/${VERSION}/${GH_REPO_BIN}"
|
# -s: Silent mode.
|
||||||
|
# -f: Fail silently on server errors.
|
||||||
|
# -L: Follow redirects.
|
||||||
|
# -m: Set maximum time allowed for the transfer.
|
||||||
|
|
||||||
curl --silent --fail --location --max-time "${TIMEOUT}" "${LINK}" -o "${GH_REPO_BIN}" || {
|
if [ -n "$GITHUB_API_TOKEN" ] && [ "${#GITHUB_API_TOKEN}" -gt 36 ]; then
|
||||||
echo "Error downloading latest release"
|
CURL_OUTPUT="$(curl -sfL -m $TIMEOUT -H "Authorization: Bearer $GITHUB_API_TOKEN" https://api.github.com/repos/${GH_REPO}/releases/latest)"
|
||||||
exit 2
|
EXIT_CODE=$?
|
||||||
}
|
else
|
||||||
|
CURL_OUTPUT="$(curl -sfL -m $TIMEOUT https://api.github.com/repos/${GH_REPO}/releases/latest)"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
fi
|
||||||
|
|
||||||
tar zxf "$GH_REPO_BIN" || {
|
VERSION=""
|
||||||
echo "Error extracting ${GH_REPO_BIN}"
|
if [ $EXIT_CODE -eq 0 ]; then
|
||||||
exit 2
|
# Extracts the latest version using jq, awk, or sed.
|
||||||
}
|
if command -v jq >/dev/null 2>&1; then
|
||||||
|
# Use jq -n because the output is not a valid JSON in sh.
|
||||||
mkdir -p "${INSTALL_PATH}" || exit 2
|
VERSION=$(jq -n "$CURL_OUTPUT" | jq -r '.tag_name')
|
||||||
cp mailpit "${INSTALL_PATH}" || exit 2
|
elif command -v awk >/dev/null 2>&1; then
|
||||||
chmod 755 "${INSTALL_PATH}/mailpit" || exit 2
|
VERSION=$(echo "$CURL_OUTPUT" | awk -F: '$1 ~ /tag_name/ {gsub(/[^v0-9\.]+/, "", $2) ;print $2; exit}')
|
||||||
case "$OS" in
|
elif command -v sed >/dev/null 2>&1; then
|
||||||
'linux')
|
VERSION=$(echo "$CURL_OUTPUT" | sed -n 's/.*"tag_name": *"\([^"]*\)".*/\1/p')
|
||||||
if [ "$(id -u)" -eq "0" ]; then
|
else
|
||||||
chown root:root "${INSTALL_PATH}/mailpit" || exit 2
|
EXIT_CODE=3
|
||||||
fi
|
fi
|
||||||
;;
|
fi
|
||||||
'freebsd' | 'openbsd' | 'netbsd' | 'darwin')
|
|
||||||
if [ "$(id -u)" -eq "0" ]; then
|
# Validate the version.
|
||||||
chown root:wheel "${INSTALL_PATH}/mailpit" || exit 2
|
case "$VERSION" in
|
||||||
fi
|
v[0-9][0-9\.]*) ;;
|
||||||
;;
|
|
||||||
*)
|
*)
|
||||||
echo 'OS not supported'
|
echo "There was an error trying to check what is the latest version of Mailpit."
|
||||||
exit 2
|
echo "Please try again later."
|
||||||
|
exit $EXIT_CODE
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
rm -rf "$tmp_dir"
|
TEMP_DIR="$(mktemp -qd)"
|
||||||
echo "Installed successfully to ${INSTALL_PATH}/mailpit"
|
EXIT_CODE=$?
|
||||||
|
# Ensure the temporary directory exists and is a directory.
|
||||||
|
if [ -z "$TEMP_DIR" ] || [ ! -d "$TEMP_DIR" ]; then
|
||||||
|
echo "ERROR: Creating temporary directory."
|
||||||
|
exit $EXIT_CODE
|
||||||
|
fi
|
||||||
|
|
||||||
|
GH_REPO_BIN="mailpit-${OS}-${OS_ARCH}.tar.gz"
|
||||||
|
if [ "$INSTALL_PATH" = "/" ]; then
|
||||||
|
INSTALL_BIN_PATH="/mailpit"
|
||||||
|
else
|
||||||
|
INSTALL_BIN_PATH="${INSTALL_PATH}/mailpit"
|
||||||
|
fi
|
||||||
|
cd "$TEMP_DIR" || EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -eq 0 ]; then
|
||||||
|
# Download the latest release.
|
||||||
|
#
|
||||||
|
# Description of the sort parameters for curl command.
|
||||||
|
# -s: Silent mode.
|
||||||
|
# -f: Fail silently on server errors.
|
||||||
|
# -L: Follow redirects.
|
||||||
|
# -m: Set maximum time allowed for the transfer.
|
||||||
|
# -o: Write output to a file instead of stdout.
|
||||||
|
curl -sfL -m $TIMEOUT -o "${GH_REPO_BIN}" "https://github.com/${GH_REPO}/releases/download/${VERSION}/${GH_REPO_BIN}"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
|
||||||
|
# The following conditions check each step of the installation.
|
||||||
|
# If there is an error in any of the steps, an error message is printed.
|
||||||
|
|
||||||
|
if [ $EXIT_CODE -eq 0 ]; then
|
||||||
|
if ! [ -f "${GH_REPO_BIN}" ]; then
|
||||||
|
EXIT_CODE=1
|
||||||
|
echo "ERROR: Downloading latest release."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $EXIT_CODE -eq 0 ]; then
|
||||||
|
tar zxf "$GH_REPO_BIN"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -ne 0 ]; then
|
||||||
|
echo "ERROR: Extracting \"${GH_REPO_BIN}\"."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $EXIT_CODE -eq 0 ] && [ ! -d "$INSTALL_PATH" ]; then
|
||||||
|
mkdir -p "${INSTALL_PATH}"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -ne 0 ]; then
|
||||||
|
echo "ERROR: Creating \"${INSTALL_PATH}\" directory."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $EXIT_CODE -eq 0 ]; then
|
||||||
|
cp mailpit "$INSTALL_BIN_PATH"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -ne 0 ]; then
|
||||||
|
echo "ERROR: Copying mailpit to \"${INSTALL_PATH}\" directory."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $EXIT_CODE -eq 0 ]; then
|
||||||
|
chmod 755 "$INSTALL_BIN_PATH"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -ne 0 ]; then
|
||||||
|
echo "ERROR: Setting permissions for \"$INSTALL_BIN_PATH\" binary."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Set the owner and group to root:root if the script is run as root.
|
||||||
|
if [ $EXIT_CODE -eq 0 ] && [ "$(id -u)" -eq "0" ]; then
|
||||||
|
OWNER="root"
|
||||||
|
GROUP="root"
|
||||||
|
# Set the OWNER, GROUP variable when the OS not use the default root:root.
|
||||||
|
case "$OS" in
|
||||||
|
darwin) GROUP="wheel" ;;
|
||||||
|
*) ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
chown "${OWNER}:${GROUP}" "$INSTALL_BIN_PATH"
|
||||||
|
EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -ne 0 ]; then
|
||||||
|
echo "ERROR: Setting ownership for \"$INSTALL_BIN_PATH\" binary."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "ERROR: Changing to temporary directory."
|
||||||
|
exit $EXIT_CODE
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Cleanup the temporary directory.
|
||||||
|
rm -rf "$TEMP_DIR"
|
||||||
|
# Check the EXIT_CODE variable, and print the success or error message.
|
||||||
|
if [ $EXIT_CODE -ne 0 ]; then
|
||||||
|
echo "There was an error installing Mailpit."
|
||||||
|
exit $EXIT_CODE
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Installed successfully to \"$INSTALL_BIN_PATH\"."
|
||||||
|
exit 0
|
||||||
|
|||||||
Reference in New Issue
Block a user