Skip to content

Commit e1d5c53

Browse files
committed
manual: improve audit section, explain all
1 parent 8c3ed3b commit e1d5c53

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

source/manual/updates.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ By navigating to :menuselection:`System --> Firmware --> Settings`, you can infl
1717

1818
.. Tip::
1919
The settings page is also the place where you can run audits which help debugging common connectivitty issues,
20-
just press the "Run an audit" and choose "Connectivity" from the list.
20+
just press the "Run an audit" and choose "Connectivity" from the list if you encounter issues with the remote
21+
server.
2122

2223
-------------
2324
Minor updates
@@ -47,9 +48,15 @@ OPNsense will download all release files for an offline upgrade (kernel, package
4748
After a reboot, it will install all updates and when it is done, it will reboot again, then you should be on the
4849
desired release.
4950

50-
-----------------------
51-
Troubleshooting updates
52-
-----------------------
51+
---------------
52+
Firmware audits
53+
---------------
54+
55+
Audits provided are troubleshooting tools for a variety of purposes explained below.
56+
The forum is a good place to post your update and upgrade issues if you get stuck despite the best effort.
57+
58+
The cleanup audit triggers an immediate removal of all tempporary update files. Sometimes these files are not
59+
cleaned up correctly and can cause issues with the next round of package updates.
5360

5461
The connectivity audit offers a direction where to look for issues during updates and the following causes are
5562
in our experience most common:
@@ -66,4 +73,9 @@ Additionally, major ugpgrades may not pass certain sanity checks that need to be
6673
* "The Package manager is incompatible and needs a reinstall." can indicate misuse of the FreeBSD repository. Try to reinstall the "pkg" package via `System --> Firmware --> Packages`.
6774
* "Core package not known to package database." can mean that the mirror settings are wrong, the main mirror no longer holds any packages or that the mirror is unreachable for other reasons.
6875

69-
The forum is a good place to post your update and upgrade issues if you get stuck despite the best effort.
76+
The security audit checks each installed package's version against a database of known vulnerabilities. Vulnerabilities
77+
are reported for triage and inspection, not for reporting them to OPNsense. The appearance of vulnerabilities in an install
78+
indicate that the next update will likely address them.
79+
80+
After having performed a major upgrade, the upgrade audit shows the package upgrade log for further inspection.
81+
This can be helpful to identify package conflicts that led to partial or full upgrade failures.

0 commit comments

Comments
 (0)