-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetup.py
More file actions
1344 lines (1209 loc) · 50.6 KB
/
setup.py
File metadata and controls
1344 lines (1209 loc) · 50.6 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 python3
"""
Flask Platform Setup Wizard
============================
Self-contained, one-shot setup wizard for a Flask-based web platform.
Usage:
python setup.py [--port PORT] [--host HOST]
The wizard spins up a temporary web interface on the given host/port (default
localhost:5050), guides the admin through initial configuration, provisions the
server, and shuts itself down cleanly once complete.
"""
from __future__ import annotations
import argparse
import json
import multiprocessing
import os
import re
import shutil
import socket
import subprocess
import sys
import threading
import time
import urllib.request
from queue import Empty, Queue
from flask import Flask, Response, jsonify, redirect, render_template_string, request, session, url_for
# ---------------------------------------------------------------------------
# App setup
# ---------------------------------------------------------------------------
app = Flask(__name__)
app.secret_key = os.urandom(32)
# ---------------------------------------------------------------------------
# Global state (single-admin wizard — not intended for concurrent use)
# ---------------------------------------------------------------------------
_config: dict = {} # Persisted form data across phases
_log_queue: Queue = Queue() # SSE log messages for Phase 3
_provisioning_done = threading.Event()
_non_interactive: bool = False # Set to True when running without the web UI
# ---------------------------------------------------------------------------
# Helper utilities
# ---------------------------------------------------------------------------
DEFAULT_WORKERS = 2 * multiprocessing.cpu_count() + 1
def _get_public_ip() -> str:
"""Try several public-IP-detection endpoints; return the first that works."""
urls = [
"https://ifconfig.me/ip",
"https://api.ipify.org",
"https://ipecho.net/plain",
]
for url in urls:
try:
with urllib.request.urlopen(url, timeout=5) as resp: # noqa: S310
ip = resp.read().decode().strip()
if re.match(r"^\d{1,3}(\.\d{1,3}){3}$", ip):
return ip
except Exception:
continue
return "UNKNOWN"
def _get_ipv6() -> str:
"""Return the server's public IPv6 address, or empty string."""
try:
result = subprocess.run(
["curl", "-6", "-s", "--connect-timeout", "4", "https://ifconfig.me/ip"],
capture_output=True, text=True, timeout=5,
)
ip = result.stdout.strip()
if ":" in ip:
return ip
except Exception:
pass
return ""
def _check_dns(domain: str, expected_ip: str) -> tuple[bool, str]:
"""Check whether *domain* resolves to *expected_ip*."""
try:
results = socket.getaddrinfo(domain, None)
resolved = {r[4][0] for r in results}
if expected_ip in resolved:
return True, f"✓ {domain} → {expected_ip}"
return False, f"✗ {domain} resolves to {resolved!r}, expected {expected_ip}"
except socket.gaierror:
return False, f"✗ DNS lookup failed for {domain}"
def _log(msg: str, level: str = "info") -> None:
if _non_interactive:
prefix = {"head": ">>>", "ok": "[OK]", "warn": "[WARN]", "err": "[ERR]"}.get(level, " ")
print(f"{prefix} {msg}", flush=True)
else:
_log_queue.put({"level": level, "msg": msg})
def _run(cmd: list[str], check: bool = True) -> subprocess.CompletedProcess:
"""Run a shell command, streaming output to the log queue."""
_log(f"$ {' '.join(cmd)}")
result = subprocess.run(cmd, capture_output=True, text=True)
if result.stdout:
for line in result.stdout.splitlines():
_log(line)
if result.stderr:
for line in result.stderr.splitlines():
_log(line, "warn")
if check and result.returncode != 0:
raise subprocess.CalledProcessError(result.returncode, cmd)
return result
# ---------------------------------------------------------------------------
# Embedded HTML templates
# ---------------------------------------------------------------------------
_BASE_HTML = """<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<title>Flask Platform Setup Wizard</title>
<style>
*{box-sizing:border-box;margin:0;padding:0}
body{font-family:'Segoe UI',sans-serif;background:#0f172a;color:#e2e8f0;min-height:100vh}
.container{max-width:1200px;margin:0 auto;padding:2rem 1rem}
h1{font-size:1.8rem;color:#38bdf8;margin-bottom:.25rem}
.subtitle{color:#94a3b8;margin-bottom:2rem;font-size:.95rem}
h2{font-size:1.2rem;color:#7dd3fc;margin-bottom:1rem;border-bottom:1px solid #1e3a5f;padding-bottom:.5rem}
h3{font-size:1rem;color:#94a3b8;margin-bottom:.75rem}
.layout{display:grid;grid-template-columns:1fr 1fr;gap:1.5rem}
@media(max-width:900px){.layout{grid-template-columns:1fr}}
.card{background:#1e293b;border-radius:8px;padding:1.5rem;border:1px solid #334155}
.field{margin-bottom:1.25rem}
label{display:block;font-size:.85rem;color:#94a3b8;margin-bottom:.4rem;font-weight:500}
input[type=text],input[type=number],select,textarea{
width:100%;padding:.5rem .75rem;background:#0f172a;border:1px solid #334155;
border-radius:6px;color:#e2e8f0;font-size:.9rem;transition:border-color .2s
}
input:focus,select:focus,textarea:focus{outline:none;border-color:#38bdf8}
input.error{border-color:#f87171}
.hint{font-size:.78rem;color:#64748b;margin-top:.3rem}
.row{display:grid;grid-template-columns:1fr 1fr;gap:1rem}
.checkbox-row{display:flex;align-items:center;gap:.5rem;margin-bottom:1rem}
.checkbox-row input{width:auto}
.checkbox-row label{margin:0;font-size:.9rem;color:#cbd5e1}
.env-row{display:grid;grid-template-columns:1fr 1fr auto;gap:.5rem;margin-bottom:.5rem}
.env-row input{margin:0}
button.add-env{background:#1d4ed8;border:none;color:#fff;padding:.4rem .9rem;
border-radius:6px;cursor:pointer;font-size:.85rem;margin-top:.25rem}
button.add-env:hover{background:#2563eb}
button.remove-env{background:#7f1d1d;border:none;color:#fff;padding:.25rem .6rem;
border-radius:6px;cursor:pointer;font-size:.85rem}
.btn-primary{display:inline-block;padding:.65rem 1.75rem;background:#0369a1;
border:none;color:#fff;border-radius:6px;font-size:.95rem;cursor:pointer;
font-weight:600;transition:background .2s}
.btn-primary:hover{background:#0284c7}
.btn-secondary{display:inline-block;padding:.65rem 1.75rem;background:#334155;
border:none;color:#e2e8f0;border-radius:6px;font-size:.95rem;cursor:pointer;font-weight:600}
.btn-success{background:#15803d;color:#fff;border:none;padding:.65rem 1.75rem;
border-radius:6px;font-size:.95rem;cursor:pointer;font-weight:600}
.btn-success:hover{background:#16a34a}
.btn-danger{background:#991b1b;color:#fff;border:none;padding:.65rem 1.75rem;
border-radius:6px;font-size:.95rem;cursor:pointer;font-weight:600}
pre.preview{background:#020617;border:1px solid #1e3a5f;border-radius:6px;
padding:1rem;font-size:.78rem;color:#7dd3fc;overflow-x:auto;white-space:pre;
min-height:80px;line-height:1.6}
.section-toggle{display:none}
.section-toggle.visible{display:block}
.badge{display:inline-block;padding:.15rem .5rem;border-radius:4px;font-size:.75rem;font-weight:600}
.badge-info{background:#0c4a6e;color:#7dd3fc}
.badge-warn{background:#78350f;color:#fcd34d}
.badge-ok{background:#14532d;color:#86efac}
.badge-err{background:#7f1d1d;color:#fca5a5}
.dns-record{background:#0f172a;border:1px solid #1e3a5f;border-radius:6px;
padding:.75rem 1rem;font-family:monospace;font-size:.85rem;margin-bottom:.5rem;color:#a5f3fc}
.log-box{background:#020617;border:1px solid #1e3a5f;border-radius:6px;
padding:1rem;height:400px;overflow-y:auto;font-family:monospace;font-size:.8rem;line-height:1.7}
.log-info{color:#94a3b8}
.log-warn{color:#fbbf24}
.log-err{color:#f87171}
.log-ok{color:#86efac}
.log-head{color:#38bdf8;font-weight:bold}
.step-list{list-style:none;margin-bottom:1.5rem}
.step-list li{padding:.5rem .75rem;margin-bottom:.4rem;border-radius:6px;
background:#0f172a;border-left:3px solid #334155;font-size:.9rem;color:#94a3b8}
.step-list li.active{border-left-color:#38bdf8;color:#e2e8f0}
.step-list li.done{border-left-color:#22c55e;color:#86efac}
.step-list li.fail{border-left-color:#ef4444;color:#fca5a5}
#dns-status{margin-top:1rem;padding:.75rem 1rem;border-radius:6px;display:none}
.alert{padding:.75rem 1rem;border-radius:6px;margin-bottom:1.5rem;font-size:.9rem}
.alert-info{background:#0c4a6e;border:1px solid #0369a1;color:#bae6fd}
.alert-warn{background:#78350f;border:1px solid #b45309;color:#fde68a}
.alert-success{background:#14532d;border:1px solid #15803d;color:#bbf7d0}
.alert-error{background:#7f1d1d;border:1px solid #991b1b;color:#fecaca}
.tabs{display:flex;gap:.5rem;margin-bottom:1rem}
.tab{padding:.4rem 1rem;border-radius:6px 6px 0 0;background:#0f172a;
border:1px solid #334155;border-bottom:none;cursor:pointer;font-size:.85rem;color:#94a3b8}
.tab.active{background:#1e293b;color:#38bdf8;border-bottom:1px solid #1e293b}
.tab-panel{display:none}.tab-panel.active{display:block}
</style>
</head>
<body>
<div class="container">
<h1>⚡ Flask Platform Setup Wizard</h1>
<p class="subtitle">One-shot provisioning for your Flask-based web platform</p>
{% block content %}{% endblock %}
</div>
</body>
</html>"""
_FORM_HTML = _BASE_HTML.replace("{% block content %}{% endblock %}", """
<div class="layout">
<!-- ===== LEFT: FORM ===== -->
<div>
<form id="setupForm" method="POST" action="/configure" novalidate>
<!-- Phase indicator -->
<div class="alert alert-info" style="margin-bottom:1.5rem">
<strong>Phase 1 of 3</strong> — Fill in the form below.
A live configuration preview updates on the right as you type.
</div>
<!-- SITE INFO -->
<div class="card" style="margin-bottom:1.25rem">
<h2>Site Information</h2>
<div class="field">
<label for="site_name">Site / App Name *</label>
<input type="text" id="site_name" name="site_name"
placeholder="mywikiapp" value="{{ cfg.site_name or '' }}"
pattern="[a-z0-9_-]+" required/>
<p class="hint">Lowercase, letters, numbers, hyphens, underscores only.
Used as the systemd service name and nginx config filename.</p>
</div>
<div class="field">
<label for="deploy_mode">Deployment Mode *</label>
<select id="deploy_mode" name="deploy_mode">
<option value="ip" {% if cfg.deploy_mode != 'domain' %}selected{% endif %}>IP Only</option>
<option value="domain" {% if cfg.deploy_mode == 'domain' %}selected{% endif %}>Custom Domain</option>
</select>
</div>
<div id="domain_section" class="section-toggle {% if cfg.deploy_mode == 'domain' %}visible{% endif %}">
<div class="field">
<label for="domain">Domain Name</label>
<input type="text" id="domain" name="domain"
placeholder="example.com" value="{{ cfg.domain or '' }}"/>
<p class="hint">Just the bare domain, no http:// prefix.</p>
</div>
<div class="checkbox-row">
<input type="checkbox" id="include_www" name="include_www" value="1"
{% if cfg.include_www %}checked{% endif %}/>
<label for="include_www">Also serve www.<domain></label>
</div>
<div class="checkbox-row">
<input type="checkbox" id="redirect_https" name="redirect_https" value="1"
{% if cfg.redirect_https %}checked{% endif %}/>
<label for="redirect_https">Redirect HTTP → HTTPS</label>
</div>
<div class="checkbox-row">
<input type="checkbox" id="use_certbot" name="use_certbot" value="1"
{% if cfg.use_certbot %}checked{% endif %}/>
<label for="use_certbot">Obtain SSL certificate via Certbot (Let's Encrypt)</label>
</div>
<div class="field" id="certbot_email_field" style="{% if not cfg.use_certbot %}display:none{% endif %}">
<label for="certbot_email">Certbot Notification Email (recommended)</label>
<input type="text" id="certbot_email" name="certbot_email"
placeholder="admin@example.com" value="{{ cfg.certbot_email or '' }}"/>
<p class="hint">Let's Encrypt will send certificate expiry reminders to this address.</p>
</div>
</div>
</div>
<!-- APP CONFIG -->
<div class="card" style="margin-bottom:1.25rem">
<h2>Application Configuration</h2>
<div class="field">
<label for="entrypoint">App Entry Point *</label>
<input type="text" id="entrypoint" name="entrypoint"
placeholder="app:app" value="{{ cfg.entrypoint or 'app:app' }}" required/>
<p class="hint">Python module and callable, e.g. <code>wsgi:app</code></p>
</div>
<div class="row">
<div class="field">
<label for="venv_path">Virtualenv Path *</label>
<input type="text" id="venv_path" name="venv_path"
placeholder="/var/www/myapp/venv" value="{{ cfg.venv_path or '' }}" required/>
</div>
<div class="field">
<label for="app_dir">App Working Directory *</label>
<input type="text" id="app_dir" name="app_dir"
placeholder="/var/www/myapp" value="{{ cfg.app_dir or '' }}" required/>
</div>
</div>
<div class="row">
<div class="field">
<label for="app_user">App User *</label>
<input type="text" id="app_user" name="app_user"
placeholder="www-data" value="{{ cfg.app_user or '' }}" required/>
<p class="hint">Do not use root.</p>
</div>
<div class="field">
<label for="app_group">App Group</label>
<input type="text" id="app_group" name="app_group"
placeholder="(defaults to user)" value="{{ cfg.app_group or '' }}"/>
</div>
</div>
<div class="row">
<div class="field">
<label for="workers">Gunicorn Workers</label>
<input type="number" id="workers" name="workers" min="1" max="64"
placeholder="{{ default_workers }}"
value="{{ cfg.workers or default_workers }}"/>
<p class="hint">Recommended: 2 × CPU cores + 1 = {{ default_workers }}</p>
</div>
<div class="field">
<label for="sock_path">Gunicorn Socket Path *</label>
<input type="text" id="sock_path" name="sock_path"
placeholder="/run/myapp/myapp.sock"
value="{{ cfg.sock_path or '' }}" required/>
</div>
</div>
<div class="row">
<div class="field">
<label for="http_port">HTTP Port</label>
<input type="number" id="http_port" name="http_port" min="1" max="65535"
value="{{ cfg.http_port or 80 }}"/>
</div>
</div>
</div>
<!-- ENVIRONMENT VARIABLES -->
<div class="card" style="margin-bottom:1.25rem">
<h2>Environment Variables</h2>
<p class="hint" style="margin-bottom:.75rem">
These will be written to <code>/etc/systemd/system/<appname>.env</code>
(chmod 600, owned by root).
</p>
<div id="env_pairs">
{% for k, v in (cfg.env_vars or []) %}
<div class="env-row">
<input type="text" name="env_key[]" placeholder="KEY" value="{{ k }}"/>
<input type="text" name="env_val[]" placeholder="value" value="{{ v }}"/>
<button type="button" class="remove-env" onclick="removeEnv(this)">✕</button>
</div>
{% endfor %}
</div>
<button type="button" class="add-env" onclick="addEnv()">+ Add Variable</button>
</div>
<button type="submit" class="btn-primary">Continue →</button>
</form>
</div>
<!-- ===== RIGHT: PREVIEW ===== -->
<div>
<div class="card" style="position:sticky;top:1rem">
<h2>Live Configuration Preview</h2>
<div class="tabs">
<div class="tab active" onclick="showTab('tab-service', event)">systemd service</div>
<div class="tab" onclick="showTab('tab-env', event)">env file</div>
<div class="tab" onclick="showTab('tab-nginx', event)">nginx</div>
</div>
<div id="tab-service" class="tab-panel active">
<pre class="preview" id="prev_service"></pre>
</div>
<div id="tab-env" class="tab-panel">
<pre class="preview" id="prev_env"></pre>
</div>
<div id="tab-nginx" class="tab-panel">
<pre class="preview" id="prev_nginx"></pre>
</div>
</div>
</div>
</div>
<script>
// ---- Tab switching ----
function showTab(id, evt) {
document.querySelectorAll('.tab-panel').forEach(p => p.classList.remove('active'));
document.querySelectorAll('.tab').forEach(t => t.classList.remove('active'));
document.getElementById(id).classList.add('active');
if (evt && evt.target) evt.target.classList.add('active');
}
// ---- Deploy mode toggle ----
document.getElementById('deploy_mode').addEventListener('change', function() {
const ds = document.getElementById('domain_section');
ds.classList.toggle('visible', this.value === 'domain');
updatePreview();
});
document.getElementById('use_certbot').addEventListener('change', function() {
const ef = document.getElementById('certbot_email_field');
if (ef) ef.style.display = this.checked ? '' : 'none';
});
// ---- Env variable management ----
function addEnv() {
const container = document.getElementById('env_pairs');
const row = document.createElement('div');
row.className = 'env-row';
row.innerHTML = '<input type="text" name="env_key[]" placeholder="KEY"/>' +
'<input type="text" name="env_val[]" placeholder="value"/>' +
'<button type="button" class="remove-env" onclick="removeEnv(this)">✕</button>';
container.appendChild(row);
row.querySelectorAll('input').forEach(i => i.addEventListener('input', updatePreview));
}
function removeEnv(btn) { btn.closest('.env-row').remove(); updatePreview(); }
// ---- Live preview generator ----
function getVal(id) { const el = document.getElementById(id); return el ? el.value.trim() : ''; }
function getChecked(id) { const el = document.getElementById(id); return el ? el.checked : false; }
function buildServicePreview(cfg) {
const env = cfg.envVars.map(([k]) => `Environment="${k}=..."`).join('\n');
return `[Unit]
Description=${cfg.siteName} gunicorn service
After=network.target
[Service]
Type=notify
User=${cfg.user || '<user>'}
Group=${cfg.group || cfg.user || '<group>'}
WorkingDirectory=${cfg.appDir || '<app_dir>'}
RuntimeDirectory=${cfg.siteName || '<appname>'}
EnvironmentFile=/etc/systemd/system/${cfg.siteName || '<appname>'}.env
ExecStart=${cfg.venv || '<venv>'}/bin/gunicorn \\
--workers ${cfg.workers || 3} \\
--bind unix:${cfg.sock || '<sock_path>'} \\
${cfg.entry || '<entrypoint>'}
ExecReload=/bin/kill -s HUP $MAINPID
KillMode=mixed
TimeoutStopSec=5
PrivateTmp=true
Restart=on-failure
[Install]
WantedBy=multi-user.target`;
}
function buildEnvPreview(cfg) {
if (!cfg.envVars.length) return '# No environment variables defined';
return cfg.envVars.map(([k, v]) => `${k}=${v}`).join('\n');
}
function buildNginxPreview(cfg) {
const name = cfg.siteName || '<appname>';
const sock = cfg.sock || '<sock_path>';
const port = cfg.httpPort || 80;
let serverName = '_';
if (cfg.mode === 'domain' && cfg.domain) {
serverName = cfg.domain + (cfg.www ? ' www.' + cfg.domain : '');
}
let upstreamBlock = `upstream ${name}_app {
server unix:${sock} fail_timeout=0;
}`;
let httpsBlock = '';
if (cfg.mode === 'domain' && cfg.redirectHttps) {
httpsBlock = `
server {
listen ${port};
server_name ${serverName};
return 301 https://$host$request_uri;
}
server {
listen 443 ssl;
server_name ${serverName};
ssl_certificate /etc/letsencrypt/live/${cfg.domain}/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/${cfg.domain}/privkey.pem;
include /etc/letsencrypt/options-ssl-nginx.conf;
location / {
proxy_pass http://${name}_app;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}`;
} else {
httpsBlock = `
server {
listen ${port};
server_name ${serverName};
location / {
proxy_pass http://${name}_app;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}`;
}
return upstreamBlock + '\n' + httpsBlock;
}
function getEnvVars() {
const keys = [...document.querySelectorAll('input[name="env_key[]"]')].map(e => e.value.trim());
const vals = [...document.querySelectorAll('input[name="env_val[]"]')].map(e => e.value.trim());
return keys.map((k, i) => [k, vals[i] || '']).filter(([k]) => k);
}
function updatePreview() {
const cfg = {
siteName: getVal('site_name'),
mode: getVal('deploy_mode'),
domain: getVal('domain'),
www: getChecked('include_www'),
redirectHttps: getChecked('redirect_https'),
entry: getVal('entrypoint'),
venv: getVal('venv_path'),
appDir: getVal('app_dir'),
user: getVal('app_user'),
group: getVal('app_group'),
workers: parseInt(getVal('workers')) || {{ default_workers }},
sock: getVal('sock_path'),
httpPort: getVal('http_port') || 80,
envVars: getEnvVars(),
};
document.getElementById('prev_service').textContent = buildServicePreview(cfg);
document.getElementById('prev_env').textContent = buildEnvPreview(cfg);
document.getElementById('prev_nginx').textContent = buildNginxPreview(cfg);
}
// ---- Client-side validation ----
document.getElementById('setupForm').addEventListener('submit', function(e) {
let valid = true;
const required = ['site_name','entrypoint','venv_path','app_dir','app_user','sock_path'];
required.forEach(id => {
const el = document.getElementById(id);
if (!el) return;
el.classList.remove('error');
if (!el.value.trim()) { el.classList.add('error'); valid = false; }
});
if (document.getElementById('deploy_mode').value === 'domain') {
const d = document.getElementById('domain');
d.classList.remove('error');
const domainVal = d.value.trim();
const domainRe = /^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,}$/;
if (!domainVal || !domainRe.test(domainVal)) { d.classList.add('error'); valid = false; }
}
// Validate site_name format
const sn = document.getElementById('site_name');
if (sn.value.trim() && !/^[a-z0-9_-]+$/.test(sn.value.trim())) {
sn.classList.add('error'); valid = false;
}
// Validate paths start with /
['venv_path','app_dir','sock_path'].forEach(id => {
const el = document.getElementById(id);
if (el && el.value.trim() && !el.value.trim().startsWith('/')) {
el.classList.add('error'); valid = false;
}
});
if (!valid) { e.preventDefault(); alert('Please fix the highlighted fields before continuing.'); }
});
// ---- Attach input listeners ----
document.querySelectorAll('input,select,textarea').forEach(el => {
el.addEventListener('input', updatePreview);
el.addEventListener('change', updatePreview);
});
// Initial render
updatePreview();
</script>
""")
_DNS_HTML = _BASE_HTML.replace("{% block content %}{% endblock %}", """
<div style="max-width:700px">
<div class="alert alert-warn">
<strong>Phase 2 — DNS Configuration Required</strong><br/>
Before provisioning can begin, you need to set the following DNS records.
DNS verification must pass before continuing.
</div>
<div class="card" style="margin-bottom:1.25rem">
<h2>Required DNS Records</h2>
<p style="color:#94a3b8;font-size:.9rem;margin-bottom:1rem">
Set these records with your domain registrar or DNS provider.
Changes may take a few minutes to propagate.
</p>
<div class="dns-record">
<span class="badge badge-info">A</span>
<strong>{{ domain }}</strong> → {{ server_ip }}
</div>
{% if include_www %}
<div class="dns-record">
<span class="badge badge-info">A</span>
<strong>www.{{ domain }}</strong> → {{ server_ip }}
</div>
{% endif %}
{% if ipv6 %}
<div class="dns-record">
<span class="badge badge-warn">AAAA</span>
<strong>{{ domain }}</strong> → {{ ipv6 }}
</div>
{% if include_www %}
<div class="dns-record">
<span class="badge badge-warn">AAAA</span>
<strong>www.{{ domain }}</strong> → {{ ipv6 }}
</div>
{% endif %}
{% endif %}
</div>
<div class="card" style="margin-bottom:1.25rem">
<h2>DNS Verification</h2>
<p style="color:#94a3b8;font-size:.9rem;margin-bottom:1rem">
Click <strong>Verify DNS</strong> to check whether your domain resolves correctly.
You can re-check as many times as needed.
</p>
<button class="btn-secondary" id="verifyBtn" onclick="verifyDNS()">🔍 Verify DNS</button>
<div id="dns-status" style="margin-top:1rem;padding:.75rem 1rem;border-radius:6px;display:none"></div>
</div>
<form method="POST" action="/provision">
<button type="submit" class="btn-primary" id="continueBtn" disabled
style="opacity:.5;cursor:not-allowed">
Proceed to Provisioning →
</button>
<span id="continueHint" style="color:#64748b;font-size:.85rem;margin-left:.75rem">
(DNS must be verified first)
</span>
</form>
</div>
<script>
let dnsOk = false;
async function verifyDNS() {
const btn = document.getElementById('verifyBtn');
const status = document.getElementById('dns-status');
btn.disabled = true;
btn.textContent = '⏳ Checking…';
status.style.display = 'none';
try {
const resp = await fetch('/verify_dns', {method: 'POST'});
const data = await resp.json();
status.style.display = 'block';
if (data.ok) {
status.className = 'alert alert-success';
status.innerHTML = '<strong>✓ DNS verified!</strong><br/>' +
data.results.map(r => r.msg).join('<br/>');
dnsOk = true;
const continueBtn = document.getElementById('continueBtn');
continueBtn.disabled = false;
continueBtn.style.opacity = '1';
continueBtn.style.cursor = 'pointer';
document.getElementById('continueHint').style.display = 'none';
} else {
status.className = 'alert alert-error';
status.innerHTML = '<strong>✗ DNS not yet ready</strong><br/>' +
data.results.map(r => r.msg).join('<br/>');
}
} catch(err) {
status.style.display = 'block';
status.className = 'alert alert-error';
status.textContent = 'Error checking DNS: ' + err;
}
btn.disabled = false;
btn.textContent = '🔍 Verify DNS';
}
</script>
""")
_PROVISION_HTML = _BASE_HTML.replace("{% block content %}{% endblock %}", """
<div class="layout">
<div>
<div class="alert alert-info" style="margin-bottom:1.5rem">
<strong>Phase 3 — Automated Provisioning</strong><br/>
The wizard is now setting up your server. Do not close this window.
</div>
<div class="card">
<h2>Provisioning Steps</h2>
<ul class="step-list" id="stepList">
<li id="step-packages">Install system packages</li>
<li id="step-sockdir">Create socket directory</li>
<li id="step-envfile">Write environment file</li>
<li id="step-service">Write systemd service</li>
<li id="step-systemd">Enable & start service</li>
<li id="step-nginx">Write nginx config</li>
<li id="step-certbot">Obtain SSL certificate</li>
<li id="step-done">Finalise & self-destruct</li>
</ul>
</div>
</div>
<div>
<div class="card">
<h2>Live Log</h2>
<div class="log-box" id="logBox"></div>
<div id="provision-result" style="margin-top:1rem;display:none"></div>
</div>
</div>
</div>
<script>
const logBox = document.getElementById('logBox');
const stepMap = {
'packages': 'step-packages',
'sockdir': 'step-sockdir',
'envfile': 'step-envfile',
'service': 'step-service',
'systemd': 'step-systemd',
'nginx': 'step-nginx',
'certbot': 'step-certbot',
'done': 'step-done',
};
function appendLog(msg, level) {
const line = document.createElement('div');
line.className = 'log-' + (level || 'info');
line.textContent = msg;
logBox.appendChild(line);
logBox.scrollTop = logBox.scrollHeight;
}
function setStep(step, state) {
const el = document.getElementById(stepMap[step]);
if (el) { el.className = state; }
}
const es = new EventSource('/log_stream');
es.addEventListener('log', function(e) {
const data = JSON.parse(e.data);
appendLog(data.msg, data.level);
});
es.addEventListener('step', function(e) {
const data = JSON.parse(e.data);
setStep(data.step, data.state);
});
es.addEventListener('done', function(e) {
const data = JSON.parse(e.data);
es.close();
const result = document.getElementById('provision-result');
result.style.display = 'block';
if (data.success) {
result.innerHTML = '<div class="alert alert-success"><strong>✓ Provisioning complete!</strong><br/>' +
data.message + '<br/><br/><em>This setup wizard will shut down in 5 seconds…</em></div>';
setTimeout(() => { window.location.href = '/done'; }, 5000);
} else {
result.innerHTML = '<div class="alert alert-error"><strong>✗ Provisioning failed</strong><br/>' +
data.message + '</div>';
}
});
es.onerror = function() {
if (es.readyState === EventSource.CLOSED) return;
appendLog('Connection lost. Reload the page to reconnect.', 'err');
};
</script>
""")
_DONE_HTML = _BASE_HTML.replace("{% block content %}{% endblock %}", """
<div style="max-width:600px;text-align:center;margin:4rem auto">
<div style="font-size:4rem;margin-bottom:1rem">🎉</div>
<h2 style="color:#86efac;font-size:1.6rem;margin-bottom:1rem">Setup Complete!</h2>
<p style="color:#94a3b8;margin-bottom:2rem">
Your Flask platform has been provisioned and the setup wizard is shutting down.<br/>
You can now access your application at:
</p>
<div class="dns-record" style="font-size:1rem;text-align:center;margin-bottom:2rem">
{{ url }}
</div>
<p style="color:#64748b;font-size:.85rem">
This page will go away once the wizard process exits.
</p>
</div>
""")
# ---------------------------------------------------------------------------
# Routes — Phase 1 (form)
# ---------------------------------------------------------------------------
@app.route("/", methods=["GET"])
def index():
cfg = session.get("cfg", {})
return render_template_string(
_FORM_HTML,
cfg=cfg,
default_workers=DEFAULT_WORKERS,
)
@app.route("/configure", methods=["POST"])
def configure():
"""Persist form data and advance to Phase 2 (DNS) or Phase 3 (IP)."""
env_keys = request.form.getlist("env_key[]")
env_vals = request.form.getlist("env_val[]")
env_vars = [(k.strip(), v.strip()) for k, v in zip(env_keys, env_vals) if k.strip()]
cfg = {
"site_name": request.form.get("site_name", "").strip(),
"deploy_mode": request.form.get("deploy_mode", "ip"),
"domain": request.form.get("domain", "").strip(),
"include_www": bool(request.form.get("include_www")),
"redirect_https": bool(request.form.get("redirect_https")),
"use_certbot": bool(request.form.get("use_certbot")),
"certbot_email": request.form.get("certbot_email", "").strip(),
"entrypoint": request.form.get("entrypoint", "app:app").strip(),
"venv_path": request.form.get("venv_path", "").strip(),
"app_dir": request.form.get("app_dir", "").strip(),
"app_user": request.form.get("app_user", "").strip(),
"app_group": request.form.get("app_group", "").strip(),
"workers": int(request.form.get("workers") or DEFAULT_WORKERS),
"sock_path": request.form.get("sock_path", "").strip(),
"http_port": int(request.form.get("http_port") or 80),
"env_vars": env_vars,
}
if not cfg["app_group"]:
cfg["app_group"] = cfg["app_user"]
session["cfg"] = cfg
if cfg["deploy_mode"] == "domain":
return redirect(url_for("dns_page"))
return redirect(url_for("provision_page"))
# ---------------------------------------------------------------------------
# Routes — Phase 2 (DNS)
# ---------------------------------------------------------------------------
@app.route("/dns", methods=["GET"])
def dns_page():
cfg = session.get("cfg", {})
if not cfg:
return redirect(url_for("index"))
server_ip = _get_public_ip()
session["server_ip"] = server_ip
ipv6 = _get_ipv6()
return render_template_string(
_DNS_HTML,
domain=cfg.get("domain", ""),
include_www=cfg.get("include_www", False),
server_ip=server_ip,
ipv6=ipv6,
)
@app.route("/verify_dns", methods=["POST"])
def verify_dns():
cfg = session.get("cfg", {})
server_ip = session.get("server_ip", _get_public_ip())
domain = cfg.get("domain", "")
results = []
all_ok = True
ok, msg = _check_dns(domain, server_ip)
results.append({"ok": ok, "msg": msg})
if not ok:
all_ok = False
if cfg.get("include_www"):
ok2, msg2 = _check_dns(f"www.{domain}", server_ip)
results.append({"ok": ok2, "msg": msg2})
if not ok2:
all_ok = False
if all_ok:
session["dns_verified"] = True
return jsonify({"ok": all_ok, "results": results})
# ---------------------------------------------------------------------------
# Routes — Phase 3 (provisioning)
# ---------------------------------------------------------------------------
@app.route("/provision", methods=["GET", "POST"])
def provision_page():
cfg = session.get("cfg", {})
if not cfg:
return redirect(url_for("index"))
if cfg.get("deploy_mode") == "domain" and not session.get("dns_verified"):
return redirect(url_for("dns_page"))
# Kick off provisioning in background thread (only once)
if not _provisioning_done.is_set():
t = threading.Thread(target=_run_provisioning, args=(dict(cfg),), daemon=True)
t.start()
return render_template_string(_PROVISION_HTML)
@app.route("/log_stream")
def log_stream():
"""SSE endpoint streaming provisioning log messages."""
def generate():
while not _provisioning_done.is_set():
try:
item = _log_queue.get(timeout=1)
if item.get("__step__"):
yield f"event: step\ndata: {json.dumps(item)}\n\n"
elif item.get("__done__"):
yield f"event: done\ndata: {json.dumps(item)}\n\n"
return
else:
yield f"event: log\ndata: {json.dumps(item)}\n\n"
except Empty:
yield ": heartbeat\n\n"
# Drain remaining messages
while True:
try:
item = _log_queue.get_nowait()
if item.get("__step__"):
yield f"event: step\ndata: {json.dumps(item)}\n\n"
elif item.get("__done__"):
yield f"event: done\ndata: {json.dumps(item)}\n\n"
return
else:
yield f"event: log\ndata: {json.dumps(item)}\n\n"
except Empty:
break
return Response(generate(), mimetype="text/event-stream",
headers={"Cache-Control": "no-cache", "X-Accel-Buffering": "no"})
@app.route("/done")
def done_page():
cfg = session.get("cfg", {})
if cfg.get("deploy_mode") == "domain" and cfg.get("domain"):
scheme = "https" if cfg.get("use_certbot") or cfg.get("redirect_https") else "http"
url = f"{scheme}://{cfg['domain']}"
else:
url = f"http://<your-server-ip>"
resp = render_template_string(_DONE_HTML, url=url)
# Schedule shutdown after response is sent
threading.Timer(2.0, _shutdown).start()
return resp
# ---------------------------------------------------------------------------
# Provisioning logic
# ---------------------------------------------------------------------------
def _step(step: str, state: str) -> None:
if _non_interactive:
if state == "active":
print(f"\n[STEP] {step} ...", flush=True)
elif state == "done":
print(f"[STEP] {step} done.", flush=True)
elif state == "fail":
print(f"[STEP] {step} FAILED.", flush=True)
else:
_log_queue.put({"__step__": True, "step": step, "state": state})
def _run_provisioning(cfg: dict) -> None:
"""Execute all provisioning steps sequentially."""
name = cfg["site_name"]
user = cfg["app_user"]
group = cfg["app_group"]
venv = cfg["venv_path"]
app_dir = cfg["app_dir"]
workers = cfg["workers"]
sock = cfg["sock_path"]
entry = cfg["entrypoint"]
env_vars = cfg.get("env_vars", [])
domain = cfg.get("domain", "")
include_www = cfg.get("include_www", False)
redirect_https = cfg.get("redirect_https", False)
use_certbot = cfg.get("use_certbot", False)
certbot_email = cfg.get("certbot_email", "")
deploy_mode = cfg.get("deploy_mode", "ip")
http_port = cfg.get("http_port", 80)
try:
# ------------------------------------------------------------------
# Step 1: System packages
# ------------------------------------------------------------------
_step("packages", "active")
_log("=== Installing system packages ===", "head")
packages = ["nginx", "python3-pip", "gunicorn"]
if use_certbot:
packages += ["certbot", "python3-certbot-nginx"]
_run(["apt-get", "update", "-qq"])
_run(["apt-get", "install", "-y"] + packages)
_step("packages", "done")
# ------------------------------------------------------------------
# Step 2: Socket directory
# ------------------------------------------------------------------