mirror of
https://github.com/jcreek/OpenNetworkDiagram.git
synced 2026-07-14 03:23:44 +00:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a7dbcf426f | |||
| 1d656ff120 | |||
| 45203a4c28 | |||
| 4cbec53394 |
@@ -0,0 +1,6 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: github-actions
|
||||||
|
directory: /
|
||||||
|
schedule:
|
||||||
|
interval: weekly
|
||||||
@@ -13,6 +13,27 @@ concurrency:
|
|||||||
cancel-in-progress: false
|
cancel-in-progress: false
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
changed-files:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
outputs:
|
||||||
|
readme: ${{ steps.filter.outputs.readme }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Detect changed files
|
||||||
|
id: filter
|
||||||
|
uses: dorny/paths-filter@v3
|
||||||
|
with:
|
||||||
|
filters: |
|
||||||
|
readme:
|
||||||
|
- README.md
|
||||||
|
|
||||||
release:
|
release:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
@@ -38,7 +59,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Create Git tag + GitHub release
|
- name: Create Git tag + GitHub release
|
||||||
id: semantic
|
id: semantic
|
||||||
uses: cycjimmy/semantic-release-action@v5.0.2
|
uses: cycjimmy/semantic-release-action@v5
|
||||||
with:
|
with:
|
||||||
extra_plugins: |
|
extra_plugins: |
|
||||||
@semantic-release/commit-analyzer
|
@semantic-release/commit-analyzer
|
||||||
@@ -89,3 +110,23 @@ jobs:
|
|||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
cache-from: type=gha
|
cache-from: type=gha
|
||||||
cache-to: type=gha,mode=max
|
cache-to: type=gha,mode=max
|
||||||
|
|
||||||
|
dockerhub-overview:
|
||||||
|
needs: changed-files
|
||||||
|
if: needs.changed-files.outputs.readme == 'true'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Update Docker Hub repository overview
|
||||||
|
uses: peter-evans/dockerhub-description@v4
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
repository: ${{ env.IMAGE_NAME }}
|
||||||
|
readme-filepath: ./README.md
|
||||||
|
enable-url-completion: true
|
||||||
|
|||||||
@@ -1,177 +1,146 @@
|
|||||||
# **Open Network Diagram**
|
# Open Network Diagram
|
||||||
|
|
||||||

|
[](https://hub.docker.com/r/jcreek23/open-network-diagram)
|
||||||

|
[](https://github.com/jcreek/OpenNetworkDiagram/actions/workflows/release.yml)
|
||||||

|
[](https://github.com/jcreek/OpenNetworkDiagram/actions/workflows/docker.yml)
|
||||||

|
[](https://github.com/jcreek/OpenNetworkDiagram/releases)
|
||||||

|
[](https://opennetworkdiagram.jcreek.co.uk)
|
||||||
|
|
||||||
**A declarative, self-hosted tool for visualising and managing home lab & network architecture diagrams.**
|
**A declarative, self-hosted containerised tool for visualising and managing home lab & network architecture diagrams.**
|
||||||
|
|
||||||
---
|
Open Network Diagram helps you document your infrastructure in a visual UI while keeping a real JSON source of truth you can version, back up, and reuse.
|
||||||
|
|
||||||
## **📝 About**
|
- Homelab-friendly: run it in minutes with Docker.
|
||||||
|
- Practical: edit in the UI and autosave to `network.json`.
|
||||||
|
- Declarative: keep your topology in Git if you want.
|
||||||
|
|
||||||
**Open Network Diagram** is an **open-source, self-hosted tool** for creating **interactive network and infrastructure diagrams** using a **declarative JSON format**.
|
[Docker Hub](https://hub.docker.com/r/jcreek23/open-network-diagram) | [Live Demo (Read-Only)](https://opennetworkdiagram.jcreek.co.uk) | [GitHub Releases](https://github.com/jcreek/OpenNetworkDiagram/releases)
|
||||||
|
|
||||||
✅ **Fully self-hostable via Docker**
|

|
||||||
✅ **Docker-first deployment target** (Netlify optional for demo hosting)
|
|
||||||
✅ **Interactive network visualisation**
|
|
||||||
✅ **Single-page modal editor with live updates**
|
|
||||||
✅ **Debounced autosave to JSON (self-hosted)**
|
|
||||||
✅ **Local vendored icon catalog (offline runtime)**
|
|
||||||
✅ **Lightweight Svelte**
|
|
||||||
|
|
||||||
Use it to **document your home lab, office network, or cloud infrastructure** with an easy-to-use web interface.
|
## Features
|
||||||
|
|
||||||
---
|
- Network view with ethernet labels to make physical and logical links easy to read.
|
||||||
|
- Non-network view for host-first inventory and service mapping.
|
||||||
|
- Expandable VM lists per machine for quick virtualization visibility.
|
||||||
|
- Modal editor for machines/devices with live diagram updates.
|
||||||
|
- JSON-backed persistence with autosave in self-hosted mode.
|
||||||
|
- Docker-first deployment with writable data volume support.
|
||||||
|
- Optional read-only mode for public demos and safe sharing.
|
||||||
|
- Local vendored icon catalog for offline-friendly runtime behavior.
|
||||||
|
|
||||||
## **🚀 Quick Start (For Users)**
|
## Why Home Lab Users Use It
|
||||||
|
|
||||||
### **1️⃣ Create Your Runtime Data File**
|
- Keep an always-up-to-date map of machines, VMs, and devices.
|
||||||
|
- Edit quickly through a modal UI instead of hand-editing large diagrams.
|
||||||
|
- Persist everything to JSON so backups and Git workflows stay simple.
|
||||||
|
- Stay fully self-hosted with no runtime dependency on external APIs.
|
||||||
|
|
||||||
Copy the template and edit your own network data:
|
## 2-Minute Docker Quick Start
|
||||||
|
|
||||||
|
This is the fastest way to run Open Network Diagram for a home lab.
|
||||||
|
|
||||||
|
1. Create a local data folder and seed your first `network.json`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cp data/network.json.example data/network.json
|
mkdir -p ond-data
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/jcreek/OpenNetworkDiagram/main/data/network.json.example -o ond-data/network.json
|
||||||
```
|
```
|
||||||
|
|
||||||
### **2️⃣ Run Open Network Diagram via Docker**
|
2. Run the published Docker image:
|
||||||
|
|
||||||
From this repo:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose up --build
|
docker run -d \
|
||||||
```
|
--name open-network-diagram \
|
||||||
|
--restart unless-stopped \
|
||||||
Or pull and run directly:
|
-p 8080:3000 \
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run -d -p 8080:3000 \
|
|
||||||
-e NETWORK_DATA_FILE=/app/data/network.json \
|
-e NETWORK_DATA_FILE=/app/data/network.json \
|
||||||
-e NETWORK_BACKUP_DIR=/app/data/.backups \
|
-e NETWORK_BACKUP_DIR=/app/data/.backups \
|
||||||
-v "$(pwd)/data:/app/data" \
|
-v "$(pwd)/ond-data:/app/data" \
|
||||||
jcreek23/open-network-diagram
|
jcreek23/open-network-diagram:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
- **`-p 8080:3000`** → Maps the app to `http://localhost:8080`
|
3. Open the app at `http://localhost:8080`.
|
||||||
- **`-v .../data:/app/data`** → Uses your local writable `data/network.json`
|
|
||||||
|
|
||||||
### **3️⃣ Open the Web UI**
|
4. Edit your topology in the UI. Changes persist to `ond-data/network.json`.
|
||||||
|
|
||||||
Visit **`http://localhost:8080`** to view your network diagram.
|
Useful follow-up commands:
|
||||||
|
|
||||||
### **4️⃣ Modify Your Network (Modal UI + JSON Persistence)**
|
```bash
|
||||||
|
docker logs -f open-network-diagram
|
||||||
|
docker stop open-network-diagram
|
||||||
|
docker rm open-network-diagram
|
||||||
|
```
|
||||||
|
|
||||||
- Edit machines/devices/VMs/ports directly in the modal UI.
|
## What It Looks Like
|
||||||
- Diagram updates immediately as you edit.
|
|
||||||
- In self-hosted Docker/local mode, changes autosave to mounted **`data/network.json`**.
|
|
||||||
- Netlify/demo is intentionally read-only; edits are in-memory only.
|
|
||||||
|
|
||||||
---
|
| Network view with ethernet labels | Non-network view with VMs expanded | Modal editing a machine |
|
||||||
|
| -------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
|  |  |  |
|
||||||
|
|
||||||
## **👩💻 Development Setup**
|
## Docker Compose Option
|
||||||
|
|
||||||
### **1️⃣ Clone the Repository**
|
If you prefer compose:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
open-network-diagram:
|
||||||
|
image: jcreek23/open-network-diagram:latest
|
||||||
|
ports:
|
||||||
|
- '8080:3000'
|
||||||
|
volumes:
|
||||||
|
- ./ond-data:/app/data
|
||||||
|
environment:
|
||||||
|
NETWORK_DATA_FILE: /app/data/network.json
|
||||||
|
NETWORK_BACKUP_DIR: /app/data/.backups
|
||||||
|
restart: unless-stopped
|
||||||
|
```
|
||||||
|
|
||||||
|
Start it with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## For Developers
|
||||||
|
|
||||||
|
### Local Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/jcreek/OpenNetworkDiagram.git
|
git clone https://github.com/jcreek/OpenNetworkDiagram.git
|
||||||
cd open-network-diagram
|
cd OpenNetworkDiagram
|
||||||
```
|
|
||||||
|
|
||||||
### **2️⃣ Install Dependencies**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm install
|
pnpm install
|
||||||
```
|
|
||||||
|
|
||||||
### **3️⃣ Run in Development Mode**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm run dev
|
pnpm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
- Runs at `http://localhost:5173`
|
App URL: `http://localhost:5173`
|
||||||
|
|
||||||
### **4️⃣ Build Targets**
|
### Build Targets
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm run build # default (Docker/static target)
|
pnpm run build # default build
|
||||||
pnpm run build:docker # explicit Docker/static target
|
pnpm run build:docker # Docker/static target
|
||||||
pnpm run build:netlify # Netlify target (read-only mode)
|
pnpm run build:netlify # Netlify target (read-only mode)
|
||||||
pnpm run icons:manifest # regenerate local vendor icon manifest
|
pnpm run icons:manifest # regenerate local vendor icon manifest
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
### Runtime and Persistence
|
||||||
|
|
||||||
## **🛠️ Project Structure**
|
- API endpoint: `GET/PUT /api/network-data`
|
||||||
|
- Writes are enabled unless `NETWORK_READ_ONLY=true`
|
||||||
|
- Writes are persisted atomically to the configured data file
|
||||||
|
- Rolling backups are kept in the backup directory (last 5)
|
||||||
|
|
||||||
```text
|
Environment variables:
|
||||||
open-network-diagram/
|
|
||||||
├── src/ # Svelte app source
|
|
||||||
├── src/lib/config/vendorIconManifest.ts # Generated local icon catalog
|
|
||||||
├── static/data/network.json # Demo dataset (Netlify/demo)
|
|
||||||
├── static/icons/vendor/ # Vendored icon assets (runtime-local)
|
|
||||||
├── data/network.json.example # User data template (Docker)
|
|
||||||
├── third_party/ # Third-party license/provenance notes
|
|
||||||
├── Dockerfile # Docker build/runtime
|
|
||||||
├── server.mjs # Node runtime server (static + /api/network-data)
|
|
||||||
├── docker-compose.yml # Local Docker run with mounted data
|
|
||||||
├── netlify.toml # Netlify build config
|
|
||||||
├── .github/workflows/ # CI workflows (PR build + automated release/publish)
|
|
||||||
└── README.md # Documentation
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
- `NETWORK_READ_ONLY` (default: `false`)
|
||||||
|
- Set to `true` to disable writes and force read-only mode.
|
||||||
|
- `NETWORK_DATA_FILE` (default: `data/network.json`)
|
||||||
|
- JSON file path to read/write.
|
||||||
|
- `NETWORK_BACKUP_DIR` (default: `data/.backups`)
|
||||||
|
- Directory for backup files.
|
||||||
|
|
||||||
## **📦 Docker Build & Deployment**
|
### JSON Example
|
||||||
|
|
||||||
### **Build the Docker Image Locally**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker build -t open-network-diagram .
|
|
||||||
```
|
|
||||||
|
|
||||||
### **Run Locally**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run --rm -p 8080:3000 \
|
|
||||||
-e NETWORK_DATA_FILE=/app/data/network.json \
|
|
||||||
-e NETWORK_BACKUP_DIR=/app/data/.backups \
|
|
||||||
-v "$(pwd)/data:/app/data" \
|
|
||||||
open-network-diagram
|
|
||||||
```
|
|
||||||
|
|
||||||
### **Write API Environment Variables**
|
|
||||||
|
|
||||||
- **`NETWORK_READ_ONLY`** (default: `false`)
|
|
||||||
Set to `true` to disable `PUT /api/network-data` and force read-only mode.
|
|
||||||
- **`NETWORK_DATA_FILE`** (default: `data/network.json`)
|
|
||||||
JSON file path to read/write.
|
|
||||||
- **`NETWORK_BACKUP_DIR`** (default: sibling `.backups`)
|
|
||||||
Backup directory for rolling save backups (last 5 retained).
|
|
||||||
|
|
||||||
### **Local Icon Catalog (No Runtime Network Dependency)**
|
|
||||||
|
|
||||||
- Icons are vendored locally under **`static/icons/vendor/homarr/`**.
|
|
||||||
- The searchable catalog is generated into **`src/lib/config/vendorIconManifest.ts`**.
|
|
||||||
- Third-party provenance and licensing are documented in:
|
|
||||||
- **`third_party/homarr-dashboard-icons/SOURCE.txt`**
|
|
||||||
- **`third_party/homarr-dashboard-icons/LICENSE`**
|
|
||||||
- **`third_party/homarr-dashboard-icons/NOTICE.txt`**
|
|
||||||
- Runtime icon search/rendering does not call external APIs.
|
|
||||||
|
|
||||||
### **CI/CD (GitHub Actions + Netlify)**
|
|
||||||
|
|
||||||
- GitHub Actions workflow (`.github/workflows/docker.yml`) builds Docker on PRs (validation only).
|
|
||||||
- GitHub Actions workflow (`.github/workflows/release.yml`) runs on `main`, creates semantic version tags/releases, and publishes Docker images to **Docker Hub** (`jcreek23/open-network-diagram`).
|
|
||||||
- Netlify uses its own CI/CD pipeline with `netlify.toml` (`pnpm run build:netlify`).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## **📝 JSON Network Configuration Example**
|
|
||||||
|
|
||||||
Define your network using **`network.json`**:
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -195,27 +164,37 @@ Define your network using **`network.json`**:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
### Project Structure
|
||||||
|
|
||||||
## **🤝 Contributing**
|
```text
|
||||||
|
OpenNetworkDiagram/
|
||||||
|
├── src/ # Svelte app source
|
||||||
|
├── src/lib/config/vendorIconManifest.ts # Generated local icon catalog
|
||||||
|
├── static/data/network.json # Demo dataset (Netlify)
|
||||||
|
├── static/icons/vendor/ # Vendored icon assets (runtime-local)
|
||||||
|
├── data/network.json.example # Starter data template for Docker users
|
||||||
|
├── third_party/ # Third-party provenance + licensing
|
||||||
|
├── Dockerfile # Docker build/runtime image
|
||||||
|
├── server.mjs # Node runtime server (static + API)
|
||||||
|
├── docker-compose.yml # Local compose example (build from repo)
|
||||||
|
├── netlify.toml # Netlify build config
|
||||||
|
└── .github/workflows/ # CI workflows
|
||||||
|
```
|
||||||
|
|
||||||
We welcome contributions! To contribute:
|
### CI/CD
|
||||||
|
|
||||||
1. **Fork the repository**.
|
- `docker.yml`: validates Docker build on pull requests.
|
||||||
2. **Create a feature branch** (`git checkout -b feature-name`).
|
- `release.yml`: semantic release on `main` and Docker Hub publish for tagged releases.
|
||||||
3. **Commit your changes** (`git commit -m "Add feature X"`).
|
- Docker Hub image: [`jcreek23/open-network-diagram`](https://hub.docker.com/r/jcreek23/open-network-diagram)
|
||||||
4. **Push to your fork** (`git push origin feature-name`).
|
|
||||||
5. **Submit a Pull Request**.
|
|
||||||
|
|
||||||
---
|
## Contributing
|
||||||
|
|
||||||
## **📜 License**
|
1. Fork the repository.
|
||||||
|
2. Create a feature branch.
|
||||||
|
3. Commit your changes.
|
||||||
|
4. Push your branch.
|
||||||
|
5. Open a pull request.
|
||||||
|
|
||||||
[GNU GPL v3 License](LICENSE) – Free to use, modify, and distribute, except distributing closed source versions.
|
## License
|
||||||
|
|
||||||
---
|
[GNU GPL v3](LICENSE)
|
||||||
|
|
||||||
## **📬 Contact**
|
|
||||||
|
|
||||||
**Author:** [Joshua Creek](https://github.com/jcreek)
|
|
||||||
**Project Repo:** [GitHub](https://github.com/jcreek/OpenNetworkDiagram)
|
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 276 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 334 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 274 KiB |
+198
-120
@@ -5,6 +5,47 @@
|
|||||||
"ipAddress": "10.0.0.3",
|
"ipAddress": "10.0.0.3",
|
||||||
"role": "Hypervisor",
|
"role": "Hypervisor",
|
||||||
"operatingSystem": "Proxmox",
|
"operatingSystem": "Proxmox",
|
||||||
|
"iconKey": "homarr:proxmox",
|
||||||
|
"software": {
|
||||||
|
"vms": [
|
||||||
|
{
|
||||||
|
"name": "OpnSense",
|
||||||
|
"role": "Router/Firewall/Gateway (DHCP 10.0.0.100-254)",
|
||||||
|
"ipAddress": "10.0.0.1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "TPLink Omada Controller",
|
||||||
|
"role": "Network Controller (:8043)",
|
||||||
|
"ipAddress": "10.0.0.4"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "PiVPN (WireGuard)",
|
||||||
|
"role": "VPN Server",
|
||||||
|
"ipAddress": "10.0.0.5"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "PiHole",
|
||||||
|
"role": "DNS Ad-blocker (installed, not in active use)",
|
||||||
|
"ipAddress": "10.0.0.6"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Dashy",
|
||||||
|
"role": "Dashboard",
|
||||||
|
"ipAddress": "10.0.0.12"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "ProxRouter-Docker",
|
||||||
|
"role": "Docker host (Nginx reverse proxy, RustDesk, TwinGate)",
|
||||||
|
"ipAddress": "10.0.0.23"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "Intel N100",
|
||||||
|
"ram": "8GB",
|
||||||
|
"networkPorts": 4,
|
||||||
|
"networkPortSpeedGbps": 1
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -34,45 +75,23 @@
|
|||||||
"port": "wan"
|
"port": "wan"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": {
|
|
||||||
"vms": [
|
|
||||||
{
|
|
||||||
"name": "OpnSense",
|
|
||||||
"role": "Router/Firewall/Gateway (DHCP 10.0.0.100-254)",
|
|
||||||
"ipAddress": "10.0.0.1"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "TPLink Omada Controller",
|
|
||||||
"role": "Network Controller (:8043)",
|
|
||||||
"ipAddress": "10.0.0.4"
|
|
||||||
},
|
|
||||||
{ "name": "PiVPN (WireGuard)", "role": "VPN Server", "ipAddress": "10.0.0.5" },
|
|
||||||
{
|
|
||||||
"name": "PiHole",
|
|
||||||
"role": "DNS Ad-blocker (installed, not in active use)",
|
|
||||||
"ipAddress": "10.0.0.6"
|
|
||||||
},
|
|
||||||
{ "name": "Dashy", "role": "Dashboard", "ipAddress": "10.0.0.12" },
|
|
||||||
{
|
|
||||||
"name": "ProxRouter-Docker",
|
|
||||||
"role": "Docker host (Nginx reverse proxy, RustDesk, TwinGate)",
|
|
||||||
"ipAddress": "10.0.0.23"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "Intel N100",
|
|
||||||
"ram": "8GB",
|
|
||||||
"networkPorts": 4,
|
|
||||||
"networkPortSpeedGbps": 1
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "Asustor NAS",
|
"machineName": "Asustor NAS",
|
||||||
"ipAddress": "10.0.0.9",
|
"ipAddress": "10.0.0.9",
|
||||||
"role": "NAS",
|
"role": "NAS",
|
||||||
"operatingSystem": "Asustor ADM",
|
"operatingSystem": "Asustor ADM",
|
||||||
|
"iconKey": "homarr:asustor",
|
||||||
|
"software": {
|
||||||
|
"vms": []
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "Realtek RTD1296 Quad Core 1.4GHz",
|
||||||
|
"ram": "2GB",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -82,20 +101,23 @@
|
|||||||
"port": "3"
|
"port": "3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": { "vms": [] },
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "Realtek RTD1296 Quad Core 1.4GHz",
|
|
||||||
"ram": "2GB",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "Home Assistant Green",
|
"machineName": "Home Assistant Green",
|
||||||
"ipAddress": "10.0.0.13",
|
"ipAddress": "10.0.0.13",
|
||||||
"role": "Smart Home Controller",
|
"role": "Smart Home Controller",
|
||||||
"operatingSystem": "Home Assistant OS",
|
"operatingSystem": "Home Assistant OS",
|
||||||
|
"iconKey": "homarr:home-assistant",
|
||||||
|
"software": {
|
||||||
|
"vms": []
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "Home Assistant Custom SoC",
|
||||||
|
"ram": "Unknown",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -105,20 +127,23 @@
|
|||||||
"port": "4"
|
"port": "4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": { "vms": [] },
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "Home Assistant Custom SoC",
|
|
||||||
"ram": "Unknown",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "Plex Server",
|
"machineName": "Plex Server",
|
||||||
"ipAddress": "10.0.0.11",
|
"ipAddress": "10.0.0.11",
|
||||||
"role": "Media Server",
|
"role": "Media Server",
|
||||||
"operatingSystem": "Ubuntu Server",
|
"operatingSystem": "Ubuntu Server",
|
||||||
|
"iconKey": "homarr:plex",
|
||||||
|
"software": {
|
||||||
|
"vms": []
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "Intel N100",
|
||||||
|
"ram": "Unknown",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -128,20 +153,23 @@
|
|||||||
"port": "5"
|
"port": "5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": { "vms": [] },
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "Intel N100",
|
|
||||||
"ram": "Unknown",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "Win11 N100",
|
"machineName": "Win11 N100",
|
||||||
"ipAddress": "10.0.0.8",
|
"ipAddress": "10.0.0.8",
|
||||||
"role": "Media Downloader",
|
"role": "Media Downloader",
|
||||||
"operatingSystem": "Windows 11",
|
"operatingSystem": "Windows 11",
|
||||||
|
"iconKey": "homarr:windows-11",
|
||||||
|
"software": {
|
||||||
|
"vms": []
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "Intel N100",
|
||||||
|
"ram": "Unknown",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -151,20 +179,40 @@
|
|||||||
"port": "6"
|
"port": "6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": { "vms": [] },
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "Intel N100",
|
|
||||||
"ram": "Unknown",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "Win11 Backblaze NAS",
|
"machineName": "Win11 Backblaze NAS",
|
||||||
"ipAddress": "10.0.0.7",
|
"ipAddress": "10.0.0.7",
|
||||||
"role": "Backup NAS + Hypervisor",
|
"role": "Backup NAS + Hypervisor",
|
||||||
"operatingSystem": "TrueNAS Scale",
|
"operatingSystem": "TrueNAS Scale",
|
||||||
|
"iconKey": "homarr:backblaze",
|
||||||
|
"software": {
|
||||||
|
"vms": [
|
||||||
|
{
|
||||||
|
"name": "Win11NAS",
|
||||||
|
"role": "Backblaze Backup VM",
|
||||||
|
"ipAddress": "10.0.0.24"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "MakeMKV",
|
||||||
|
"role": "Blu-ray Ripper",
|
||||||
|
"ipAddress": "10.0.0.14"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Handbrake",
|
||||||
|
"role": "Video Transcoder",
|
||||||
|
"ipAddress": "10.0.0.15"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "AMD Ryzen 5 4600G",
|
||||||
|
"ram": "16GB",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1,
|
||||||
|
"gpu": "EVGA GeForce GTX 1050 Ti"
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -174,37 +222,14 @@
|
|||||||
"port": "7"
|
"port": "7"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": {
|
|
||||||
"vms": [
|
|
||||||
{ "name": "Win11NAS", "role": "Backblaze Backup VM", "ipAddress": "10.0.0.24" },
|
|
||||||
{ "name": "MakeMKV", "role": "Blu-ray Ripper", "ipAddress": "10.0.0.14" },
|
|
||||||
{ "name": "Handbrake", "role": "Video Transcoder", "ipAddress": "10.0.0.15" }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "AMD Ryzen 5 4600G",
|
|
||||||
"ram": "16GB",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1,
|
|
||||||
"gpu": "EVGA GeForce GTX 1050 Ti"
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "TrueNAS Host",
|
"machineName": "TrueNAS Host",
|
||||||
"ipAddress": "10.0.0.10",
|
"ipAddress": "10.0.0.10",
|
||||||
"role": "Storage + VM Host",
|
"role": "Storage + VM Host",
|
||||||
"operatingSystem": "TrueNAS Scale",
|
"operatingSystem": "TrueNAS Scale",
|
||||||
"ports": [
|
"iconKey": "homarr:truenas",
|
||||||
{
|
|
||||||
"portName": "eth0",
|
|
||||||
"speedGbps": 1,
|
|
||||||
"connectedTo": {
|
|
||||||
"device": "Gigabit Switch",
|
|
||||||
"port": "8"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"software": {
|
"software": {
|
||||||
"vms": [
|
"vms": [
|
||||||
{
|
{
|
||||||
@@ -219,13 +244,45 @@
|
|||||||
"ram": "Unknown",
|
"ram": "Unknown",
|
||||||
"networkPorts": 1,
|
"networkPorts": 1,
|
||||||
"networkPortSpeedGbps": 1
|
"networkPortSpeedGbps": 1
|
||||||
}
|
},
|
||||||
|
"ports": [
|
||||||
|
{
|
||||||
|
"portName": "eth0",
|
||||||
|
"speedGbps": 1,
|
||||||
|
"connectedTo": {
|
||||||
|
"device": "Gigabit Switch",
|
||||||
|
"port": "8"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "AI Server",
|
"machineName": "AI Server",
|
||||||
"ipAddress": "10.0.0.20",
|
"ipAddress": "10.0.0.20",
|
||||||
"role": "AI Dev/Inference",
|
"role": "AI Dev/Inference",
|
||||||
"operatingSystem": "Pop!_OS",
|
"operatingSystem": "Pop!_OS",
|
||||||
|
"iconKey": "homarr:ollama-dark",
|
||||||
|
"software": {
|
||||||
|
"vms": [
|
||||||
|
{
|
||||||
|
"name": "Ollama",
|
||||||
|
"role": "LLM Inference",
|
||||||
|
"ipAddress": "10.0.0.21"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Bot Training",
|
||||||
|
"role": "AI Training",
|
||||||
|
"ipAddress": "10.0.0.22"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "AMD Ryzen 5 3600",
|
||||||
|
"ram": "32GB",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1,
|
||||||
|
"gpu": "Gigabyte GeForce GTX 1080"
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -235,26 +292,23 @@
|
|||||||
"port": "9"
|
"port": "9"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": {
|
|
||||||
"vms": [
|
|
||||||
{ "name": "Ollama", "role": "LLM Inference", "ipAddress": "10.0.0.21" },
|
|
||||||
{ "name": "Bot Training", "role": "AI Training", "ipAddress": "10.0.0.22" }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "AMD Ryzen 5 3600",
|
|
||||||
"ram": "32GB",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1,
|
|
||||||
"gpu": "Gigabyte GeForce GTX 1080"
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"machineName": "Immich Mini PC",
|
"machineName": "Immich Mini PC",
|
||||||
"ipAddress": "10.0.0.30",
|
"ipAddress": "10.0.0.30",
|
||||||
"role": "Photo Server",
|
"role": "Photo Server",
|
||||||
"operatingSystem": "Linux",
|
"operatingSystem": "Linux",
|
||||||
|
"iconKey": "homarr:immich",
|
||||||
|
"software": {
|
||||||
|
"vms": []
|
||||||
|
},
|
||||||
|
"hardware": {
|
||||||
|
"cpu": "Unknown",
|
||||||
|
"ram": "Unknown",
|
||||||
|
"networkPorts": 1,
|
||||||
|
"networkPortSpeedGbps": 1
|
||||||
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -264,14 +318,7 @@
|
|||||||
"port": "10"
|
"port": "10"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"software": { "vms": [] },
|
|
||||||
"hardware": {
|
|
||||||
"cpu": "Unknown",
|
|
||||||
"ram": "Unknown",
|
|
||||||
"networkPorts": 1,
|
|
||||||
"networkPortSpeedGbps": 1
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"devices": [
|
"devices": [
|
||||||
@@ -279,6 +326,7 @@
|
|||||||
"name": "Gigabit Switch",
|
"name": "Gigabit Switch",
|
||||||
"ipAddress": "unknown",
|
"ipAddress": "unknown",
|
||||||
"type": "Network Switch",
|
"type": "Network Switch",
|
||||||
|
"iconKey": "switch",
|
||||||
"notes": "Main 24-port switch. Wireless access point uplinks through this switch.",
|
"notes": "Main 24-port switch. Wireless access point uplinks through this switch.",
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
@@ -403,7 +451,11 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"portName": "20",
|
"portName": "20",
|
||||||
"speedGbps": 1
|
"speedGbps": 1,
|
||||||
|
"connectedTo": {
|
||||||
|
"device": "NanoKVM Lite",
|
||||||
|
"port": "port0"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"portName": "21",
|
"portName": "21",
|
||||||
@@ -443,6 +495,7 @@
|
|||||||
"name": "HDHomeRun",
|
"name": "HDHomeRun",
|
||||||
"ipAddress": "10.0.0.2",
|
"ipAddress": "10.0.0.2",
|
||||||
"type": "TV Tuner",
|
"type": "TV Tuner",
|
||||||
|
"iconKey": "homarr:hdhomerun",
|
||||||
"ports": [
|
"ports": [
|
||||||
{
|
{
|
||||||
"portName": "eth0",
|
"portName": "eth0",
|
||||||
@@ -458,37 +511,62 @@
|
|||||||
"name": "3DS",
|
"name": "3DS",
|
||||||
"ipAddress": "10.0.0.17",
|
"ipAddress": "10.0.0.17",
|
||||||
"type": "Handheld Console",
|
"type": "Handheld Console",
|
||||||
"notes": "Wi-Fi only."
|
"notes": "Wi-Fi only.",
|
||||||
|
"ports": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "2DS",
|
"name": "2DS",
|
||||||
"ipAddress": "10.0.0.18",
|
"ipAddress": "10.0.0.18",
|
||||||
"type": "Handheld Console",
|
"type": "Handheld Console",
|
||||||
"notes": "Wi-Fi only."
|
"notes": "Wi-Fi only.",
|
||||||
|
"ports": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Nintendo Switch",
|
"name": "Nintendo Switch",
|
||||||
"ipAddress": "10.0.0.19",
|
"ipAddress": "10.0.0.19",
|
||||||
"type": "Gaming Console",
|
"type": "Gaming Console",
|
||||||
"notes": "Wi-Fi only."
|
"notes": "Wi-Fi only.",
|
||||||
|
"ports": [
|
||||||
|
{
|
||||||
|
"portName": "port0",
|
||||||
|
"speedGbps": 1
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "NanoKVM Lite",
|
"name": "NanoKVM Lite",
|
||||||
"ipAddress": "10.0.0.26",
|
"ipAddress": "10.0.0.26",
|
||||||
"type": "KVM Device",
|
"type": "KVM Device",
|
||||||
"notes": "Port link not yet modeled."
|
"notes": "Port link not yet modeled.",
|
||||||
|
"ports": [
|
||||||
|
{
|
||||||
|
"portName": "port0",
|
||||||
|
"speedGbps": 1,
|
||||||
|
"connectedTo": {
|
||||||
|
"device": "Gigabit Switch",
|
||||||
|
"port": "20"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "UPS Pi",
|
"name": "UPS Pi",
|
||||||
"ipAddress": "10.0.0.27",
|
"ipAddress": "10.0.0.27",
|
||||||
"type": "Power Monitoring Device",
|
"type": "Power Monitoring Device",
|
||||||
"notes": "Port link not yet modeled."
|
"notes": "Port link not yet modeled.",
|
||||||
|
"ports": [
|
||||||
|
{
|
||||||
|
"portName": "port0",
|
||||||
|
"speedGbps": 1
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Waveshare",
|
"name": "Waveshare",
|
||||||
"ipAddress": "10.0.0.28",
|
"ipAddress": "10.0.0.28",
|
||||||
"type": "Peripheral Device",
|
"type": "Peripheral Device",
|
||||||
"notes": "Port link not yet modeled."
|
"notes": "Port link not yet modeled.",
|
||||||
|
"ports": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user