Skip to content

INSTALL.md

Latest commit

 

History

History
194 lines (140 loc) · 7.99 KB

INSTALL.md

File metadata and controls

194 lines (140 loc) · 7.99 KB
Raw

Panduan Instalasi KusumaVision NMS

Dokumen ini adalah titik awal instalasi. Ikuti 3 langkah: (1) pilih jalur yang cocok untuk Anda, (2) pastikan spek minimum terpenuhi, (3) ikuti langkah jalur pilihan. Setiap jalur menaut ke panduan detailnya.

Ingin memasang aplikasi Android (APK)? Itu terpisah dari server — lihat docs/BUILD_APK.md.

1. Pilih jalur instalasi

Ada 3 jalur. Pilih satu sesuai kondisi Anda:

Kondisi Anda Jalur Ringkas
Pakai Windows / macOS, atau ingin pasang lengkap di 1 PC untuk dibagikan ke banyak lokasi (seperti NetNumen) A — Docker appliance Install Docker Desktop → start.bat / ./start.sh → buka http://localhost:8080
Punya server / VPS Ubuntu kosong (22.04 / 24.04) dan mau produksi permanen B — install.sh sudo bash install.sh — pasang semuanya otomatis dalam 1 perintah
Developer yang butuh kontrol penuh / ngoprek kode C — Manual (dev) Ikuti langkah manual di handbook

Bingung? Aturan sederhana:

  • Windows/macOS atau mau cepat & portable → Jalur A (Docker).
  • Server Linux untuk produksi → Jalur B (install.sh).
  • Ngoprek/kembangkan kode → Jalur C (manual).

2. Minimum spek

Sesuaikan dengan jalur yang Anda pilih. Angka "minimum" = bisa jalan; "disarankan" = nyaman untuk puluhan OLT + banyak ONU.

2a. Menjalankan aplikasi web

Sumber daya Minimum Disarankan Catatan
CPU 2 core 4 core Poller SNMP + worker antrean
RAM 2 GB (Docker: 4 GB) 4–8 GB PostgreSQL + Redis + PHP-FPM + Go poller + worker
Disk 15 GB 25 GB+ OS + runtime + DB (tumbuh mengikuti jumlah OLT/ONU & log)
OS Ubuntu 22.04/24.04 (Jalur B) · Windows 10/11 / macOS / Linux + Docker (Jalur A) — —
Jaringan Bisa menjangkau OLT: SNMP UDP/161 + Telnet TCP/23 — Server & OLT idealnya satu jaringan/VPN

Skala kasar: ~2 GB RAM cukup untuk belasan OLT. Untuk 30+ OLT dengan polling rapat + banyak ONU, naikkan ke 4–8 GB RAM dan 4 core.

2b. Membangun (build) APK Android

Build APK berat (butuh Flutter + Android SDK + JDK). Detail & langkah: BUILD_APK.md. Ringkasnya:

Sumber daya Minimum Disarankan
RAM 8 GB (di bawah ini Gradle swap-thrash) 16 GB
Disk kosong 15 GB (toolchain ~5,4 GB + cache Gradle + output) 20 GB+
CPU 2 core 4 core+

Penting: membangun APK tidak wajib. Kalau hanya ingin memakai aplikasi Android, cukup unduh APK jadi yang sudah dibuild (lihat BUILD_APK.md §Install di HP). Build sendiri hanya perlu jika Anda mengubah kode aplikasi mobile.

3. Jalur A — Docker appliance (Windows / macOS / Linux)

Seluruh stack (web, PostgreSQL, Redis, poller Go, worker, scheduler, telnet-proxy) berjalan sebagai container. Data tersimpan permanen di volume. Paling mudah & portabel.

  1. Pasang Docker
    • Windows / macOS: Docker Desktop (pastikan status Running).
      • Windows perlu WSL 2 aktif (virtualisasi ON di BIOS + wsl --update).
    • Linux: Docker Engine + plugin compose (docker compose version harus jalan).
  2. Ambil folder proyek (git clone atau salin dari flashdisk).
  3. Jalankan:
    • Windows: double-click start.bat.
    • Linux / macOS: ./start.sh
    • Manual (semua OS): 
      cp .env.docker.example .env      # sekali; edit DB_PASSWORD & ADMIN_* (lihat DOCKER.md §4)
docker compose up -d --build     # pertama kali agak lama
  4. Buka http://localhost:8080. Login pakai admin yang diisi di .env (atau buat manual, lihat §5).

📖 Panduan lengkap (backup, update, distribusi image prebuilt tanpa source, troubleshooting Windows CRLF/WSL): docs/DOCKER.md.

4. Jalur B — install.sh (server Ubuntu kosong)

Satu perintah memasang seluruh runtime (PHP 8.3, Composer, Node 22, PostgreSQL, Redis, Nginx, Supervisor, Go, Net-SNMP), membuat database + .env, build frontend & Go poller, migrasi, lalu mendaftarkan daemon Supervisor + Nginx site, dan opsional membuat akun admin.

cd /var/www
sudo mkdir -p KusumaVisionNMS
sudo chown "$USER:$USER" KusumaVisionNMS
git clone https://github.com/Masamune21-dev/KusumaVisionNMS.git KusumaVisionNMS
cd KusumaVisionNMS

sudo bash install.sh                 # interaktif — ditanya APP_URL, DB, akun admin

Atau non-interaktif (isi via environment variable):

sudo APP_URL=http://nms.example.com \
     ADMIN_EMAIL=admin@bmkv.net ADMIN_PASSWORD='GANTI_DENGAN_PASSWORD_KUAT' \
     ENABLE_UFW=1 bash install.sh --yes
  • Skrip aman dijalankan ulang (idempotent). Opsi lain: sudo bash install.sh --help.
  • Verifikasi kapan saja: bash scripts/check-requirements.sh.
  • Di akhir, skrip mencetak password database yang digenerate — simpan.

📖 Detail tiap langkah + gotcha config cache: handbook 04 — Instalasi & Deploy. Hardening OS/Nginx/UFW/SSH: LOCAL_PRODUCTION_HARDENING.md.

5. Jalur C — Manual (dev / kontrol penuh)

Untuk lingkungan pengembangan atau bila ingin memahami tiap langkah. Ringkas:

# 1. Dependensi
composer install
npm install

# 2. Environment
cp .env.example .env
php artisan key:generate

# 3. Sesuaikan .env (DB PostgreSQL, Redis) — lihat handbook 04

# 4. Database
php artisan migrate

# 5. Buat admin (registrasi publik dimatikan)
php artisan user:create --name="Admin" --email=admin@example.com --password=rahasia

# 6. Jalankan (semua sekaligus)
composer dev            # serve + queue + logs + vite

📖 Langkah lengkap (Supervisor, Nginx, telnet-proxy, harden ke production): handbook 04.

6. Setelah instalasi (semua jalur)

  • Buat/masuk admin. Jika belum punya akun (Jalur A/B tanpa ADMIN_*), buat:
    • Docker: docker compose exec app php artisan user:create --name="Admin" --email=admin@bmkv.net --password=passwordkuat
    • Ubuntu/manual: php artisan user:create --name="Admin" --email=admin@bmkv.net --password=passwordkuat
  • Cek sehat. bash scripts/check-requirements.sh (Jalur B/C) atau docker compose ps (Jalur A).
  • Tambah OLT pertama. Login → menu SmartOLT → tambah OLT → Test SNMP.
  • Opsional: notifikasi Telegram, ACS/TR069, token API, push FCM mobile — semua dari menu Pengaturan (admin). Lihat README.md.

7. Aplikasi Android (APK)

Aplikasi Android mengonsumsi REST API v1 server ini, jadi server harus jalan lebih dulu dan API v1 diaktifkan (Pengaturan → API & Token). Dua pilihan:

  • Cuma mau pakai → unduh APK jadi dan sideload ke HP. Lihat BUILD_APK.md → Install di HP.
  • Mau build sendiri (setelah ubah kode mobile) → ikuti BUILD_APK.md (install toolchain Flutter/SDK/JDK di Linux atau Windows + spek + signing).

8. Troubleshooting cepat

Gejala Lihat
Docker: port bentrok / container restart / CRLF di Windows DOCKER.md §9
Site 500 setelah ubah .env/config handbook 04 — Gotcha config cache
Polling tak jalan / data tak ter-refresh Pastikan daemon queue/scheduler aktif (handbook 13)
Build APK gagal (RAM/Gradle/lisensi) BUILD_APK.md §Troubleshooting
Cek requirement kurang apa bash scripts/check-requirements.sh

Referensi