Skip to content

Commit 95d1810

Browse files
nemesifiernemesifier
committed
[docs] Updated openvpn docs #322
Related to #322
1 parent de20a1c commit 95d1810

File tree

1 file changed

+81
-66
lines changed

1 file changed

+81
-66
lines changed

‎docs/source/backends/openvpn.rst‎

Lines changed: 81 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -86,70 +86,85 @@ Required properties:
8686
- proto
8787
- dev
8888

89-
======================== ======= ============ ============================
90-
key name type default allowed values
91-
======================== ======= ============ ============================
92-
``name`` string 2 to 24 alphanumeric
93-
characters, dashes and
94-
underscores
95-
``mode`` string ``p2p`` or ``server``
96-
``proto`` string ``udp``, ``tcp-client``,
97-
``tcp-server``
98-
``port`` integer ``1194`` integers
99-
``dev_type`` string ``tun``, ``tap``
100-
``dev`` string any non-whitespace character
101-
(max length: 15)
102-
``local`` string any string
103-
``comp_lzo`` string ``adaptive`` ``yes``, ``no`` or
104-
``adaptive``
105-
``auth`` string ``SHA1`` see `auth property source
106-
code`_
107-
``cipher`` string ``BF-CBC`` see `cipher property source
108-
code`_
109-
``engine`` string ``bsd``, ``rsax``,
110-
``dynamic`` or empty string
111-
``ca`` string any non whitespace character
112-
``cert`` string any non whitespace character
113-
``key`` string any non whitespace character
114-
``pkcs12`` string any non whitespace character
115-
``tls_auth`` string string containing TLS Auth
116-
key
117-
``ns_cert_type`` string ``client``, ``server`` or
118-
empty string
119-
``mtu_disc`` string ``no`` ``no``, ``maybe`` or ``yes``
120-
``mtu_test`` boolean ``False``
121-
``fragment`` integer ``0`` any positive integer
122-
``mssfix`` integer ``1450`` any positive integer
123-
``keepalive`` string two numbers separated by one
124-
space
125-
``persist_tun`` boolean ``False``
126-
``persist_key`` boolean ``False``
127-
``up`` string any non whitespace character
128-
``up_delay`` integer ``0`` any positive integer
129-
``down`` string any non whitespace character
130-
``script_security`` integer ``1`` ``0``, ``1``, ``2``, ``3``
131-
``user`` string any string
132-
``group`` string any string
133-
``mute`` integer ``0`` any positive integer
134-
``status`` string string and number separated
135-
by space, eg:
136-
``/var/log/openvpn.status
137-
10``
138-
``status_version`` integer ``1`` ``1``, ``2``, ``3``
139-
``mute_replay_warnings`` boolean ``False``
140-
``secret`` string any non whitespace character
141-
``reneg_sec`` integer ``3600`` any positive integer
142-
``tls_timeout`` integer ``2`` any positive integer
143-
``tls_cipher`` string any string
144-
``remote_cert_tls`` string ``client``, ``server`` or
145-
empty string
146-
``float`` boolean ``False``
147-
``auth_nocache`` boolean ``False``
148-
``fast_io`` boolean ``False``
149-
``log`` string filesystem path
150-
``verb`` integer ``1`` from ``0`` (disabled) to
151-
``11`` (very verbose)
152-
======================== ======= ============ ============================
89+
========================= ======= ============ ===========================
90+
key name type default allowed values
91+
========================= ======= ============ ===========================
92+
``name`` string 2 to 24 alphanumeric
93+
characters, dashes and
94+
underscores
95+
``mode`` string ``p2p`` or ``server``
96+
``proto`` string ``udp``, ``tcp-client``,
97+
``tcp-server``
98+
``port`` integer ``1194`` integers
99+
``data_ciphers`` list list of dicts, each dict
100+
need to have ``cipher`` and
101+
``optional``, see `cipher
102+
property source code`_ for
103+
the allowed ciphers
104+
``data_ciphers_fallback`` string see `cipher property source
105+
code`_
106+
``dev_type`` string ``tun``, ``tap``
107+
``dev`` string any non-whitespace
108+
character (max length: 15)
109+
``local`` string any string
110+
``comp_lzo`` string ``adaptive`` ``yes``, ``no`` or
111+
``adaptive``
112+
``auth`` string ``SHA1`` see `auth property source
113+
code`_
114+
``cipher`` string ``BF-CBC`` see `cipher property source
115+
code`_
116+
``engine`` string ``bsd``, ``rsax``,
117+
``dynamic`` or empty string
118+
``ca`` string any non whitespace
119+
character
120+
``cert`` string any non whitespace
121+
character
122+
``key`` string any non whitespace
123+
character
124+
``pkcs12`` string any non whitespace
125+
character
126+
``tls_auth`` string string containing TLS Auth
127+
key
128+
``ns_cert_type`` string ``client``, ``server`` or
129+
empty string
130+
``mtu_disc`` string ``no`` ``no``, ``maybe`` or
131+
``yes``
132+
``mtu_test`` boolean ``False``
133+
``fragment`` integer ``0`` any positive integer
134+
``mssfix`` integer ``1450`` any positive integer
135+
``keepalive`` string two numbers separated by
136+
one space
137+
``persist_tun`` boolean ``False``
138+
``persist_key`` boolean ``False``
139+
``up`` string any non whitespace
140+
character
141+
``up_delay`` integer ``0`` any positive integer
142+
``down`` string any non whitespace
143+
character
144+
``script_security`` integer ``1`` ``0``, ``1``, ``2``, ``3``
145+
``user`` string any string
146+
``group`` string any string
147+
``mute`` integer ``0`` any positive integer
148+
``status`` string string and number separated
149+
by space, eg:
150+
``/var/log/openvpn.status
151+
10``
152+
``status_version`` integer ``1`` ``1``, ``2``, ``3``
153+
``mute_replay_warnings`` boolean ``False``
154+
``secret`` string any non whitespace
155+
character
156+
``reneg_sec`` integer ``3600`` any positive integer
157+
``tls_timeout`` integer ``2`` any positive integer
158+
``tls_cipher`` string any string
159+
``remote_cert_tls`` string ``client``, ``server`` or
160+
empty string
161+
``float`` boolean ``False``
162+
``auth_nocache`` boolean ``False``
163+
``fast_io`` boolean ``False``
164+
``log`` string filesystem path
165+
``verb`` integer ``1`` from ``0`` (disabled) to
166+
``11`` (very verbose)
167+
========================= ======= ============ ===========================
153168

154169
Client specific settings
155170
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -209,9 +224,9 @@ For a list of all the OpenVPN configuration settings, refer to the
209224
`OpenVPN 2.3 manual
210225
<https://community.openvpn.net/openvpn/wiki/Openvpn23ManPage>`_.
211226

212-
.. _auth property source code: https://github.com/openwisp/netjsonconfig/blob/master/netjsonconfig/backends/openvpn/schema.py#L79-L89
227+
.. _auth property source code: https://github.com/openwisp/netjsonconfig/blob/master/netjsonconfig/backends/openvpn/schema.py#L157-L186
213228

214-
.. _cipher property source code: https://github.com/openwisp/netjsonconfig/blob/master/netjsonconfig/backends/openvpn/schema.py#L90-L103
229+
.. _cipher property source code: https://github.com/openwisp/netjsonconfig/blob/master/netjsonconfig/backends/openvpn/schema.py#L8-L91
215230

216231
Automatic generation of clients
217232
-------------------------------

0 commit comments

Comments
 (0)