mirror of
https://github.com/OpenVPN/openvpn.git
synced 2025-05-09 13:41:06 +08:00
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. This is just a backport of git master 6099ab67122429c0 adjusting for the slight changes in release/2.4. The contents is the same as git master, as it is still valid for v2.4. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20190412202020.24045-1-davids@openvpn.net> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg18364.html Signed-off-by: Gert Doering <gert@greenie.muc.de>
This commit is contained in:
parent
6a5c9bb146
commit
abbfd4c887
104
INSTALL
104
INSTALL
@ -1,6 +1,6 @@
|
|||||||
Installation instructions for OpenVPN, a Secure Tunneling Daemon
|
Installation instructions for OpenVPN, a Secure Tunneling Daemon
|
||||||
|
|
||||||
Copyright (C) 2002-2018 OpenVPN Inc. This program is free software;
|
Copyright (C) 2002-2019 OpenVPN Inc. This program is free software;
|
||||||
you can redistribute it and/or modify
|
you can redistribute it and/or modify
|
||||||
it under the terms of the GNU General Public License version 2
|
it under the terms of the GNU General Public License version 2
|
||||||
as published by the Free Software Foundation.
|
as published by the Free Software Foundation.
|
||||||
@ -10,26 +10,30 @@ as published by the Free Software Foundation.
|
|||||||
QUICK START:
|
QUICK START:
|
||||||
|
|
||||||
Unix:
|
Unix:
|
||||||
./configure && make && make-install
|
./configure && make && make install
|
||||||
|
|
||||||
*************************************************************************
|
*************************************************************************
|
||||||
|
|
||||||
To download OpenVPN, go to:
|
To download OpenVPN source code of releases, go to:
|
||||||
|
|
||||||
http://openvpn.net/download.html
|
https://openvpn.net/community-downloads/
|
||||||
|
|
||||||
OpenVPN releases are also available as Debian/RPM packages:
|
OpenVPN releases are also available as Debian/RPM packages:
|
||||||
|
|
||||||
https://community.openvpn.net/openvpn/wiki/OpenvpnSoftwareRepos
|
https://community.openvpn.net/openvpn/wiki/OpenvpnSoftwareRepos
|
||||||
|
|
||||||
|
OpenVPN development versions can be found here:
|
||||||
|
|
||||||
|
https://github.com/OpenVPN/openvpn
|
||||||
|
https://gitlab.com/OpenVPN/openvpn
|
||||||
|
https://sourceforge.net/p/openvpn/openvpn/ci/master/tree/
|
||||||
|
|
||||||
|
They should all be in sync at any time.
|
||||||
|
|
||||||
To download easy-rsa go to:
|
To download easy-rsa go to:
|
||||||
|
|
||||||
https://github.com/OpenVPN/easy-rsa
|
https://github.com/OpenVPN/easy-rsa
|
||||||
|
|
||||||
To download tap-windows (NDIS 5) driver source code go to:
|
|
||||||
|
|
||||||
https://github.com/OpenVPN/tap-windows
|
|
||||||
|
|
||||||
To download tap-windows (NDIS 6) driver source code go to:
|
To download tap-windows (NDIS 6) driver source code go to:
|
||||||
|
|
||||||
https://github.com/OpenVPN/tap-windows6
|
https://github.com/OpenVPN/tap-windows6
|
||||||
@ -40,15 +44,11 @@ To get the cross-compilation environment go to:
|
|||||||
|
|
||||||
For step-by-step instructions with real-world examples see:
|
For step-by-step instructions with real-world examples see:
|
||||||
|
|
||||||
http://openvpn.net/howto.html
|
https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN
|
||||||
https://community.openvpn.net/openvpn/wiki
|
https://community.openvpn.net/openvpn/wiki
|
||||||
|
https://openvpn.net/community-resources/
|
||||||
|
|
||||||
For examples see:
|
Also see the man page for more information.
|
||||||
|
|
||||||
http://openvpn.net/examples.html
|
|
||||||
|
|
||||||
Also see the man page for more information, usage examples, and information on
|
|
||||||
firewall configuration.
|
|
||||||
|
|
||||||
*************************************************************************
|
*************************************************************************
|
||||||
|
|
||||||
@ -100,11 +100,12 @@ CHECK OUT SOURCE FROM SOURCE REPOSITORY:
|
|||||||
Clone the repository:
|
Clone the repository:
|
||||||
|
|
||||||
git clone https://github.com/OpenVPN/openvpn
|
git clone https://github.com/OpenVPN/openvpn
|
||||||
|
git clone https://gitlab.com/OpenVPN/openvpn
|
||||||
git clone git://openvpn.git.sourceforge.net/gitroot/openvpn/openvpn
|
git clone git://openvpn.git.sourceforge.net/gitroot/openvpn/openvpn
|
||||||
|
|
||||||
Check out stable version:
|
Check out stable version:
|
||||||
|
|
||||||
git checkout -b 2.2 remotes/origin/release/2.2
|
git checkout release/2.4
|
||||||
|
|
||||||
Check out master (unstable) branch:
|
Check out master (unstable) branch:
|
||||||
|
|
||||||
@ -134,7 +135,7 @@ BUILD A TARBALL FROM SOURCE REPOSITORY CHECKOUT:
|
|||||||
|
|
||||||
autoreconf -i -v -f
|
autoreconf -i -v -f
|
||||||
./configure
|
./configure
|
||||||
make dist
|
make distcheck
|
||||||
|
|
||||||
*************************************************************************
|
*************************************************************************
|
||||||
|
|
||||||
@ -160,24 +161,19 @@ environment. See tests/t_client.rc-sample for details.
|
|||||||
OPTIONS for ./configure:
|
OPTIONS for ./configure:
|
||||||
|
|
||||||
--disable-lzo disable LZO compression support [default=yes]
|
--disable-lzo disable LZO compression support [default=yes]
|
||||||
--enable-lzo-stub don't compile LZO compression support but still
|
--disable-lz4 Disable LZ4 compression support
|
||||||
allow limited interoperability with LZO-enabled
|
--enable-comp-stub Don't compile compression support but still allow limited interoperability with compression-enabled peers
|
||||||
peers [default=no]
|
|
||||||
--disable-crypto disable crypto support [default=yes]
|
--disable-crypto disable crypto support [default=yes]
|
||||||
--disable-ssl disable SSL support for TLS-based key exchange
|
--disable-ofb-cfb disable support for OFB and CFB cipher modes
|
||||||
[default=yes]
|
[default=yes]
|
||||||
--enable-x509-alt-username
|
--enable-x509-alt-username
|
||||||
enable the --x509-username-field feature
|
enable the --x509-username-field feature
|
||||||
[default=no]
|
[default=no]
|
||||||
--disable-multi disable client/server support (--mode server +
|
|
||||||
client mode) [default=yes]
|
|
||||||
--disable-server disable server support only (but retain client
|
--disable-server disable server support only (but retain client
|
||||||
support) [default=yes]
|
support) [default=yes]
|
||||||
--disable-plugins disable plug-in support [default=yes]
|
--disable-plugins disable plug-in support [default=yes]
|
||||||
--disable-management disable management server support [default=yes]
|
--disable-management disable management server support [default=yes]
|
||||||
--enable-pkcs11 enable pkcs11 support [default=no]
|
--enable-pkcs11 enable pkcs11 support [default=no]
|
||||||
--disable-socks disable Socks support [default=yes]
|
|
||||||
--disable-http-proxy disable HTTP proxy support [default=yes]
|
|
||||||
--disable-fragment disable internal fragmentation support (--fragment)
|
--disable-fragment disable internal fragmentation support (--fragment)
|
||||||
[default=yes]
|
[default=yes]
|
||||||
--disable-multihome disable multi-homed UDP server support (--multihome)
|
--disable-multihome disable multi-homed UDP server support (--multihome)
|
||||||
@ -187,44 +183,74 @@ OPTIONS for ./configure:
|
|||||||
--disable-debug disable debugging support (disable gremlin and verb
|
--disable-debug disable debugging support (disable gremlin and verb
|
||||||
7+ messages) [default=yes]
|
7+ messages) [default=yes]
|
||||||
--enable-small enable smaller executable size (disable OCC, usage
|
--enable-small enable smaller executable size (disable OCC, usage
|
||||||
message, and verb 4 parm list) [default=yes]
|
message, and verb 4 parm list) [default=no]
|
||||||
--enable-password-save allow --askpass and --auth-user-pass passwords to be
|
|
||||||
read from a file [default=yes]
|
|
||||||
--enable-iproute2 enable support for iproute2 [default=no]
|
--enable-iproute2 enable support for iproute2 [default=no]
|
||||||
--disable-def-auth disable deferred authentication [default=yes]
|
--disable-def-auth disable deferred authentication [default=yes]
|
||||||
--disable-pf disable internal packet filter [default=yes]
|
--disable-pf disable internal packet filter [default=yes]
|
||||||
|
--disable-plugin-auth-pam
|
||||||
|
disable auth-pam plugin [default=platform specific]
|
||||||
|
--disable-plugin-down-root
|
||||||
|
disable down-root plugin [default=platform specific]
|
||||||
|
--enable-pam-dlopen dlopen libpam [default=no]
|
||||||
--enable-strict enable strict compiler warnings (debugging option)
|
--enable-strict enable strict compiler warnings (debugging option)
|
||||||
[default=no]
|
[default=no]
|
||||||
--enable-pedantic enable pedantic compiler warnings, will not generate
|
--enable-pedantic enable pedantic compiler warnings, will not generate
|
||||||
a working executable (debugging option) [default=no]
|
a working executable (debugging option) [default=no]
|
||||||
|
--enable-werror promote compiler warnings to errors, will cause
|
||||||
|
builds to fail if the compiler issues warnings
|
||||||
|
(debugging option) [default=no]
|
||||||
--enable-strict-options enable strict options check between peers (debugging
|
--enable-strict-options enable strict options check between peers (debugging
|
||||||
option) [default=no]
|
option) [default=no]
|
||||||
--enable-selinux enable SELinux support [default=no]
|
--enable-selinux enable SELinux support [default=no]
|
||||||
--enable-systemd enable systemd suppport [default=no]
|
--enable-systemd enable systemd support [default=no]
|
||||||
|
--enable-async-push enable async-push support for plugins providing
|
||||||
|
deferred authentication [default=no]
|
||||||
|
|
||||||
ENVIRONMENT for ./configure:
|
ENVIRONMENT for ./configure:
|
||||||
|
|
||||||
|
PLUGINDIR Path of plug-in directory [default=LIBDIR/openvpn/plugins]
|
||||||
IFCONFIG full path to ipconfig utility
|
IFCONFIG full path to ipconfig utility
|
||||||
ROUTE full path to route utility
|
ROUTE full path to route utility
|
||||||
IPROUTE full path to ip utility
|
IPROUTE full path to ip utility
|
||||||
NETSTAT path to netstat utility
|
NETSTAT path to netstat utility
|
||||||
MAN2HTML path to man2html utility
|
MAN2HTML path to man2html utility
|
||||||
GIT path to git utility
|
GIT path to git utility
|
||||||
|
SYSTEMD_ASK_PASSWORD
|
||||||
|
path to systemd-ask-password utility
|
||||||
|
SYSTEMD_UNIT_DIR
|
||||||
|
Path of systemd unit directory [default=LIBDIR/systemd/system]
|
||||||
|
TMPFILES_DIR
|
||||||
|
Path of tmpfiles directory [default=LIBDIR/tmpfiles.d]
|
||||||
|
|
||||||
|
ENVIRONMENT variables adjusting parameters related to dependencies
|
||||||
|
|
||||||
TAP_CFLAGS C compiler flags for tap
|
TAP_CFLAGS C compiler flags for tap
|
||||||
OPENSSL_CFLAGS
|
LIBPAM_CFLAGS
|
||||||
C compiler flags for OpenSSL, overriding pkg-config
|
C compiler flags for libpam
|
||||||
OPENSSL_LIBS
|
LIBPAM_LIBS linker flags for libpam
|
||||||
linker flags for OpenSSL, overriding pkg-config
|
|
||||||
POLARSSL_CFLAGS
|
|
||||||
C compiler flags for polarssl
|
|
||||||
POLARSSL_LIBS
|
|
||||||
linker flags for polarssl
|
|
||||||
LZO_CFLAGS C compiler flags for lzo
|
|
||||||
LZO_LIBS linker flags for lzo
|
|
||||||
PKCS11_HELPER_CFLAGS
|
PKCS11_HELPER_CFLAGS
|
||||||
C compiler flags for PKCS11_HELPER, overriding pkg-config
|
C compiler flags for PKCS11_HELPER, overriding pkg-config
|
||||||
PKCS11_HELPER_LIBS
|
PKCS11_HELPER_LIBS
|
||||||
linker flags for PKCS11_HELPER, overriding pkg-config
|
linker flags for PKCS11_HELPER, overriding pkg-config
|
||||||
|
OPENSSL_CFLAGS
|
||||||
|
C compiler flags for OpenSSL
|
||||||
|
OPENSSL_LIBS
|
||||||
|
linker flags for OpenSSL
|
||||||
|
MBEDTLS_CFLAGS
|
||||||
|
C compiler flags for mbedtls
|
||||||
|
MBEDTLS_LIBS
|
||||||
|
linker flags for mbedtls
|
||||||
|
LZO_CFLAGS C compiler flags for lzo
|
||||||
|
LZO_LIBS linker flags for lzo
|
||||||
|
LZ4_CFLAGS C compiler flags for lz4
|
||||||
|
LZ4_LIBS linker flags for lz4
|
||||||
|
libsystemd_CFLAGS
|
||||||
|
C compiler flags for libsystemd, overriding pkg-config
|
||||||
|
libsystemd_LIBS
|
||||||
|
linker flags for libsystemd, overriding pkg-config
|
||||||
|
P11KIT_CFLAGS
|
||||||
|
C compiler flags for P11KIT, overriding pkg-config
|
||||||
|
P11KIT_LIBS linker flags for P11KIT, overriding pkg-config
|
||||||
|
|
||||||
*************************************************************************
|
*************************************************************************
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user