Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 2.88 KB

REQUIREMENTS.md

File metadata and controls

75 lines (58 loc) · 2.88 KB

Requirements

Linux

Requirement Minimum Recommended Notes
Kernel 4.18+ 5.4+ XDP support required for eBPF mode
glibc 2.31+ 2.35+ For binary releases
Architecture x86_64 x86_64, aarch64 ARM64 supported
Memory 128 MB 512 MB+ Depends on traffic volume and rule count
Disk 100 MB 500 MB+ For logs and MMDB files

Windows

Requirement Minimum Notes
OS Server 2022 / Windows 11 x86_64 only
eBPF for Windows v1.1.0+ Optional — enables XDP/eBPF packet filtering
Test Signing Enabled Required for eBPF kernel driver (bcdedit /set testsigning on)

Note: On Windows, Synapse runs in agent mode only. Proxy mode (HTTP/HTTPS termination) is not available on Windows.

Dependencies

Dependency Required Purpose
libbpf Linux only eBPF program loading
Redis Proxy mode Caching for certs, threat intel, CAPTCHA, content scan results
ClamAV Optional Content scanning (malware detection)
eBPF for Windows Optional Windows XDP/eBPF support

Tested platforms

Linux

Distribution Version Status Notes
Ubuntu 24.04 LTS ✅ Tested Recommended
Ubuntu 22.04 LTS ✅ Tested Fully supported
Ubuntu 20.04 LTS ✅ Tested All features, glibc 2.31
Ubuntu 18.04 LTS ✅ Tested All features, kernel 4.15→5.4 HWE
Ubuntu 16.04 LTS ⚠️ Limited iptables backend only (no XDP)
Debian 12 (Bookworm) ✅ Tested Fully supported
Debian 11 (Bullseye) ✅ Compatible glibc 2.31
RHEL / Rocky / Alma 9.x ✅ Tested Fully supported
RHEL / CentOS 8.x ⚠️ Compatible Kernel 4.18
Fedora 39+ ✅ Compatible Latest kernel
Amazon Linux 2023 ✅ Compatible AWS optimised

Windows

Platform Version Status Notes
Windows Server 2022+ ✅ Tested Agent mode, Windows Service, eBPF/XDP
Windows 11+ ✅ Tested Agent mode, terminal TUI

Kernel feature requirements

Feature Required For Check Command
XDP Packet filtering grep XDP /boot/config-$(uname -r)
BPF eBPF programs grep BPF /boot/config-$(uname -r)
BTF BPF Type Format ls /sys/kernel/btf/vmlinux

Build dependencies (from source)

# Ubuntu / Debian
apt-get install clang llvm libelf-dev libssl-dev zlib1g-dev \
  libzstd-dev pkg-config libcap-dev binutils-multiarch-dev cmake

# RHEL / Fedora
dnf install clang llvm elfutils-libelf-devel openssl-devel zlib-devel \
  zstd-devel pkgconfig libcap-devel binutils cmake