forked from bulwarkmail/webmail
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetup.sh
More file actions
1261 lines (1063 loc) · 42.1 KB
/
setup.sh
File metadata and controls
1261 lines (1063 loc) · 42.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
# =============================================================================
# Bulwark Webmail - Interactive Setup Script
# =============================================================================
set -euo pipefail
# -- CLI Flags ----------------------------------------------------------------
DRY_RUN=false
for arg in "$@"; do
case "$arg" in
--dry-run) DRY_RUN=true ;;
-h|--help)
echo "Usage: bash setup.sh [--dry-run]"
echo " --dry-run Walk through the installer without writing files or running commands"
exit 0
;;
esac
done
# -- Colors & Symbols ---------------------------------------------------------
BOLD='\033[1m'
DIM='\033[2m'
ITALIC='\033[3m'
UNDERLINE='\033[4m'
RESET='\033[0m'
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[0;33m'
BLUE='\033[0;34m'
MAGENTA='\033[0;35m'
CYAN='\033[0;36m'
WHITE='\033[1;37m'
BG_BLUE='\033[44m'
BG_GREEN='\033[42m'
BG_MAGENTA='\033[45m'
# ASCII-safe symbols (no Unicode that breaks when piped)
OK="${GREEN}[OK]${RESET}"
FAIL="${RED}[!!]${RESET}"
WARN="${YELLOW}[!!]${RESET}"
SKIP="${DIM}[--]${RESET}"
INFO="${CYAN}>>>${RESET}"
TIP="${YELLOW}TIP${RESET}"
ARROW="${CYAN}-->${RESET}"
STAR="${CYAN}*${RESET}"
# -- State --------------------------------------------------------------------
set +u
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
set -u
ENV_FILE="${SCRIPT_DIR}/.env.local"
# Config values (defaults)
CFG_APP_NAME="Bulwark Webmail"
CFG_JMAP_SERVER_URL=""
CFG_STALWART_FEATURES="true"
CFG_OAUTH_ENABLED="false"
CFG_OAUTH_ONLY="false"
CFG_OAUTH_CLIENT_ID=""
CFG_OAUTH_CLIENT_SECRET=""
CFG_OAUTH_ISSUER_URL=""
CFG_SESSION_SECRET=""
CFG_SETTINGS_SYNC_ENABLED="false"
CFG_SETTINGS_DATA_DIR="./data/settings"
CFG_LOG_FORMAT="text"
CFG_LOG_LEVEL="info"
CFG_LOGIN_COMPANY_NAME=""
CFG_LOGIN_LOGO_LIGHT_URL=""
CFG_LOGIN_LOGO_DARK_URL=""
CFG_FAVICON_URL=""
CFG_APP_LOGO_LIGHT_URL=""
CFG_APP_LOGO_DARK_URL=""
CFG_LOGIN_IMPRINT_URL=""
CFG_LOGIN_PRIVACY_POLICY_URL=""
CFG_LOGIN_WEBSITE_URL=""
CFG_DEPLOY_METHOD=""
CFG_PORT="3000"
CURRENT_STEP=0
TOTAL_STEPS=7
STEP_NAMES=(
""
"Server"
"Auth"
"Security"
"Logging"
"Branding"
"Deploy"
"Confirm"
)
# -- Terminal Utilities -------------------------------------------------------
get_term_size() {
TERM_COLS=$(tput cols 2>/dev/null || echo 80)
TERM_ROWS=$(tput lines 2>/dev/null || echo 24)
}
clear_screen() { printf '\033[2J\033[H'; }
hide_cursor() { printf '\033[?25l'; }
show_cursor() { printf '\033[?25h'; }
print_center() {
local text="$1"
local clean
clean=$(echo -e "$text" | sed 's/\x1b\[[0-9;]*m//g')
local pad=$(( (TERM_COLS - ${#clean}) / 2 ))
[[ $pad -lt 0 ]] && pad=0
printf "%${pad}s" ""
echo -e "$text"
}
# Draw a horizontal line using ASCII dashes
hr() {
local color="${1:-$DIM}"
echo -e "${color}$(printf '%*s' "$TERM_COLS" '' | tr ' ' '-')${RESET}"
}
# Draw a box around text (ASCII-safe)
box() {
local text="$1"
local color="${2:-$CYAN}"
local clean
clean=$(echo -e "$text" | sed 's/\x1b\[[0-9;]*m//g')
local len=${#clean}
local inner=$(( len + 2 ))
local top="+$(printf '%*s' "$inner" '' | tr ' ' '-')+"
local pad=$(( (TERM_COLS - inner - 2) / 2 ))
[[ $pad -lt 0 ]] && pad=0
local sp
sp=$(printf '%*s' "$pad" '')
echo -e "${sp}${color}${top}${RESET}"
echo -e "${sp}${color}|${RESET} ${text} ${color}|${RESET}"
echo -e "${sp}${color}${top}${RESET}"
}
# Print an info note
note() {
local text="$1"
echo -e " ${CYAN}${BOLD}NOTE:${RESET} ${DIM}${text}${RESET}"
}
# Validate that a URL points to a JMAP server
check_jmap_server() {
local url="$1"
# Need curl or wget
local http_tool=""
if command -v curl &>/dev/null; then
http_tool="curl"
elif command -v wget &>/dev/null; then
http_tool="wget"
else
echo -e " ${SKIP} Cannot verify server (curl/wget not found)"
return 0
fi
# Strip trailing slash
url="${url%/}"
echo -ne " ${DIM}Checking JMAP server...${RESET}"
local response=""
local http_code=""
local jmap_found=false
# Helper to fetch a URL and return response body
fetch_url() {
local target="$1"
if [[ "$http_tool" == "curl" ]]; then
curl -s -L --connect-timeout 5 --max-time 10 "$target" 2>/dev/null || echo ""
else
wget -q --timeout=10 -O - "$target" 2>/dev/null || echo ""
fi
}
get_http_code() {
local target="$1"
if [[ "$http_tool" == "curl" ]]; then
curl -s -o /dev/null -w '%{http_code}' --connect-timeout 5 --max-time 10 "$target" 2>/dev/null || echo "000"
else
wget -q --spider --timeout=10 "$target" 2>/dev/null && echo "200" || echo "000"
fi
}
# Check if a response body looks like a JMAP session
is_jmap_session() {
echo "$1" | grep -qiE '"capabilities"|"apiUrl"|"downloadUrl"|"urn:ietf:params:jmap'
}
# Try multiple known JMAP endpoints
local endpoints=("/.well-known/jmap" "/jmap/session" "/jmap")
for endpoint in "${endpoints[@]}"; do
response=$(fetch_url "${url}${endpoint}")
if [[ -n "$response" ]] && is_jmap_session "$response"; then
jmap_found=true
break
fi
done
echo -ne "\r \r"
if [[ "$jmap_found" == true ]]; then
echo -e " ${OK} ${GREEN}JMAP server verified${RESET}"
return 0
fi
# No JMAP session found at any endpoint -- check if server is reachable at all
http_code=$(get_http_code "$url")
if [[ "$http_code" == "000" ]]; then
echo -e " ${FAIL} ${RED}Could not connect to ${url}${RESET}"
echo -e " ${DIM}Check that the URL is correct and the server is running.${RESET}"
return 1
fi
# Server is reachable but JMAP session not found at standard paths
echo -e " ${WARN} ${YELLOW}Server is reachable (HTTP ${http_code}) but JMAP session was not detected${RESET}"
echo -e " ${DIM}Checked: /.well-known/jmap, /jmap/session, /jmap${RESET}"
echo -e " ${DIM}This is OK if a reverse proxy routes JMAP traffic separately${RESET}"
echo -e " ${DIM}(e.g. webmail and mail server share the same domain).${RESET}"
local continue_anyway="true"
prompt_yesno "Continue with this URL?" "true" "continue_anyway"
if [[ "$continue_anyway" != "true" ]]; then
return 1
fi
return 0
}
# Read a single key press (for menu navigation)
read_key() {
local key
IFS= read -rsn1 key
if [[ "$key" == $'\x1b' ]]; then
read -rsn2 -t 0.1 key2 || true
key="${key}${key2}"
fi
echo "$key"
}
# -- Input Helpers ------------------------------------------------------------
# Prompt with default value (safe - no eval)
prompt_value() {
local label="$1"
local default="$2"
local var_name="$3"
local required="${4:-false}"
show_cursor
if [[ -n "$default" ]]; then
echo -ne " ${BOLD}${label}${RESET} ${DIM}(${default})${RESET}: "
else
echo -ne " ${BOLD}${label}${RESET}: "
fi
local input
read -r input
input="${input:-$default}"
if [[ "$required" == "true" && -z "$input" ]]; then
echo -e " ${RED}This field is required. Please enter a value.${RESET}"
prompt_value "$label" "$default" "$var_name" "$required"
return
fi
printf -v "$var_name" '%s' "$input"
hide_cursor
}
# Yes/No prompt (safe - no eval)
prompt_yesno() {
local label="$1"
local default="$2"
local var_name="$3"
local yn_display
if [[ "$default" == "true" ]]; then
yn_display="${GREEN}${BOLD}Y${RESET}${DIM}/n${RESET}"
else
yn_display="${DIM}y/${RESET}${GREEN}${BOLD}N${RESET}"
fi
show_cursor
echo -ne " ${BOLD}${label}${RESET} [${yn_display}]: "
local input
read -r input
input=$(echo "$input" | tr '[:upper:]' '[:lower:]')
local result
case "$input" in
y|yes) result="true" ;;
n|no) result="false" ;;
*) result="$default" ;;
esac
printf -v "$var_name" '%s' "$result"
hide_cursor
}
# Interactive menu selector (ASCII arrows)
menu_select() {
local label="$1"
shift
local options=("$@")
local selected=0
local count=${#options[@]}
hide_cursor
echo -e " ${BOLD}${label}${RESET}"
echo ""
while true; do
for (( i=0; i<count; i++ )); do
if [[ $i -eq $selected ]]; then
echo -e " ${GREEN}${BOLD}> ${options[$i]}${RESET}"
else
echo -e " ${DIM} ${options[$i]}${RESET}"
fi
done
echo ""
echo -e " ${DIM}Use arrow keys to navigate, Enter to select${RESET}"
local key
key=$(read_key)
case "$key" in
$'\x1b[A') selected=$(( (selected - 1 + count) % count )) ;;
$'\x1b[B') selected=$(( (selected + 1) % count )) ;;
"") break ;;
esac
local lines_up=$(( count + 2 ))
printf '\033[%dA' "$lines_up"
done
show_cursor
MENU_RESULT=$selected
MENU_VALUE="${options[$selected]}"
}
# -- Progress Bar -------------------------------------------------------------
draw_progress_bar() {
local current="$1"
local total="$2"
local max_width=56
local width=$max_width
[[ $(( TERM_COLS - 30 )) -lt $width ]] && width=$(( TERM_COLS - 30 ))
[[ $width -lt 20 ]] && width=20
local filled=$(( width * current / total ))
local empty=$(( width - filled ))
local pct=$(( 100 * current / total ))
local bar=""
[[ $filled -gt 0 ]] && bar=$(printf '%*s' "$filled" '' | tr ' ' '#')
[[ $empty -gt 0 ]] && bar="${bar}$(printf '%*s' "$empty" '' | tr ' ' '.')"
# Build step label row
local label_row=" "
for (( s=1; s<=total; s++ )); do
if [[ $s -lt $current ]]; then
label_row+="${GREEN}${STEP_NAMES[$s]}${RESET} "
elif [[ $s -eq $current ]]; then
label_row+="${WHITE}${BOLD}${STEP_NAMES[$s]}${RESET} "
else
label_row+="${DIM}${STEP_NAMES[$s]}${RESET} "
fi
[[ $s -lt $total ]] && label_row+="${DIM}>${RESET} "
done
print_center "${label_row}"
echo ""
echo -e " ${DIM}[${RESET}${GREEN}${bar:0:$filled}${RESET}${DIM}${bar:$filled}${RESET}${DIM}]${RESET} ${BOLD}${pct}%%${RESET} ${DIM}(step ${current}/${total})${RESET}"
}
# Spinner for async operations (ASCII-safe)
spinner() {
local pid=$1
local message="${2:-Working...}"
local frames=('|' '/' '-' '\')
local i=0
hide_cursor
while kill -0 "$pid" 2>/dev/null; do
echo -ne "\r ${CYAN}${frames[$i]}${RESET} ${message}"
i=$(( (i + 1) % ${#frames[@]} ))
sleep 0.1
done
echo -ne "\r ${OK} ${message} \n"
show_cursor
}
# -- Screen Rendering ---------------------------------------------------------
draw_header() {
get_term_size
clear_screen
echo ""
if [[ "$DRY_RUN" == true ]]; then
box "BULWARK WEBMAIL SETUP -- DRY RUN" "$MAGENTA"
else
box "BULWARK WEBMAIL SETUP" "$CYAN"
fi
echo ""
if [[ $CURRENT_STEP -gt 0 ]]; then
draw_progress_bar "$CURRENT_STEP" "$TOTAL_STEPS"
echo ""
fi
hr
echo ""
}
draw_footer() {
echo ""
hr
echo ""
if [[ $CURRENT_STEP -eq 0 ]]; then
print_center "${DIM}Press Enter to begin${RESET}"
elif [[ $CURRENT_STEP -le $TOTAL_STEPS ]]; then
print_center "${DIM}Press Enter to continue | Ctrl+C to abort${RESET}"
fi
}
# -- Section header inside a step
section_header() {
local number="$1"
local title="$2"
local subtitle="${3:-}"
echo -e " ${CYAN}${BOLD}Step ${number}: ${title}${RESET}"
if [[ -n "$subtitle" ]]; then
echo -e " ${DIM}${subtitle}${RESET}"
fi
echo ""
}
# -- Screens ------------------------------------------------------------------
screen_welcome() {
CURRENT_STEP=0
draw_header
local version
version=$(cat "${SCRIPT_DIR}/VERSION" 2>/dev/null || echo "dev")
print_center "${BOLD}Welcome to Bulwark Webmail${RESET}"
print_center "${DIM}v${version}${RESET}"
echo ""
echo ""
echo -e " This wizard will walk you through configuring your webmail instance."
echo -e " It takes about ${BOLD}2 minutes${RESET} and will generate a ${BOLD}.env.local${RESET} file."
echo ""
echo -e " ${BOLD}What we'll set up:${RESET}"
echo ""
echo -e " ${STAR} ${BOLD}Server${RESET} - Connect to your JMAP mail server (Stalwart, etc.)"
echo -e " ${STAR} ${BOLD}Auth${RESET} - Choose Basic Auth, OAuth2/OIDC, or both"
echo -e " ${STAR} ${BOLD}Security${RESET} - Session secrets, \"Remember me\", settings sync"
echo -e " ${STAR} ${BOLD}Logging${RESET} - Log format and verbosity"
echo -e " ${STAR} ${BOLD}Branding${RESET} - Company name, links on the login page"
echo -e " ${STAR} ${BOLD}Deployment${RESET} - Node.js, Docker, or Docker Compose"
echo ""
hr
echo ""
echo -e " ${BOLD}System Check${RESET}"
echo ""
local all_ok=true
# Node.js
if command -v node &>/dev/null; then
local node_ver
node_ver=$(node --version)
local node_major
node_major=$(echo "$node_ver" | grep -oP '(?<=v)\d+' || echo "0")
if [[ "$node_major" -ge 18 ]]; then
echo -e " ${OK} Node.js ${node_ver}"
else
echo -e " ${WARN} Node.js ${node_ver} ${YELLOW}(v18+ recommended)${RESET}"
fi
else
echo -e " ${FAIL} Node.js not found ${RED}(required for local builds)${RESET}"
all_ok=false
fi
# npm
if command -v npm &>/dev/null; then
local npm_ver
npm_ver=$(npm --version)
echo -e " ${OK} npm v${npm_ver}"
else
echo -e " ${FAIL} npm not found ${RED}(required for local builds)${RESET}"
all_ok=false
fi
# Docker
if command -v docker &>/dev/null; then
local docker_ver
docker_ver=$(docker --version 2>/dev/null | grep -oP '\d+\.\d+\.\d+' | head -1 || echo "installed")
echo -e " ${OK} Docker v${docker_ver}"
else
echo -e " ${SKIP} Docker not found ${DIM}(needed only for Docker deployments)${RESET}"
fi
# Git
if command -v git &>/dev/null; then
local git_ver
git_ver=$(git --version | grep -oP '\d+\.\d+\.\d+' || echo "installed")
echo -e " ${OK} Git v${git_ver}"
else
echo -e " ${SKIP} Git not found ${DIM}(optional)${RESET}"
fi
# openssl
if command -v openssl &>/dev/null; then
echo -e " ${OK} OpenSSL available"
else
echo -e " ${SKIP} OpenSSL not found ${DIM}(needed for auto-generating secrets)${RESET}"
fi
echo ""
if [[ "$all_ok" == false ]]; then
echo -e " ${YELLOW}${BOLD}WARNING:${RESET} ${YELLOW}Some required tools are missing.${RESET}"
echo -e " ${YELLOW}Install Node.js 18+ and npm before deploying with Node.js.${RESET}"
echo -e " ${YELLOW}You can still proceed if you plan to use Docker.${RESET}"
echo ""
fi
if [[ -f "$ENV_FILE" ]]; then
note "Found existing .env.local -- your current values will be used as defaults."
fi
draw_footer
read -r
}
screen_server_config() {
CURRENT_STEP=1
draw_header
section_header 1 "Server Configuration" \
"Point Bulwark Webmail at your mail server."
echo -e " ${BOLD}General${RESET}"
echo -e " ${DIM}This name appears in the browser tab and on the login page.${RESET}"
echo ""
prompt_value "Application name" "$CFG_APP_NAME" "CFG_APP_NAME"
echo ""
echo -e " ${BOLD}Mail Server${RESET}"
echo -e " ${DIM}Enter the base URL of your Stalwart (or JMAP-compatible) server.${RESET}"
echo -e " ${DIM}Example: https://mail.example.com${RESET}"
echo ""
local jmap_url_valid=false
while [[ "$jmap_url_valid" == false ]]; do
prompt_value "JMAP server URL" "$CFG_JMAP_SERVER_URL" "CFG_JMAP_SERVER_URL" "true"
# Validate URL format
if [[ ! "$CFG_JMAP_SERVER_URL" =~ ^https?:// ]]; then
echo -e " ${WARN} URL should start with https:// or http://"
CFG_JMAP_SERVER_URL="https://${CFG_JMAP_SERVER_URL}"
echo -e " ${DIM}Auto-corrected to: ${CFG_JMAP_SERVER_URL}${RESET}"
fi
echo ""
# Validate it's actually a JMAP server
if check_jmap_server "$CFG_JMAP_SERVER_URL"; then
jmap_url_valid=true
else
echo ""
echo -e " ${DIM}Please enter a different URL or fix the server.${RESET}"
echo ""
CFG_JMAP_SERVER_URL=""
fi
done
echo ""
echo -e " ${BOLD}Features${RESET}"
echo -e " ${DIM}Adds password change and Sieve filter management.${RESET}"
echo -e " ${DIM}Safe to enable even on non-Stalwart servers.${RESET}"
echo ""
prompt_yesno "Enable Stalwart-specific features?" "$CFG_STALWART_FEATURES" "CFG_STALWART_FEATURES"
echo ""
echo -e " ${BOLD}Network${RESET}"
echo -e " ${DIM}The port the web UI will listen on. Default is 3000.${RESET}"
echo ""
prompt_value "Port" "$CFG_PORT" "CFG_PORT"
draw_footer
read -r
}
screen_auth_config() {
CURRENT_STEP=2
draw_header
section_header 2 "Authentication" \
"Choose how users log in to the webmail."
echo -e " Basic Auth (username + password) is ${BOLD}always available${RESET}."
echo -e " You can optionally add ${BOLD}OAuth2 / OpenID Connect${RESET} for single sign-on."
echo ""
prompt_yesno "Enable OAuth2/OIDC?" "$CFG_OAUTH_ENABLED" "CFG_OAUTH_ENABLED"
if [[ "$CFG_OAUTH_ENABLED" == "true" ]]; then
echo ""
hr
echo ""
echo -e " ${BOLD}OAuth2 / OIDC Configuration${RESET}"
echo ""
echo -e " ${DIM}Enable this if ALL users authenticate via your identity provider.${RESET}"
prompt_yesno "OAuth-only mode? (hides the password form)" "$CFG_OAUTH_ONLY" "CFG_OAUTH_ONLY"
echo ""
prompt_value "OAuth Client ID" "$CFG_OAUTH_CLIENT_ID" "CFG_OAUTH_CLIENT_ID" "true"
echo ""
echo -e " ${DIM}Leave empty for public clients using PKCE only (no secret needed).${RESET}"
prompt_value "OAuth Client Secret" "$CFG_OAUTH_CLIENT_SECRET" "CFG_OAUTH_CLIENT_SECRET"
echo ""
echo -e " ${DIM}For external IdPs (Keycloak, Authentik, Entra ID, etc.).${RESET}"
echo -e " ${DIM}Leave empty to use Stalwart's built-in OAuth.${RESET}"
prompt_value "OAuth Issuer URL" "$CFG_OAUTH_ISSUER_URL" "CFG_OAUTH_ISSUER_URL"
else
echo ""
note "Users will log in with their email and password (Basic Auth over HTTPS)."
echo -e " ${DIM}You can enable OAuth2 later by editing .env.local.${RESET}"
fi
draw_footer
read -r
}
screen_security_config() {
CURRENT_STEP=3
draw_header
section_header 3 "Security & Sessions" \
"Configure session persistence and cross-device settings sync."
echo -e " A ${BOLD}session secret${RESET} is a random key used to encrypt the \"Remember me\""
echo -e " cookie. Without it, users must log in every time they open the app."
echo ""
local generate_secret="false"
if [[ -z "$CFG_SESSION_SECRET" ]]; then
prompt_yesno "Auto-generate a secure session secret? (recommended)" "true" "generate_secret"
if [[ "$generate_secret" == "true" ]]; then
if command -v openssl &>/dev/null; then
CFG_SESSION_SECRET=$(openssl rand -base64 32)
echo -e " ${OK} Session secret generated (via openssl)"
else
CFG_SESSION_SECRET=$(head -c 32 /dev/urandom | base64)
echo -e " ${OK} Session secret generated (via /dev/urandom)"
fi
else
prompt_value "Session secret (paste your own)" "" "CFG_SESSION_SECRET"
fi
else
echo -e " ${OK} Session secret is already configured"
prompt_yesno "Regenerate it?" "false" "generate_secret"
if [[ "$generate_secret" == "true" ]]; then
if command -v openssl &>/dev/null; then
CFG_SESSION_SECRET=$(openssl rand -base64 32)
else
CFG_SESSION_SECRET=$(head -c 32 /dev/urandom | base64)
fi
echo -e " ${OK} Session secret regenerated"
fi
fi
echo ""
if [[ -n "$CFG_SESSION_SECRET" ]]; then
echo -e " ${BOLD}With a session secret, you get:${RESET}"
echo -e " ${STAR} \"Remember me\" checkbox on the login page"
echo -e " ${STAR} Credentials encrypted at rest with AES-256-GCM"
echo ""
hr
echo ""
echo -e " ${BOLD}Settings Sync${RESET}"
echo ""
echo -e " Sync user preferences (theme, layout, etc.) across devices."
echo -e " Settings are stored server-side in a local directory."
echo ""
prompt_yesno "Enable settings sync?" "$CFG_SETTINGS_SYNC_ENABLED" "CFG_SETTINGS_SYNC_ENABLED"
if [[ "$CFG_SETTINGS_SYNC_ENABLED" == "true" ]]; then
echo ""
echo -e " ${DIM}Make sure this directory is persistent and backed up.${RESET}"
prompt_value "Data directory for synced settings" "$CFG_SETTINGS_DATA_DIR" "CFG_SETTINGS_DATA_DIR"
fi
else
echo ""
note "Without a session secret, \"Remember me\" and settings sync are disabled."
echo -e " ${DIM}You can add a SESSION_SECRET to .env.local at any time.${RESET}"
fi
draw_footer
read -r
}
screen_logging_config() {
CURRENT_STEP=4
draw_header
section_header 4 "Logging" \
"Control how Bulwark Webmail writes logs."
echo -e " ${BOLD}Log Format${RESET}"
echo ""
menu_select "Choose a format:" \
"text - Colored, human-readable (good for terminals)" \
"json - Structured JSON (good for log aggregation)"
case $MENU_RESULT in
0) CFG_LOG_FORMAT="text" ;;
1) CFG_LOG_FORMAT="json" ;;
esac
echo ""
echo -e " ${BOLD}Log Level${RESET}"
echo ""
menu_select "Choose verbosity:" \
"error - Errors only" \
"warn - Errors + warnings" \
"info - Standard output (recommended)" \
"debug - Verbose (for development/troubleshooting)"
case $MENU_RESULT in
0) CFG_LOG_LEVEL="error" ;;
1) CFG_LOG_LEVEL="warn" ;;
2) CFG_LOG_LEVEL="info" ;;
3) CFG_LOG_LEVEL="debug" ;;
esac
echo ""
note "Use 'info' for production. Switch to 'debug' temporarily when troubleshooting."
draw_footer
read -r
}
screen_login_customization() {
CURRENT_STEP=5
draw_header
section_header 5 "Branding" \
"Customize logos, favicon, and login page for your domain identity."
echo -e " All fields are ${BOLD}optional${RESET}. Press Enter to skip any field."
echo ""
echo -e " ${DIM}Custom favicon for the browser tab (SVG recommended, 32×32 to 512×512px)${RESET}"
echo -e " ${DIM}Leave blank to use the default Bulwark favicon.${RESET}"
prompt_value "Favicon URL" "$CFG_FAVICON_URL" "CFG_FAVICON_URL"
echo ""
echo -e " ${DIM}App logo shown in the sidebar (SVG recommended, 24×24 to 128×128px)${RESET}"
echo -e " ${DIM}Leave blank for no sidebar logo.${RESET}"
prompt_value "App logo URL (light mode)" "$CFG_APP_LOGO_LIGHT_URL" "CFG_APP_LOGO_LIGHT_URL"
echo ""
prompt_value "App logo URL (dark mode)" "$CFG_APP_LOGO_DARK_URL" "CFG_APP_LOGO_DARK_URL"
echo ""
echo -e " ${DIM}Shown on the login page footer. Example: Acme Corp${RESET}"
prompt_value "Company / organization name" "$CFG_LOGIN_COMPANY_NAME" "CFG_LOGIN_COMPANY_NAME"
echo ""
echo -e " ${DIM}Custom logo URLs for the login page (SVG recommended, 32×32 to 512×512px)${RESET}"
echo -e " ${DIM}Leave blank to use the default Bulwark logo.${RESET}"
prompt_value "Login logo URL (light mode)" "$CFG_LOGIN_LOGO_LIGHT_URL" "CFG_LOGIN_LOGO_LIGHT_URL"
echo ""
prompt_value "Login logo URL (dark mode)" "$CFG_LOGIN_LOGO_DARK_URL" "CFG_LOGIN_LOGO_DARK_URL"
echo ""
prompt_value "Website URL" "$CFG_LOGIN_WEBSITE_URL" "CFG_LOGIN_WEBSITE_URL"
echo ""
prompt_value "Imprint / legal notice URL" "$CFG_LOGIN_IMPRINT_URL" "CFG_LOGIN_IMPRINT_URL"
echo ""
prompt_value "Privacy policy URL" "$CFG_LOGIN_PRIVACY_POLICY_URL" "CFG_LOGIN_PRIVACY_POLICY_URL"
if [[ -z "$CFG_LOGIN_COMPANY_NAME" && -z "$CFG_LOGIN_LOGO_LIGHT_URL" && -z "$CFG_LOGIN_LOGO_DARK_URL" && -z "$CFG_FAVICON_URL" && -z "$CFG_APP_LOGO_LIGHT_URL" && -z "$CFG_APP_LOGO_DARK_URL" && -z "$CFG_LOGIN_WEBSITE_URL" && -z "$CFG_LOGIN_IMPRINT_URL" && -z "$CFG_LOGIN_PRIVACY_POLICY_URL" ]]; then
echo ""
note "No branding configured. The app will use defaults."
fi
draw_footer
read -r
}
screen_deployment() {
CURRENT_STEP=6
draw_header
section_header 6 "Deployment Method" \
"Choose how you want to run Bulwark Webmail."
local docker_available=false
command -v docker &>/dev/null && docker_available=true
echo -e " ${BOLD}Available options:${RESET}"
echo ""
menu_select "Choose deployment method:" \
"Node.js - Build locally (npm install + npm run build + npm start)" \
"Docker - Pull and run a pre-built container image" \
"Docker Compose - Use the included docker-compose.yml"
case $MENU_RESULT in
0) CFG_DEPLOY_METHOD="node" ;;
1) CFG_DEPLOY_METHOD="docker" ;;
2) CFG_DEPLOY_METHOD="compose" ;;
esac
echo ""
case "$CFG_DEPLOY_METHOD" in
"node")
note "Good for development or when you want full control over the build."
echo -e " ${DIM}Requires: Node.js 18+, npm${RESET}"
;;
"docker")
note "Easiest option for production. No build tools needed on the host."
echo -e " ${DIM}Requires: Docker${RESET}"
;;
"compose")
note "Best for production. Easy to manage with 'docker compose up/down'."
echo -e " ${DIM}Requires: Docker + Docker Compose v2${RESET}"
;;
esac
if [[ "$CFG_DEPLOY_METHOD" != "node" && "$docker_available" == false ]]; then
echo ""
echo -e " ${WARN} ${YELLOW}Docker is not installed on this machine.${RESET}"
echo -e " ${YELLOW}You can still generate the .env.local and deploy later.${RESET}"
fi
draw_footer
read -r
}
screen_summary() {
CURRENT_STEP=7
draw_header
section_header 7 "Review Configuration" \
"Please review your settings before applying."
# Server
echo -e " ${CYAN}${BOLD}SERVER${RESET}"
echo -e " App Name .............. ${BOLD}${CFG_APP_NAME}${RESET}"
echo -e " JMAP Server URL ....... ${BOLD}${CFG_JMAP_SERVER_URL}${RESET}"
echo -e " Stalwart Features ..... ${BOLD}${CFG_STALWART_FEATURES}${RESET}"
echo -e " Port .................. ${BOLD}${CFG_PORT}${RESET}"
echo ""
# Auth
echo -e " ${CYAN}${BOLD}AUTHENTICATION${RESET}"
if [[ "$CFG_OAUTH_ENABLED" == "true" ]]; then
echo -e " OAuth2/OIDC ........... ${GREEN}${BOLD}Enabled${RESET}"
echo -e " OAuth-only mode ....... ${BOLD}${CFG_OAUTH_ONLY}${RESET}"
echo -e " Client ID ............. ${BOLD}${CFG_OAUTH_CLIENT_ID}${RESET}"
[[ -n "$CFG_OAUTH_CLIENT_SECRET" ]] && \
echo -e " Client Secret ......... ${BOLD}********${RESET}"
[[ -n "$CFG_OAUTH_ISSUER_URL" ]] && \
echo -e " Issuer URL ............ ${BOLD}${CFG_OAUTH_ISSUER_URL}${RESET}"
else
echo -e " Method ................ ${DIM}Basic Auth only${RESET}"
fi
echo ""
# Security
echo -e " ${CYAN}${BOLD}SECURITY${RESET}"
if [[ -n "$CFG_SESSION_SECRET" ]]; then
echo -e " Session Secret ........ ${GREEN}${BOLD}Set${RESET} ${DIM}(Remember me enabled)${RESET}"
echo -e " Settings Sync ......... ${BOLD}${CFG_SETTINGS_SYNC_ENABLED}${RESET}"
[[ "$CFG_SETTINGS_SYNC_ENABLED" == "true" ]] && \
echo -e " Settings Directory .... ${BOLD}${CFG_SETTINGS_DATA_DIR}${RESET}"
else
echo -e " Session Secret ........ ${DIM}Not set${RESET}"
fi
echo ""
# Logging
echo -e " ${CYAN}${BOLD}LOGGING${RESET}"
echo -e " Format ................ ${BOLD}${CFG_LOG_FORMAT}${RESET}"
echo -e " Level ................. ${BOLD}${CFG_LOG_LEVEL}${RESET}"
echo ""
# Login page
echo -e " ${CYAN}${BOLD}BRANDING${RESET}"
if [[ -n "$CFG_LOGIN_COMPANY_NAME" || -n "$CFG_LOGIN_LOGO_LIGHT_URL" || -n "$CFG_LOGIN_LOGO_DARK_URL" || -n "$CFG_FAVICON_URL" || -n "$CFG_APP_LOGO_LIGHT_URL" || -n "$CFG_APP_LOGO_DARK_URL" || -n "$CFG_LOGIN_WEBSITE_URL" || -n "$CFG_LOGIN_IMPRINT_URL" || -n "$CFG_LOGIN_PRIVACY_POLICY_URL" ]]; then
[[ -n "$CFG_FAVICON_URL" ]] && \
echo -e " Favicon URL ........... ${BOLD}${CFG_FAVICON_URL}${RESET}"
[[ -n "$CFG_APP_LOGO_LIGHT_URL" ]] && \
echo -e " App Logo (light) ...... ${BOLD}${CFG_APP_LOGO_LIGHT_URL}${RESET}"
[[ -n "$CFG_APP_LOGO_DARK_URL" ]] && \
echo -e " App Logo (dark) ....... ${BOLD}${CFG_APP_LOGO_DARK_URL}${RESET}"
[[ -n "$CFG_LOGIN_COMPANY_NAME" ]] && \
echo -e " Company Name .......... ${BOLD}${CFG_LOGIN_COMPANY_NAME}${RESET}"
[[ -n "$CFG_LOGIN_LOGO_LIGHT_URL" ]] && \
echo -e " Login Logo (light) .... ${BOLD}${CFG_LOGIN_LOGO_LIGHT_URL}${RESET}"
[[ -n "$CFG_LOGIN_LOGO_DARK_URL" ]] && \
echo -e " Login Logo (dark) ..... ${BOLD}${CFG_LOGIN_LOGO_DARK_URL}${RESET}"
[[ -n "$CFG_LOGIN_WEBSITE_URL" ]] && \
echo -e " Website URL ........... ${BOLD}${CFG_LOGIN_WEBSITE_URL}${RESET}"
[[ -n "$CFG_LOGIN_IMPRINT_URL" ]] && \
echo -e " Imprint URL ........... ${BOLD}${CFG_LOGIN_IMPRINT_URL}${RESET}"
[[ -n "$CFG_LOGIN_PRIVACY_POLICY_URL" ]] && \
echo -e " Privacy Policy URL .... ${BOLD}${CFG_LOGIN_PRIVACY_POLICY_URL}${RESET}"
else
echo -e " ${DIM}(using defaults)${RESET}"
fi
echo ""
# Deployment
echo -e " ${CYAN}${BOLD}DEPLOYMENT${RESET}"
case "$CFG_DEPLOY_METHOD" in
"node") echo -e " Method ................ ${BOLD}Node.js (local build)${RESET}" ;;
"docker") echo -e " Method ................ ${BOLD}Docker (container)${RESET}" ;;
"compose") echo -e " Method ................ ${BOLD}Docker Compose${RESET}" ;;
esac
echo ""
hr
echo ""
local confirm
prompt_yesno "Apply this configuration and proceed?" "true" "confirm"
if [[ "$confirm" != "true" ]]; then
echo ""
echo -e " ${YELLOW}Setup cancelled. No files were modified.${RESET}"
echo ""
show_cursor
exit 0
fi
}
# -- Write Configuration -----------------------------------------------------
write_env_file() {
if [[ "$DRY_RUN" == true ]]; then
echo -e " ${DIM}[dry-run] Would back up existing .env.local${RESET}"
echo -e " ${DIM}[dry-run] Would write .env.local with the above configuration${RESET}"
return
fi
# Backup existing if present
if [[ -f "$ENV_FILE" ]]; then
local backup="${ENV_FILE}.backup.$(date +%Y%m%d_%H%M%S)"
cp "$ENV_FILE" "$backup"
echo -e " ${OK} Backed up existing .env.local --> $(basename "$backup")"
fi
cat > "$ENV_FILE" << ENVEOF
# =============================================================================
# Bulwark Webmail -- Configuration
# Generated by setup.sh on $(date '+%Y-%m-%d %H:%M:%S')
# =============================================================================
# -- JMAP Server (required) ---------------------------------------------------
APP_NAME=${CFG_APP_NAME}
JMAP_SERVER_URL=${CFG_JMAP_SERVER_URL}
# -- Stalwart Mail Server Integration -----------------------------------------
STALWART_FEATURES=${CFG_STALWART_FEATURES}
# -- OAuth / OpenID Connect ---------------------------------------------------
OAUTH_ENABLED=${CFG_OAUTH_ENABLED}
ENVEOF
if [[ "$CFG_OAUTH_ENABLED" == "true" ]]; then
cat >> "$ENV_FILE" << ENVEOF
OAUTH_ONLY=${CFG_OAUTH_ONLY}
OAUTH_CLIENT_ID=${CFG_OAUTH_CLIENT_ID}
ENVEOF
[[ -n "$CFG_OAUTH_CLIENT_SECRET" ]] && echo "OAUTH_CLIENT_SECRET=${CFG_OAUTH_CLIENT_SECRET}" >> "$ENV_FILE"
[[ -n "$CFG_OAUTH_ISSUER_URL" ]] && echo "OAUTH_ISSUER_URL=${CFG_OAUTH_ISSUER_URL}" >> "$ENV_FILE"
fi
cat >> "$ENV_FILE" << ENVEOF
# -- Session & Security -------------------------------------------------------