Update README.md
co-authored-by: assistant
This commit is contained in:
assistant
@@ -1,56 +1,96 @@
|
|||||||
# Multipurpose Radio Server (MRS)
|
<!-- Header -->
|
||||||
|
<div id="top" align="center">
|
||||||
|
<br />
|
||||||
|
|
||||||
|
<!-- Logo -->
|
||||||
|
<img src="https://meshtastic.org/assets/images/lora-topology-2-c80684f1eafdf2a71fbaf26e494fb26d.webp" alt="Logo" width="200" height="200">
|
||||||
|
|
||||||
|
<!-- Title -->
|
||||||
|
### Multipurpose Radio Server (MRS)
|
||||||
|
|
||||||
|
<!-- Description -->
|
||||||
|
A comprehensive, offline-first communication and intelligence platform built for service-denied environments.
|
||||||
|
|
||||||
|
<!-- Repo badges (Using generic placeholders as dynamic data is unavailable) -->
|
||||||
|
[](https://git.zakscode.com/ztimson/mrs/tags)
|
||||||
|
[](https://git.zakscode.com/ztimson/mrs/pull)
|
||||||
|
[](https://git.zakscode.com/ztimson/mrs/issues)
|
||||||
|
|
||||||
|
<!-- Links -->
|
||||||
|
---
|
||||||
|
<div align="center">
|
||||||
|
<a href="https://git.zakscode.com/ztimson/mrs/wiki" target="_blank">Documentation</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/mrs/releases" target="_blank">Release Notes</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/mrs/issues/new?template=.github/issue_template/bug.md" target="_blank">Report a Bug</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/mrs/issues/new?template=.github/issue_template/enhancement.md" target="_blank">Request a Feature</a>
|
||||||
|
</div >
|
||||||
|
|
||||||
---
|
---
|
||||||
|
</div >
|
||||||
|
|
||||||
###### By: Zakary Timson
|
## Table of Contents
|
||||||
###### Date: September 2026
|
- [About](#top)
|
||||||
###### Version: 1.0
|
- [Description](#description)
|
||||||
|
- [Inspiration](#inspiration)
|
||||||
|
- [Capabilities](#capabilities)
|
||||||
|
- [Manual](#manual)
|
||||||
|
- [Setup](#setup)
|
||||||
|
- [Production](#production)
|
||||||
|
- [Development](#development)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
---
|
## About
|
||||||
|
|
||||||
> Compact communication and information exchange server for service-denied areas. Ideal for disaster response, long-range tracking, and offline-first operations.
|
### Description
|
||||||
|
MRS is a hardware-focused radio server that acts as the core of the system, providing the physical connectivity and reconnaissance capabilities. It is unified by the OpenCast media/control layer and the AI-Harness intelligence layer.
|
||||||
|
|
||||||
---
|
### Inspiration
|
||||||
|
This project was built for resiliency and offline capability, drawing from:
|
||||||
|
- [A.C.I.D](https://www.youtube.com/watch?v=nSrYmkGq9TM)
|
||||||
|
- [Offline internet](https://www.youtube.com/watch?v=L5RJZmuRJKA)
|
||||||
|
- [Meshtastic radios](https://morosx.com/ols/products/xtak-lora-mesh)
|
||||||
|
- [HaLow mesh network](https://www.youtube.com/watch?v=ofR7GFNZzJY)
|
||||||
|
- [Signal Intelligence](https://www.youtube.com/watch?v=Nam87B2u6bo&t=1942s)
|
||||||
|
|
||||||
## 🗂️ Capabilities
|
### Capabilities
|
||||||
|
|
||||||
**Networking:**
|
**Networking**
|
||||||
* 900 MHz HaLow / 2.4/5 GHz Mesh WiFi (B.A.T.M.A.N.)
|
* **Mesh:** 900 MHz HaLow / 2.4/5 GHz Mesh WiFi (B.A.T.M.A.N.)
|
||||||
* LoRa radio communication (Meshtastic node)
|
* **Radio:** LoRa radio (Meshtastic node).
|
||||||
* Captive portal & device home page setup
|
* **Connectivity:** Captive portal & device home page setup via OpenCast.
|
||||||
|
|
||||||
**Communication:**
|
**Communication & Data**
|
||||||
* Offline federated chat (Synapse/Element)
|
* **Chat:** Offline federated chat (Synapse/Element)
|
||||||
* GPS positioning & offline maps
|
* **Archive:** Offline knowledge base (Kiwix) and file hosting (AI-Harness).
|
||||||
|
* **Tracking:** GPS positioning & offline maps using gpsd, chrony.
|
||||||
|
|
||||||
**Tools & Integration:**
|
**Recon & Security**
|
||||||
* **AI Assistant**: Powered by the custom **AI-Harness** (Gemma4-e2b)
|
* **Tools:** Bettercap, nmap, aircrack, Metasploit, and SDRAngel for hardware and RF recon.
|
||||||
* **Knowledge Base**: Offline access via **Kiwix** (Harness provided)
|
* **Media:** Control and casting interface provided by OpenCast.
|
||||||
* **Reconnaissance**: Bettercap, nmap, aircrack, Metasploit, and SDRAngel
|
|
||||||
* **Media/Control**: Control and casting interface provided by **OpenCast**
|
|
||||||
* **Remote Access**: VNC built into the **OpenCast** layer
|
|
||||||
|
|
||||||
---
|
## Manual
|
||||||
|
|
||||||
## 🛠️ Technical Focus
|
### Setup
|
||||||
|
**Production**
|
||||||
|
1. Run the core MRS services to establish the hardware/radio backbone.
|
||||||
|
2. OpenCast (port 3000) and AI-Harness (port 3001) are required to provide the media control and intelligence interface.
|
||||||
|
|
||||||
MRS acts as the hardware and recon core. All features are unified through the OpenCast control panel and the AI-Harness layer.
|
**Development**
|
||||||
|
1. Install dependencies: `npm install`
|
||||||
|
2. Start core services: `npm run dev`
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## Built With
|
||||||
|
|
||||||
```bash
|
<p>
|
||||||
# Clone and install
|
<!-- List key technologies here -->
|
||||||
git clone https://git.zakscode.com/ztimson/mrs
|
</p>
|
||||||
cd mrs
|
[](https://www.electronjs.org/)
|
||||||
|
[](https://nodejs.org/)
|
||||||
|
[](https://typescriptlang.org/)
|
||||||
|
[](https://www.nginx.com/)
|
||||||
|
[](https://github.com/ztimson/ai-harness)
|
||||||
|
|
||||||
# Install base dependencies
|
## License
|
||||||
npm ci
|
Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing
|
||||||
|
|
||||||
# Start core services
|
See the [license](./LICENSE) for more information.
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📜 License
|
|
||||||
|
|
||||||
This project is licensed under the MIT License.
|
|
||||||
Reference in New Issue
Block a user