summaryrefslogtreecommitdiff
path: root/docs/vpn/openvpn.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-09-04 21:19:21 +0200
committerChristian Poessinger <christian@poessinger.com>2019-11-07 21:54:53 +0100
commitb5a7d9037c2f89a83bfff5b1490a41682a4d8d3a (patch)
treeeb2ce597f9cf2edf6496a5746b421804ec902377 /docs/vpn/openvpn.rst
parent653a6eed8d12dd6054f19ccacfeb35a0817e0b97 (diff)
downloadvyos-documentation-b5a7d9037c2f89a83bfff5b1490a41682a4d8d3a.tar.gz
vyos-documentation-b5a7d9037c2f89a83bfff5b1490a41682a4d8d3a.zip
OpenVPN: explain how to pass quotes to openvpn-option
Diffstat (limited to 'docs/vpn/openvpn.rst')
-rw-r--r--docs/vpn/openvpn.rst12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/vpn/openvpn.rst b/docs/vpn/openvpn.rst
index 7e468c7b..d0bc279b 100644
--- a/docs/vpn/openvpn.rst
+++ b/docs/vpn/openvpn.rst
@@ -424,6 +424,16 @@ options to OpenVPN.
set interfaces openvpn vtun10 openvpn-option 'persistent-key'
-Will add `persistent-key` at the end of the generated OpenVPN configuration.
+Will add ``persistent-key`` at the end of 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.
+
+Sometimes option lines in the generated OpenVPN configurarion require quotes.
+This is done through a hack on our config generator. You can pass Quotes using
+the ``&quot;`` statement.
+
+.. code-block:: sh
+
+ set interfaces openvpn vtun10 openvpn-option 'push &quot;keepalive 1 10&quot;'
+
+Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file.