mirror of
https://github.com/opnsense/docs
synced 2024-11-01 15:40:23 +00:00
110 lines
3.8 KiB
ReStructuredText
110 lines
3.8 KiB
ReStructuredText
==============
|
|
OPNsense Tools
|
|
==============
|
|
|
|
The OPNsense project offers a number of tools to instantly patch the system,
|
|
revert a package to a previous (older version) state or revert the whole kernel.
|
|
|
|
---------------
|
|
opnsense-update
|
|
---------------
|
|
The opnsense-update utility offers combined kernel and base system upgrades
|
|
using remotely fetched binary sets, as well as package upgrades via pkg.
|
|
For a complete list of options look at the manpage on the system.
|
|
|
|
Example:
|
|
--------
|
|
A minor update also updated the kernel and you experience some driver issues with your NIC.
|
|
Open your browser and go to
|
|
|
|
https://pkg.opnsense.org/FreeBSD:11:amd64/18.1/sets/
|
|
|
|
Here you can see all the kernels for version 18.1. Be aware to change the version if you are on a newer version.
|
|
As an example you updated from 18.1.4 to 18.1.5 you have now installed kernel-18.1.5.
|
|
To revert back to the last stable you can see kernel-18.1 so the syntax would be:
|
|
|
|
|
|
# opnsense-update -kr 18.1
|
|
|
|
# opnsense-shell reboot
|
|
|
|
|
|
Where -k only touches the kernel and -r takes the version number.
|
|
|
|
|
|
To switch back to the current kernel just use
|
|
|
|
# opnsense-update -k
|
|
|
|
# opnsense-shell reboot
|
|
|
|
.. Warning::
|
|
Before reverting a kernel please consult the forums or open an issue via Github.
|
|
You should only revert kernels on test machines or when qualified team members advise you to do so!
|
|
|
|
|
|
---------------
|
|
opnsense-revert
|
|
---------------
|
|
The opnsense-revert utility offers to securely install previous versions of packages
|
|
found in an OPNsense release as long as the selected mirror caches said release.
|
|
For a complete list of options look at the manpage on the system.
|
|
|
|
Example 1:
|
|
----------
|
|
The latest update of OPNsense to version 18.1.5 did a minor jump for the IPSec package "strongswan".
|
|
From this moment your VPNs are unstable and only a restart helps.
|
|
|
|
To check if the update of the package is the reason you can easily revert the package
|
|
to its previous state while running the latest OPNsense version itself.
|
|
|
|
# opnsense-revert -r 18.1.4 strongswan
|
|
|
|
With this command you can, for example, run OPNsense 18.1.5 while using the 18.1.4 version of strongswan.
|
|
If you want to go back to the current release version just do
|
|
|
|
# opnsense-revert strongswan
|
|
|
|
Example 2:
|
|
----------
|
|
The previous revert of strongswan was not the solution you expected so you try to completely revert to the previous
|
|
OPNsense version:
|
|
|
|
# opnsense-revert -r 18.1.4 opnsense
|
|
|
|
Be aware to also check if there were kernel updates like above to also downgrade the kernel if needed!
|
|
|
|
|
|
--------------
|
|
opnsense-patch
|
|
--------------
|
|
The opnsense-patch utility treats all arguments as upstream git repository commit hashes,
|
|
downloads them and finally applies them in order.
|
|
Patches can also be reversed by reapplying them, but multiple patches must be given in reverse order to succeed.
|
|
For a complete list of options look at the manpage on the system.
|
|
|
|
|
|
Example 1:
|
|
----------
|
|
In the Traffic Shaper a newly introduced typo prevents the system from setting the correct ipfw ruleset.
|
|
You were asked by the developer to test a fresh patch 63cfe0a at URL https://github.com/opnsense/core/commit/63cfe0a96c83eee0e8aea0caa841f4fc7b92a8d0
|
|
At the end of the page there's the short version 63cfe0a so the command would be:
|
|
|
|
# opnsense-patch 63cfe0a
|
|
|
|
If it doesn't fix your issue or makes it even worse, you can just reapply the command
|
|
to revert it.
|
|
|
|
Example 2:
|
|
----------
|
|
You need a special feature for a plugin and ask in Github for it.
|
|
A developer adds it and ask you to install the patch 699f1f2 for testing.
|
|
The full link to it would be https://github.com/opnsense/plugins/commit/699f1f28a33ce0122fa0e2f5e6e1f48eb3c4f074
|
|
|
|
# opnsense-patch -c plugins 699f1f2
|
|
|
|
The -c changes the default core to plugin repo and adds the patch to the system.
|
|
|
|
It is also possible to add patches from different users, just add -a githubusername before -c
|
|
|