Skip to content

Commit 0daec1c

Browse files
docs: add notes about dangers of installing on unsupported pfsense versions
1 parent 48f90a7 commit 0daec1c

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ API package and provide you with the information you need to configure and use t
3333
For new users, it is recommended to refer to the links in the [Getting Started section](#getting-started) to begin. Otherwise, the installation
3434
commands are included below for quick reference.
3535

36+
> [!WARNING]
37+
> Before installing the package, always ensure your pfSense version is supported! Support version are listed [here](https://pfrest.org/INSTALL_AND_CONFIG/#supported-pfsense-versions).
38+
> Installation of the package on unsupported versions of pfSense may result in unexpected behavior and/or system instability.
39+
3640
Install on pfSense CE:
3741

3842
```bash
@@ -50,6 +54,7 @@ pkg-static -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/re
5054
> the [releases page](https://github.com/jaredhendrickson13/pfsense-api/releases) to find the package built for
5155
> your version of pfSense.
5256
57+
5358
## Disclaimers
5459

5560
> [!CAUTION]

docs/INSTALL_AND_CONFIG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ run pfSense. It's recommended to follow Netgate's [minimum hardware requirements
1818
- pfSense Plus 24.03
1919
- pfSense Plus 24.11
2020

21+
!!! Warning
22+
Installation of the package on unsupported versions of pfSense may result in unexpected behavior and/or system instability.
23+
2124
!!! Tip
2225
Don't see your version of pfSense? Older versions of pfSense may be supported by older versions of this package.
2326
Check the [releases page](https://github.com/jaredhendrickson13/pfsense-api/releases).

0 commit comments

Comments
 (0)