Requirements
This page summarises what servers and network need for COD. The checklist helps IT management prepare the project.
As of: November 2026, COD 3.8.6
Documentation
Overview
| Area | Applies to | Details |
|---|---|---|
| Servers and databases | Self Hosted | Servers on this page |
| Names and addresses | all operating models | Names and addresses |
| Network devices: LLDP, SNMP, SSH, RADIUS | all operating models | Network devices |
| Time, DNS, certificates, internet access | time and DNS for all, server topics for Self Hosted | Time and DNS |
| Connections and firewall rules | all operating models | Connections and firewall rules on this page |
Checklist "Ready for COD"
Go through the list with your team. Note who is responsible. Clarify open items with your partner before the installation date.
| Item | Why | Responsible |
|---|---|---|
| Operating model chosen: Self Hosted, Shared Hosted or Private Hosted | determines what you provide yourself | IT management |
| With Self Hosted: server with Ubuntu Server 22.04, 24.04 or 26.04 LTS (amd64), freshly installed, access as root or with sudo | installation and updates run through apt | Servers |
| With Self Hosted: credentials for the package repository are available | no packages without credentials | IT management |
| With Self Hosted: access to the package repository, directly or through a proxy | installation and updates | Servers, firewall |
| HTTPS certificate approach decided: installation CA, your own certificate or a reverse proxy | COD works over HTTPS only | Servers |
| Time synchronisation (NTP) on the COD server, database servers and module servers, recommended on network devices | otherwise audit status "degraded" and timestamps that do not match | Servers, network |
| Naming scheme defined, one name per device in all systems | COD links topology, monitoring and backup through the name | Network |
| Fixed management addresses, static or by DHCP reservation | network object, backup and monitoring depend on the address | Network |
| Forward and reverse DNS for the COD server and module servers (recommended) | certificate and readability | Servers |
| LLDP enabled on switches and routers, with system name and management address | basis of the network map | Network |
| SNMP v1 or v2c on the network devices, read-only, with an access list for the COD source address | ports and port status | Network |
| SSH with a dedicated user for COD on devices that are read or backed up | neighbours, clients, backup | Network |
| A path from the COD server to every location, for example through VPN, with a fixed source address | all queries come from there | Network, firewall |
| Firewall rules from the list "Connections and firewall rules" in place | no query without a rule | Firewall |
| For monitoring: your own Zabbix instance, API token with write access to your own server groups | COD reads from your Zabbix and creates hosts there | Monitoring |
| For NAC: switches send RADIUS from their management address | otherwise no NAC sessions on the port | Network |
| Two independent access paths at remote locations | a change must not cost you access | Network |
Note: Devices without LLDP, such as cameras or building technology, do not appear in the network map automatically. You can draw them in by hand. Devices without SSH cannot be backed up directly. Clarify such devices with your partner in advance.
Servers (Self Hosted)
With Shared Hosted and Private Hosted, extocode provides the COD server. This section then applies only to components you operate yourself.
| Item | Requirement |
|---|---|
| Operating system | Ubuntu Server 22.04 LTS, 24.04 LTS or 26.04 LTS, freshly installed. |
| Architecture | amd64 |
| Privileges | root or sudo |
| Delivery | Debian packages through apt, for example the meta package cod-all. No containers |
| Repository | Credentials from extocode for apt.extoco.de. You receive the repository credentials as part of the project. |
| Internet during installation and updates | extocode's package repository, the Ubuntu archives, NodeSource and, on 22.04 and 24.04, the PostgreSQL repository. Directly or through an HTTP proxy. Details under Internet access |
| Runtime | Node.js 24. The setup script installs it |
| Databases | MariaDB and PostgreSQL 18 or later. Installed locally or on existing database servers. The installation rejects older PostgreSQL versions |
| Cache | Redis, Valkey on Ubuntu 26.04. Always runs on the COD server |
| HTTPS | Required for every access. See Certificates |
| Time | NTP on the COD server, database servers and module servers. See Time |
| Hardware | Your partner gives you guide values for your size. |
| Firewall on the server | The packages do not set up firewall rules. You define the rules yourself |
For the workstations:
| Item | Requirement |
|---|---|
| Browser | Access to COD over HTTPS only |
| Passkeepr extension | Chrome 137 or later, or Firefox 140 or later. From COD 3.8.6, extension version 3.3.6 or later |
| Interface language | English |
How to spread the services over one or more servers is described under Deployment shapes.
Connections and firewall rules
Customers and partners receive the list of connections and firewall rules as part of the project.
These principles apply to the direction of the connections:
| From | To | Purpose |
|---|---|---|
| Users' browsers | COD | Interface over HTTPS. A reverse proxy can sit in front |
| COD | Network devices, firewalls, Zabbix, vCenter, directory service, mail server | COD opens the connection and queries or controls |
| Backup service | Backed-up devices | SSH or SFTP, optionally through a jump host |
| Ansible service | Switches | SSH for configuration |
| Network devices | NAC service | RADIUS |
| Network devices | TACACS+ service | TACACS+ |
| Users' browsers | A device's web interface | only "Open web UI". The browser must then reach the device itself |
If modules run on hosts of their own: the connection between COD and module servers belongs in a trusted network.
Restrict all access on the devices to the source address of COD and of the module servers. More under Names and addresses.
What your network needs per module
Network and MikroTik
- COD queries switches and routers through SNMP v1 or v2c, SSH and optionally a vendor API.
- LLDP with system name, system name equal to the asset name.
- COD reads MikroTik routers through the RouterOS REST interface and over SSH.
- Details: Network devices
Automation
- The Ansible service configures switches from Allied Telesis, Cisco and Ruijie over SSH.
- The user needs configuration rights on the device. You receive the minimum rights as part of the project.
- Discovery in the Network module must have run first.
NAC
- Switches and access points speak RADIUS to the NAC service. The NAC service sends Change of Authorization and Disconnect to the devices.
- Devices support 802.1X or MAC authentication and send RADIUS from their management address.
- One shared secret per device, identical in COD and on the device.
TACACS+
- Network devices speak TACACS+ to the TACACS+ service.
- On the device: a TACACS+ client with server address and shared secret, accounting enabled.
- RouterOS has no TACACS+ client of its own. You therefore do not connect MikroTik routers through TACACS+.
Firewall and Captive Portal
- COD talks to the firewall through its HTTPS API and over SSH. COD checks reachability with ICMP and a connection attempt to the API.
- Supported: AIMdefense, OPNsense, pfSense and DynFi. The self-registration plugin and Captive Portal are for OPNsense only.
- With the plugin, the firewall registers itself with COD once. For this it must reach COD's address.
- Details: Firewalls
Monitoring
- COD talks to the API of your Zabbix frontend. Zabbix queries the devices itself. A Zabbix proxy per location has proven useful.
- API token with write access to your own server groups.
- Asset name equal to the Zabbix host name.
Backup
- The Backup service opens SSH or SFTP to the device, optionally through a jump host. Devices without SSH cannot be backed up directly.
- For database backups, the Backup service connects to the MariaDB server.
- For failure mails, the backup instance needs a mail server.
Hypervisor
- The hypervisor service on the COD server talks to vCenter or ESXi over HTTPS.
- Credentials per connection and location. You receive the minimum rights as part of the project.
Passkeepr
- The browser extension talks to COD over HTTPS. Passkeepr should stay on the COD server where possible.
- Optionally the browser checks passwords against a public breach database. Details under Internet access.
Inventory and other connections
- i-doit: COD reads through the i-doit API, read-only, with an API key.
- Directory service: COD talks to the domain controller over LDAPS. LDAP is possible.
- Mail per location: COD sends through your mail server.
- Audit: COD sends the audit log to your SIEM through syslog over TLS.
- OTP and GRC have no network requirements of their own.
Handout
The content of this page and its three subpages is available as the handout "Preparing for COD: requirements". Handout as PDF on the Downloads page