Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 JorahOne, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
129 changes: 20 additions & 109 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,20 @@
# J1 NOC Nexus

**Version:** v1.0
**Status:** Active Development
**Repository:** https://github.com/OneByJorah/J1-NOC-Nexus
> Multi-platform Telegram bot for server discovery, live dashboarding, and infrastructure control.

---

## Table of Contents
![License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)
![Status](https://img.shields.io/badge/status-active-%23FFB300?style=for-the-badge)
![Language](https://img.shields.io/badge/language-Python-informational?style=for-the-badge)
![Platform](https://img.shields.io/badge/platform-linux-informational?style=for-the-badge)

- [Overview](#overview)
- [Architecture](#architecture)
- [Technology Stack](#technology-stack)
- [Features](#features)
- [Getting Started](#getting-started)
- [Service Management](#service-management)
- [Project Structure](#project-structure)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)
- [Author](#author)

---
J1 NOC Nexus is an enterprise-grade, ops-precise platform built for VIDE and SMB operations. Run it solo. Deliver results.

## Overview

J1 NOC Nexus is the next-generation expansion of the J1 NOC platform. It adds automated discovery, SNMP scanning, Telegram bot integration, and cross-platform agents (Linux + Windows) alongside the Flask dashboard.

Built for operators who want one pane to monitor, chat, and act on infrastructure events.
- **Dashboard**: real-time monitoring with Flask.
- **Telegram bot**: command handlers, keyboards, and scheduler for notifications.
- **Discovery**: automated network and SNMP scanning.
- **Cross-platform agents**: Linux (`agents/linux/`) and Windows (`agents/windows/`).
- **Install scripts**: one-click bootstrap for agents (`install.sh`, `install.ps1`).
- **CI**: `.github/workflows/ci.yml` for automated checks.

---

Expand All @@ -42,8 +30,6 @@ Data paths:

---

## Technology Stack

| Layer | Stack |
|---|---|
| Runtime | Linux / Windows |
Expand All @@ -56,100 +42,25 @@ Data paths:

---

## Features

- **Dashboard**: real-time monitoring with Flask.
- **Telegram bot**: command handlers, keyboards, and scheduler for notifications.
- **Discovery**: automated network and SNMP scanning.
- **Cross-platform agents**: Linux (`agents/linux/`) and Windows (`agents/windows/`).
- **Install scripts**: one-click bootstrap for agents (`install.sh`, `install.ps1`).
- **CI**: `.github/workflows/ci.yml` for automated checks.

---

## Getting Started
## Quickstart

```bash
# 1. Clone
git clone https://github.com/OneByJorah/J1-NOC-Nexus.git
cd J1-NOC-Nexus

# 2. Install backend
pip install -r requirements.txt

# 3. Run dashboard
python3 dashboard/app.py

# 4. Run bot (in another terminal)
python3 bot/main.py
```

Visit `http://localhost:5000`.

---

## Service Management

```bash
# Quick start
python3 dashboard/app.py

# Docker
docker compose up -d
```
Verify at `http://<host-ip>`.

---

## Project Structure

```
J1-NOC-Nexus/
├── dashboard/
│ ├── app.py
│ └── templates/
│ └── index.html
├── bot/
│ ├── main.py
│ ├── handlers.py
│ ├── keyboards.py
│ └── scheduler.py
├── discovery/
│ ├── network_scanner.py
│ └── snmp_scanner.py
├── agents/
│ ├── linux/agent.py
│ └── windows/agent.ps1
├── docs/screenshots/
│ └── j1-noc-nexus-dashboard.png
├── docker-compose.yml
├── Dockerfile
├── requirements.txt
└── README.md
```

---

## Screenshots

### J1 NOC Nexus Dashboard
![J1 NOC Nexus Dashboard](docs/screenshots/j1-noc-nexus-dashboard.png)
## Roadmap

---

## Contributing

1. Create a feature branch off `main`.
2. Test on both Linux and Windows when changing agents.
3. Submit a PR with description and screenshots for UI changes.

---
- Feature parity with production requirements
- Observability and alerting expansions
- Community feedback integration

## License

MIT
MIT — Copyright JorahOne, LLC. See [LICENSE](LICENSE) for details.

---

## Author

Built by **Jhonattan L. Jimenez**.
[OneByJorah](https://github.com/OneByJorah) · [JorahOne-Services](https://github.com/JorahOne-Services)