Knowledge base
Lantern documentation
Install the collector, connect it to your network, set up sign-in, and get the most out of the map. Every screenshot is from the current preview build.
1Install the collectorWindows or Linux, on a machine that can reach your switches.
2Point it at your networkSNMP credentials, seed devices and discovery subnets.
3Set up sign-inActive Directory, Entra ID, Google, Okta or local accounts.
Get started
- What is Lantern?Lantern maps a network's switches, firewalls, access points and the devices behind them, and points out what needs attention.
- How Lantern worksThe collector, what it reads from your devices, where data is kept, and the network ports involved.
- RequirementsWhat the collector machine, your network and your devices need.
- Install on WindowsDownload, verify and run the collector on Windows, then keep it running in the background.
- Install on LinuxInstall the collector as a systemd service on x86-64 or ARM64 Linux.
- First sign-inCreate the first administrator, then sign in and find your way around.
- Configure the collectorTell Lantern which devices to poll, with which SNMP credentials, and which subnets it may discover.
- Check collectionSee which devices answer, which credential each one uses, and why a device is not being polled.
Sign-in and users
- Sign-in and rolesHow people sign in to Lantern, the three roles, and how directory groups become roles.
- LDAP and Active DirectoryLet people sign in with their directory account, and give them roles from directory groups.
- Microsoft Entra IDSign in with Microsoft 365 and Entra ID accounts, with roles from app roles or groups.
- Google WorkspaceSign in with Google Workspace accounts from your domain.
- OktaSign in with Okta, with roles from Okta groups.
- Other OpenID Connect providersUse Auth0, Keycloak, JumpCloud, Duo or any OpenID Connect provider, and test it before turning it on.
- Users and local accountsSee who can sign in, add local accounts, reset passwords, disable people, and read sign-in activity.
- Serve Lantern over HTTPSGive Lantern a certificate and a name so people can reach it safely from their own computers.
Use Lantern
- DashboardThe site at a glance, with what needs attention first.
- The mapRead the map, choose what it shows, highlight a VLAN, colour links by speed or cable, and search.
- DevicesA device's details: identity, problems, ports, PoE, live monitoring and SSH.
- Loops and unmanaged switchesHow Lantern detects a network loop, traces where it starts, and finds switches hiding behind access ports.
- History and compareStep back to an earlier state of the network and see exactly what changed.
- InventoryDevices, endpoints and optics in sortable tables, with column choice and CSV export.
- Health and best practiceIssues by severity, the fourteen best-practice checks, and how the score is calculated.
- MonitoringTurn any SNMP value into a monitor with confirmed status changes, alerts, maintenance windows and notifications.
- ChangesThe event log, recorded SSH sessions, and saved snapshots.
- ReportsThe lifecycle and capacity report, ready to print or export.
- SSH sessionsOpen a recorded SSH session to a device through Lantern with PuTTY.
- SettingsData collection, appearance, and where to find sign-in and users.
Reference
- SecurityHow Lantern protects your devices, your credentials and your sign-ins, and what is still open in the preview.
- TroubleshootingCommon problems and how to fix them.
- Backups and updatesWhat to back up, how to restore, and how to update the collector.
- Command-line optionsEvery option of the collector program.
- Simulator and test faultsExplore Lantern with a simulated network, and break it on purpose to see how problems look.