# OpenRF

<!-- BOOKSTACK-DOCUMENT-RELEASE:BEGIN -->
# OpenRF

| Field | Value |
| --- | --- |
| Distribution | BSS — OpenSOF |
| Product | OpenSOF |
| Release | 0.15.1 |
| Deployment | `opensof.bss.dev` |
| Source | `/srv/bss/releases/OpenSOF-v0.15.0-20app` |
| Evidence | Catalog intent plus component-scoped static evidence |
| Source fingerprint | `cda583b42f2a0d296b268ab5b174932a378c8be6fb52ffa1af14af896e990f6e` |
| Status | Generated baseline — human review required |

> **Verification boundary:** This page combines platform design guidance with static evidence from the release. It does not prove that every detected interface is enabled, reachable, secure, or operational in the deployed environment.

## Purpose

The radio registration, spectrum sensing, control and distributed RF processing capability for heterogeneous SDRs and radio utilities.

## Operational value

Provides one operational layer for registering radios, viewing spectrum, running utilities and publishing detections from edge nodes.

## Differentiators

Uses common SDR abstractions where practical, supports distributed edge processing, and connects RF observations to timing, semantics, tracks and tasking.

## Platform connections

- OpenPNT
- OpenSSA
- OpenTrack
- OpenAnalytics
- OpenCOP

## Release detection

| Status | Score | Evidence items |
| --- | --- | --- |
| detected | 224 | 12 |

| Evidence type | Source | Match |
| --- | --- | --- |
| path | `OPENRF.md` | `openrf` |
| path | `lib/openrf-controller/server.js` | `openrf` |
| path | `lib/openrf-controller/src/store.js` | `openrf` |
| path | `openrf/API.md` | `openrf` |
| path | `openrf/ARCHITECTURE.md` | `openrf` |
| content | `CHANGELOG.md` | `openrf` |
| content | `DEPLOY-GODADDY.md` | `openrf` |
| content | `OPENBUS.md` | `openrf` |
| content | `OPENCOP.md` | `openrf` |
| content | `OPENCYBERSEC-QUICKSTART.md` | `openrf` |
| path | `edge/openssa-sensor/reference/open-rf/app.js` | `open-rf` |
| path | `edge/openssa-sensor/reference/open-rf/index.html` | `open-rf` |

## Candidate REST/API interfaces

No component-specific REST route was associated by the scanner.

## Candidate real-time interfaces

No component-specific WebSocket endpoint was associated by the scanner.

## Configuration candidates

| Variable | Default | Evidence |
| --- | --- | --- |
| `ADDRESS` | — | openrf/agent/functions/probe-n310.sh |
| `API_BASE` | — | open-rf/app.js, public/open-networks/app.js, public/open-rf/app.js |
| `BASE` | http://127.0.0.1:3000 | DEPLOY-GODADDY.md, OPENCYBERSEC-QUICKSTART.md, OPENCYBERSEC.md, UPGRADE-v0.14.0.md |
| `BASE_PATH` | — | open-rf/app.js, public/open-rf/app.js, third_party/ontowiki/application/scripts/travis/install-services.sh |
| `BUILD` | — | edge/openpnt-linuxptp/SELF-TEST.sh, edge/openssa-sensor/install/install-native-uhd.sh, edge/openssa-sensor/native/uhd_spectrum_engine/build-simulation.sh, edge/openssa-sensor/native/uhd_spectrum_engine/build.sh |
| `BUILD_DIR` | $ENGINE/build | edge/openssa-sensor/install/install-native-uhd.sh, edge/openssa-sensor/native/uhd_spectrum_engine/build-simulation.sh, edge/openssa-sensor/native/uhd_spectrum_engine/build.sh |
| `CONFIG` | — | drivers/install_openpnt_agent.sh, edge/opencybersec/install.sh, edge/openssa-sensor/install/check-sensor.sh, edge/openssa-sensor/install/install-sensor.sh |
| `CORE_DIR` | — | openrf/agent/functions/start-5g-core.sh, openrf/agent/functions/status-5g-core.sh |
| `DATA_DIR` | path.join(ROOT | OPENCYBERSEC-QUICKSTART.md, OPENCYBERSEC.md, RELEASE-MANIFEST-v0.14.0.json, UPGRADE-v0.14.0.md |
| `ENGINE` | — | edge/openssa-sensor/install/install-native-uhd.sh |
| `EUID` | $(id -u | drivers/install_openpnt_agent.sh, edge/opencybersec/install.sh, edge/opencybersec/uninstall.sh, edge/openpnt-linuxptp/install-linuxptp.sh |
| `GNB` | — | openrf/agent/functions/start-5g-ran-b210-50mhz.sh, openrf/agent/functions/start-5g-ran-n78-n310.sh |
| `HERE` | — | edge/openpnt-linuxptp/SELF-TEST.sh, edge/openpnt-linuxptp/install-linuxptp.sh, edge/openssa-sensor/native/uhd_spectrum_engine/build-simulation.sh, edge/openssa-sensor/native/uhd_spectrum_engine/build.sh |
| `HOME` | /tmp | lib/openllm/pipeline-engine.js, openrf/agent/functions/start-5g-core.sh, openrf/agent/functions/status-5g-core.sh, third_party/ontowiki/.travis.yml |
| `HOST` | 0.0.0.0 | server.js, lib/openrf-controller/server.js |
| `OPENCYBERSEC_AGENT_TOKEN` | [REDACTED] | OPENCYBERSEC-QUICKSTART.md, OPENCYBERSEC.md, server.js, examples/opencybersec/ingest-examples.sh |
| `OPENCYBERSEC_OPERATOR_TOKEN` | [REDACTED] | OPENCYBERSEC-QUICKSTART.md, OPENCYBERSEC.md, server.js, examples/opencybersec/ingest-examples.sh |
| `OPENRF_5G_CORE_DIR` | $HOME/5g/magic-core | openrf/agent/functions/start-5g-core.sh, openrf/agent/functions/status-5g-core.sh |
| `OPENRF_AGENT_OFFLINE_SECONDS` | 70 | lib/openrf-controller/server.js |
| `OPENRF_AGENT_TOKEN` | [REDACTED] | server.js, lib/openrf-controller/server.js, openrf/API.md |
| `OPENRF_BASE_PATH` | /open-rf | lib/openrf-controller/server.js |
| `OPENRF_DATA_DIR` | path.join(DATA | server.js, lib/openrf-controller/server.js |
| `OPENRF_DISPATCH_LEASE_SECONDS` | 90 | lib/openrf-controller/server.js |
| `OPENRF_OPERATOR_TOKEN` | [REDACTED] | server.js, lib/openrf-controller/server.js, openrf/API.md, openrf/README-UPSTREAM-v0.3.0.md |
| `OPENRF_PYTHON` | /usr/bin/python3 | openrf/agent/src/openrf_agent/util.py |
| `OPENRF_RADIO_ADDRESS` | 192.168.20.2 | openrf/agent/functions/probe-n310.sh |
| `OPENRF_RADIO_ID` | N310-01 | openrf/agent/functions/start-5g-ran-n78-n310.sh |
| `OPENRF_READ_TOKEN` | — | server.js, lib/openrf-controller/server.js, openrf/API.md |
| `PORT` | 3000 | server.js, edge/openssa-sensor/local_server.js, lib/openrf-controller/server.js |
| `PYTHONUNBUFFERED` | 1 | openrf/agent/systemd/openrf-agent.service |
| `ROOT` | — | edge/opencybersec/install.sh, edge/openpnt-linuxptp/SELF-TEST.sh, edge/openpnt-linuxptp/install-linuxptp.sh, edge/openssa-sensor/install-demo-sensor.sh |
| `RUN_GROUP` | — | openrf/agent/install.sh |
| `RUN_USER` | — | openrf/agent/install.sh |
| `SUDO_USER` | $USER | edge/openssa-sensor/install/install-sensor.sh, edge/openssa-sensor/install/update-existing-sensor.sh, openrf/agent/install.sh |
| `UHD_INCLUDE_DIRS` | — | edge/openssa-sensor/native/uhd_spectrum_engine/CMakeLists.txt |
| `UHD_LIBRARIES` | — | edge/openssa-sensor/native/uhd_spectrum_engine/CMakeLists.txt |
| `USER` | — | edge/openssa-sensor/SENSOR_INSTALL.md, edge/openssa-sensor/install-demo-sensor.sh, edge/openssa-sensor/install/install-sensor.sh, edge/openssa-sensor/install/update-existing-sensor.sh |

## Service candidates

| Service | ExecStart | Source |
| --- | --- | --- |
| openrf-agent.service | `/usr/local/bin/openrf-agent --config /etc/openrf/openrf-agent.json` | `openrf/agent/systemd/openrf-agent.service` |

## External dependencies/endpoints

| Host | URL | Source |
| --- | --- | --- |
| ${req.headers.host | `http://${req.headers.host/` | `lib/openrf-controller/server.js` |
| controller-ip | `http://controller-ip:8075/open-rf/` | `openrf/README-UPSTREAM-v0.3.0.md` |
| loammhpng4.c36.airoapp.ai | `https://loammhpng4.c36.airoapp.ai/` | `CHANGELOG.md` |

## Verification checklist

- Confirm the component is included and enabled in this edition/release.
- Record its authoritative service, process/container, port, base URL and health endpoint.
- Exercise its primary operator workflow and capture expected versus actual results.
- Verify authentication, authorization, audit, error behavior and data handling policy.
- Verify OpenBus/OpenKnowledge relationships and time/provenance metadata where applicable.
- Document known limitations and the release in which they are corrected.
<!-- BOOKSTACK-DOCUMENT-RELEASE:END -->

---

## Maintainer Notes

<!-- BOOKSTACK-DOCUMENT-RELEASE:NOTES-BEGIN -->
Add human-reviewed deployment notes, corrections, decisions, screenshots, and links here. Content outside the generated block is preserved on future runs.
<!-- BOOKSTACK-DOCUMENT-RELEASE:NOTES-END -->