README

MorMap is a LibreNMS plugin for logical network diagrams, physical location plans and reusable device images.

Install

Run the following command as the librenms user from your LibreNMS installation directory, normally /opt/librenms:

lnms plugin:add morivasaraki/mormap

The release tag for this package is v1.1.7. Upload the archive contents to the repository root so composer.json is at the top level, then create the tag. The command above installs this version after Packagist has indexed that tag.

Requirements: a working LibreNMS installation with its Composer plugin system, PHP 8.2 or later within PHP 8.x, and the PHP DOM and Fileinfo extensions. Composer resolves the required librenms/plugin-interfaces dependency. Open MorMap from the LibreNMS menu after installation.

If MorMap was previously disabled, enable its existing internal plugin identifier:

lnms plugin:enable portmap

Local installation before publishing

The same package can be installed through lnms before a GitHub tag or Packagist release exists. Register its extracted directory as a Composer path repository for the librenms user, then use the normal plugin command. This is a local package source, not a fully offline LibreNMS installation; Composer may still need network access for dependencies.

Save drafts and close MorMap tabs. Back up storage/app/mormap, composer.json, composer.lock, and composer.plugins.json (if present). Keep the local source directory until switching back to the public release.

For example, upload the ZIP to /tmp/mormap-1.1.7.zip. As root, extract it into a new directory readable by librenms:

unzip /tmp/mormap-1.1.7.zip -d /opt/mormap-1.1.7
su - librenms

As librenms:

cd /opt/librenms
php scripts/composer_wrapper.php config --global repositories.mormap-local '{"type":"path","url":"/opt/mormap-1.1.7","options":{"symlink":false,"versions":{"morivasaraki/mormap":"1.1.7"}}}'
lnms plugin:add morivasaraki/mormap '^1.1.7'
php scripts/composer_wrapper.php show morivasaraki/mormap

The final command must report 1.1.7. Reopen MorMap and check Help for 1.1.7. The paths above are examples; the archive does not need to be uploaded to /root. Extract the package once without mixing files from older releases. composer.json must be directly inside /opt/mormap-1.1.7.

After the v1.1.7 tag has been published and indexed by Packagist, switch back to the public repository as librenms:

cd /opt/librenms
php scripts/composer_wrapper.php config --global --unset repositories.mormap-local
lnms plugin:add morivasaraki/mormap '^1.1.7'

Check the installation output and composer.lock before removing the extracted directory: MorMap should now use a GitHub distribution rather than a local path. A global path repository takes precedence over Packagist while configured. Existing custom repositories for MorMap must also be reviewed if Composer selects an unexpected source.

References: LibreNMS maintainer's local plugin example, Composer path repositories and explicit local versions.

Workspaces

Logical: create network diagrams, bind image connection points to device ports, draw cables, inspect discovered port details and publish maps.
Physical: organize sites, buildings, floors, server rooms and racks; place equipment; document active and passive cabling; and trace paths through patch panels and outlets. Import background plans at Site, Building, Floor and ServerRoom levels.
Asset Library: manage reusable device images, stencils and connection points.

Logical and Physical share device and port identities while keeping their connections separate. Save drafts, publish maps and export drawings using the controls inside MorMap. Undo retains the last fifty actions in Logical, Physical and Asset Library workspace sessions; reloading the page starts a new history.

Use Help or F1 for the complete English and French guides included in the application. Help and export assets are bundled locally.

Dashboard maps

Save and Publish a Logical or Physical map in MorMap.
Open a LibreNMS dashboard you can edit, then choose Add Widget → MorMap.
Open the new widget’s settings (pencil icon), select the published map and Save.

Use the MorMap widget for MorMap publications. LibreNMS’s Custom Map widget lists its own native maps. Drafts appear in the MorMap selector after publishing. Authenticated non-admin users can view published maps subject to their LibreNMS device permissions and dashboard access; publishing does not grant anonymous access. Dashboard widgets show the live map without toolbars, side panels, zoom badges, footers or notification bars and automatically fit the content when resized. Opening a published map directly retains its normal controls. Device and port monitoring and hover details remain active in both views.

Viewing permissions

Administrators retain all editing tools. Other authenticated users open MorMap's published-map list from the menu and can view permitted Logical and Physical publications, including dashboard embeds. LibreNMS users with global read access can view all published maps. A restricted user must have LibreNMS permission to view every monitored device placed on the map; a map containing no monitored devices requires global read or administrator access. VM guest details and remote equipment are filtered by device permissions. Unpublished physical placement metadata is not exposed to readers.

Dashboard access follows LibreNMS's dashboard policy. Widget settings require permission to update that dashboard. Publishing never enables anonymous access or gives readers permission to edit a draft.

Data and upgrades

MorMap stores maps, uploaded images, physical plans and infrastructure records under storage/app/mormap in the LibreNMS installation. Back up this directory and your LibreNMS Composer configuration and lock files before upgrading. Save drafts and close open MorMap editor tabs before replacing the installed version.

Version 1.1.7 remains compatible with maps from 1.0.0–1.1.6, including route-cache recovery and menu error protection. The public package name is morivasaraki/mormap; the internal plugin identifier remains portmap, and existing /plugin/mormap URLs and storage paths are retained.

When upgrading from 0.9.8 or earlier, the first infrastructure load separates Logical and Physical connections into schema 2 and retains the original graph in infrastructure/graph-before-topology-v2.json. Restoring a pre-0.9.9 release requires its matching pre-upgrade data backup. An existing custom Composer path repository may continue to select its local package; migrate that repository configuration before switching such an installation to the public package.

License

MorMap is licensed under the MIT License. Bundled libraries and fonts retain their own notices in package/third-party.

Concept, design and development: Morteza VASARAKI — GitHub.

Official reference: LibreNMS plugin packages.

1.1.7 changes

Duct bodies, endpoints, corners, branches and redrawn routes now obey the workspace Snap setting. Grid spacing matches the workspace and alignment tolerance follows zoom. Original cable identities, endpoints and pre-duct routes remain intact.
Context menus close when clicking elsewhere, including drawing and VM controls that intercept pointer events.
Drawing Properties displays numbers with at most two decimal places, retaining full stored precision when a field is not edited. Drawing, moving and resizing shapes snaps to nearby shape edges and centres, with temporary alignment guides; disable Snap for free placement.
Shape Format Painter includes label font size/color/bold/position, corner radius, opacity, dash, arrows, text alignment and other visual styling. Target identity, label text, geometry, lock and Physical view are preserved.
Expanded VM groups render in front of drawings, ducts and cluster headers, including published maps and dashboard embeds.
Double-click a cluster name to expand or collapse it. Title dragging, the chevron, Undo/Redo and read-only viewer behavior remain available.

1.1.6 changes

Shape Properties now includes Label: text, six top/bottom alignment positions, free dragging or exact custom offsets, font size, color and bold. Labels follow their shapes and persist in Save, Undo/Redo, published maps, dashboards and SVG exports in Logical and Physical.
Click a duct body to show individual cable routes or bundle them again. The name/count box has been removed; View cables and status remains available in the context menu.
Right-click a duct → Edit duct route to move endpoints, corners and segments. Redraw duct route accepts successive waypoints; Shift chooses the vertical-first elbow, Backspace removes the last waypoint, Enter finishes and Escape cancels. Logical SVG coordinates are normalized before route editing, preserving orthogonal route validation.
Delete duct removes only its presentation. Original cable routes, identities, port bindings and connections remain intact; Undo restores the duct.
The blue VM-count badge shows/hides the VM group on the map. Right-click → Virtual machines & containers… opens the management panel. Published maps and dashboard widgets support transient view toggles without changing saved data.

1.1.5 changes

Shared Logical and Physical drawing tools: rectangle, ellipse, line, arrow, double arrow, polygon and multiline text. Drawings retain their current location and Layout/Cabling view.
Eight resize handles, exact position/size/rotation, fill, outline, dash, opacity, rounded corners and text styling. Select several drawings to align/distribute them, duplicate them, lock position or change front/back layering. Ctrl/Cmd+D duplicates selected drawings. Save, Undo/Redo, published maps, dashboard views and SVG exports retain annotations.
Parallel cable routes… in the cable context menu previews selected orthogonal routes with configurable spacing and corridor position. Cable IDs and actual endpoint bindings remain unchanged. Duct and collapsed-cluster route segments also support exact numeric placement.
Cluster frames have a saved position and size in map coordinates. Select the header and drag any corner or edge to resize. Expanded and collapsed sizes are independent. Zoom no longer changes frame geometry, and resizing does not move or scale hosts or their cables. Fit cluster frame to hosts is an explicit context-menu action.
Moving a cluster translates its hosts and internal routes. External cable corridors and external shared ducts stay in place while their endpoint connections follow the hosts. This avoids moving the switch end of a carefully arranged route.
Cables shown at a collapsed cluster have their own editable presentation routes. Click a cable, then drag its segment or bend handles; right-click to add/remove a bend or reset that displayed route. Expanded cable routes are preserved.
Duct branches exit equipment boundaries before joining the corridor. Cables from one collapsed cluster share a single branch to the duct; the switch end retains every actual port connection. Click a branch to edit its route independently of the duct trunk. Manual branch routes are saved separately for expanded and collapsed views.
Group sizes and route edits participate in Save, Undo/Redo, publication and exports. Published maps and dashboard viewers keep read-only expand/collapse behavior. Existing 1.1.4 groups require no migration command; their frame is retained when first edited.

1.1.4 changes

Add visual clusters with a name, color, built-in platform icon (Proxmox, Hyper-V, ESXi, KVM or generic), or an image from Asset Library.
Move a cluster by its header, open or collapsed. Member spacing, internal routes, attached external cable endpoints, saved VM-group positions and associated ducts move consistently. Group color is descriptive; monitoring counts describe hosts, not HA or quorum health.
Select hosts with Ctrl/Shift-click, then right-click → Create cluster…. Use Cluster properties to change membership, name, icon or color. An imported custom icon is available in Cluster icon. Clicking the chevron expands or collapses the group. Ungroup hosts releases the group and preserves the hosts and cables.
Select cables with Ctrl/Shift-click, then right-click → Create cable duct…. Select at least two cables and a name/color/width. The duct has a shared route and short branches to the actual endpoints. Click its label to show the original independent routes or bundle them again. Right-click → View cables and status lists each cable and its endpoints/status.
Drag the duct to move its route. Select/right-click it to reveal bend and segment handles; drag these handles or use Add duct bend here / Remove duct bend. Release all cables removes the duct presentation without deleting any cable or changing its original route, port binding or shared connection.
Save, Undo/Redo, published maps, embedded dashboards and exports include both features. Published viewers can expand/collapse locally without changing the saved publication. Save and Publish again to change the published default.
Groups are local to each map and Physical location/cabling view. Dragging rack-mounted members changes their diagram positions in that view; their rack, U allocation and other views stay intact. Ungrouping retains the current drawing positions. A duct shared with cables outside the moved cluster stays in place; its branches follow their endpoints.

1.1.3 changes

Add a per-device checkbox beside Resolved IP in Logical and Physical Properties. Hidden IP labels stay hidden in published maps, dashboard widgets and exports.
Preserve existing IP display by default. Include the preference in Apply properties, Save and Undo/Redo without sharing it across maps.

1.1.2 changes

Fix the Add Device form excluding a known Stack's own first-member interfaces when it initially opens in Standalone mode. The form now restores the known Stack presentation; interfaces assigned to other members remain separate.
Display binding rows in Asset Library point order, including newly added points. Overlay saved port IDs and manual coordinates instead of replacing the Asset's point list with an older device profile.
Preserve current bindings when reopening Bind image ports in Logical and Physical. An optional image-scoped slot identity keeps newly saved bindings associated with their Asset points, including after labels or coordinates change. Legacy maps remain supported; ambiguous old positions are retained without guessing or deleting them.
Keep explicit Unbound selections and manual assignments when Reload ports succeeds. Failed requests retain the displayed inventory. Missing saved port IDs are identified as unavailable and restored when that same ID returns; they are not silently mapped to another interface.
Distinguish raw LibreNMS inventory counts from interfaces available after Stack filtering. Fill by interface order uses eligible inventory and remains unavailable when there are no eligible interfaces. Hardware / all-interface scope, natural name order, SNMP index order, duplicate-port checks and existing topology rules are retained.
Align the visible version and Help version at 1.1.2. No map data reset, cable deletion, layout redesign, VM behavior change or permission change is part of this release.

1.1.0 changes

Restore Unpublish in Logical, with publication revision checks and Undo/Redo. Removing a publication preserves its editable draft and shared connections. Route-cache recovery includes the new action.
Allow authenticated non-admin viewing through the MorMap menu, published maps and dashboard widget, using LibreNMS device and dashboard permissions. Drafts, library management and configuration remain administrative.
Removing a Physical connection point, equipment placement or location from a view preserves shared cables. Explicit cable deletion and Disconnect still disconnect the selected relationship.
Undo/Redo of shared infrastructure changes and Unpublish preserves the current draft geometry and pending edits instead of reloading an older saved layout.
Temporarily disable interaction during map loading to prevent a delayed Reload response from overwriting newly accepted edits.
Save independent positions for free-standing equipment in each Physical Cabling context. Moving it there preserves its normal location coordinates; default placement remains unchanged.
Physical Fit content includes manual cable detours, information boxes, labels and backgrounds.
Permit unrelated edits to a map containing a previously saved interface that LibreNMS deleted or reassigned. Retain its drawing and inventory warning. New invalid bindings or connections remain rejected.
Retain existing VM eligibility, Show VMs, OS icons, cable advisories, topology separation, manual routes, layouts and the fifty-action Undo history. Non-admin cross-plan location links open permitted published Physical plans.

1.0.9 changes

Show VMs in a hypervisor’s right-click menu now expands or collapses its guest group directly on the map, retaining its saved position, size and guest selection. It does not open the configuration panel.
The same action is available in Logical and Physical editors, published maps and LibreNMS dashboard widgets. In published maps and widgets, toggles are temporary and do not modify drafts or published data. Dashboard fitting includes expanded groups.
Host and guest selection now checks both LibreNMS OS classification and device type. Devices must be classified as servers without a conflicting non-server type; switches and other incompatible devices cannot be assigned as hosts, VMs or containers. The picker explains unavailable choices, and the server validates every assignment before saving the batch. Server classification permits manual membership; it does not automatically discover whether a server is virtual or which host owns it.
Previously saved incompatible assignments are retained with Review VM assignments warnings. Use Unlink to remove a wrong membership, or assign a valid guest to its correct hypervisor. Undo remains available. An invalid switch assignment no longer makes the switch a recognized hypervisor.
A recognized host without assigned guests displays an empty group. Existing OS icons, assignment controls, manual positioning, cables and other menus are retained.

1.0.8 changes

Add Show VMs at the top of a hypervisor’s right-click menu in Logical and Physical. A host is recognized by existing MorMap guest assignments or LibreNMS virtualization discovery; a normal Linux/Windows OS or a device name alone does not make it a hypervisor.
Show LibreNMS OS icons before guest names in the guest list and map groups, including Linux distribution and custom device icons resolved by LibreNMS. Existing group controls, monitoring status, membership, cables and saved layouts are retained.

1.0.7 changes

Associate existing LibreNMS devices with a hypervisor as VMs or containers in Logical and Physical. Choose a device, open Properties → Virtual machines / containers → Assign LibreNMS devices, select the guests, then apply. VMID is optional and entered manually. No hypervisor API or additional credentials are required.
The host badge opens a searchable guest list with VM/CT filters, OS, IP and current LibreNMS monitoring status. Up/Down describes monitoring reachability, not the guest power state. Missing inventory is shown as unavailable and its membership is retained for review.
Select guests and choose Show selected on map. Drag the group header or resize its lower-right corner. Several groups can be open. Save retains positions per map, hypervisor and Physical location/view. Collapse/expand and refresh preserve placement; dotted membership lines are independent of cables.
Assignments are shared between workspaces and saved immediately with Undo/Redo. Unlink removes membership, preserving the LibreNMS device, map placements and connections. Reassigning shows the previous host and explicitly moves the selected guest. Map group layout uses normal Save, Undo and Publish. Published viewers can inspect and temporarily expand/collapse without writing changes.
Visible cable strokes, white outlines and dotted membership lines scale with zoom, eliminating oversized cable outlines when zooming out. Invisible cable selection targets retain their usable screen width. Cable routes, formatting values and topology rules are retained.
Add route-cache recovery for the new guest API. Existing map files without guest groups load unchanged; new membership data is stored under storage/app/mormap/virtualization/guests.json.

1.0.6 changes

Restore the Locations tree in standalone published Physical plans. Use the tree, breadcrumbs or double-click a location to enter its interior. Double-click also works when the Pan hand tool is selected; dragging still pans. Dashboard widgets retain their existing compact presentation.
Add Unpublish beside Publish in the Physical editor. Select the saved plan and click Unpublish to remove its published snapshot from the Maps menu and publication selector while retaining the editable draft and all connections. Undo restores the publication; Publish can create it again. Widgets using that publication will need it republished or another map selected.
Keep publication revision checks and administrator permissions, and recover route caches from earlier releases for the new action. Other tools, connectivity rules, data formats and Logical views are unchanged.

1.0.5 changes

Preserve LibreNMS widget translations by removing MorMap's premature registration of the host widgets translation group. MorMap provides its own widget title through its controller.
Apply the uncluttered dashboard presentation to embedded published Logical and Physical maps. Normal editor and standalone viewer layouts are unchanged.
Verify stored connection endpoints against the LibreNMS inventory on map/infrastructure reads and status refreshes. Connections to confirmed deleted or reassigned interfaces with no remaining placement in any saved map are moved to disconnected records, so stale records no longer occupy an active port or return from an old published snapshot.
Retain a complete graph backup before each inventory correction under storage/app/mormap/infrastructure/graph-before-inventory-<revision>.json. Saved map files, routes, images and valid off-map connections are preserved. Equal device names, monitoring outages and disabled/down states never trigger deletion or automatic ID reassignment. A removed interface still placed in a saved map keeps its drawing and shows an inventory warning for review.
Keep engineering advisories, topology separation, explicit disconnection and Undo/Redo. Invalid identities and malformed data remain subject to validation.

1.0.4 changes

Allow additional connections on occupied ports in Logical, Physical, remote links and links across locations. Existing cables and their manual routes are retained.
Show nonblocking warnings for ambiguous connectivity, physical continuity loops and stack-role mismatches, including after Save and reload.
Allow Save, Undo and Redo with multiple connections per port. Explicit Disconnect still targets the selected cable.
Keep connected Front / Rear terminations selectable. Reusing an exact endpoint pair selects or retains its existing connection and details.
Preserve the current appearance, fifty-action history, published views and native dashboard widget.

1.0.3 changes

Add a native MorMap dashboard widget with a published Logical / Physical map selector, using LibreNMS’s own widget settings storage and access checks.
Recover route caches that predate the dashboard widget.
Restore published-view Pan, Fit, Properties and Print / Export controls; hide the top brand/Help strip and left device/location list.
Remove the standalone large MorMap logo from the LibreNMS Maps dropdown; retain a small inline icon beside each map name. Logos elsewhere are unchanged.
Increase Undo/Redo to 50 actions in all three workspaces, including port and cable drags and deletion actions.
Update Help and dashboard instructions and size embedded maps to the widget.

1.0.2 changes

Release connections when their last saved cable drawing is removed with a device or port. Keep connections still drawn in another saved map.
Explicitly deleting a cable or using Disconnect removes its shared connection across maps in the same topology when saved. Undo and Save restore it. Logical and Physical connections remain independent.
Expose a manual logical disconnect action for pre-existing connections without a visible cable. Save the map to complete disconnection.
Increase Logical and Physical Undo/Redo to 20 entries, including physical port and cable drags.
Show a small MorMap icon beside published maps and present maps without editing chrome.
Provide an iframe snippet for the LibreNMS Notes dashboard widget, with selected text for manual copying when clipboard access is unavailable or denied.
Keep route-cache recovery and guarded menu rendering for the mormap.home route.
Update the Help version and English/French history instructions.

IP labels (1.1.3)

Select a monitored device in Logical or Physical, then use the checkbox beside Resolved IP in Properties. Checked shows the IP on the map; unchecked hides that IP label. Click Apply properties, then Save. Publish the updated map to apply the setting to published views and LibreNMS dashboard widgets. The setting is per device placement and per map; existing maps keep showing IPs. Device names, inventory, connections and technical inspection details are unchanged. Undo/Redo includes the setting.

morivasaraki / mormap

Package info

Security

Statistics