Runbook persediaan DNS & TLS
Keperluan domain
Yabanin memerlukan 3 subdomain untuk pelaksanaan pengeluaran (semuanya dengan TLS yang diurus oleh Caddy):
| Subdomain | Tujuan | Perkhidmatan | Port |
|---|---|---|---|
api.yourdomain.com | Gerbang — API serasi OpenAI | gateway | 8082 → Caddy → 443 |
admin.yourdomain.com | Panel pentadbir dan UI pengebilan | admin | 8086 → Caddy → 443 |
dash.yourdomain.com | Papan pemuka kos (SPA React) | dashboard-web | nginx → Caddy → 443 |
Rekod DNS
Daripada pendaftar domain anda, tambah tiga rekod A yang menunjuk kepada IP VPS:
Type Name Value TTL
A api <VPS_IP> 300
A admin <VPS_IP> 300
A dash <VPS_IP> 300
Gantikan <VPS_IP> dengan alamat IP awam VPS anda yang sebenar.
TLS / SSL
Caddy (melalui deploy/caddy/Caddyfile.tmpl) mengendalikan HTTPS automatik melalui Let's Encrypt. Pengurusan sijil secara manual tidak diperlukan — sebaik sahaja DNS diselesaikan, Caddy memperuntukkan sijil secara automatik.
Gerbang juga menerima domainnya melalui pembolehubah persekitaran:
API_DOMAIN→ lalai kepadaapi.yourdomain.comADMIN_DOMAIN→ lalai kepadaadmin.yourdomain.comDASHBOARD_DOMAIN→ lalai kepadadash.yourdomain.com
Gantikan lalai ini dengan menetapkan pembolehubah env dalam .env (disalin ke deploy/secrets/env) sebelum pelaksanaan:
# deploy/secrets/env
API_DOMAIN=api.example.com
ADMIN_DOMAIN=admin.example.com
DASHBOARD_DOMAIN=dash.example.com
Urutan pelaksanaan
- Beli domain dan catatkan alamat IP VPS anda
- Tambah rekod A DNS (3 subdomain → IP VPS)
- Sunting
deploy/secrets/envdengan domain anda yang sebenar - Jalankan pelaksanaan:
./scripts/deploy.sh - Sahkan semakan kesihatan — skrip menyemak semua perkhidmatan secara automatik
# After deploy, verify:
curl -sI https://api.yourdomain.com/v1/chat/completions | head -1
# Expected: HTTP/2 401 (unauthorized — API is up, no valid key)
Penyelesaian masalah
Caddy tidak memperoleh sijil
- Pastikan rekod DNS tersebar (
dig api.yourdomain.com) - Semak log Caddy:
docker compose logs caddy - Sahkan port 80/443 terbuka pada tembok api VPS
- Let's Encrypt mempunyai had kadar — jangan banjiri permintaan
Gerbang tidak dapat mencapai domain
- Semak pembolehubah env gerbang dalam
.env(API_DOMAIN, ADMIN_DOMAIN) - Sahkan blok domain Caddyfile.tmpl sepadan dengan rekod DNS anda