Instalasi dan Konfigurasi Awal

config/config.yaml adalah inti konfigurasi Deep Eye: daftar ai_providers, parameter scanner, dan preset vulnerability_scanner dibaca dari berkas itu. Repository ini tidak punya tahap build; instalasi berarti menyiapkan virtual environment .deep-venv, memasang requirements.txt, lalu menghasilkan satu berkas konfigurasi. Halaman ini hanya membahas pembentukan dan pembacaan berkas tersebut. Pemakaian flag sehari-hari ada di Antarmuka CLI.

Siklus status konfigurasi

Skrip installer menyalin template hanya bila config/config.yaml belum ada, sehingga berkas lama tidak tertimpa (scripts/install.sh:60-69¹). Wizard onboard menulis berkas yang sama dari nol lewat write_config (utils/onboard.py:279-286²). ConfigLoader adalah jalur terakhir: berkas yang tidak ditemukan menghasilkan konfigurasi bawaan (utils/config_loader.py:18-47³).

stateDiagram-v2
    [*] --> TanpaConfig
    TanpaConfig --> DariTemplate: installer menyalin config.example.yaml
    TanpaConfig --> ConfigLama: config.yaml sudah ada
    DariTemplate --> Wizard: python deep_eye.py --setup
    DariTemplate --> Dimuat: deep_eye.py -c config/config.yaml
    ConfigLama --> Wizard: --setup-force menimpa
    ConfigLama --> Dimuat
    Wizard --> Ditulis: write_config menulis YAML baru
    Ditulis --> Dimuat
    Dimuat --> SiapScan: validate_config lolos
    Dimuat --> DefaultBawaan: berkas hilang atau YAML gagal di-parse
    DefaultBawaan --> SiapScan
    SiapScan --> [*]
    style TanpaConfig fill:#f59e0b,color:#000
    style DariTemplate fill:#f59e0b,color:#000
    style ConfigLama fill:#f59e0b,color:#000
    style Wizard fill:#f59e0b,color:#000
    style Ditulis fill:#2d7d46,color:#fff
    style SiapScan fill:#2d7d46,color:#fff
    style Dimuat fill:#8b5cf6,color:#fff
    style DefaultBawaan fill:#dc2626,color:#fff
%% fig: Siklus status config/config.yaml
%% desc: Berkas konfigurasi lahir dari installer atau wizard, dibaca ConfigLoader, dan berakhir pada konfigurasi bawaan bila berkas hilang atau rusak.

Dua percabangan menentukan status akhir diagram di atas. Opsi --setup dan --setup-force menjalankan run_onboard lalu langsung return 0, sehingga tidak ada scan yang dimulai (deep_eye.py:252-255⁴). Tanpa opsi itu, berkas yang tidak ada memicu wizard, sedangkan berkas yang ada dibaca lewat ConfigLoader.load (deep_eye.py:257-264⁵).

Skrip installer

scripts/install.sh dipakai di Linux/macOS dan scripts/install.ps1 di Windows. Keduanya menjalankan urutan yang sama dengan perintah berbeda.

⚠️ Berkas hasil salinan belum bisa dipakai scan apa adanya. Blok openai masih berisi api_key: "sk-your-openai-api-key-here" dengan enabled: true (config/config.example.yaml:6-8¹⁵). API key tersimpan plaintext di config/config.yaml, jadi batasi izin berkas itu dengan chmod 600 (SECURITY.md:29-34¹⁶).

Template config/config.example.yaml

Template ini adalah referensi lengkap, sementara wizard hanya menulis sebagian kunci. Baris pembukanya memang menginstruksikan penyalinan manual ke config.yaml (config/config.example.yaml:1-2¹⁷).

Arti tiap kunci enabled_checks dijelaskan di Pemindai Kerentanan dan Katalog Modul, sedangkan bentuk entri provider dibahas di Lapisan AI Provider.

Wizard onboard

Wizard dijalankan dengan python deep_eye.py --setup, dan --setup-force menimpa berkas yang sudah ada tanpa konfirmasi tambahan (deep_eye.py:145-155²²). Bila config_path sudah ada dan force tidak diberikan, run_onboard menanyakan konfirmasi; penolakan membuat berkas lama dipakai apa adanya lewat yaml.safe_load (utils/onboard.py:171-181²³).

run_onboard memanggil enam fungsi wizard secara berurutan (utils/onboard.py:192-198²⁴), lalu merakit satu dict yang memuat ai_providers, scanner, vulnerability_scanner, reporting, logging, rate_limiting, database, oast, experimental, dan mobile (utils/onboard.py:200-251²⁵).

API key yang dibiarkan kosong tidak menggagalkan wizard: nilainya diganti placeholder your-<provider>-api-key-here dan harus disunting sesudahnya (utils/onboard.py:341-352³²). Setelah write_config, _print_summary menampilkan ringkasan provider, target, threads, jumlah checks, format laporan, dan perintah untuk menjalankan ulang wizard (utils/onboard.py:475-487³³). docs/QUICKSTART.md merangkum urutan yang sama dan menegaskan wizard berjalan otomatis ketika config/config.yaml hilang (docs/QUICKSTART.md:30-36³⁴).

Pilihan format laporan pada langkah 4 hanya menetapkan nilai awal. Daftar format yang benar-benar dipakai saat ekspor dibahas di Pelaporan dan Ekspor.

Membaca konfigurasi dan substitusi environment variable

ConfigLoader.load membaca YAML dengan yaml.safe_load, mengganti variabel environment, lalu mencatat Configuration loaded from <path>. Berkas yang tidak ada hanya menghasilkan logger.warning dan konfigurasi bawaan, dan kegagalan parse juga ditangkap lalu diganti konfigurasi bawaan (utils/config_loader.py:18-47³).

Substitusi bekerja rekursif pada string, dict, dan list, dengan pola ${NAMA_VAR} dan ${NAMA_VAR:-default} (utils/config_loader.py:49-66³⁵). Artinya nilai rahasia bisa disimpan di environment dan config/config.yaml hanya memuat rujukannya.

⚠️ Fallback bawaan tidak setara dengan template. Konfigurasi bawaan hanya memuat satu entri ai_providers.openai dengan enabled: False, scanner.default_threads: 5, default_depth: 2, sepuluh enabled_checks, dan reporting.default_format: html (utils/config_loader.py:69-111³⁶). Scan dengan konfigurasi ini tidak memakai AI provider apa pun, jadi periksa kembali hasil wizard sebelum menjalankan target nyata.