Skip to content

Commit 34eefe6

Browse files
committed
Update README.md
1 parent 68889a0 commit 34eefe6

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A single-page browser application for visualising `/etc/config/firewall` relationships. Paste or upload an OpenWrt firewall configuration, map devices to zones, and visually inspect zone-to-zone and device-to-device connectivity.
44

5+
---
6+
57
## Features
68

79
- **No Backend Required** — All parsing and analysis happens in your browser; no server, database, or build step needed
@@ -14,16 +16,19 @@ A single-page browser application for visualising `/etc/config/firewall` relatio
1416
- **Multiple Graph Layouts** — Force-directed, circular, and breadth-first layouts
1517
- **Relationship Filtering** — Show all paths, allowed only, blocked only, zone-only, or device-only relationships
1618

19+
---
20+
1721
## Quick Start
1822

1923
1. **Open the app**: Open [`public/index.html`](public/index.html) in any modern browser
2024
2. **Paste your firewall config**: Copy `/etc/config/firewall` from your OpenWrt router and paste it into the textarea
2125
3. **Map devices to zones**: Add devices with names, IP addresses, and their associated firewall zones (via import or manually)
22-
4. **Visualise relationships**: The graph renders automatically showing zones, devices, and their connectivity
26+
4. **Map subnets**: Add subnets mappings (import via `scripts/openwrt_export_subnet_mappings.sh`)
27+
5. **Visualise relationships**: The graph renders automatically showing zones, devices, and their connectivity
2328

2429
---
2530

26-
### Getting Firewall Config from OpenWrt
31+
### 1. Getting Firewall Config from OpenWrt
2732

2833
On your OpenWrt router:
2934

@@ -37,7 +42,7 @@ Or copy it remotely:
3742
scp root@<router-ip>:/etc/config/firewall ./firewall.conf
3843
```
3944

40-
### Importing Devices
45+
### 2. Importing Devices
4146

4247
Use the **Import** section to bulk-load devices from:
4348

@@ -58,7 +63,7 @@ sh /tmp/openwrt_export_hosts.sh
5863

5964
Output format: `ip,hostname,zone,mac`
6065

61-
### Importing Subnet Mappings
66+
### 3. Importing Subnet Mappings
6267

6368
The `scripts/openwrt_export_subnet_mappings.sh` script generates UCI outputs which can be pasted into Subnet Mappings and `Import UCI Subnets`
6469

0 commit comments

Comments
 (0)