Skip to content

getting-started.md

Latest commit

 

History

History
70 lines (46 loc) · 1.61 KB

getting-started.md

File metadata and controls

70 lines (46 loc) · 1.61 KB
Raw

Getting Started

1. Install

From the repo root:

./install.sh --with-pypnm-webui
./install.sh --with-pypnm-cmts-webui

Important:

  • this is where you choose runtime mode (pypnm-webui vs pypnm-cmts-webui)
  • the installer persists that choice in .env and runtime YAML product_profile
  • switching modes later means re-running install with the other profile flag

If you also want docs/release tooling in .venv:

./install.sh --development

If WebUI and local backend are on the same machine:

./install.sh --with-pypnm-webui --with-pypnm-docsis
./install.sh --with-pypnm-cmts-webui --with-pypnm-docsis-cmts

2. Start the WebUI

pypnm-webui serve
pypnm-cmts-webui serve

Default URL:

  • http://127.0.0.1:4175

3. Configure runtime instances

Use the interactive menu:

pypnm-cmts-webui config-menu

This writes machine-local runtime overrides to:

  • public/config/pypnm-instances.local.yaml

Useful menu shortcut:

  • choose s to show the minimal runtime YAML schema example

4. First operator check

  1. open Health and confirm the selected CMTS API is reachable use per-agent Log to download backend logs and Reload to restart the web service
  2. open Serving Group -> RxMER
  3. pick serving groups and confirm cable modems populate
  4. verify request JSON using the Request JSON popup in the Capture Request header
  5. open Single Capture -> Dashboard and confirm the modem table populates
  6. use an Action route (for example RxMER or Spectrum Analyzer) to verify handoff into PW-derived pages

See: