Browse code

docs: Update INSTALL

The INSTALL file contained several minor errors, typos and was generally
not up-to-date in regards to what ./configure provides today. In
addition, several URL references have moved around to new homes.

Signed-off-by: David Sommerseth <davids@openvpn.net>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20190327120604.21101-1-davids@openvpn.net>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg18307.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>

David Sommerseth authored on 2019/03/27 21:06:04
Showing 1 changed files
... ...
@@ -1,6 +1,6 @@
1 1
 Installation instructions for OpenVPN, a Secure Tunneling Daemon
2 2
 
3
-Copyright (C) 2002-2018 OpenVPN Inc. This program is free software;
3
+Copyright (C) 2002-2019 OpenVPN Inc. This program is free software;
4 4
 you can redistribute it and/or modify
5 5
 it under the terms of the GNU General Public License version 2
6 6
 as published by the Free Software Foundation.
... ...
@@ -10,25 +10,29 @@ as published by the Free Software Foundation.
10 10
 QUICK START:
11 11
 
12 12
   Unix:
13
-    ./configure && make && make-install
13
+    ./configure && make && make install
14 14
 
15 15
 *************************************************************************
16 16
 
17
-To download OpenVPN, go to:
17
+To download OpenVPN source code of releases, go to:
18 18
 
19
-    http://openvpn.net/download.html
19
+    https://openvpn.net/community-downloads/
20 20
 
21 21
 OpenVPN releases are also available as Debian/RPM packages:
22 22
 
23 23
     https://community.openvpn.net/openvpn/wiki/OpenvpnSoftwareRepos
24 24
 
25
-To download easy-rsa go to:
25
+OpenVPN development versions can be found here:
26 26
 
27
-    https://github.com/OpenVPN/easy-rsa
27
+   https://github.com/OpenVPN/openvpn
28
+   https://gitlab.com/OpenVPN/openvpn
29
+   https://sourceforge.net/p/openvpn/openvpn/ci/master/tree/
28 30
 
29
-To download tap-windows (NDIS 5) driver source code go to:
31
+They should all be in sync at any time.
30 32
 
31
-    https://github.com/OpenVPN/tap-windows
33
+To download easy-rsa go to:
34
+
35
+    https://github.com/OpenVPN/easy-rsa
32 36
 
33 37
 To download tap-windows (NDIS 6) driver source code go to:
34 38
 
... ...
@@ -40,15 +44,11 @@ To get the cross-compilation environment go to:
40 40
 
41 41
 For step-by-step instructions with real-world examples see:
42 42
 
43
-    http://openvpn.net/howto.html
43
+    https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN
44 44
     https://community.openvpn.net/openvpn/wiki
45
+    https://openvpn.net/community-resources/
45 46
 
46
-For examples see:
47
-
48
-    http://openvpn.net/examples.html
49
-
50
-Also see the man page for more information, usage examples, and information on
51
-firewall configuration.
47
+Also see the man page for more information.
52 48
 
53 49
 *************************************************************************
54 50
 
... ...
@@ -73,7 +73,7 @@ REQUIRES:
73 73
       TUN/TAP Driver Configuration section below for more info.
74 74
 
75 75
 OPTIONAL (but recommended):
76
-  (1) OpenSSL library, necessary for encryption, version 0.9.8 or higher
76
+  (1) OpenSSL library, necessary for encryption, version 1.0.1 or higher
77 77
       required, available from http://www.openssl.org/
78 78
   (2) mbed TLS library, an alternative for encryption, version 2.0 or higher
79 79
       required, available from https://tls.mbed.org/
... ...
@@ -100,11 +100,12 @@ CHECK OUT SOURCE FROM SOURCE REPOSITORY:
100 100
   Clone the repository:
101 101
 
102 102
     git clone https://github.com/OpenVPN/openvpn
103
+    git clone https://gitlab.com/OpenVPN/openvpn
103 104
     git clone git://openvpn.git.sourceforge.net/gitroot/openvpn/openvpn
104 105
 
105 106
   Check out stable version:
106 107
 
107
-    git checkout -b 2.2 remotes/origin/release/2.2
108
+    git checkout release/2.4
108 109
 
109 110
   Check out master (unstable) branch:
110 111
 
... ...
@@ -134,7 +135,7 @@ BUILD A TARBALL FROM SOURCE REPOSITORY CHECKOUT:
134 134
 
135 135
 	autoreconf -i -v -f
136 136
 	./configure
137
-	make dist
137
+	make distcheck
138 138
 
139 139
 *************************************************************************
140 140
 
... ...
@@ -160,24 +161,19 @@ environment. See tests/t_client.rc-sample for details.
160 160
 OPTIONS for ./configure:
161 161
 
162 162
   --disable-lzo           disable LZO compression support [default=yes]
163
-  --enable-lzo-stub       don't compile LZO compression support but still
164
-                          allow limited interoperability with LZO-enabled
165
-                          peers [default=no]
163
+  --disable-lz4           Disable LZ4 compression support
164
+  --enable-comp-stub      Don't compile compression support but still allow limited interoperability with compression-enabled peers
166 165
   --disable-crypto        disable crypto support [default=yes]
167
-  --disable-ssl           disable SSL support for TLS-based key exchange
166
+  --disable-ofb-cfb       disable support for OFB and CFB cipher modes
168 167
                           [default=yes]
169 168
   --enable-x509-alt-username
170 169
                           enable the --x509-username-field feature
171 170
                           [default=no]
172
-  --disable-multi         disable client/server support (--mode server +
173
-                          client mode) [default=yes]
174 171
   --disable-server        disable server support only (but retain client
175 172
                           support) [default=yes]
176 173
   --disable-plugins       disable plug-in support [default=yes]
177 174
   --disable-management    disable management server support [default=yes]
178 175
   --enable-pkcs11         enable pkcs11 support [default=no]
179
-  --disable-socks         disable Socks support [default=yes]
180
-  --disable-http-proxy    disable HTTP proxy support [default=yes]
181 176
   --disable-fragment      disable internal fragmentation support (--fragment)
182 177
                           [default=yes]
183 178
   --disable-multihome     disable multi-homed UDP server support (--multihome)
... ...
@@ -187,44 +183,74 @@ OPTIONS for ./configure:
187 187
   --disable-debug         disable debugging support (disable gremlin and verb
188 188
                           7+ messages) [default=yes]
189 189
   --enable-small          enable smaller executable size (disable OCC, usage
190
-                          message, and verb 4 parm list) [default=yes]
191
-  --enable-password-save  allow --askpass and --auth-user-pass passwords to be
192
-                          read from a file [default=yes]
190
+                          message, and verb 4 parm list) [default=no]
193 191
   --enable-iproute2       enable support for iproute2 [default=no]
194 192
   --disable-def-auth      disable deferred authentication [default=yes]
195 193
   --disable-pf            disable internal packet filter [default=yes]
194
+  --disable-plugin-auth-pam
195
+                          disable auth-pam plugin [default=platform specific]
196
+  --disable-plugin-down-root
197
+                          disable down-root plugin [default=platform specific]
198
+  --enable-pam-dlopen     dlopen libpam [default=no]
196 199
   --enable-strict         enable strict compiler warnings (debugging option)
197 200
                           [default=no]
198 201
   --enable-pedantic       enable pedantic compiler warnings, will not generate
199 202
                           a working executable (debugging option) [default=no]
203
+  --enable-werror         promote compiler warnings to errors, will cause
204
+                          builds to fail if the compiler issues warnings
205
+                          (debugging option) [default=no]
200 206
   --enable-strict-options enable strict options check between peers (debugging
201 207
                           option) [default=no]
202 208
   --enable-selinux        enable SELinux support [default=no]
203 209
   --enable-systemd        enable systemd support [default=no]
210
+  --enable-async-push     enable async-push support for plugins providing
211
+                          deferred authentication [default=no]
204 212
 
205 213
 ENVIRONMENT for ./configure:
206 214
 
215
+  PLUGINDIR   Path of plug-in directory [default=LIBDIR/openvpn/plugins]
207 216
   IFCONFIG    full path to ipconfig utility
208 217
   ROUTE       full path to route utility
209 218
   IPROUTE     full path to ip utility
210 219
   NETSTAT     path to netstat utility
211 220
   MAN2HTML    path to man2html utility
212 221
   GIT         path to git utility
222
+  SYSTEMD_ASK_PASSWORD
223
+              path to systemd-ask-password utility
224
+  SYSTEMD_UNIT_DIR
225
+              Path of systemd unit directory [default=LIBDIR/systemd/system]
226
+  TMPFILES_DIR
227
+              Path of tmpfiles directory [default=LIBDIR/tmpfiles.d]
228
+
229
+ENVIRONMENT variables adjusting parameters related to dependencies
230
+
213 231
   TAP_CFLAGS  C compiler flags for tap
214
-  OPENSSL_CFLAGS
215
-              C compiler flags for OpenSSL, overriding pkg-config
216
-  OPENSSL_LIBS
217
-              linker flags for OpenSSL, overriding pkg-config
218
-  POLARSSL_CFLAGS
219
-              C compiler flags for polarssl
220
-  POLARSSL_LIBS
221
-              linker flags for polarssl
222
-  LZO_CFLAGS  C compiler flags for lzo
223
-  LZO_LIBS    linker flags for lzo
232
+  LIBPAM_CFLAGS
233
+              C compiler flags for libpam
234
+  LIBPAM_LIBS linker flags for libpam
224 235
   PKCS11_HELPER_CFLAGS
225 236
               C compiler flags for PKCS11_HELPER, overriding pkg-config
226 237
   PKCS11_HELPER_LIBS
227 238
               linker flags for PKCS11_HELPER, overriding pkg-config
239
+  OPENSSL_CFLAGS
240
+              C compiler flags for OpenSSL
241
+  OPENSSL_LIBS
242
+              linker flags for OpenSSL
243
+  MBEDTLS_CFLAGS
244
+              C compiler flags for mbedtls
245
+  MBEDTLS_LIBS
246
+              linker flags for mbedtls
247
+  LZO_CFLAGS  C compiler flags for lzo
248
+  LZO_LIBS    linker flags for lzo
249
+  LZ4_CFLAGS  C compiler flags for lz4
250
+  LZ4_LIBS    linker flags for lz4
251
+  libsystemd_CFLAGS
252
+              C compiler flags for libsystemd, overriding pkg-config
253
+  libsystemd_LIBS
254
+              linker flags for libsystemd, overriding pkg-config
255
+  P11KIT_CFLAGS
256
+              C compiler flags for P11KIT, overriding pkg-config
257
+  P11KIT_LIBS linker flags for P11KIT, overriding pkg-config
228 258
 
229 259
 *************************************************************************
230 260