-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmailapi.sh
More file actions
2978 lines (2629 loc) · 96.1 KB
/
Copy pathmailapi.sh
File metadata and controls
2978 lines (2629 loc) · 96.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
# =============================================================================
# MailAPI — One-click install, configure, and manage script
# =============================================================================
set -euo pipefail
SRC_DIR="$(cd "$(dirname "$0")" && pwd)"
# --------------- Paths (portable defaults) ---------------
# 默认安装目录:root 用 /opt/mailapi;非 root 用 $XDG_DATA_HOME 或 $HOME/.local/share。
DEFAULT_INSTALL_DIR="/opt/mailapi"
if [[ "${EUID:-$(id -u)}" -ne 0 ]]; then
if [[ -n "${XDG_DATA_HOME:-}" ]]; then
DEFAULT_INSTALL_DIR="${XDG_DATA_HOME%/}/mailapi"
elif [[ -n "${HOME:-}" ]]; then
DEFAULT_INSTALL_DIR="${HOME%/}/.local/share/mailapi"
else
DEFAULT_INSTALL_DIR="./.mailapi"
fi
fi
INSTALL_DIR="${MAILAPI_DIR:-$DEFAULT_INSTALL_DIR}"
BIN_DIR="${MAILAPI_BIN_DIR:-$INSTALL_DIR/bin}"
LOG_DIR="${MAILAPI_LOG_DIR:-$INSTALL_DIR/logs}"
CONFIG_FILE="${MAILAPI_CONFIG:-$INSTALL_DIR/config.yaml}"
COMPOSE_FILE="${MAILAPI_COMPOSE:-$INSTALL_DIR/docker-compose.yml}"
ENV_FILE="${MAILAPI_ENV_FILE:-$INSTALL_DIR/infra.env}"
# Infra defaults(优先:显式环境变量;其次:ENV_FILE;最后:内置默认)
# 注意:这里先给出默认值,稍后会在 init_infra_env 中根据 ENV_FILE 再次归一化并 export。
INFRA_BIND_ADDR="${MAILAPI_INFRA_BIND_ADDR:-127.0.0.1}"
MINIO_ROOT_USER="${MAILAPI_MINIO_ROOT_USER:-minioadmin}"
MINIO_ROOT_PASSWORD="${MAILAPI_MINIO_ROOT_PASSWORD:-minioadmin}"
MONGO_IMAGE="${MAILAPI_MONGO_IMAGE:-mongo:7}"
REDIS_IMAGE="${MAILAPI_REDIS_IMAGE:-redis:7-alpine}"
NATS_IMAGE="${MAILAPI_NATS_IMAGE:-nats:2}"
MINIO_IMAGE="${MAILAPI_MINIO_IMAGE:-minio/minio:latest}"
# --------------- Colors ---------------
RED='\033[0;31m'; GREEN='\033[0;32m'; YELLOW='\033[1;33m'
CYAN='\033[0;36m'; NC='\033[0m'
if [[ -n "${NO_COLOR:-}" || "${MAILAPI_NO_COLOR:-}" == "1" || ! -t 1 ]]; then
RED=""; GREEN=""; YELLOW=""; CYAN=""; NC=""
fi
info() { echo -e "${GREEN}[INFO]${NC} $*"; }
warn() { echo -e "${YELLOW}[WARN]${NC} $*"; }
error() { echo -e "${RED}[ERROR]${NC} $*" >&2; }
# --------------- Utilities (bash 3.2 compatible) ---------------
lower() { echo "${1:-}" | tr '[:upper:]' '[:lower:]'; }
trim() {
local s="${1:-}"
# leading
s="${s#"${s%%[![:space:]]*}"}"
# trailing
s="${s%"${s##*[![:space:]]}"}"
echo "$s"
}
have_cmd() { command -v "${1:-}" &>/dev/null; }
is_tty() { [[ -t 0 && -t 1 ]]; }
is_noninteractive() {
[[ "${MAILAPI_NONINTERACTIVE:-}" == "1" ]] && return 0
is_tty || return 0
return 1
}
load_infra_env_file() {
# 安全加载 env 文件:只允许白名单 key,且不覆盖已显式设置的环境变量。
# 该文件应只包含 KEY=VALUE(可选带引号)行,不执行任何代码。
local f="${1:-}"
[[ -n "$f" ]] || return 0
[[ -f "$f" ]] || return 0
local line key val
while IFS= read -r line || [[ -n "$line" ]]; do
# CRLF 兼容:去掉尾部 \r
line="${line%$'\r'}"
line="$(trim "$line")"
[[ -z "$line" || "$line" == \#* ]] && continue
if [[ "$line" =~ ^([A-Za-z_][A-Za-z0-9_]*)[[:space:]]*=[[:space:]]*(.*)$ ]]; then
key="${BASH_REMATCH[1]}"
val="${BASH_REMATCH[2]}"
# 去掉一层引号(支持 "..." 或 '...')
if [[ "$val" =~ ^\".*\"$ ]]; then
val="${val:1:${#val}-2}"
elif [[ "$val" =~ ^\'.*\'$ ]]; then
val="${val:1:${#val}-2}"
fi
case "$key" in
MAILAPI_INFRA_BIND_ADDR)
[[ -z "${MAILAPI_INFRA_BIND_ADDR:-}" ]] && export MAILAPI_INFRA_BIND_ADDR="$val"
;;
MAILAPI_MINIO_ROOT_USER)
[[ -z "${MAILAPI_MINIO_ROOT_USER:-}" ]] && export MAILAPI_MINIO_ROOT_USER="$val"
;;
MAILAPI_MINIO_ROOT_PASSWORD)
[[ -z "${MAILAPI_MINIO_ROOT_PASSWORD:-}" ]] && export MAILAPI_MINIO_ROOT_PASSWORD="$val"
;;
MAILAPI_MONGO_IMAGE)
[[ -z "${MAILAPI_MONGO_IMAGE:-}" ]] && export MAILAPI_MONGO_IMAGE="$val"
;;
MAILAPI_REDIS_IMAGE)
[[ -z "${MAILAPI_REDIS_IMAGE:-}" ]] && export MAILAPI_REDIS_IMAGE="$val"
;;
MAILAPI_NATS_IMAGE)
[[ -z "${MAILAPI_NATS_IMAGE:-}" ]] && export MAILAPI_NATS_IMAGE="$val"
;;
MAILAPI_MINIO_IMAGE)
[[ -z "${MAILAPI_MINIO_IMAGE:-}" ]] && export MAILAPI_MINIO_IMAGE="$val"
;;
esac
fi
done <"$f"
}
init_infra_env() {
# 解析 ENV_FILE,并把最终值同步到本脚本变量 + export(供 docker compose 使用)。
load_infra_env_file "$ENV_FILE"
INFRA_BIND_ADDR="${MAILAPI_INFRA_BIND_ADDR:-$INFRA_BIND_ADDR}"
MINIO_ROOT_USER="${MAILAPI_MINIO_ROOT_USER:-$MINIO_ROOT_USER}"
MINIO_ROOT_PASSWORD="${MAILAPI_MINIO_ROOT_PASSWORD:-$MINIO_ROOT_PASSWORD}"
MONGO_IMAGE="${MAILAPI_MONGO_IMAGE:-$MONGO_IMAGE}"
REDIS_IMAGE="${MAILAPI_REDIS_IMAGE:-$REDIS_IMAGE}"
NATS_IMAGE="${MAILAPI_NATS_IMAGE:-$NATS_IMAGE}"
MINIO_IMAGE="${MAILAPI_MINIO_IMAGE:-$MINIO_IMAGE}"
export MAILAPI_INFRA_BIND_ADDR="$INFRA_BIND_ADDR"
export MAILAPI_MINIO_ROOT_USER="$MINIO_ROOT_USER"
export MAILAPI_MINIO_ROOT_PASSWORD="$MINIO_ROOT_PASSWORD"
export MAILAPI_MONGO_IMAGE="$MONGO_IMAGE"
export MAILAPI_REDIS_IMAGE="$REDIS_IMAGE"
export MAILAPI_NATS_IMAGE="$NATS_IMAGE"
export MAILAPI_MINIO_IMAGE="$MINIO_IMAGE"
}
init_infra_env
confirm_danger() {
local prompt="${1:-Proceed?}"
if is_noninteractive; then
[[ "${MAILAPI_CONFIRM:-}" == "1" || "${MAILAPI_FORCE:-}" == "1" ]]
return $?
fi
local ans=""
read -rp "${prompt} [y/N] " ans
[[ "$(lower "${ans:-}")" == "y" ]]
}
read_default() {
local prompt="$1"
local default="$2"
if is_noninteractive; then
echo "$default"
return 0
fi
local ans=""
read -rp "$prompt" ans
echo "${ans:-$default}"
}
read_secret_default() {
# 与 read_default 类似,但交互模式下不回显输入(适合密码/密钥)。
local prompt="$1"
local default="$2"
if is_noninteractive; then
echo "$default"
return 0
fi
local ans=""
read -rsp "$prompt" ans
echo ""
echo "${ans:-$default}"
}
normalize_yes() {
local v
v="$(lower "$(trim "${1:-}")")"
case "$v" in
y|yes|1|true|on) echo "y" ;;
*) echo "n" ;;
esac
}
is_number() {
[[ "${1:-}" =~ ^[0-9]+$ ]]
}
validate_port() {
local p="${1:-}"
local name="${2:-port}"
if ! is_number "$p"; then
error "Invalid ${name}: $p (must be 1-65535)"
return 1
fi
if ((p < 1 || p > 65535)); then
error "Invalid ${name}: $p (must be 1-65535)"
return 1
fi
return 0
}
random_hex() {
local bytes="${1:-32}"
if have_cmd openssl; then
openssl rand -hex "$bytes"
return 0
fi
if [[ -r /dev/urandom ]] && have_cmd od; then
# od 输出可能包含空格/换行
od -An -tx1 -N "$bytes" /dev/urandom | tr -d ' \n'
return 0
fi
error "Cannot generate random bytes: need openssl or /dev/urandom+od"
return 1
}
docker_compose() {
# 兼容 Docker Compose V2(docker compose)与 V1(docker-compose)
local env_args=()
if [[ -f "$ENV_FILE" ]]; then
env_args+=(--env-file "$ENV_FILE")
fi
if docker compose version &>/dev/null 2>&1; then
docker compose "${env_args[@]}" -f "$COMPOSE_FILE" "$@"
return 0
fi
if have_cmd docker-compose; then
docker-compose "${env_args[@]}" -f "$COMPOSE_FILE" "$@"
return 0
fi
error "Docker Compose not found: need 'docker compose' or 'docker-compose'"
return 1
}
# --------------- Safety / IO helpers ---------------
resolve_abs() {
# 兼容 macOS(无 realpath)/ Linux:用 dirname + pwd -P 解析绝对路径。
# 注意:该函数允许目标不存在(只要其父目录存在)。
local p="${1:-}"
[[ -n "$p" ]] || return 1
local d b
d="$(cd "$(dirname "$p")" 2>/dev/null && pwd -P)" || return 1
b="$(basename "$p")"
printf "%s/%s\n" "$d" "$b"
}
path_is_under() {
local child="$1" root="$2"
[[ "$child" == "$root" || "$child" == "$root/"* ]]
}
assert_safe_path_under_install() {
# 仅允许卸载删除 INSTALL_DIR 之下的路径,避免环境变量误配置导致误删系统目录。
local p="${1:-}"
[[ -n "$p" ]] || return 1
local root abs home
root="$(resolve_abs "$INSTALL_DIR")" || return 1
abs="$(resolve_abs "$p")" || return 1
# INSTALL_DIR 本身必须是“足够具体”的目录,禁止指向系统根目录或 HOME 根目录。
case "$root" in
""|"/") return 1 ;;
"/etc"|"/usr"|"/var"|"/bin"|"/sbin"|"/lib"|"/lib64") return 1 ;;
esac
home="${HOME:-}"
if [[ -n "$home" ]]; then
home="$(resolve_abs "$home" 2>/dev/null || echo "$home")"
case "$root" in
"$home"|"$home/") return 1 ;;
esac
fi
case "$abs" in
""|"/") return 1 ;;
"/etc"|"/usr"|"/var"|"/bin"|"/sbin"|"/lib"|"/lib64") return 1 ;;
esac
path_is_under "$abs" "$root"
}
write_file_atomic() {
# 用法:write_file_atomic /path/to/file <<EOF ... EOF
# 原子写入 + 默认收紧权限(用于含密钥的 config)。
local target="${1:-}"
[[ -n "$target" ]] || return 1
local dir tmp
dir="$(dirname "$target")"
mkdir -p "$dir"
umask 077
tmp="$(mktemp_compat)"
cat >"$tmp"
mv -f "$tmp" "$target"
}
write_file_atomic_mode() {
# 用法:write_file_atomic_mode /path/to/file 0644 <<EOF ... EOF
local target="${1:-}"
local mode="${2:-0644}"
[[ -n "$target" ]] || return 1
local dir tmp
dir="$(dirname "$target")"
mkdir -p "$dir"
tmp="$(mktemp_compat)"
cat >"$tmp"
chmod "$mode" "$tmp" 2>/dev/null || true
mv -f "$tmp" "$target"
}
backup_file() {
local f="${1:-}"
[[ -n "$f" ]] || return 0
[[ -f "$f" ]] || return 0
local ts
ts="$(date +%Y%m%d%H%M%S 2>/dev/null || echo $$)"
if cp -p "$f" "${f}.bak.${ts}" 2>/dev/null; then
info "Backup created: ${f}.bak.${ts}"
return 0
fi
if cp "$f" "${f}.bak.${ts}" 2>/dev/null; then
info "Backup created: ${f}.bak.${ts}"
return 0
fi
warn "Failed to create backup for: $f"
return 1
}
write_infra_env_file() {
# 把 infra 相关变量持久化到 ENV_FILE(包含 MinIO 凭证),便于跨会话保持一致。
# 默认不覆盖已有文件;需要覆盖时传入 "1" 或设置 MAILAPI_ENV_OVERWRITE=1。
local overwrite="${1:-0}"
if [[ "${MAILAPI_ENV_OVERWRITE:-}" == "1" ]]; then
overwrite="1"
fi
mkdir -p "$(dirname "$ENV_FILE")"
if [[ -f "$ENV_FILE" ]] && [[ "$overwrite" != "1" ]]; then
return 0
fi
if [[ -f "$ENV_FILE" ]]; then
backup_file "$ENV_FILE" || true
fi
{
echo "MAILAPI_INFRA_BIND_ADDR=$INFRA_BIND_ADDR"
echo "MAILAPI_MINIO_ROOT_USER=$MINIO_ROOT_USER"
echo "MAILAPI_MINIO_ROOT_PASSWORD=$MINIO_ROOT_PASSWORD"
echo "MAILAPI_MONGO_IMAGE=$MONGO_IMAGE"
echo "MAILAPI_REDIS_IMAGE=$REDIS_IMAGE"
echo "MAILAPI_NATS_IMAGE=$NATS_IMAGE"
echo "MAILAPI_MINIO_IMAGE=$MINIO_IMAGE"
} | write_file_atomic "$ENV_FILE"
info "Infra env written to $ENV_FILE"
}
ensure_infra_env_file() {
[[ -f "$ENV_FILE" ]] && return 0
write_infra_env_file 0
}
pid_matches_service() {
# 避免 PID reuse 误杀无关进程:校验 pid 对应的 command 确实是本服务。
local svc="$1" pid="$2"
have_cmd ps || return 0
local cmd
cmd="$(ps -p "$pid" -o command= 2>/dev/null || true)"
[[ -n "$cmd" ]] && [[ "$cmd" == *"/mailapi-${svc}"* ]]
}
with_service_lock() {
# 进程内互斥:避免多次 start/stop 竞态(无 flock 时回退 mkdir 锁)。
local svc="$1"; shift
local lock_dir="${INSTALL_DIR%/}/.${svc}.lock"
local i=0
while ! mkdir "$lock_dir" 2>/dev/null; do
i=$((i + 1))
if ((i > 50)); then
error "Failed to acquire lock for ${svc}: $lock_dir"
return 1
fi
sleep 0.1
done
trap 'rmdir "$lock_dir" 2>/dev/null || true' RETURN
"$@"
local rc=$?
trap - RETURN
rmdir "$lock_dir" 2>/dev/null || true
return $rc
}
retry() {
# 用法:retry <attempts> <sleep_ms> -- <cmd...>
local attempts="${1:-5}"
local sleep_ms="${2:-200}"
shift 2
[[ "${1:-}" == "--" ]] && shift
local i=1
while true; do
"$@" && return 0
[[ $i -ge $attempts ]] && return 1
# 兼容 bash:用整型运算拼出秒的小数表示,避免依赖 awk。
local s=$((sleep_ms / 1000))
local ms=$((sleep_ms % 1000))
if ((ms == 0)); then
sleep "$s"
else
sleep "$(printf "%d.%03d" "$s" "$ms")"
fi
sleep_ms=$((sleep_ms * 2))
i=$((i + 1))
done
}
probe_port() {
local h="$1" p="$2"
if have_cmd nc; then
nc -z -w 1 "$h" "$p" &>/dev/null
return $?
fi
# /dev/tcp 仅在 bash 下可用(本脚本要求 bash)。
(exec 3<>"/dev/tcp/${h}/${p}") &>/dev/null
}
# =====================================================================
# help
# =====================================================================
show_help() {
cat <<EOF
${CYAN}MailAPI Management Script${NC}
Usage: $0 <command> [args]
${CYAN}Setup:${NC}
install Build binaries, generate config, and (optionally) start infra
build Build Go binaries only
config Generate or reconfigure config.yaml
infra-up Start infrastructure (MongoDB, Redis, NATS, MinIO)
infra-down Stop infrastructure
infra-clean Stop infra and REMOVE volumes (DANGEROUS)
${CYAN}Service:${NC}
start [service] Start services (api|smtp|worker|all, default: all)
stop [service] Stop services (api|smtp|worker|all, default: all)
restart [service] Restart services (api|smtp|worker|all, default: all)
status [service] Show service status (api|smtp|worker|all, default: all)
${CYAN}Logs:${NC}
logs [service] [lines] Tail logs (default: all, 200 lines)
${CYAN}Ops:${NC}
doctor|check Diagnostics: env/deps/infra/services (+ debug health if enabled)
upgrade [--pull|pull] Rebuild binaries and restart services; with pull: pull & recreate infra
uninstall [--purge] Remove services/binaries (keep config by default; --purge also removes config & docker volumes)
compose <args...> Pass-through to docker compose using managed compose file
setcap-smtp (Linux) Grant mailapi-smtp cap_net_bind_service for binding :25 as non-root
smoke Smoke test (debug healthz/readyz if enabled + key API flow)
${CYAN}Domain & Key:${NC}
genkey [name] [prefix] Generate an API key (prefix: sk or dk; default: sk)
list-domains List configured domains
list-apikeys List configured API keys (redacted)
${CYAN}Misc:${NC}
help Show this help message
Environment (paths):
MAILAPI_DIR Override install dir (default: /opt/mailapi or XDG_DATA_HOME)
MAILAPI_BIN_DIR Override binary dir
MAILAPI_LOG_DIR Override log dir
MAILAPI_CONFIG Override config file path
MAILAPI_COMPOSE Override docker-compose.yml path
MAILAPI_ENV_FILE Infra env file path (default: <INSTALL_DIR>/infra.env)
MAILAPI_NO_COLOR=1 Disable ANSI colors (or set NO_COLOR)
Environment (infra):
MAILAPI_SKIP_INFRA=1 Skip docker infra (no docker required)
MAILAPI_INFRA_BIND_ADDR Bind addr for infra ports (default: 127.0.0.1)
MAILAPI_MINIO_ROOT_USER MinIO root user
MAILAPI_MINIO_ROOT_PASSWORD MinIO root password
MAILAPI_MONGO_IMAGE Mongo image (default: mongo:7)
MAILAPI_REDIS_IMAGE Redis image (default: redis:7-alpine)
MAILAPI_NATS_IMAGE NATS image (default: nats:2)
MAILAPI_MINIO_IMAGE MinIO image (default: minio/minio:latest)
MAILAPI_INFRA_WAIT_TIMEOUT Wait seconds for infra ports (default: 30)
Environment (config, non-interactive):
MAILAPI_NONINTERACTIVE=1 Disable all prompts (use defaults/env)
MAILAPI_CONFIRM=1 Auto-confirm dangerous ops in non-interactive mode (or MAILAPI_FORCE=1)
MAILAPI_CONFIG_OVERWRITE=1 Overwrite existing config in non-interactive mode
MAILAPI_ENV_OVERWRITE=1 Overwrite existing infra.env when generating config
MAILAPI_COMPOSE_OVERWRITE=1 Overwrite existing docker-compose.yml when generating compose
MAILAPI_SERVICE_USER systemd: set User= for services (optional; beware smtp :25)
MAILAPI_SERVICE_GROUP systemd: set Group= for services (default: same as user)
MAILAPI_DOMAINS Comma-separated domains (e.g. a.com,b.com)
MAILAPI_PRIVATE_DOMAINS Comma-separated private domains (optional; wildcard API keys will NOT implicitly include them)
MAILAPI_API_PORT API port (default: 8080)
MAILAPI_SMTP_PORT SMTP port (default: 25)
MAILAPI_SMTP_DOMAIN SMTP EHLO domain (default: mail.<first domain>)
MAILAPI_SMTP_TLS_ENABLED y/yes/1 to enable SMTP STARTTLS (RFC 3207)
MAILAPI_SMTP_TLS_CERT_FILE SMTP TLS cert file path (PEM; relative paths are relative to config.yaml)
MAILAPI_SMTP_TLS_KEY_FILE SMTP TLS key file path (PEM)
MAILAPI_SMTP_TLS_REQUIRE_TLS y/yes/1 to require STARTTLS before MAIL/RCPT/DATA (returns 530 otherwise)
MAILAPI_SMTP_TLS_MIN_VERSION TLS min version (1.2|1.3; default: 1.2)
MAILAPI_SMTP_TLS_SELF_SIGNED y/yes/1 to auto-generate self-signed cert/key when missing (requires openssl; default: y when TLS enabled)
MAILAPI_CFWORKER_UPSTREAM cfworker upstream URL (optional)
MAILAPI_ENABLE_DIALECTS y/yes/1 to enable dialect routing
MAILAPI_BASE_HOST baseHost when dialects enabled (default: api.<first domain>)
MAILAPI_DEFAULT_DIALECT defaultDialect (default: duck)
MAILAPI_ENABLED_DIALECTS enabledDialects CSV (default: duck,cfworker,yyds)
MAILAPI_UNKNOWN_DIALECT unknownDialect (reject|fallback; default: reject)
MAILAPI_KEY_PREFIX Default prefix for genkey (sk or dk)
Environment (smoke):
MAILAPI_SMOKE_URL Base URL for smoke test (default: http://127.0.0.1:<apiPort>)
MAILAPI_SMOKE_DEBUG_URL Debug base URL for health/metrics (default: from server.api.debug when enabled)
MAILAPI_SMOKE_HOST Optional Host header (useful for dialect routing tests)
MAILAPI_SMOKE_API_KEY API key for smoke (default: first key in config.yaml)
MAILAPI_SMOKE_DOMAIN Domain for smoke (default: first domain in config.yaml)
MAILAPI_SMOKE_PASSWORD Password for smoke-created account (optional; default: random)
MAILAPI_SMOKE_TIMEOUT Per-request timeout seconds (default: 10)
MAILAPI_CURL_INSECURE=1 Pass -k to curl (skip TLS verification; use only for dev/testing)
EOF
}
# =====================================================================
# prerequisites
# =====================================================================
check_go() {
if ! command -v go &>/dev/null; then
error "Go is not installed. Please install Go from https://go.dev/dl/"
return 1
fi
local required=""
if [[ -f "$SRC_DIR/go.mod" ]]; then
required=$(awk '/^go / {print $2; exit}' "$SRC_DIR/go.mod" 2>/dev/null || true)
fi
if [[ -n "$required" ]]; then
info "Go $(go version | awk '{print $3}') (go.mod: go ${required})"
else
info "Go $(go version | awk '{print $3}')"
fi
}
check_docker() {
if ! command -v docker &>/dev/null; then
error "Docker is not installed. Please install Docker: https://docs.docker.com/get-docker/"
return 1
fi
info "Docker $(docker --version | awk '{print $3}' | tr -d ',')"
# Compose V2 或 docker-compose
if docker compose version &>/dev/null 2>&1; then
info "Docker Compose: docker compose"
:
fi
if have_cmd docker-compose; then
info "Docker Compose: docker-compose"
:
fi
if ! (docker compose version &>/dev/null 2>&1 || have_cmd docker-compose); then
error "Docker Compose is required: install Docker Compose V2 (docker compose) or docker-compose"
return 1
fi
# 尽早发现“docker 客户端已安装但 daemon 不可用/无权限”的场景。
# 这些问题在 docker compose 阶段才暴露会更难定位。
if ! docker version &>/dev/null 2>&1; then
local hint=""
case "$(lower "$(uname -s 2>/dev/null || echo unknown)")" in
darwin) hint="Hint: On macOS, ensure Docker Desktop is running." ;;
linux)
if uname -r 2>/dev/null | tr '[:upper:]' '[:lower:]' | grep -q "microsoft"; then
hint="Hint: In WSL, ensure Docker Desktop integration is enabled, or start the docker daemon inside WSL."
else
hint="Hint: On Linux, try: sudo systemctl start docker (and add your user to the docker group)."
fi
;;
esac
error "Docker daemon is not reachable (docker version failed)."
[[ -n "$hint" ]] && error "$hint"
error "If you don't want docker infra, set: MAILAPI_SKIP_INFRA=1"
return 1
fi
return 0
}
# =====================================================================
# build
# =====================================================================
do_build() {
info "Building MailAPI binaries..."
check_go
mkdir -p "$BIN_DIR"
(cd "$SRC_DIR" && go build -o "$BIN_DIR/mailapi-api" ./cmd/api)
info "Built mailapi-api"
(cd "$SRC_DIR" && go build -o "$BIN_DIR/mailapi-smtp" ./cmd/smtp)
info "Built mailapi-smtp"
(cd "$SRC_DIR" && go build -o "$BIN_DIR/mailapi-worker" ./cmd/worker)
info "Built mailapi-worker"
info "All binaries installed to $BIN_DIR"
}
# =====================================================================
# infrastructure (docker compose)
# =====================================================================
write_compose() {
mkdir -p "$INSTALL_DIR"
if [[ -f "$COMPOSE_FILE" ]] && [[ "${MAILAPI_COMPOSE_OVERWRITE:-}" != "1" ]]; then
warn "Compose file already exists at $COMPOSE_FILE (set MAILAPI_COMPOSE_OVERWRITE=1 to overwrite)."
return 0
fi
if [[ -f "$COMPOSE_FILE" ]]; then
backup_file "$COMPOSE_FILE" || true
fi
write_file_atomic "$COMPOSE_FILE" <<'COMPOSE'
version: "3.8"
services:
mongodb:
image: ${MAILAPI_MONGO_IMAGE:-mongo:7}
restart: unless-stopped
ports: ["${MAILAPI_INFRA_BIND_ADDR:-127.0.0.1}:27017:27017"]
volumes: ["mongo_data:/data/db"]
redis:
image: ${MAILAPI_REDIS_IMAGE:-redis:7-alpine}
restart: unless-stopped
ports: ["${MAILAPI_INFRA_BIND_ADDR:-127.0.0.1}:6379:6379"]
nats:
image: ${MAILAPI_NATS_IMAGE:-nats:2}
restart: unless-stopped
command: ["-js", "-sd", "/data"]
ports: ["${MAILAPI_INFRA_BIND_ADDR:-127.0.0.1}:4222:4222"]
volumes: ["nats_data:/data"]
minio:
image: ${MAILAPI_MINIO_IMAGE:-minio/minio:latest}
restart: unless-stopped
command: server /data --console-address ":9001"
ports:
- "${MAILAPI_INFRA_BIND_ADDR:-127.0.0.1}:9000:9000"
- "${MAILAPI_INFRA_BIND_ADDR:-127.0.0.1}:9001:9001"
environment:
MINIO_ROOT_USER: ${MAILAPI_MINIO_ROOT_USER:-minioadmin}
MINIO_ROOT_PASSWORD: ${MAILAPI_MINIO_ROOT_PASSWORD:-minioadmin}
volumes: ["minio_data:/data"]
volumes:
mongo_data:
nats_data:
minio_data:
COMPOSE
info "Docker Compose file written to $COMPOSE_FILE"
}
do_infra_up() {
if [[ "${MAILAPI_SKIP_INFRA:-}" == "1" ]]; then
warn "MAILAPI_SKIP_INFRA=1, skipping infra-up"
return 0
fi
check_docker
ensure_infra_env_file
if [[ ! -f "$COMPOSE_FILE" ]]; then
write_compose
fi
info "Starting infrastructure containers..."
docker_compose up -d
# Wait for infra ports (best-effort)
local timeout="${MAILAPI_INFRA_WAIT_TIMEOUT:-30}"
local host="$INFRA_BIND_ADDR"
if [[ "$host" == "0.0.0.0" || -z "$host" ]]; then
host="127.0.0.1"
fi
wait_port() {
local h="$1" p="$2" name="$3" t="${4:-30}"
local end=$((SECONDS + t))
while ((SECONDS < end)); do
if probe_port "$h" "$p" &>/dev/null; then
info "${name} is ready (${h}:${p})"
return 0
fi
sleep 1
done
warn "${name} not ready after ${t}s (${h}:${p})"
return 1
}
info "Waiting for infrastructure to be ready (timeout=${timeout}s)..."
wait_port "$host" 27017 "MongoDB" "$timeout" || true
wait_port "$host" 6379 "Redis" "$timeout" || true
wait_port "$host" 4222 "NATS" "$timeout" || true
wait_port "$host" 9000 "MinIO" "$timeout" || true
info "Infrastructure is running"
}
do_infra_down() {
if [[ "${MAILAPI_SKIP_INFRA:-}" == "1" ]]; then
warn "MAILAPI_SKIP_INFRA=1, skipping infra-down"
return 0
fi
check_docker
ensure_infra_env_file
if [[ ! -f "$COMPOSE_FILE" ]]; then
warn "No docker-compose.yml found at $COMPOSE_FILE"
return
fi
info "Stopping infrastructure containers..."
docker_compose down
info "Infrastructure stopped"
}
do_infra_clean() {
if [[ "${MAILAPI_SKIP_INFRA:-}" == "1" ]]; then
warn "MAILAPI_SKIP_INFRA=1, skipping infra-clean"
return 0
fi
check_docker
ensure_infra_env_file
if [[ ! -f "$COMPOSE_FILE" ]]; then
warn "No docker-compose.yml found at $COMPOSE_FILE"
return
fi
warn "This will stop infra and REMOVE volumes (MongoDB/NATS/MinIO data will be deleted)."
if ! confirm_danger "Proceed?"; then
if is_noninteractive; then
warn "Refusing to run infra-clean without confirmation in non-interactive mode."
warn "Set MAILAPI_CONFIRM=1 to proceed."
fi
info "Cancelled."
return 0
fi
info "Stopping infrastructure containers and removing volumes..."
docker_compose down -v
info "Infrastructure cleaned"
}
# =====================================================================
# config generation
# =====================================================================
generate_api_key() {
# 32-byte random key (hex, 64 chars) with sk_ prefix by default.
local prefix="${1:-${MAILAPI_KEY_PREFIX:-sk}}"
prefix="$(lower "$(trim "$prefix")")"
case "$prefix" in
sk|sk_) prefix="sk_" ;;
dk|dk_) prefix="dk_" ;;
*) prefix="sk_" ;;
esac
echo "${prefix}$(random_hex 32)"
}
do_config() {
mkdir -p "$INSTALL_DIR"
local overwriting=0
if [[ -f "$CONFIG_FILE" ]]; then
warn "Config already exists at $CONFIG_FILE"
if is_noninteractive; then
if [[ "${MAILAPI_CONFIG_OVERWRITE:-}" == "1" ]]; then
warn "MAILAPI_CONFIG_OVERWRITE=1, overwriting config."
overwriting=1
else
info "Keeping existing config (set MAILAPI_CONFIG_OVERWRITE=1 to overwrite)."
return 0
fi
else
if ! confirm_danger "Overwrite config?"; then
info "Keeping existing config."
return 0
fi
overwriting=1
fi
fi
echo ""
echo -e "${CYAN}=== MailAPI Configuration ===${NC}"
echo ""
# Domains(支持 MAILAPI_DOMAINS=example.com,example.org 非交互模式)
local domains=()
if [[ -n "${MAILAPI_DOMAINS:-}" ]]; then
IFS=',' read -r -a domains <<<"${MAILAPI_DOMAINS}"
else
if is_noninteractive; then
domains=("example.com")
warn "MAILAPI_DOMAINS is empty in non-interactive mode, using example.com"
else
while true; do
read -rp "Add email domain (empty to finish): " dom
dom="$(trim "$dom")"
[[ -z "$dom" ]] && break
domains+=("$dom")
done
fi
fi
# sanitize domains (trim, drop empties)
local dom
local cleaned=()
for dom in "${domains[@]}"; do
dom="$(trim "$dom")"
[[ -z "$dom" ]] && continue
cleaned+=("$dom")
done
domains=("${cleaned[@]}")
if [[ ${#domains[@]} -eq 0 ]]; then
domains=("example.com")
warn "No domains entered, using example.com"
fi
# 私有域名(可选):isPrivate=true 的域名不会被 wildcard("*")API key 隐式放开,必须显式列在 apiKeys[].domains 中。
local private_domains_csv_default="${MAILAPI_PRIVATE_DOMAINS:-}"
local private_domains_csv="$private_domains_csv_default"
if ! is_noninteractive; then
private_domains_csv="$(read_default "Private domains (comma-separated, empty=none) [${private_domains_csv_default}]: " "$private_domains_csv_default")"
fi
private_domains_csv="$(trim "$private_domains_csv")"
# 归一化成 ",a.com,b.com," 形式,便于精确 contains 判断(避免部分匹配)。
local private_domains_norm=","
if [[ -n "$private_domains_csv" ]]; then
local _pd
local _priv_arr=()
IFS=',' read -r -a _priv_arr <<<"$private_domains_csv"
for _pd in "${_priv_arr[@]}"; do
_pd="$(lower "$(trim "$_pd")")"
[[ -z "$_pd" ]] && continue
private_domains_norm+="${_pd},"
done
fi
# API key
local admin_key
admin_key=$(generate_api_key)
info "Generated admin API key: $admin_key"
# JWT secret
local jwt_secret
jwt_secret=$(random_hex 32)
# SMTP domain
local smtp_domain_default="${MAILAPI_SMTP_DOMAIN:-mail.${domains[0]}}"
smtp_domain="$(read_default "SMTP EHLO domain [${smtp_domain_default}]: " "$smtp_domain_default")"
# API port
local api_port_default="${MAILAPI_API_PORT:-8080}"
api_port="$(read_default "API port [${api_port_default}]: " "$api_port_default")"
# SMTP port
local smtp_port_default="${MAILAPI_SMTP_PORT:-25}"
smtp_port="$(read_default "SMTP port [${smtp_port_default}]: " "$smtp_port_default")"
validate_port "$api_port" "API port"
validate_port "$smtp_port" "SMTP port"
# SMTP STARTTLS(可选)
local smtp_tls_enabled="${MAILAPI_SMTP_TLS_ENABLED:-}"
if [[ -z "$smtp_tls_enabled" ]]; then
if is_noninteractive; then
smtp_tls_enabled="n"
else
read -rp "Enable SMTP STARTTLS (RFC 3207)? [y/N] " smtp_tls_enabled
fi
fi
smtp_tls_enabled="$(normalize_yes "$smtp_tls_enabled")"
local smtp_tls_certFile="" smtp_tls_keyFile="" smtp_tls_require="n" smtp_tls_minVersion="1.2"
if [[ "$smtp_tls_enabled" == "y" ]]; then
local smtp_tls_cert_default="${MAILAPI_SMTP_TLS_CERT_FILE:-certs/smtp.crt}"
local smtp_tls_key_default="${MAILAPI_SMTP_TLS_KEY_FILE:-certs/smtp.key}"
local smtp_tls_require_default="${MAILAPI_SMTP_TLS_REQUIRE_TLS:-n}"
local smtp_tls_min_default="${MAILAPI_SMTP_TLS_MIN_VERSION:-1.2}"
smtp_tls_certFile="$(read_default "SMTP TLS cert file (PEM) [${smtp_tls_cert_default}]: " "$smtp_tls_cert_default")"
smtp_tls_keyFile="$(read_default "SMTP TLS key file (PEM) [${smtp_tls_key_default}]: " "$smtp_tls_key_default")"
smtp_tls_require="$(read_default "Require STARTTLS before MAIL/RCPT/DATA? [${smtp_tls_require_default}]: " "$smtp_tls_require_default")"
smtp_tls_minVersion="$(read_default "SMTP TLS min version (1.2|1.3) [${smtp_tls_min_default}]: " "$smtp_tls_min_default")"
smtp_tls_certFile="$(trim "$smtp_tls_certFile")"
smtp_tls_keyFile="$(trim "$smtp_tls_keyFile")"
smtp_tls_minVersion="$(trim "$smtp_tls_minVersion")"
smtp_tls_require="$(normalize_yes "$smtp_tls_require")"
if [[ -z "$smtp_tls_certFile" || -z "$smtp_tls_keyFile" ]]; then
error "SMTP TLS is enabled but cert/key file is empty. Set MAILAPI_SMTP_TLS_CERT_FILE / MAILAPI_SMTP_TLS_KEY_FILE (or provide input)."
return 1
fi
if [[ "$smtp_tls_minVersion" != "1.3" ]]; then
smtp_tls_minVersion="1.2"
fi
# 若证书文件不存在:尝试按需生成自签名证书,保证一键安装可用(仅建议用于开发/测试)。
# 注意:相对路径按 config.yaml 所在目录解析(与服务端一致)。
local smtp_tls_self_signed="${MAILAPI_SMTP_TLS_SELF_SIGNED:-}"
if [[ -z "$smtp_tls_self_signed" ]]; then
if is_noninteractive; then
smtp_tls_self_signed="y"
else
read -rp "Generate self-signed SMTP TLS cert/key if missing? [Y/n] " smtp_tls_self_signed
[[ -z "$smtp_tls_self_signed" ]] && smtp_tls_self_signed="y"
fi
fi
smtp_tls_self_signed="$(normalize_yes "$smtp_tls_self_signed")"
local cfg_dir_abs
cfg_dir_abs="$(cd "$(dirname "$CONFIG_FILE")" && pwd)"
local cert_abs="$smtp_tls_certFile"
local key_abs="$smtp_tls_keyFile"
if [[ "$cert_abs" != /* ]]; then cert_abs="${cfg_dir_abs%/}/${cert_abs}"; fi
if [[ "$key_abs" != /* ]]; then key_abs="${cfg_dir_abs%/}/${key_abs}"; fi
if [[ ! -f "$cert_abs" || ! -f "$key_abs" ]]; then
if [[ "$smtp_tls_self_signed" == "y" ]]; then
if ! have_cmd openssl; then
error "SMTP TLS cert/key not found and openssl is not available to generate a self-signed certificate."
error "Missing: $cert_abs / $key_abs"
return 1
fi
mkdir -p "$(dirname "$cert_abs")" "$(dirname "$key_abs")"
info "Generating self-signed SMTP TLS cert/key:"
info " cert: $cert_abs"
info " key: $key_abs"
openssl req -x509 -newkey rsa:2048 -sha256 -days 3650 -nodes \
-keyout "$key_abs" -out "$cert_abs" -subj "/CN=${smtp_domain}"
chmod 600 "$key_abs" 2>/dev/null || true
else
error "SMTP TLS is enabled but cert/key file not found:"
error " cert: $cert_abs"
error " key: $key_abs"
error "Provide existing files or set MAILAPI_SMTP_TLS_SELF_SIGNED=1 to auto-generate."
return 1
fi
fi
fi
# MinIO 凭证(会写入 config.yaml,同时写入 infra.env 供 docker compose 使用,确保两者一致)。
local minio_user_default="$MINIO_ROOT_USER"
local minio_pass_default="$MINIO_ROOT_PASSWORD"
if [[ $overwriting -eq 1 ]]; then
# 尝试从旧配置中提取,避免误改导致现有 MinIO 无法访问。
local cfg_minio_user cfg_minio_pass
cfg_minio_user="$(config_minio_access_key "$CONFIG_FILE")"
cfg_minio_pass="$(config_minio_secret_key "$CONFIG_FILE")"
[[ -n "$cfg_minio_user" ]] && minio_user_default="$cfg_minio_user"
[[ -n "$cfg_minio_pass" ]] && minio_pass_default="$cfg_minio_pass"