# yaml-language-server: $schema=https://schema.zeabur.app/template.json
apiVersion: zeabur.com/v1
kind: Template
metadata:
    name: NetAlertX
spec:
    description: |
        NetAlertX is a network device scanner and alert system. It monitors your local network for new or disconnected devices, tracks IP and MAC addresses, and sends notifications via email, webhooks, and other channels.
    coverImage: https://avatars.githubusercontent.com/u/163520720
    icon: https://avatars.githubusercontent.com/u/163520720
    variables:
        - key: PUBLIC_DOMAIN
          type: DOMAIN
          name: Domain
          description: The domain to access NetAlertX
    tags:
        - Tool
        - Monitoring
    readme: |
        # NetAlertX

        A network device scanner and alert system. Monitors your local network for new or disconnected devices, tracks IP and MAC addresses, and sends customizable notifications.

        > **Note**: Network device scanning requires host network mode for ARP/ping scanning, which is not available in containerized cloud environments. The web UI, device management, 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 dashboard to view detected devices
        2. **Configure scanning** — set up network scanning parameters in the settings page
        3. **Set up notifications** — configure email, webhook, Pushover, NTFY, or other notification channels
        4. **Review device history** — track when devices connect and disconnect from your network
        5. **Manage devices** — assign names, groups, and notes to discovered devices
        6. **Use the API** — access device data programmatically via the built-in REST API

        ## Key Features

        - Network device discovery via ARP, ping, and other methods
        - New device and disconnection alerts
        - Multi-channel notifications (email, webhook, Pushover, NTFY, and more)
        - Device history and presence tracking
        - Web-based dashboard with search and filtering
        - REST API for programmatic access
        - SQLite storage (no external database needed)

        ## License

        GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
    services:
        - name: netalertx
          icon: https://avatars.githubusercontent.com/u/163520720
          template: PREBUILT_V2
          spec:
            source:
                image: ghcr.io/netalertx/netalertx:26.3.15
            ports:
                - id: web
                  port: 20211
                  type: HTTP
            volumes:
                - id: netalertx-config
                  dir: /app/config
                - id: netalertx-db
                  dir: /app/db
            env:
                PORT:
                    default: "20211"
                TZ:
                    default: UTC
          domainKey: PUBLIC_DOMAIN
localization:
    es-ES:
        description: |
            NetAlertX es un escaner de dispositivos de red y sistema de alertas. Monitorea dispositivos nuevos o desconectados en la red local, rastrea direcciones IP y MAC, y envia notificaciones.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: Dominio
              description: El dominio para acceder a NetAlertX
        readme: |
            # NetAlertX

            Escaner de dispositivos de red y sistema de alertas. Monitorea dispositivos nuevos o desconectados y envia notificaciones personalizables.

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

            ## Que puedes hacer despues del despliegue

            1. **Visita tu dominio** — visualiza los dispositivos detectados
            2. **Configura el escaneo** — ajusta los parametros de escaneo de red
            3. **Configura notificaciones** — configura Email, Webhook y otros canales
            4. **Revisa el historial** — rastrea conexiones y desconexiones de dispositivos

            ## Licencia

            GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
    id-ID:
        description: |
            NetAlertX adalah pemindai perangkat jaringan dan sistem peringatan. Memantau perangkat baru atau terputus di jaringan lokal, melacak alamat IP dan MAC, serta mengirim notifikasi.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: Domain
              description: Domain untuk mengakses NetAlertX
        readme: |
            # NetAlertX

            Pemindai perangkat jaringan dan sistem peringatan. Memantau perangkat baru atau terputus dan mengirim notifikasi yang dapat dikustomisasi.

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

            ## Apa yang bisa dilakukan setelah deploy

            1. **Buka domain** — lihat perangkat yang terdeteksi
            2. **Konfigurasi pemindaian** — atur parameter pemindaian jaringan
            3. **Atur notifikasi** — konfigurasi Email, Webhook, dan saluran lainnya
            4. **Tinjau riwayat** — lacak koneksi dan pemutusan perangkat

            ## Lisensi

            GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
    ja-JP:
        description: |
            NetAlertX はネットワークデバイススキャナーとアラートシステムです。ローカルネットワーク上の新規・切断デバイスを監視し、IP・MAC アドレスを追跡して通知を送信します。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: ドメイン
              description: NetAlertX にアクセスするためのドメイン
        readme: |
            # NetAlertX

            ネットワークデバイススキャナーとアラートシステム。新規・切断デバイスを監視し、カスタマイズ可能な通知を送信。

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

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

            1. **ドメインにアクセス** — 検出されたデバイスを表示
            2. **スキャンを設定** — ネットワークスキャンパラメータを構成
            3. **通知を設定** — Email、Webhook などの通知チャネルを構成
            4. **デバイス履歴を確認** — 接続・切断の記録を追跡
            5. **デバイスを管理** — 名前やグループを割り当て

            ## ライセンス

            GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
    ko-KR:
        description: |
            NetAlertX는 네트워크 장치 스캐너 및 알림 시스템입니다. 로컬 네트워크에서 새로운 또는 연결이 끊긴 장치를 모니터링하고, IP 및 MAC 주소를 추적하며 알림을 보냅니다.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 도메인
              description: NetAlertX에 접속할 도메인
        readme: |
            # NetAlertX

            네트워크 장치 스캐너 및 알림 시스템. 새로운 또는 연결이 끊긴 장치를 모니터링하고 맞춤 알림을 보냅니다.

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

            ## 배포 후 할 수 있는 것

            1. **도메인 접속** — 감지된 장치 확인
            2. **스캔 설정** — 네트워크 스캔 매개변수 구성
            3. **알림 설정** — Email, Webhook 등 알림 채널 구성
            4. **장치 이력 확인** — 연결/해제 기록 추적

            ## 라이선스

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

            เครื่องมือสแกนอุปกรณ์เครือข่ายและระบบแจ้งเตือน ตรวจสอบอุปกรณ์ใหม่หรือที่ถูกตัดการเชื่อมต่อและส่งการแจ้งเตือนที่ปรับแต่งได้

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

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

            1. **เข้าสู่โดเมน** — ดูอุปกรณ์ที่ตรวจพบ
            2. **ตั้งค่าการสแกน** — กำหนดพารามิเตอร์การสแกนเครือข่าย
            3. **ตั้งค่าการแจ้งเตือน** — กำหนด Email, Webhook และช่องทางอื่น ๆ
            4. **ตรวจสอบประวัติ** — ติดตามการเชื่อมต่อและการตัดการเชื่อมต่อ

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

            GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
    zh-CN:
        description: |
            NetAlertX 是网络设备扫描与警报系统。监控局域网上的新设备或断线设备，追踪 IP 和 MAC 地址，并通过多种渠道发送通知。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 域名
              description: 访问 NetAlertX 的域名
        readme: |
            # NetAlertX

            网络设备扫描与警报系统。监控局域网的新设备或断线设备，追踪 IP 和 MAC 地址，并发送自定义通知。

            > **注意**：网络设备扫描需要 host 网络模式进行 ARP/ping 扫描，在容器化云端环境中不可用。Web 界面、设备管理和历史记录功能可正常使用。

            ## 部署后可以做什么

            1. **打开域名** — 查看检测到的设备
            2. **配置扫描** — 在设置页面配置网络扫描参数
            3. **设置通知** — 配置 Email、Webhook 等通知渠道
            4. **查看设备历史** — 追踪设备的连接和断开记录
            5. **管理设备** — 为发现的设备指定名称和备注

            ## 许可证

            GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
    zh-TW:
        description: |
            NetAlertX 是網路裝置掃描與警報系統。監控區域網路上的新裝置或斷線裝置，追蹤 IP 和 MAC 位址，並透過多種管道發送通知。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 網域
              description: 存取 NetAlertX 的網域
        readme: |
            # NetAlertX

            網路裝置掃描與警報系統。監控區域網路的新裝置或斷線裝置，追蹤 IP 和 MAC 位址，並發送自訂通知。

            > **注意**：網路裝置掃描需要 host 網路模式進行 ARP/ping 掃描，在容器化雲端環境中無法使用。網頁介面、裝置管理和歷史記錄功能可正常運作。

            ## 部署後可以做什麼

            1. **開啟網域** — 檢視偵測到的裝置
            2. **設定掃描** — 在設定頁面配置網路掃描參數
            3. **設定通知** — 配置 Email、Webhook、Pushover 等通知管道
            4. **檢視裝置歷史** — 追蹤裝置的連線和斷線記錄
            5. **管理裝置** — 為發現的裝置指定名稱、群組和備註

            ## 授權

            GPL-3.0 — [GitHub](https://github.com/netalertx/NetAlertX)
