deploy: add one-command installer with configuration preservation
This commit is contained in:
SIMKEEP committed
1 parent
ce4dfd635d
commit
7f50d512c7
4 files changed
+401
No files matched your search
Executable
+171
@@ -0,0 +1,171 @@
|
||||
#!/usr/bin/env bash
|
||||
set -Eeuo pipefail
|
||||
|
||||
DOWNLOAD_BASE='https://raw.githubusercontent.com/rest-rain/simkeep/main'
|
||||
staging=''
|
||||
|
||||
fail() {
|
||||
printf '错误：%s\n' "$*" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
cleanup() {
|
||||
if [[ -n "$staging" ]]; then
|
||||
rm -rf -- "$staging"
|
||||
fi
|
||||
}
|
||||
|
||||
usage() {
|
||||
cat <<'USAGE'
|
||||
用法：bash install.sh [选项]
|
||||
|
||||
--dir 目录 部署目录，默认当前目录下的 simkeep
|
||||
--port 端口 首次部署的端口，默认 5180
|
||||
--url HTTP地址 首次部署的访问地址，默认 http://localhost:端口
|
||||
--non-interactive 使用参数或默认值，不询问配置
|
||||
--help 显示帮助
|
||||
|
||||
需要已安装且可用的 Docker Engine、Docker Compose 插件和 curl。
|
||||
已有 .env 和 docker-compose.yml 会保留；端口、地址参数仅用于首次部署。
|
||||
再次执行会按已有配置拉取镜像并更新容器，数据保存在原命名卷中。
|
||||
USAGE
|
||||
}
|
||||
|
||||
normalize_port() {
|
||||
[[ "$1" =~ ^[0-9]{1,5}$ ]] || fail '端口必须是 1 到 65535 的整数。'
|
||||
local value
|
||||
value=$((10#$1))
|
||||
((value >= 1 && value <= 65535)) || fail '端口必须是 1 到 65535 的整数。'
|
||||
printf '%s' "$value"
|
||||
}
|
||||
|
||||
validate_url() {
|
||||
local pattern='^http://(\[[0-9A-Fa-f:]+\]|[A-Za-z0-9][A-Za-z0-9._-]*)(:([0-9]{1,5}))?/?$'
|
||||
[[ "$1" =~ $pattern ]] || fail '访问地址请使用 http://服务器IP:端口 或 http://域名:端口。'
|
||||
if [[ -n "${BASH_REMATCH[3]}" ]]; then
|
||||
normalize_port "${BASH_REMATCH[3]}" >/dev/null
|
||||
fi
|
||||
}
|
||||
|
||||
prompt() {
|
||||
local answer
|
||||
printf '%s [%s]：' "$1" "$2" >&3
|
||||
IFS= read -r answer <&3 || fail '未能读取配置，请使用 --non-interactive 和相应参数。'
|
||||
printf '%s' "${answer:-$2}"
|
||||
}
|
||||
|
||||
download() {
|
||||
curl -fsSL --connect-timeout 15 --max-time 60 --retry 2 \
|
||||
-o "$staging/$1" "$DOWNLOAD_BASE/$1" || fail "下载 $1 失败，请检查 GitHub 网络后重试。"
|
||||
[[ -s "$staging/$1" ]] || fail "下载的 $1 为空，请重试。"
|
||||
}
|
||||
|
||||
main() {
|
||||
local install_dir="$PWD/simkeep" port='' public_url='' interactive=1 has_terminal=0
|
||||
local new_env=1 new_compose=1
|
||||
while (($#)); do
|
||||
case "$1" in
|
||||
--dir|--port|--url)
|
||||
[[ $# -ge 2 && -n "$2" ]] || fail "$1 缺少参数。"
|
||||
case "$1" in
|
||||
--dir) install_dir=$2 ;;
|
||||
--port) port=$2 ;;
|
||||
--url) public_url=$2 ;;
|
||||
esac
|
||||
shift 2
|
||||
;;
|
||||
--non-interactive) interactive=0; shift ;;
|
||||
--help|-h) usage; return ;;
|
||||
*) fail "未知选项：$1。使用 --help 查看帮助。" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ -n "$port" ]]; then
|
||||
port=$(normalize_port "$port")
|
||||
fi
|
||||
if [[ -n "$public_url" ]]; then
|
||||
validate_url "$public_url"
|
||||
public_url=${public_url%/}
|
||||
fi
|
||||
for dependency in docker curl awk; do
|
||||
command -v "$dependency" >/dev/null 2>&1 || fail "缺少 $dependency，请先安装。"
|
||||
done
|
||||
docker info >/dev/null 2>&1 || fail 'Docker 未启动或当前用户没有权限，请先确认 docker info 能正常执行。'
|
||||
docker compose version >/dev/null 2>&1 || fail '请先安装 Docker Compose 插件，确认 docker compose version 能正常执行。'
|
||||
|
||||
[[ ! -e "$install_dir" || -d "$install_dir" ]] || fail '部署目录已经存在，但不是文件夹。'
|
||||
for configuration in .env docker-compose.yml; do
|
||||
if [[ -e "$install_dir/$configuration" || -L "$install_dir/$configuration" ]]; then
|
||||
[[ -f "$install_dir/$configuration" ]] || fail "$configuration 已经存在，但不是可用文件。"
|
||||
fi
|
||||
done
|
||||
[[ ! -f "$install_dir/.env" ]] || new_env=0
|
||||
[[ ! -f "$install_dir/docker-compose.yml" ]] || new_compose=0
|
||||
|
||||
if ((new_env)); then
|
||||
if ((interactive)) && { exec 3<>/dev/tty; } 2>/dev/null; then
|
||||
has_terminal=1
|
||||
fi
|
||||
if [[ -z "$port" ]]; then
|
||||
if ((has_terminal)); then
|
||||
port=$(prompt '宿主机端口' '5180')
|
||||
else
|
||||
port=5180
|
||||
fi
|
||||
port=$(normalize_port "$port")
|
||||
fi
|
||||
if [[ -z "$public_url" ]]; then
|
||||
if ((has_terminal)); then
|
||||
public_url=$(prompt 'HTTP 访问地址（远程部署时填写服务器 IP 或域名）' "http://localhost:$port")
|
||||
else
|
||||
public_url="http://localhost:$port"
|
||||
fi
|
||||
validate_url "$public_url"
|
||||
public_url=${public_url%/}
|
||||
fi
|
||||
else
|
||||
printf '保留已有 .env，按其中的配置部署；如需调整端口或地址，请编辑该文件。\n'
|
||||
fi
|
||||
|
||||
umask 077
|
||||
mkdir -p -- "$install_dir"
|
||||
install_dir=$(cd -- "$install_dir" && pwd -P)
|
||||
staging=$(mktemp -d "$install_dir/.simkeep-install.XXXXXX")
|
||||
trap cleanup EXIT
|
||||
if ((new_compose)); then
|
||||
download docker-compose.yml
|
||||
fi
|
||||
if ((new_env)); then
|
||||
download .env.example
|
||||
awk -v port="$port" -v url="$public_url" '
|
||||
/^SIMKEEP_PORT=/ { print "SIMKEEP_PORT=" port; next }
|
||||
/^SIMKEEP_PUBLIC_URL=/ { print "SIMKEEP_PUBLIC_URL=" url; next }
|
||||
{ print }
|
||||
' "$staging/.env.example" > "$staging/.env"
|
||||
fi
|
||||
if ((new_compose)); then
|
||||
mv -- "$staging/docker-compose.yml" "$install_dir/docker-compose.yml"
|
||||
fi
|
||||
if ((new_env)); then
|
||||
if [[ ! -e "$install_dir/.env.example" && ! -L "$install_dir/.env.example" ]]; then
|
||||
mv -- "$staging/.env.example" "$install_dir/.env.example"
|
||||
fi
|
||||
mv -- "$staging/.env" "$install_dir/.env"
|
||||
fi
|
||||
chmod 600 -- "$install_dir/.env"
|
||||
|
||||
local compose=(docker compose --project-directory "$install_dir" --env-file "$install_dir/.env" -f "$install_dir/docker-compose.yml")
|
||||
"${compose[@]}" config --quiet || fail 'Compose 配置验证失败，请检查部署目录中的配置文件。'
|
||||
"${compose[@]}" pull web || fail '镜像拉取失败，请检查网络和 .env 中的 SIMKEEP_IMAGE 后重试。'
|
||||
"${compose[@]}" up -d --wait --wait-timeout 120 web || fail '容器未通过健康检查，请在部署目录执行 docker compose logs --tail=100 web。'
|
||||
|
||||
printf '\n部署完成。\n配置目录：%s\n' "$install_dir"
|
||||
if ((new_env)); then
|
||||
printf '访问地址：%s\n' "$public_url"
|
||||
else
|
||||
printf '访问地址以 .env 中的 SIMKEEP_PUBLIC_URL 为准。\n'
|
||||
fi
|
||||
printf '首次使用请在网页创建账号，再到通知设置配置 Telegram / 邮件。\n'
|
||||
}
|
||||
|
||||
main "$@"
|
||||
Reference in new issue
Block a user