# yaml-language-server: $schema=https://schema.zeabur.app/template.json
apiVersion: zeabur.com/v1
kind: Template
metadata:
    name: WatchYourLAN
spec:
    description: |
        WatchYourLAN is a lightweight network IP scanner with a web GUI. It uses ARP scanning to detect devices on your local network, keeps a history of discovered hosts, and sends notifications when new devices appear.
    coverImage: https://avatars.githubusercontent.com/u/47522788
    icon: https://avatars.githubusercontent.com/u/47522788
    variables:
        - key: PUBLIC_DOMAIN
          type: DOMAIN
          name: Domain
          description: The domain to access WatchYourLAN
    tags:
        - Tool
        - Monitoring
    readme: |
        # WatchYourLAN

        A lightweight network IP scanner with a web GUI. Detects devices via ARP scanning, keeps discovery history, and sends alerts for new hosts.

        > **Note**: ARP-based network scanning requires host network mode, which is not available in containerized cloud environments. The web UI and history features will function, but live scanning of your local network requires running on bare metal or a VM with host networking.

        ## What You Can Do After Deployment

        1. **Visit your domain** — open the web dashboard to view scanned hosts
        2. **Configure network interfaces** — set the `IFACES` environment variable to your target interfaces
        3. **Adjust scan interval** — change `TIMEOUT` to control how often scans run (default: 120 seconds)
        4. **Switch themes** — set `THEME` to any Bootstrap theme name and `COLOR` to light or dark
        5. **Enable notifications** — configure `SHOUTRRR_URL` for alerts when new devices are found
        6. **Export metrics** — enable Prometheus or InfluxDB export for monitoring dashboards

        ## Key Features

        - ARP-based network scanning
        - Web GUI with device history
        - Configurable scan intervals
        - New device notifications via Shoutrrr
        - Prometheus and InfluxDB metrics export
        - Light and dark themes
        - SQLite storage (no external database needed)

        ## License

        MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    services:
        - name: watchyourlan
          icon: https://avatars.githubusercontent.com/u/47522788
          template: PREBUILT_V2
          spec:
            source:
                image: aceberg/watchyourlan:2.1.4
            ports:
                - id: web
                  port: 8840
                  type: HTTP
            volumes:
                - id: wyl-data
                  dir: /data/WatchYourLAN
            env:
                COLOR:
                    default: dark
                IFACES:
                    default: eth0
                LOG_LEVEL:
                    default: info
                THEME:
                    default: sand
                TIMEOUT:
                    default: "120"
                TZ:
                    default: UTC
          domainKey: PUBLIC_DOMAIN
localization:
    es-ES:
        description: |
            WatchYourLAN es un escaner de IP de red ligero con interfaz web. Usa escaneo ARP para detectar dispositivos en la red local, mantiene historial y envia notificaciones de nuevos dispositivos.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: Dominio
              description: El dominio para acceder a WatchYourLAN
        readme: |
            # WatchYourLAN

            Escaner de IP de red ligero con interfaz web. Detecta dispositivos mediante ARP y mantiene historial de descubrimiento.

            > **Nota**: El escaneo ARP requiere modo de red host, no disponible en entornos cloud containerizados.

            ## Que puedes hacer despues del despliegue

            1. **Visita tu dominio** — visualiza los hosts escaneados
            2. **Configura interfaces de red** — ajusta la variable `IFACES`
            3. **Ajusta el intervalo de escaneo** — modifica `TIMEOUT`
            4. **Activa notificaciones** — configura `SHOUTRRR_URL`

            ## Licencia

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    id-ID:
        description: |
            WatchYourLAN adalah pemindai IP jaringan ringan dengan antarmuka web. Menggunakan pemindaian ARP untuk mendeteksi perangkat di jaringan lokal, menyimpan riwayat, dan mengirim notifikasi saat perangkat baru ditemukan.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: Domain
              description: Domain untuk mengakses WatchYourLAN
        readme: |
            # WatchYourLAN

            Pemindai IP jaringan ringan dengan antarmuka web. Mendeteksi perangkat melalui pemindaian ARP dan menyimpan riwayat penemuan.

            > **Catatan**: Pemindaian ARP memerlukan mode jaringan host yang tidak tersedia di lingkungan cloud terkontainerisasi.

            ## Apa yang bisa dilakukan setelah deploy

            1. **Buka domain** — lihat host yang dipindai
            2. **Konfigurasi antarmuka jaringan** — atur variabel `IFACES`
            3. **Sesuaikan interval pemindaian** — ubah `TIMEOUT`
            4. **Aktifkan notifikasi** — konfigurasi `SHOUTRRR_URL`

            ## Lisensi

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    ja-JP:
        description: |
            WatchYourLAN は軽量なネットワーク IP スキャナーで、Web GUI を備えています。ARP スキャンでローカルネットワーク上のデバイスを検出し、履歴を保存し、新しいデバイスが見つかった際に通知を送信します。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: ドメイン
              description: WatchYourLAN にアクセスするためのドメイン
        readme: |
            # WatchYourLAN

            軽量なネットワーク IP スキャナー。ARP スキャンでデバイスを検出し、履歴を保存、新規ホスト検出時に通知を送信。

            > **注意**: ARP ネットワークスキャンにはホストネットワークモードが必要で、コンテナ化されたクラウド環境では利用できません。

            ## デプロイ後にできること

            1. **ドメインにアクセス** — スキャンされたホストを表示
            2. **ネットワークインターフェースを設定** — `IFACES` 環境変数を調整
            3. **スキャン間隔を調整** — `TIMEOUT` でスキャン頻度を制御
            4. **通知を有効化** — `SHOUTRRR_URL` で新デバイスアラートを受信
            5. **メトリクスをエクスポート** — Prometheus または InfluxDB エクスポートを有効化

            ## ライセンス

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    ko-KR:
        description: |
            WatchYourLAN은 웹 GUI가 포함된 경량 네트워크 IP 스캐너입니다. ARP 스캔으로 로컬 네트워크의 장치를 감지하고, 발견 이력을 저장하며, 새 장치 발견 시 알림을 보냅니다.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 도메인
              description: WatchYourLAN에 접속할 도메인
        readme: |
            # WatchYourLAN

            웹 GUI가 포함된 경량 네트워크 IP 스캐너. ARP 스캔으로 장치를 감지하고 이력을 저장합니다.

            > **참고**: ARP 네트워크 스캔은 호스트 네트워크 모드가 필요하며, 컨테이너화된 클라우드 환경에서는 사용할 수 없습니다.

            ## 배포 후 할 수 있는 것

            1. **도메인 접속** — 스캔된 호스트 확인
            2. **네트워크 인터페이스 설정** — `IFACES` 환경 변수 조정
            3. **스캔 간격 조정** — `TIMEOUT`으로 스캔 빈도 제어
            4. **알림 활성화** — `SHOUTRRR_URL`로 새 장치 알림 수신

            ## 라이선스

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    th-TH:
        description: |
            WatchYourLAN เป็นเครื่องมือสแกน IP เครือข่ายน้ำหนักเบาพร้อมหน้าเว็บ ใช้การสแกน ARP เพื่อตรวจจับอุปกรณ์ในเครือข่ายท้องถิ่น เก็บประวัติ และส่งการแจ้งเตือนเมื่อพบอุปกรณ์ใหม่
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: โดเมน
              description: โดเมนสำหรับเข้าถึง WatchYourLAN
        readme: |
            # WatchYourLAN

            เครื่องมือสแกน IP เครือข่ายน้ำหนักเบาพร้อมหน้าเว็บ ตรวจจับอุปกรณ์ผ่านการสแกน ARP และเก็บประวัติการค้นพบ

            > **หมายเหตุ**: การสแกน ARP ต้องใช้โหมดเครือข่าย host ซึ่งไม่สามารถใช้ได้ในสภาพแวดล้อมคลาวด์แบบคอนเทนเนอร์

            ## สิ่งที่ทำได้หลังจากติดตั้ง

            1. **เข้าสู่โดเมน** — ดูโฮสต์ที่สแกนได้
            2. **ตั้งค่าอินเทอร์เฟซเครือข่าย** — ปรับตัวแปร `IFACES`
            3. **ปรับช่วงเวลาสแกน** — เปลี่ยน `TIMEOUT`
            4. **เปิดใช้การแจ้งเตือน** — ตั้งค่า `SHOUTRRR_URL`

            ## สัญญาอนุญาต

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    zh-CN:
        description: |
            WatchYourLAN 是轻量级的网络 IP 扫描器，带有 Web 界面。使用 ARP 扫描检测局域网设备，保存发现记录，并在检测到新设备时发送通知。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 域名
              description: 访问 WatchYourLAN 的域名
        readme: |
            # WatchYourLAN

            轻量级的网络 IP 扫描器，带有 Web 界面。通过 ARP 扫描检测设备、保存发现记录，并在新主机出现时发送通知。

            > **注意**：ARP 网络扫描需要 host 网络模式，在容器化云端环境中不可用。Web 界面和历史记录功能可正常使用，但实时扫描局域网需要在裸机或具有 host 网络的虚拟机上运行。

            ## 部署后可以做什么

            1. **打开域名** — 查看扫描到的主机
            2. **配置网络接口** — 调整 `IFACES` 环境变量
            3. **调整扫描间隔** — 修改 `TIMEOUT` 控制扫描频率
            4. **启用通知** — 配置 `SHOUTRRR_URL` 接收新设备警报
            5. **导出指标** — 启用 Prometheus 或 InfluxDB 导出

            ## 许可证

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)
    zh-TW:
        description: |
            WatchYourLAN 是輕量級的網路 IP 掃描器，附帶網頁介面。使用 ARP 掃描偵測區域網路上的裝置，保存發現記錄，並在偵測到新裝置時發送通知。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 網域
              description: 存取 WatchYourLAN 的網域
        readme: |
            # WatchYourLAN

            輕量級的網路 IP 掃描器，附帶網頁介面。透過 ARP 掃描偵測裝置、保存發現記錄，並在新主機出現時發送通知。

            > **注意**：ARP 網路掃描需要 host 網路模式，在容器化雲端環境中無法使用。網頁介面和歷史記錄功能可正常運作，但即時掃描區域網路需要在裸機或具有 host 網路的虛擬機上執行。

            ## 部署後可以做什麼

            1. **開啟網域** — 檢視掃描到的主機
            2. **設定網路介面** — 調整 `IFACES` 環境變數
            3. **調整掃描間隔** — 修改 `TIMEOUT` 控制掃描頻率
            4. **切換主題** — 設定 `THEME` 和 `COLOR`
            5. **啟用通知** — 設定 `SHOUTRRR_URL` 接收新裝置警報
            6. **匯出指標** — 啟用 Prometheus 或 InfluxDB 匯出

            ## 授權

            MIT — [GitHub](https://github.com/aceberg/WatchYourLAN)