summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsrividya0208 <a.srividya@vyos.io>2024-07-01 01:38:15 -0400
committersrividya0208 <a.srividya@vyos.io>2024-07-01 01:47:20 -0400
commitccdfa9fec150a409818f6f2a2cf4d5099de37b1b (patch)
tree816c515e22d8af8752b1dcb75697e6bde225b8f3
parent6a056849d77c9184ba3004251e22946e6bfa3601 (diff)
downloadvyos-documentation-ccdfa9fec150a409818f6f2a2cf4d5099de37b1b.tar.gz
vyos-documentation-ccdfa9fec150a409818f6f2a2cf4d5099de37b1b.zip
openvpn: edit of the openvpn-options
-rw-r--r--docs/configuration/interfaces/openvpn.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/configuration/interfaces/openvpn.rst b/docs/configuration/interfaces/openvpn.rst
index f51dfa94..fb85f4bf 100644
--- a/docs/configuration/interfaces/openvpn.rst
+++ b/docs/configuration/interfaces/openvpn.rst
@@ -637,17 +637,23 @@ benefit from it (see :ref:`issues_features`).
If you are a hacker or want to try on your own we support passing raw OpenVPN
options to OpenVPN.
-.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'persistent-key'
+.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'persist-key'
-Will add ``persistent-key`` at the end of the generated OpenVPN configuration.
+Will add ``persist-key`` to the generated OpenVPN configuration.
Please use this only as last resort - things might break and OpenVPN won't start
if you pass invalid options/syntax.
.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option
- 'push &quot;keepalive 1 10&quot;'
+ 'push keepalive 10 60'
Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file.
+.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option
+ 'route-up &quot;/config/auth/tun_up.sh arg1&quot;'
+
+Will add ``route-up "/config/auth/tun_up.sh arg1"`` to the generated OpenVPN
+config file. The path and arguments need to be single- or double-quoted.
+
.. note:: Sometimes option lines in the generated OpenVPN configuration require
quotes. This is done through a hack on our config generator. You can pass
quotes using the ``&quot;`` statement.