Install Zedmos on OPNsense in about ten minutes.
A friendly walkthrough for anyone setting Zedmos up at home or in a small office — no networking jargon, just the same screens you'll see, in order, with a sentence or two of context for each one.
Open the OPNsense console
Switch from the menu into the shell
OPNsense console menu listing options 0–13. Option 8 (Shell) is the one we need.
We start at the OPNsense console — the black-screen menu you see when you plug a monitor and keyboard into your firewall (or open the console of your virtual machine).
OPNsense shows a numbered list of options like Logout, Reboot system, Power off system and Shell. We want option 8) Shell so we can run a single install command.
Type 8 and press Enter. You should now see a prompt that looks like root@OPNsense:~ #. That's the shell — it's where we'll paste the installer in the next step.
- If the menu doesn’t appear, press Enter once — the console screensaver sometimes hides it.
- Don’t worry about the IP addresses and SSH fingerprints at the top of the screen — they’re just informational.
Paste the installer command
A single line fetches the installer from zedmos.com
The OPNsense shell with the fetch command typed in, pointing at https://www.zedmos.com/install/<token>.
Copy the install link from your Zedmos welcome email (or from your account page on zedmos.com), paste it into the shell, and let it run.
The command looks like this — yours will have a different long token at the end:
$ fetch -o - https://www.zedmos.com/install/<your-token> | shWhat this does, in plain English: it downloads the installer script over HTTPS and pipes it straight into the shell so it runs immediately. The token in the URL identifies your firewall and expires after first use, so it's safe to paste exactly as we provided it.
- If you mistype the URL, just press Enter — fetch will fail safely and you can try again.
- OPNsense uses fetch instead of curl. The syntax is similar but not identical — please don’t replace it with curl.
Confirm the installation
The installer asks once before it begins — answer y
Installer prompt at the bottom of the screen: Do you want to install the Zedmos plugin from the Zedmos repository now? [y/N]: y.
The installer prints a short notice on screen and then asks one yes/no question before it copies any files. You can scroll through the notice if you like, but the only thing you need to do is answer the final question.
At the bottom of the screen you'll see: “Do you want to install the Zedmos plugin from the Zedmos repository now? [y/N]”.
Type y and press Enter to start the installation.
Wait for the installer to finish
Config files created, free CTI enrolment, agent restarted
Successful installation log: policies.json, agent.json, writerd.json and zedmos_ml.json created; auto-enrollment with the public CTI hub succeeds; agent restarted.
The installer copies the Zedmos package onto OPNsense, writes a few sensible default config files, and registers your firewall in our free public threat-intelligence pool. You don’t have to type anything during this step.
You’ll see lines like:
[Zedmos] Created policies.json (fresh install)— your starting policy file.[zedmos-auto-enroll] Hub minted token tier=free— your firewall just joined the free CTI hub.DONE — engine has CTI access (tier=free)— installation complete.
When the prompt comes back, the shell part of the installation is finished. You can close this window — everything else happens in your browser.
- First-run enrolment usually takes 10–30 seconds. If it sits on “Restarting zedmos-agent…” a bit longer, that’s normal.
Open the Setup Wizard
Refresh the OPNsense menu, click any Zedmos link, accept terms
The Zedmos Installation Wizard at the Welcome step, with the terms checkbox and the Next button.
Switch to your browser, log in to the OPNsense web interface, and refresh the left navigation. A new red Zedmos entry appears, with sub-items like Dashboard, Live Sessions, Policies, Settings and Feedback. Click any one — the Setup Wizard opens automatically on first launch.
The Welcome screen on the right shows a short summary of what the wizard will configure: database, deployment mode, network interfaces and the subscription plan. On the right side you also see a System Overviewpanel summarising your hardware (CPU, RAM, interfaces). That's purely informational — nothing to fill in here.
Tick the box “I have read and accept the demo usage terms” and click Next → at the bottom right to begin.
- Don’t see Zedmos in the left menu? Hit Ctrl+F5 once — the menu cache occasionally needs a hard refresh.
Console registration (optional)
Manage many firewalls from one cloud dashboard — or skip for now
The Console Registration step with a single toggle. The toggle is off, meaning Console registration will be skipped.
The Zedmos Console (console.zedmos.com) is an optional cloud dashboard that lets you watch and configure several firewalls from one place. For a single home or small-office firewall, you can comfortably skip this step.
If you don't already have a Console account, leave the toggle off and click Next →. You can come back later via Settings → Console.
If you do want to register now, flip the toggle on, click create one now (opens console.zedmos.com in a new tab to sign up), then come back to the wizard.
- Console is free for the first firewall — registration just gives you one place to read live flows, device intelligence and health.
Pick a database
SQLite is pre-selected — keep it unless you really need Elasticsearch
Database selection screen with SQLite chosen by default and two Elasticsearch alternatives below it.
Zedmos stores events, flow records and analytics locally on the firewall. This step asks where to put them.
You have three options on the screen:
- SQLite Database (default, recommended). A single file on disk, no setup, perfect for up to about 100 devices on the network. This is the right pick for almost every home and small-office install.
- Elasticsearch Local. Installs a local Elasticsearch — useful when you have many devices and want richer search.
- Elasticsearch (remote cluster). Point at an existing enterprise Elasticsearch you already operate.
If you're not sure: keep SQLite selected and click Next →.
- You can switch the database later from Settings — no need to make a permanent decision now.
Interfaces & deployment mode
The most important step — tell Zedmos which traffic to look at
Interface Configuration with Deployment Mode set to Routed, em0 assigned to wan zone and em1 assigned to lan zone.
This step has two parts: how Zedmos sits in the path (deployment mode), and which interfaces it should watch (and what each one means).
Deployment mode — pick one
- Monitor mode.Zedmos only watches, it never blocks. Good for a first run when you want to see what's on your network without changing anything.
- Routed mode (default). Zedmos forwards packets and can block bad ones. This is what most home and small-office users want — full protection, full visibility.
- Bridge mode. Zedmos sits transparently between two network cards (L2). Advanced; use it only if you know you need it.
Interfaces — which ones to protect
Tick every network card you want Zedmos to inspect. For each one, click Set Security Zone and pick a zone:
- WAN = the side that faces the internet (the cable from your modem / ISP).
- LAN = your trusted home or office network (PCs, phones, printers, Wi-Fi).
A typical home setup is: em0 = WAN, em1= LAN. Pick at least one interface — you can't move to the next step otherwise.
Avoid ticking the interface you use to reach the OPNsense web UI as a management-only port. If you’re reachable on LAN, leave LAN ticked — that’s normal.
- Not sure which em# is which? Open OPNsense → Interfaces → Assignments in another tab. The labels there match what you see here.
- Click “Refresh Interfaces” after plugging or unplugging a cable to update the list.
Subscription
Free is the only active plan — Licensed is a placeholder for the future
Subscription step showing Free Plan selected on the left and a Licensed Plan option with a 4-group key input below it.
Choose how Zedmos talks to our threat-intelligence catalogue. Currently every install stays on Free.
- Free Plan (pre-selected). Every Zedmos firewall is automatically enrolled in the public CTI pool. You get basic monitoring, device discovery, simple reports and community support. Nothing to type.
- Licensed Plan — placeholder, not active. The field exists in the wizard, but Zedmos does not currently sell licences and the option is non-functional. In a future release this may unlock real-time blocking, custom policies, premium feeds and priority support — for now, please ignore it and leave Free selected.
Click Next → with Free Plan selected.
Licensed Plan is currently a placeholder. Zedmos is an early-stage research and engineering project — no licence is sold today, and no payment process exists. The Free Plan is the only operational option. We mention Licensed only because the wizard still shows the input field; it will become functional in a future release.
- Free pulls the public CTI catalogue automatically. The Licensed Plan is shown for completeness — there is no licence to buy at this time.
Save & Apply — start the engine
One last click and Zedmos is live
Configuration Complete screen with a green “Thank you for choosing Zedmos” message and a Save & Apply Configuration button.
You made it. The final screen confirms your configuration is ready. All that's left is to apply it.
On the right you'll see a What's Next?panel pointing to the Dashboard, Policies, Devices and Settings pages — that's where you'll spend time after installation.
Click the big green Save & Apply Configuration button. Zedmos writes your choices to disk, starts the engine, and the wizard closes. After a few seconds, refreshing the page shows the live Dashboard.
Welcome to Zedmos — thank you for installing it.
From here, every page in the Zedmos menu has its own help screen with detailed examples — so you don't need to remember anything from this guide. Below is a quick map of where to look first.
Live traffic, top talkers, and security events at a glance. This is usually the first page you’ll open every day.
See connections happening right now on your network — handy when something feels slow and you want to know why.
Allow / block rules and threat-intelligence categories. Every page in here explains what each toggle does.
Historical reports — what happened yesterday, last week, last month. Good for spotting trends and showing what Zedmos caught.
Advanced options: Console registration, TLS inspection, license, integrations. Defaults are sensible — change only what you need.
Look for the little ‘?’ panel on the right of each page. It carries the same friendly explanations you saw in this guide.
Write to support@zedmos.com any time — no question is too small. We read every message and reply ourselves.