Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/ovpn.4
- This file was added.
.\" Copyright (c) 2022 Rubicon Communications, LLC ("Netgate") | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer in the | |||||
.\" documentation and/or other materials provided with the distribution. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
.\" SUCH DAMAGE. | |||||
.\" | |||||
.Dd April 22, 2022 | |||||
.Dt OVPN 4 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm ovpn | |||||
.Nd OpenVPN DCO driver | |||||
.Sh SYNOPSIS | |||||
To compile this driver into the kernel, | |||||
place the following lines in your | |||||
kernel configuration file: | |||||
.Bd -ragged -offset indent | |||||
.Cd "device ovpn" | |||||
.Ed | |||||
.Pp | |||||
Alternatively, to load the driver as a | |||||
module at boot time, place the following line in | |||||
.Xr loader.conf 5 : | |||||
.Bd -literal -offset indent | |||||
if_ovpn_load="YES" | |||||
.Ed | |||||
pauamma_gundo.com: Does it have to be present when the kernel gets control, or is loading it during multiuser… | |||||
kpAuthorUnsubmitted Done Inline ActionsIt can be loaded at any time prior to its use. The upcoming openvpn version with DCO support should actually attempt to load it automatically if you attempt to use DCO on FreeBSD. kp: It can be loaded at any time prior to its use. The upcoming openvpn version with DCO support… | |||||
pauamma_gundo.comUnsubmitted Done Inline ActionsThen I'd mention the autoloading thing and use rc.conf loading instead (with or without bringing in sysrc(8), not sure). pauamma_gundo.com: Then I'd mention the autoloading thing and use rc.conf loading instead (with or without… | |||||
kpAuthorUnsubmitted Done Inline ActionsThis is the standard module text, I'm not sure we should be deviating from that. See for example man 4 if_bridge or man 4 if_epair. kp: This is the standard module text, I'm not sure we should be deviating from that.
See for… | |||||
pauamma_gundo.comUnsubmitted Not Done Inline ActionsPoint. (I think that decision should be revisited, but this is not the place for that discussion.) I'd still mention the autoloading thing, though. pauamma_gundo.com: Point. (I think that decision should be revisited, but this is not the place for that… | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
device driver provides support for OpenVPN DCO. | |||||
DCO, or Data Channel Offload, moves the OpenVPN data path into the kernel. | |||||
This can improve performance. | |||||
.Pp | |||||
The | |||||
.Nm | |||||
interface is created automatically by the OpenVPN daemon. | |||||
It requires no configuration other than that done by OpenVPN. |
Does it have to be present when the kernel gets control, or is loading it during multiuser startup (rc) early enough?