From 4b446997c56f07a1b2badd5a1ca42338aefd6e35 Mon Sep 17 00:00:00 2001 From: Jared Hendrickson Date: Wed, 10 Jul 2024 20:11:59 -0600 Subject: [PATCH] docs: add warnings for incompatibility with 32-bit systems --- docs/INSTALL_AND_CONFIG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/INSTALL_AND_CONFIG.md b/docs/INSTALL_AND_CONFIG.md index 573a29b33..8bb26ed91 100644 --- a/docs/INSTALL_AND_CONFIG.md +++ b/docs/INSTALL_AND_CONFIG.md @@ -8,7 +8,8 @@ Overall, the REST API package is designed to be as lightweight as possible and s run pfSense. It's recommended to follow Netgate's [minimum hardware requirements](https://docs.netgate.com/pfsense/en/latest/hardware/minimum-requirements.html). !!! Warning - While the package should behave identically on architectures other than amd64, automated testing only covers amd64 + - The package is currently not compatible with 32-bit builds of pfSense. It is recommended to use the [legacy v1 package](https://github.com/jaredhendrickson13/pfsense-api/tree/legacy) for 32-bit systems. + - While the package should behave identically on 64-bit architectures other than amd64, automated testing only covers amd64 builds of pfSense. Support on other architectures is not guaranteed. ### Supported pfSense versions