Openwalla

Openwalla is a modern Flutter app for managing and monitoring multiple OpenWrt/LuCI routers. It features an Openwalla-inspired dashboard UI, secure authentication, real-time stats, and seamless multi-router support.

---

Features

Openwalla can install optional router components from Manage Device > Router Setup. Features marked Built in only require a normal OpenWrt LuCI/RPC installation.

Router and Network

• Multiple Routers - Saves separate credentials, preferences, and cached data for each router. Relies on built-in app functionality.

• Secure Login - Connects over HTTP or HTTPS, supports self-signed certificates, securely stores credentials, and refreshes expired LuCI sessions. Relies on LuCI RPC: uhttpd-mod-ubus, rpcd-mod-luci, and rpcd-mod-iwinfo.

• Dashboard - Shows CPU, memory, load, interfaces, clients, live traffic, and enabled shortcuts. Relies on built-in app functionality; richer traffic data uses the monitoring packages below.

• Network Interfaces - Views, edits, starts, stops, and restarts LAN, WAN, VPN, and other logical interfaces through UCI and ubus. Relies on built-in OpenWrt UCI and ubus functionality.

• Wi-Fi - Manages radios, SSIDs, security, channels, and repeater connections. Relies on OpenWrt wireless tools and rpcd-mod-iwinfo.

• LAN and DHCP - Changes the LAN address, subnet, DNS, DHCP pool, and lease time while updating the saved router connection. Relies on built-in OpenWrt UCI functionality.

• Firewall and Routing - Manages firewall rules, port forwards, static IPv4 routes, and interface routing. Relies on OpenWrt firewall4 and UCI.

• Package Manager - Detects and uses apk on newer OpenWrt releases, with opkg as the fallback. Relies on the router's installed package manager.

• SSH Terminal - Opens a router shell using the saved router credentials. Relies on an OpenWrt SSH server, normally Dropbear.

• Backup and Restore - Exports or restores Openwalla state and selected router configuration. Relies on the Openwalla state-sync helper for scheduled router-side backups.

• Router Components - Compares installed Openwalla helper versions with the published script version and redeploys them when needed. Relies on Openwalla setup scripts.

Devices and Monitoring

• Device Inventory - Tracks devices by MAC address with hostname, IPv4 address, interface, online state, and traffic totals. A one-minute job pings known clients in batches of five to supplement live discovery; missed replies use the existing offline timeout. Relies on Openwalla devices collector, SQLite, ping, and nlbwmon.

• Pause and Block - Applies device-specific access rules. Manual blocks and quarantine share one verified firewall engine; scheduled pauses use the scheduling helpers. Relies on the Openwalla device-access engine, OpenWrt firewall, and scheduling helpers. conntrack clears existing device connections when available.

• Quarantine - Detects new devices through IPv4 discovery and blocks their routed IPv4/IPv6 traffic until approved. Router access remains available for recovery. Hidden devices are exempt, and release preserves independent manual or parental blocks. Relies on the Openwalla devices collector, shared device-access engine, and OpenWrt firewall.

• Parental Controls - Groups devices and applies recurring access schedules. Relies on Openwalla parental-control and scheduler helpers.

• Live Throughput - Displays current upload/download rates for the router and devices. Relies on interface counters; per-device rates use the Openwalla device-speed helper and conntrack.

• Bandwidth History - Stores summarized per-device usage for dashboard and device views. Relies on Openwalla bandwidth collector, SQLite, and conntrack.

• Statistics - Shows vnStat interface history, nlbwmon device totals, protocols, and monthly usage. Relies on vnstat/vnstat2, vnstati, and nlbwmon.

• Network Performance - Records latency, outages, Ethernet link state, DNS health, and scheduled speed tests. Relies on Openwalla network, DNS, and speed-test monitor helpers.

• Notifications - Stores router and Openwalla events in a local router database for the app inbox. Relies on Openwalla notifications helper and SQLite.

Flows

• Simple Network Flows - Periodically reads IPv4 conntrack entries and stores a lightweight connection history. Relies on Openwalla conntrack collector, conntrack, and SQLite.

• Detailed Network Flows - Reads Netify flow events with application, protocol, domain, destination, risk, and device details. Relies on netifyd, the Openwalla Netify collector, and SQLite. Use this instead of Simple Network Flows on routers with enough CPU and memory.

• Flow Usage Statistics - Optionally aggregates Netify byte counters at a configurable polling interval. Relies on Detailed Network Flows being installed and enabled.

Security and Traffic Control

• AdBlock - Controls OpenWrt domain blocking and service state. Relies on adblock and optionally luci-app-adblock.

• Smart Queue - Configures SQM to reduce latency and bufferbloat under load. Relies on sqm-scripts and optionally luci-app-sqm.

• WireGuard VPN - Creates and manages WireGuard interfaces, servers, peers, and QR configurations. Relies on wireguard-tools and luci-proto-wireguard.

• Policy-Based Routing (PBR) - Routes selected domains or addresses through a VPN or another interface. Relies on pbr and optionally luci-app-pbr.

• Dynamic DNS - Keeps a hostname synchronized with a changing public IP address. Relies on ddns-scripts, service providers, and optionally luci-app-ddns.

• Geo-Blocking - Uses country IP feeds to block inbound and outbound traffic, with split country sets and NFT reporting counters. Relies on banip and optionally luci-app-banip.

• Tor Routing - Routes all traffic or selected devices through Tor, with optional DNS routing. Relies on tor, tor-geoip, and the Openwalla Tor helper.

• Tailscale - Manages the Tailscale service, mesh VPN connection, routes, and exit-node options. Relies on tailscale and the Openwalla Tailscale helper.

• Multi-WAN - Configures WAN failover, load balancing, members, policies, and rules. Relies on mwan3, optionally luci-app-mwan3, and nftables compatibility packages when required.

• Open Source - GPLv3 licensed, with source code and releases published in the Openwalla repository.

---

Multiple Router Functionality

• Add Unlimited Routers: Each with its own credentials and settings.
• Quick Switch: Instantly switch routers from the dashboard dropdown or "Manage Routers" screen.
• Isolated Data: Each router’s dashboard, clients, and settings are kept separate.
• Edit & Remove: Update credentials, rename, or remove routers at any time.
• Auto-Connect: Remembers your last selected router and auto-connects on launch.
• Secure Storage: All credentials are stored securely on your device.

---

Screenshots

Login	Dashboard	Clients	Interfaces

---

Installation

Set Up with the App

1. Install Openwalla from Google Play after the listing is published, or use a release from the Openwalla repository.
2. Connect the phone to the OpenWrt router's LAN or Wi-Fi network.
3. Open Openwalla and enter the router address, normally 192.168.1.1, the OpenWrt username, normally root, and the router password.
4. Tap Connect. Openwalla securely saves the router profile when credential saving is enabled.
5. Open More > Manage Device > Router Setup after connecting.
6. Choose a setup profile and review its components:
   • Basic Install installs the core packages and helpers Openwalla needs.
   • Standard Install adds AdBlock, parental controls, quarantine, Smart Queue, DDNS, and WireGuard.
   • Advanced Install adds Policy-Based Routing to Basic and Standard.
   • Everything installs all bundled router features, including Netify Detailed Flow.
   • Custom Install lets you select the exact packages and Openwalla components to install or redeploy.
7. Tap Install via SSH. Installation runs independently on the router while the app reads its progress log. Phone sleep or an SSH disconnection does not stop the router job. If the app is closed, repeat the same installation selection to reconnect to its saved job. Package installation requires the router to have internet access.

Installer logs and machine-readable results are stored under /tmp/openwalla/install/<job-id>/ as install.log and status.json. Router reboots interrupt installation and clear these temporary records; jobs are not automatically rerun after a reboot. Router Setup also retains its existing timestamped logs under /root/openwalla/install-logs/.

Login hint: If Openwalla reports missing RPC permissions or cannot complete the first login, tap Need help? on the login page. Choose Copy RPC ACL via SSH to copy and apply Openwalla's bundled access-control file. This works without router internet access; enter the SSH password, or leave it blank when a fresh router does not have one yet. Return to the login page and connect again afterward.

Build from Source

git clone https://github.com/benisai/Openwalla.git
cd Openwalla
flutter pub get
flutter run

• Requires Flutter 3.32.5+ and Dart 3.8+
• Android: flutter build apk
• iOS: flutter build ios
• Release publishing: follow RELEASING.md to create signed GitHub APK and Android App Bundle releases.

---

Project Structure

lib/
├── config/                 # App configuration
├── models/                 # Data models (client, interface, router)
├── screens/                # UI screens (dashboard, clients, interfaces, login, more, etc.)
├── services/               # Business logic (API, secure storage)
├── state/                  # State management (app_state.dart)
├── widgets/                # Reusable UI components (luci_app_bar.dart)
└── main.dart               # App entry point

---

Development & Contribution

• Run in dev mode: flutter run
• Build for release: flutter build apk --release or flutter build ios --release
• Analyze code: flutter analyze

Contributions welcome! Please fork, branch, and submit a pull request.

---

Security & Privacy

• All credentials are stored securely on-device
• HTTPS and self-signed certificate support
• No analytics or tracking
• Read the Openwalla Privacy Policy for details about router data, optional self-hosted servers, and deletion.

---

Troubleshooting

• Cannot connect to the router - Confirm the phone is connected to the router's LAN or Wi-Fi, verify the router address in LuCI, and include a custom port when one is configured. Openwalla supports both HTTP and HTTPS.
• Login works in LuCI but fails in Openwalla - Tap Need help? on the login page, choose Copy RPC ACL via SSH, apply the bundled permissions, and connect again.
• Fresh router has no password - Leave the SSH password blank in the login-page RPC ACL helper. After connecting, set a root password under More > Manage Device > Router Password.
• Access denied or session expired - Tap Check Again or refresh the page. Openwalla will renew the LuCI session and retry feature validation without marking installed software as missing.
• Router Setup says there is no internet - Configure the WAN or Wi-Fi repeater first, then rerun Router Setup. The bundled RPC ACL helper works offline, but OpenWrt package installation requires internet access.
• Router Setup stops or produces no more output - Verify the saved root password and test the connection under Manage Device > Router Setup > SSH Terminal. Then rerun the selected setup profile.
• A feature says it is not installed - Use the feature's Check Again button. If it is genuinely missing, install its standalone component from the feature card or Router Setup.
• Router components are out of date - Open About, tap Router Components to run the version check, then open Router Components and redeploy the helpers.
• App cannot reconnect after a LAN IP change - Join the router's new subnet or reconnect Wi-Fi, then reopen Openwalla. The saved router profile is updated to the new LAN address automatically.
• Statistics is empty - Install the Statistics tools from the Statistics page or Router Setup. Statistics relies on vnstat/vnstat2 and nlbwmon.
• Network Flows is empty - Install either Simple Flows or Detailed Flows, enable the Flows dashboard option, and verify the corresponding collector is running. Detailed Flows requires netifyd and should not be installed alongside Simple Flows.
• Devices are missing or stale - Pull to refresh the Devices page and verify the Openwalla devices collector is installed under Router Components.
• Package installation fails - Refresh the router's package indexes and confirm its configured OpenWrt feeds match the installed firmware release. Openwalla prefers apk and falls back to opkg when needed.
• Advanced RPC check - On the router, run ubus list luci-rpc and ubus call luci-rpc getNetworkDevices '{}'. If those fail, reapply the bundled RPC ACL from the login page or restart rpcd.

---

License

GPL v3.0. See LICENSE.

---

Acknowledgments

• OpenWrt community for LuCI
• Flutter team
• OpenWrtManager inspiration
• Contributors and testers

---

Note: This app requires an OpenWrt router with LuCI web interface enabled. Make sure your router is properly configured before use.