install_debian.sh 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. #!/usr/bin/env bash
  2. set -euo pipefail
  3. timestamp() {
  4. date '+%Y-%m-%d %H:%M:%S'
  5. }
  6. log() {
  7. printf '[%s] %s\n' "$(timestamp)" "$*"
  8. }
  9. log_err() {
  10. printf '[%s] %s\n' "$(timestamp)" "$*" >&2
  11. }
  12. SERVICE_NAME="vmess-domain-rotator"
  13. RUN_USER=""
  14. RUN_GROUP=""
  15. RUN_USER_SET="0"
  16. RUN_GROUP_SET="0"
  17. RUN_HOME=""
  18. PEAK_START_HOUR="19"
  19. PEAK_END_HOUR="24"
  20. PEAK_TZ="Asia/Shanghai"
  21. PEAK_INTERVAL="10min"
  22. OFFPEAK_INTERVAL="30min"
  23. INSTALL_DEPS="1"
  24. CONFIG_PATH=""
  25. GIT_PUSH_ENABLED="1"
  26. GIT_PUSH_REMOTE="origin"
  27. GIT_HTTP_USERNAME="git"
  28. GIT_HTTP_TOKEN=""
  29. GIT_HTTP_TOKEN_FILE=""
  30. GIT_USE_CREDENTIAL_STORE="1"
  31. GIT_CREDENTIALS_FILE=""
  32. usage() {
  33. cat <<'EOF'
  34. Usage: sudo bash scripts/install_debian.sh [options]
  35. Default behavior:
  36. - Uses current git repository directory as working directory (in-place mode)
  37. - Uses the user executing sudo as service user
  38. - Enables git push after runtime-state commits
  39. Options:
  40. --user <name> Service user (default: current sudo user)
  41. --group <name> Service group (default: current sudo user's group)
  42. --interval <value> Alias for --offpeak-interval (default: 30min)
  43. --peak-start <hour> Peak period start hour, 0-23 (default: 19)
  44. --peak-end <hour> Peak period end hour, 1-24 (default: 24)
  45. --peak-tz <timezone> Peak period timezone (default: Asia/Shanghai)
  46. --peak-interval <value> Update interval during peak (default: 10min)
  47. --offpeak-interval <value> Update interval during offpeak (default: 30min)
  48. --config <path> Config file path (default: <repo>/config.server.json)
  49. --git-push <0|1> Enable/disable push to remote (default: 1)
  50. --git-push-remote <name> Remote name for push (default: origin)
  51. --git-http-username <u> Username for HTTPS auth (default: git)
  52. --git-http-token <t> HTTPS token for non-interactive push
  53. --git-http-token-file <f> Read HTTPS token from file
  54. --git-use-credential-store <0|1> Use git credential.helper store (default: 1)
  55. --git-credentials-file <f> Custom credentials file for helper store
  56. --no-install-deps Skip apt dependency install
  57. -h, --help Show help
  58. Examples:
  59. sudo bash scripts/install_debian.sh
  60. sudo bash scripts/install_debian.sh --config /opt/vmess-domain-rotator/config.server.json
  61. sudo bash scripts/install_debian.sh --peak-start 18 --peak-end 23
  62. sudo bash scripts/install_debian.sh --peak-interval 5min --offpeak-interval 15min
  63. sudo bash scripts/install_debian.sh --git-push 0
  64. EOF
  65. }
  66. run_as_service_user() {
  67. runuser -u "$RUN_USER" -- env HOME="$RUN_HOME" "$@"
  68. }
  69. while [[ $# -gt 0 ]]; do
  70. case "$1" in
  71. --user)
  72. RUN_USER="$2"
  73. RUN_USER_SET="1"
  74. shift 2
  75. ;;
  76. --group)
  77. RUN_GROUP="$2"
  78. RUN_GROUP_SET="1"
  79. shift 2
  80. ;;
  81. --interval)
  82. OFFPEAK_INTERVAL="$2"
  83. shift 2
  84. ;;
  85. --peak-start)
  86. PEAK_START_HOUR="$2"
  87. shift 2
  88. ;;
  89. --peak-end)
  90. PEAK_END_HOUR="$2"
  91. shift 2
  92. ;;
  93. --peak-tz)
  94. PEAK_TZ="$2"
  95. shift 2
  96. ;;
  97. --peak-interval)
  98. PEAK_INTERVAL="$2"
  99. shift 2
  100. ;;
  101. --offpeak-interval)
  102. OFFPEAK_INTERVAL="$2"
  103. shift 2
  104. ;;
  105. --config)
  106. CONFIG_PATH="$2"
  107. shift 2
  108. ;;
  109. --git-push)
  110. GIT_PUSH_ENABLED="$2"
  111. shift 2
  112. ;;
  113. --git-push-remote)
  114. GIT_PUSH_REMOTE="$2"
  115. shift 2
  116. ;;
  117. --git-http-username)
  118. GIT_HTTP_USERNAME="$2"
  119. shift 2
  120. ;;
  121. --git-http-token)
  122. GIT_HTTP_TOKEN="$2"
  123. shift 2
  124. ;;
  125. --git-http-token-file)
  126. GIT_HTTP_TOKEN_FILE="$2"
  127. shift 2
  128. ;;
  129. --git-use-credential-store)
  130. GIT_USE_CREDENTIAL_STORE="$2"
  131. shift 2
  132. ;;
  133. --git-credentials-file)
  134. GIT_CREDENTIALS_FILE="$2"
  135. shift 2
  136. ;;
  137. --no-install-deps)
  138. INSTALL_DEPS="0"
  139. shift
  140. ;;
  141. -h|--help)
  142. usage
  143. exit 0
  144. ;;
  145. *)
  146. log_err "Unknown option: $1"
  147. usage
  148. exit 1
  149. ;;
  150. esac
  151. done
  152. if [[ "$(id -u)" -ne 0 ]]; then
  153. log_err "Please run as root (use sudo)."
  154. exit 1
  155. fi
  156. if ! command -v runuser >/dev/null 2>&1; then
  157. log_err "Error: runuser is required on Debian for configuring service-user git credentials"
  158. exit 1
  159. fi
  160. SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
  161. if ! git -C "$SOURCE_DIR" rev-parse --is-inside-work-tree >/dev/null 2>&1; then
  162. log_err "Error: Current directory is not a git repository."
  163. log_err "This script must be run from within a git repository."
  164. exit 1
  165. fi
  166. APP_DIR="$SOURCE_DIR"
  167. if [[ -z "$CONFIG_PATH" ]]; then
  168. CONFIG_PATH="${APP_DIR}/config.server.json"
  169. elif [[ "$CONFIG_PATH" != /* ]]; then
  170. CONFIG_PATH="${APP_DIR}/${CONFIG_PATH}"
  171. fi
  172. if [[ ! -r "$CONFIG_PATH" ]]; then
  173. log_err "Error: config file not found or unreadable: $CONFIG_PATH"
  174. exit 1
  175. fi
  176. if [[ -n "${SUDO_USER:-}" ]] && [[ "$RUN_USER_SET" != "1" ]]; then
  177. RUN_USER="$SUDO_USER"
  178. fi
  179. if [[ -n "${SUDO_USER:-}" ]] && [[ "$RUN_GROUP_SET" != "1" ]]; then
  180. RUN_GROUP="$(id -gn "$SUDO_USER")"
  181. fi
  182. if [[ -z "$RUN_USER" ]]; then
  183. log_err "Error: Could not determine service user. Please run with sudo or specify --user"
  184. exit 1
  185. fi
  186. if [[ -z "$RUN_GROUP" ]]; then
  187. log_err "Error: Could not determine service group. Please run with sudo or specify --group"
  188. exit 1
  189. fi
  190. if [[ ! "$GIT_PUSH_ENABLED" =~ ^[01]$ ]]; then
  191. log_err "Error: --git-push must be 0 or 1"
  192. exit 1
  193. fi
  194. if [[ ! "$GIT_USE_CREDENTIAL_STORE" =~ ^[01]$ ]]; then
  195. log_err "Error: --git-use-credential-store must be 0 or 1"
  196. exit 1
  197. fi
  198. if [[ -z "$GIT_PUSH_REMOTE" ]]; then
  199. log_err "Error: --git-push-remote cannot be empty"
  200. exit 1
  201. fi
  202. if [[ -n "$GIT_HTTP_TOKEN" ]] && [[ -n "$GIT_HTTP_TOKEN_FILE" ]]; then
  203. log_err "Error: provide either --git-http-token or --git-http-token-file, not both"
  204. exit 1
  205. fi
  206. if [[ -n "$GIT_HTTP_TOKEN_FILE" ]] && [[ ! -r "$GIT_HTTP_TOKEN_FILE" ]]; then
  207. log_err "Error: cannot read token file: $GIT_HTTP_TOKEN_FILE"
  208. exit 1
  209. fi
  210. if [[ -n "$GIT_HTTP_TOKEN_FILE" ]]; then
  211. GIT_HTTP_TOKEN="$(tr -d '\r\n' < "$GIT_HTTP_TOKEN_FILE")"
  212. fi
  213. if [[ -n "$GIT_HTTP_TOKEN" ]] && [[ -z "$GIT_HTTP_USERNAME" ]]; then
  214. log_err "Error: --git-http-username cannot be empty when token is set"
  215. exit 1
  216. fi
  217. if [[ -n "$GIT_HTTP_TOKEN" ]] && [[ "$RUN_USER" == "root" ]]; then
  218. log_err "Error: refusing to store git token for root service user"
  219. log_err "Use --user <non-root> or disable push with --git-push 0"
  220. exit 1
  221. fi
  222. RUN_HOME="$(getent passwd "$RUN_USER" | cut -d: -f6)"
  223. if [[ -z "$RUN_HOME" ]]; then
  224. log_err "Error: could not determine home directory for user: $RUN_USER"
  225. exit 1
  226. fi
  227. to_minutes() {
  228. local val="$1"
  229. if [[ "$val" =~ ^([0-9]+)min$ ]] || [[ "$val" =~ ^([0-9]+)m$ ]]; then
  230. echo "${BASH_REMATCH[1]}"
  231. elif [[ "$val" =~ ^([0-9]+)h$ ]]; then
  232. echo $(( ${BASH_REMATCH[1]} * 60 ))
  233. else
  234. echo "$val" | tr -cd '0-9'
  235. fi
  236. }
  237. PEAK_INTERVAL_MIN=$(to_minutes "$PEAK_INTERVAL")
  238. OFFPEAK_INTERVAL_MIN=$(to_minutes "$OFFPEAK_INTERVAL")
  239. if [[ -z "$PEAK_INTERVAL_MIN" ]] || [[ "$PEAK_INTERVAL_MIN" -eq 0 ]]; then
  240. log_err "Error: invalid peak interval: $PEAK_INTERVAL"
  241. exit 1
  242. fi
  243. if [[ -z "$OFFPEAK_INTERVAL_MIN" ]] || [[ "$OFFPEAK_INTERVAL_MIN" -eq 0 ]]; then
  244. log_err "Error: invalid offpeak interval: $OFFPEAK_INTERVAL"
  245. exit 1
  246. fi
  247. # Timer runs at the minimum of the two intervals to handle both schedules
  248. if [[ "$PEAK_INTERVAL_MIN" -lt "$OFFPEAK_INTERVAL_MIN" ]]; then
  249. TIMER_INTERVAL="$PEAK_INTERVAL"
  250. else
  251. TIMER_INTERVAL="$OFFPEAK_INTERVAL"
  252. fi
  253. if [[ "$INSTALL_DEPS" == "1" ]]; then
  254. export DEBIAN_FRONTEND=noninteractive
  255. apt-get update -y
  256. apt-get install -y python3 ca-certificates git
  257. fi
  258. RUNTIME_DIR="$(/usr/bin/python3 "${APP_DIR}/scripts/domain_updater.py" --config "$CONFIG_PATH" --print-output-settings | /usr/bin/python3 -c 'import json,sys; print(json.load(sys.stdin)["runtime_dir"])')"
  259. mkdir -p "$RUNTIME_DIR"
  260. chmod +x "$APP_DIR/scripts/run_update_and_commit.sh" || true
  261. chown -R "$RUN_USER:$RUN_GROUP" "$RUNTIME_DIR"
  262. SERVICE_STATE_DIR="/var/lib/${SERVICE_NAME}"
  263. ENV_FILE="/etc/${SERVICE_NAME}.env"
  264. TOKEN_FILE=""
  265. REMOTE_URL=""
  266. AUTH_MODE="header"
  267. if [[ "$GIT_USE_CREDENTIAL_STORE" == "1" ]]; then
  268. AUTH_MODE="credential-helper-store"
  269. fi
  270. mkdir -p "$SERVICE_STATE_DIR"
  271. chown "$RUN_USER:$RUN_GROUP" "$SERVICE_STATE_DIR"
  272. chmod 750 "$SERVICE_STATE_DIR"
  273. if [[ "$GIT_PUSH_ENABLED" == "1" ]]; then
  274. REMOTE_URL="$(git -C "$APP_DIR" remote get-url "$GIT_PUSH_REMOTE" 2>/dev/null || true)"
  275. if [[ -z "$REMOTE_URL" ]]; then
  276. log_err "Warning: remote '$GIT_PUSH_REMOTE' not found now. Push may fail until remote is configured."
  277. fi
  278. fi
  279. if [[ -n "$GIT_HTTP_TOKEN" ]]; then
  280. if [[ "$GIT_USE_CREDENTIAL_STORE" == "1" ]]; then
  281. if [[ "$REMOTE_URL" =~ ^https:// ]]; then
  282. helper_value="store"
  283. if [[ -n "$GIT_CREDENTIALS_FILE" ]]; then
  284. helper_value="store --file ${GIT_CREDENTIALS_FILE}"
  285. mkdir -p "$(dirname "$GIT_CREDENTIALS_FILE")"
  286. touch "$GIT_CREDENTIALS_FILE"
  287. chown "$RUN_USER:$RUN_GROUP" "$GIT_CREDENTIALS_FILE"
  288. chmod 600 "$GIT_CREDENTIALS_FILE"
  289. fi
  290. run_as_service_user git config --global credential.helper "$helper_value"
  291. printf 'url=%s\nusername=%s\npassword=%s\n\n' "$REMOTE_URL" "$GIT_HTTP_USERNAME" "$GIT_HTTP_TOKEN" | run_as_service_user git credential approve
  292. else
  293. log_err "Warning: token provided but remote is not HTTPS; credential.helper store setup skipped."
  294. log_err "Warning: fallback to header-token-file auth mode for this install."
  295. GIT_USE_CREDENTIAL_STORE="0"
  296. fi
  297. fi
  298. if [[ "$GIT_USE_CREDENTIAL_STORE" != "1" ]]; then
  299. TOKEN_FILE="${SERVICE_STATE_DIR}/git_http_token"
  300. printf '%s\n' "$GIT_HTTP_TOKEN" >"$TOKEN_FILE"
  301. chown "$RUN_USER:$RUN_GROUP" "$TOKEN_FILE"
  302. chmod 600 "$TOKEN_FILE"
  303. AUTH_MODE="header-token-file"
  304. fi
  305. fi
  306. run_as_service_user git config --global --add safe.directory "$APP_DIR" || true
  307. cat >"$ENV_FILE" <<EOF
  308. GIT_PUSH_ENABLED=${GIT_PUSH_ENABLED}
  309. GIT_PUSH_REQUIRED=${GIT_PUSH_ENABLED}
  310. GIT_PUSH_REMOTE=${GIT_PUSH_REMOTE}
  311. GIT_RUNTIME_BRANCH=runtime-state
  312. GIT_HTTP_USERNAME=${GIT_HTTP_USERNAME}
  313. HOME=${RUN_HOME}
  314. PEAK_START_HOUR=${PEAK_START_HOUR}
  315. PEAK_END_HOUR=${PEAK_END_HOUR}
  316. PEAK_TZ=${PEAK_TZ}
  317. PEAK_INTERVAL_MIN=${PEAK_INTERVAL_MIN}
  318. OFFPEAK_INTERVAL_MIN=${OFFPEAK_INTERVAL_MIN}
  319. EOF
  320. if [[ "$GIT_USE_CREDENTIAL_STORE" == "1" ]]; then
  321. if [[ -n "$GIT_CREDENTIALS_FILE" ]]; then
  322. printf 'GIT_CREDENTIAL_HELPER=store --file %s\n' "$GIT_CREDENTIALS_FILE" >>"$ENV_FILE"
  323. else
  324. printf 'GIT_CREDENTIAL_HELPER=store\n' >>"$ENV_FILE"
  325. fi
  326. fi
  327. if [[ -n "$TOKEN_FILE" ]]; then
  328. printf 'GIT_HTTP_TOKEN_FILE=%s\n' "$TOKEN_FILE" >>"$ENV_FILE"
  329. fi
  330. chown root:root "$ENV_FILE"
  331. chmod 600 "$ENV_FILE"
  332. cat >"/etc/systemd/system/${SERVICE_NAME}.service" <<EOF
  333. [Unit]
  334. Description=VMess Domain Rotator updater
  335. After=network-online.target
  336. Wants=network-online.target
  337. [Service]
  338. Type=oneshot
  339. User=${RUN_USER}
  340. Group=${RUN_GROUP}
  341. WorkingDirectory=${APP_DIR}
  342. EnvironmentFile=-${ENV_FILE}
  343. UMask=0077
  344. ExecStart=/bin/bash ${APP_DIR}/scripts/run_update_and_commit.sh ${CONFIG_PATH}
  345. EOF
  346. cat >"/etc/systemd/system/${SERVICE_NAME}.timer" <<EOF
  347. [Unit]
  348. Description=Run VMess Domain Rotator every ${TIMER_INTERVAL}
  349. [Timer]
  350. OnBootSec=2min
  351. OnUnitActiveSec=${TIMER_INTERVAL}
  352. AccuracySec=30s
  353. Unit=${SERVICE_NAME}.service
  354. Persistent=true
  355. [Install]
  356. WantedBy=timers.target
  357. EOF
  358. systemctl daemon-reload
  359. systemctl enable --now "${SERVICE_NAME}.timer"
  360. systemctl start "${SERVICE_NAME}.service"
  361. log ""
  362. log "✓ Installation complete!"
  363. log ""
  364. log "Configuration:"
  365. log " Working directory: ${APP_DIR}"
  366. log " Config path: ${CONFIG_PATH}"
  367. log " Service user: ${RUN_USER}"
  368. log " Service group: ${RUN_GROUP}"
  369. log " Timer interval: ${TIMER_INTERVAL}"
  370. log " Peak hour: ${PEAK_START_HOUR} to ${PEAK_END_HOUR} (${PEAK_TZ})"
  371. log " Peak interval: ${PEAK_INTERVAL}"
  372. log " Off-peak interval: ${OFFPEAK_INTERVAL}"
  373. log " Push enabled: ${GIT_PUSH_ENABLED}"
  374. log " Push remote: ${GIT_PUSH_REMOTE}"
  375. log " Auth mode: ${AUTH_MODE}"
  376. log " Env file: ${ENV_FILE}"
  377. log ""
  378. log "Commands:"
  379. log " Check status: systemctl status ${SERVICE_NAME}.timer"
  380. log " View logs: journalctl -t ${SERVICE_NAME} -u ${SERVICE_NAME}.service -n 50 --no-pager"
  381. log " Manual run: sudo systemctl start ${SERVICE_NAME}.service"
  382. log " Force commit: sudo -u ${RUN_USER} /bin/bash ${APP_DIR}/scripts/run_update_and_commit.sh --force-commit ${CONFIG_PATH}"
  383. log ""