2018-01-30 10:40:13 +00:00
|
|
|
==================================
|
|
|
|
|
Virtual & Cloud based Installation
|
|
|
|
|
==================================
|
|
|
|
|
|
|
|
|
|
------------
|
|
|
|
|
Local/Server
|
|
|
|
|
------------
|
2018-06-13 11:39:47 +00:00
|
|
|
Installing OPNsense on a virtual machine can be done by using the DVD ISO image.
|
2018-01-30 10:40:13 +00:00
|
|
|
Full instructions are available in chapter :doc:`install` .
|
|
|
|
|
|
|
|
|
|
General tips
|
|
|
|
|
------------
|
|
|
|
|
For optimum performance and compatibility, these guides are given:
|
|
|
|
|
|
|
|
|
|
* Minimum required RAM is 1 GB
|
2018-11-07 16:45:54 +00:00
|
|
|
* Minimum recommended virtual disk size of 8 GB
|
2019-03-06 17:27:21 +00:00
|
|
|
* Disable all off-loading settings in :menuselection:`Interfaces --> Settings`
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
.. image:: images/disableoffloading.png
|
|
|
|
|
|
|
|
|
|
------------------
|
|
|
|
|
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2018-01-30 10:40:13 +00:00
|
|
|
VMware ESXi
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2018-01-30 10:40:13 +00:00
|
|
|
VMware offers full instructions for installing FreeBSD, these can be found
|
2023-03-09 07:31:05 +00:00
|
|
|
`here <https://partnerweb.vmware.com/GOSIG/FreeBSD_13x.html>`__.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
2019-03-06 17:27:21 +00:00
|
|
|
To install the VMware tools just goto :menuselection:`System --> Firmware --> Plugins` and install
|
2018-01-30 10:40:13 +00:00
|
|
|
**os-vmware** by clicking on the **+** sign next to it.
|
|
|
|
|
|
|
|
|
|
.. image:: images/os-vmware.png
|
|
|
|
|
|
|
|
|
|
.. Note::
|
|
|
|
|
|
2023-11-06 16:33:54 +00:00
|
|
|
While other network setups may work fine, the VMXNET 3 is the recommended one according to VMware's Compatibility Guide.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2018-01-30 10:40:13 +00:00
|
|
|
Xen
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2019-03-06 17:27:21 +00:00
|
|
|
To install the Xen tools just goto :menuselection:`System --> Firmware --> Plugins` and install
|
2018-01-30 10:40:13 +00:00
|
|
|
**os-xen** by clicking on the **+** sign next to it.
|
|
|
|
|
|
|
|
|
|
.. image:: images/os-xen.png
|
|
|
|
|
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2018-01-30 10:40:13 +00:00
|
|
|
HyperV
|
|
|
|
|
------
|
2018-02-04 12:11:03 +00:00
|
|
|
HyperV Generation 1 and 2 are supported out of the box, no additional drivers
|
|
|
|
|
or tools are needed.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
2024-02-21 07:20:57 +00:00
|
|
|
* Secure Boot setting must be un-ticked in the Hardware > Security section for the VM.
|
|
|
|
|
|
|
|
|
|
------
|
2020-07-26 11:58:08 +00:00
|
|
|
KVM
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2020-07-26 11:58:08 +00:00
|
|
|
**i440FX chipset**
|
|
|
|
|
OPNsense on KVM works with virtio disks and network devices (confirmed on QEMU 5.0).
|
|
|
|
|
|
|
|
|
|
**Q35 chipset**
|
2022-07-06 09:55:11 +00:00
|
|
|
As of 22.1.x, OPNsense is based on FreeBSD 13.0, which includes support for the virtualized Q35 chipset and newer
|
|
|
|
|
generation of KVM virtio devices.
|
|
|
|
|
Note that this was a relatively recent addition to FreeBSD, so it may not be as well tested as the i440 support.
|
2020-07-26 11:58:08 +00:00
|
|
|
|
2024-02-21 07:20:57 +00:00
|
|
|
------
|
2018-01-30 10:40:13 +00:00
|
|
|
Others
|
|
|
|
|
------
|
2020-07-26 11:58:08 +00:00
|
|
|
OPNsense can be installed on all virtual machines that support FreeBSD (such as Bhyve, VirtualBox).
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
------
|
|
|
|
|
Hosted
|
|
|
|
|
------
|
2018-06-13 11:39:47 +00:00
|
|
|
For hosted installations where you can't install using the DVD ISO an alternative
|
|
|
|
|
approach is available in the form of **opnsense-bootstrap**.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
opnsense-bootstrap
|
|
|
|
|
------------------
|
|
|
|
|
opnsense-bootstrap(8) is a tool that can completely reinstall a running system
|
|
|
|
|
in place for a thorough factory reset or to restore consistency of all the OPNsense
|
|
|
|
|
files. It can also wipe the configuration directory, but won't do that by default.
|
|
|
|
|
|
|
|
|
|
It will automatically pick up the latest available version and build a chain of
|
|
|
|
|
trust by using current package fingerprints -> CA root certificates -> HTTPS -> OPNsense
|
|
|
|
|
package fingerprints.
|
|
|
|
|
|
2018-02-04 12:11:03 +00:00
|
|
|
What it will also do is turn a supported stock FreeBSD release into an OPNsense
|
2020-07-23 11:41:47 +00:00
|
|
|
installation. Both UFS and ZFS installations are supported.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
opnsense bootstrap is available for our
|
|
|
|
|
`github source repository <https://github.com/opnsense/update/tree/master/bootstrap>`__
|
|
|
|
|
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
|
Amazon AWS EC2 Cloud
|
|
|
|
|
--------------------
|
|
|
|
|
.. image:: how-tos/images/amazon-web-services.png
|
2019-04-28 16:30:01 +00:00
|
|
|
:height: 80px
|
2018-01-30 10:40:13 +00:00
|
|
|
|
2022-11-28 18:48:13 +00:00
|
|
|
Installing OPNsense into the Amazon cloud can be a daunting task as no console is
|
2022-02-05 18:09:19 +00:00
|
|
|
offered. Luckily an easy to install AMI is also available in the aws marketplace.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
See also our how-to for :doc:`how-tos/installaws`.
|
|
|
|
|
|
2019-04-28 16:30:01 +00:00
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
|
Microsoft Azure
|
|
|
|
|
--------------------
|
|
|
|
|
.. image:: how-tos/images/Azure.png
|
|
|
|
|
:height: 80px
|
|
|
|
|
|
|
|
|
|
OPNsense is also available in the Microsoft Azure Marketplace as an easy installable virtual appliance.
|
|
|
|
|
|
|
|
|
|
See also our how-to for :doc:`how-tos/installazure`.
|
|
|
|
|
|
2018-01-30 10:40:13 +00:00
|
|
|
-------------
|
|
|
|
|
Common Issues
|
|
|
|
|
-------------
|
|
|
|
|
Some common issues have been reported for different virtual environments.
|
|
|
|
|
You can find known solutions to these problems below.
|
|
|
|
|
|
2024-02-21 07:20:57 +00:00
|
|
|
If your problem is not listed always try the General tips mentioned in the
|
2018-01-30 10:40:13 +00:00
|
|
|
article first.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
File copy failed during installation
|
2024-02-21 07:20:57 +00:00
|
|
|
------------
|
2018-01-30 10:40:13 +00:00
|
|
|
This issue is most likely caused by low memory setting. Make sure your virtual
|
2018-11-07 16:45:54 +00:00
|
|
|
OPNsense installation has a minimum of 1 GB of RAM.
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Disk Errors on VMware
|
2024-02-21 07:20:57 +00:00
|
|
|
------------
|
|
|
|
|
This issue can be caused by a defective drive. Changing the drive mode to IDE has
|
2018-01-30 10:40:13 +00:00
|
|
|
been reported to help for certain ESXi versions.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
NAT issues on XenServer
|
2024-02-21 07:20:57 +00:00
|
|
|
------------
|
2020-02-10 09:20:27 +00:00
|
|
|
This issue has been reported to be solved by disabling checksum offloading on both
|
2018-01-30 10:40:13 +00:00
|
|
|
OPNsense domU and Vifs.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Traffic Shaper does not work on VMware
|
2024-02-21 07:20:57 +00:00
|
|
|
------------
|
2018-01-30 10:40:13 +00:00
|
|
|
If you are using vmxnet3 drivers try to switch to E1000.
|
