Netsocs Synergy Installation¶
This section describes the requirements and step-by-step guides for deploying Netsocs Synergy in your infrastructure.
The primary distribution method is through an OVA (Open Virtualization Appliance) image, which encapsulates a preconfigured and optimized virtual machine for rapid deployment on compatible hypervisors.
Installation Process Phases¶
The installation process is divided into three main phases. It is recommended to follow them in the order presented.
-
Phase 1: Planning and Prerequisites
Review infrastructure, network, and security requirements before installation. -
Phase 2: OVA Deployment Guide
Step-by-step procedure to import, configure, and start the virtual machine on VMware. -
Phase 3: Management and Best Practices
Management best practices: updates, backups, monitoring, and security.
Phase 1: Planning and Prerequisites¶
About the OVA Image¶
The OVA image includes:
- Base operating system: Linux Debian or Ubuntu.
- Pre-installed libraries and dependencies.
- Netsocs services ready to use (no prior OS required on the VM).
Infrastructure Requirements¶
| Environment | vCPU | RAM | SSD Storage (Recommended) |
|---|---|---|---|
| Pilot / Small (< 100 devices) | 6 vCPU | 16 GB | 500 GB |
| Production / Large (> 100 devices) | 8–12 vCPU | 32–64 GB | 1–2 TB |
INFO
If you will store video recordings or more than 10,000 events/day, provision an additional 200–500 GB.
Network and Firewall Requirements¶
| Parameter | Requirement |
|---|---|
| IP | Static address required. |
| Services | Access to corporate DNS and NTP. |
| Discovery | Supported protocols: ONVIF, mDNS, WS-Discovery. |
Firewall Rules:
- Outbound:
443/TCP→github.com,objects.githubusercontent.com(updates).123/UDP(NTP).-
53/TCP/UDP(DNS). -
Inbound:
443/TCP(web management HTTPS).22/TCP(SSH restricted to VPN/bastion host).- Others as per integrations (RTSP, MQTT, Modbus, etc.).
Staging Environment¶
Highly recommended for:
- Validating updates.
- Testing integrations before production.
- Making changes without disrupting operations.
Phase 2: OVA Deployment Guide¶
Step-by-Step Procedure¶
- Import OVA with vSphere, Workstation, or Fusion.
- Assign Resources (vCPU and RAM according to requirements).
- Configure Storage → Thick Provision Eager Zeroed mode recommended.
- Configure Network → Assign NIC to the correct VLAN (Bridged mode).
- Start and Configure the VM:
- Hostname.
- Static IP, mask, gateway, DNS.
- NTP servers.
- Time zone.
- Verify Time Synchronization:
WARNING
Use only one method (corporate NTP or VMware Tools). Never both.
Phase 3: Management and Best Practices¶
Update Management¶
- Use only official versions from Netsocs GitHub.
- Test updates in staging before production.
- Schedule maintenance windows.
Backups¶
- 3-2-1 policy (3 copies, 2 different media, 1 off-site).
- Backups: daily incremental, weekly full.
- See guide → VM Backup.
Remote Access for Support¶
- Preferred: Site-to-site VPN or VPN with MFA.
- Alternative: Bastion host with logging.
- SSH: Restricted and temporary.
Acceptance Testing¶
- Validate connectivity to integrated systems.
- Test device discovery.
- Test critical automations (e.g., alarms → notification).
Quick Verification Checklist¶
- [ ] OVA imported and resources assigned.
- [ ] Static IP, DNS, and NTP configured.
- [ ] Valid TLS certificate installed.
- [ ] Firewall configured.
- [ ] Remote access for support validated.
- [ ] Initial backup completed.
- [ ] VM monitoring enabled.