URUFIOperator docs

Operate URUFI from edge to subscriber

The practical entry point for installing gateways, creating networks, and composing access policy in URUFI.

URUFI is a software-defined access platform. Central services hold desired network and business state; a native Edge Agent turns each Linux gateway into the local DHCP, firewall, bandwidth, captive-access, and EAP-TLS enforcement point.

Client packets do not cross the cloud. The gateway keeps enforcing its last known good state when the control plane is temporarily unavailable.

Architecture at a glance

ComponentAuthority
NOCAgents, logical networks, firewall, bandwidth profiles, service classes, EAP, releases, and operational state
Business PortalPackages, PIN inventory, subscribers, free-trial policy, and captive branding
Core APIAccount entitlement, activation, plan ownership, PIN redemption, OTP, and durable device-state delivery
Manager + ControllerAuthenticated control plane between NOC/Core and connected agents
Edge AgentLocal address allocation and kernel enforcement through DHCP, nftables, tc, IFB, captive bootstrap, and RADIUS

Keep the layers separate

URUFI deliberately separates where a device connects, what it purchased, and how its traffic is treated.

LayerObjectMeaning
Physical topologyAgent local configLAN parent, WAN uplink, access/trunk/hybrid mode, allowed VLANs
Logical addressingEdge networkNative/VLAN attachment, CIDR, gateway, MTU, DNS, DHCP pools, access mode
Technical policyService classOptional bandwidth profile plus service-scoped firewall behavior
Business entitlementPackage and accountProduct, duration, payment/free state, expiry, and effective service class

A DHCP pool never represents a package. The receiving network assigns the address before the portal knows what a subscriber will buy. Entitlement changes authorization and policy membership without forcing the client onto another IP or VLAN.

Captive access flow

  1. The client joins an untagged or VLAN-backed network and receives a locally durable DHCP lease from the edge.
  2. An unauthorized client can reach only the captive listener and configured walled garden. Ordinary HTTP is redirected locally.
  3. The edge maps source IP to its own current lease, derives the router-observed MAC, and asks Manager for a signed portal session.
  4. Core verifies the signed tenant/MAC context and processes login, free trial, or PIN.
  5. The entitlement and durable outbox commit before success is returned.
  6. Manager delivers the current device state; the edge atomically updates authorization and service-class membership.

URUFI does not intercept HTTPS. Captive detection starts with HTTP and redirects to the real HTTPS portal.

Desired state and convergence

Saving a NOC form commits desired state. It does not prove the kernel accepted it. For network policy, the agent validates the full snapshot, applies interfaces, firewall, DHCP, captive, and shaping as one transaction, verifies runtime state, persists its last known good snapshot, then acknowledges the exact revision and checksum.

StatusMeaning
PendingDesired state exists but the connected edge has not acknowledged it
FailedThe edge rejected or could not apply the candidate; the previous good state remains
ConvergedDesired and applied revision/checksum match after runtime verification

Treat Converged as the completion condition. A structured apply error identifies the failed boundary, such as VLAN permission, subnet overlap, active-lease safety, root-qdisc ownership, or unavailable interface.

Local continuity is intentional

The edge restores its checksum-validated last-known-good network, lease, firewall, authorization, and shaping input at boot. Reconnection sends a complete current snapshot, so a missed transient event does not become permanent drift.

Failure boundaries

Unavailable componentContinues locallyWaits for recovery
Manager connectionCurrent leases, expiry enforcement, firewall, shaping, and EAP materialNew portal sessions and uncached central classification
Controller APIManager-to-agent runtimeNOC changes and immediate Core control-plane calls
Core APIExisting access and NOC operationsNew portal activation, PIN redemption, and profile download
One Edge AgentOther sites and central business statePacket services only at that site
  1. Install and enroll the Edge Agent.
  2. Enable the required edge services.
  3. Create and converge the site's networks.
  4. Author and test firewall policy.
  5. Create bandwidth profiles.
  6. Compose service classes and select them from Business Portal packages.
  7. Activate one test client and verify DHCP, captive access, expiry, firewall, download, upload, reconnect, and agent restart before onboarding the site.

The documentation is English-only so operator terminology, screenshots, error codes, and support procedures remain consistent across every deployment.