Reformat README. Add compile requirements (#379)

* Reformat README. Add compile requirements * Expand the list of required packages for a successful compilation * Renamed README to README.md (Default name in github)
2025-07-10 01:34:58 +03:00 · 2017-12-03 20:51:07 +01:00
parent 1f33fbdff4
commit d94d5ed2e7
1 changed files with 38 additions and 20 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,252 @@
+SoftEther VPN (Developer Edition Master Repository)
+- An Open-Source Cross-platform Multi-protocol VPN Program
+http://www.softether.org/
+
+
+This repository has experimental codes. Pull requests are welcome.
+
+Stable Edition is available on
+https://github.com/SoftEtherVPN/SoftEtherVPN_Stable
+which the non-developer user can stable use.
+
+Source code packages (.zip and .tar.gz) and binary files of Stable Edition are also available:
+http://www.softether-download.com/
+
+We accept your patches by the acceptance policy:
+http://www.softether.org/5-download/src/9.patch
+
+Copyright (c) SoftEther Project at University of Tsukuba, Japan.
+
+The development of SoftEther VPN was supported by the MITOH Project,
+a research and development project by Japanese Government,
+subsidized by Ministry of Economy, Trade and Industry of Japan,
+administrated by Information Promotion Agency.
+https://www.ipa.go.jp/english/humandev/
+
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2
+as published by the Free Software Foundation.
+
+SoftEther VPN ("SoftEther" means "Software Ethernet") is one of the
+world's most powerful and easy-to-use multi-protocol VPN software.
+
+SoftEther VPN runs on Windows, Linux, Mac, FreeBSD and Solaris.
+
+SoftEther VPN supports most of widely-used VPN protocols
+including SSL-VPN, OpenVPN, IPsec, L2TP, MS-SSTP, L2TPv3 and EtherIP
+by the single SoftEther VPN Server program.
+
+More details on http://www.softether.org/.
+
+
+# BOARD MEMBERS OF THIS REPOSITORY
+
+
+Daiyuu Nobori (Since Jan 2, 2014)
+https://github.com/dnobori
+
+Moataz Elmasry (Since Nov 6, 2017)
+https://github.com/moatazelmasry2
+
+Zulyandri Zardi (Since Nov 6, 2017)
+https://github.com/zulzardi
+
+Alex Maslakov (Since Nov 6, 2017)
+https://github.com/GildedHonour
+
+
+
+# SOFTETHER VPN ADVANTAGES
+
+
+- Supporting all popular VPN protocols by the single VPN server:
+  SSL-VPN (HTTPS)
+  OpenVPN
+  IPsec
+  L2TP
+  MS-SSTP
+  L2TPv3
+  EtherIP
+- Free and open-source software.
+- Easy to establish both remote-access and site-to-site VPN.
+- SSL-VPN Tunneling on HTTPS to pass through NATs and firewalls.
+- Revolutionary VPN over ICMP and VPN over DNS features.
+- Resistance to highly-restricted firewall.
+- Ethernet-bridging (L2) and IP-routing (L3) over VPN.
+- Embedded dynamic-DNS and NAT-traversal so that no static nor
+  fixed IP address is required.
+- AES 256-bit and RSA 4096-bit encryptions.
+- Sufficient security features such as logging and firewall inner
+  VPN tunnel.
+- User authentication with RADIUS and NT domain controllers.
+- User authentication with X.509 client certificate.
+- Packet logging.
+- 1Gbps-class high-speed throughput performance with low memory and
+  CPU usage.
+- Windows, Linux, Mac, Android, iPhone, iPad and Windows Phone are
+  supported.
+- The OpenVPN clone function supports legacy OpenVPN clients.
+- IPv4 / IPv6 dual-stack.
+- The VPN server runs on Windows, Linux, FreeBSD, Solaris and Mac OS X.
+- Configure All settings on GUI.
+- Multi-languages (English, Japanese and Simplified-Chinese).
+- No memory leaks. High quality stable codes, intended for long-term runs.
+  We always verify that there are no memory or resource leaks before
+  releasing the build.
+- More details at http://www.softether.org/.
+
+
+# GETTING STARTED
+
+Visit the SoftEther VPN Project official web site at first:
+        http://www.softether.org/
+
+If you are not a developer, it is recommended to download the binary
+installers from:
+        http://www.softether-download.com/
+
+To build from the source,
+see "BUILD_UNIX.TXT" or "BUILD_WINDOWS.TXT" files.
+
+
+# HOW TO DOWNLOAD THE LATEST SOURCE CODE PACKAGE
+
+Go to http://www.softether-download.com/ and you can find the latest
+source-code package file in both .ZIP and .TAR.GZ format.
+
+This is the easiest way to obtain the source code of SoftEther VPN.
+
+
+# HOW TO GET THE LATEST SOURCE CODE TREE FOR DEVELOPERS
+
+If you are an open-source developer, visit our GitHub repository:
+https://github.com/SoftEtherVPN/SoftEtherVPN/
+
+You can download the up-to-date source-code tree of SoftEther VPN
+from GitHub. You may make your own fork project from our project.
+
+
+
+##  Requirements
+
+### 1. Debian/Ubuntu
+
+- gcc
+- libncurses-dev
+- libreadline-dev
+- make
+- openssl-dev
+
+### 2. Redhat/CentOS
+- gcc
+- openssl-devel
+- make
+- ncurses-devel
+- readline-devel
+## Compile and install
+
+The download and build instruction is following:
+ 
+```sh
+$ git clone https://github.com/SoftEtherVPN/SoftEtherVPN.git
+$ cd SoftEtherVPN
+$ ./configure
+$ make
+$ make install
+```
+
+
+ 
+
+# TO CIRCUMVENT YOUR GOVERNMENT'S FIREWALL RESTRICTION
+
+Because SoftEther VPN is overly strong tool to build a VPN tunnel,
+some censorship governments want to block your access to the source code
+of SoftEther VPN, by abusing their censorship firewalls.
+
+To circumvent your censor's unjust restriction,
+SoftEther VPN Project distributes the up-to-date source-code
+on all the following open-source repositories:
+
+  - GitHub
+    https://github.com/SoftEtherVPN/SoftEtherVPN/
+
+To fetch the source code from GitHub:
+```
+$ git clone https://github.com/SoftEtherVPN/SoftEtherVPN.git
+```
+We hope that you can reach one of the above URLs at least!
+
+
+# SOURCE CODE CONTRIBUTION
+
+Your contribution to SoftEther VPN Project is much appreciated.
+Please send patches to us through GitHub.
+Read the SoftEther VPN Patch Acceptance Policy in advance:
+http://www.softether.org/5-download/src/9.patch
+
+
+# DEAR SECURITY EXPERTS
+
+If you find a bug or a security vulnerability please kindly inform us
+about the problem immediately so that we can fix the security problem
+to protect a lot of users around the world as soon as possible.
+
+Our e-mail address for security reports is:
+softether-vpn-security [at] softether.org
+
+Please note that the above e-mail address is not a technical support
+inquiry address. If you need technical assistance, please visit
+http://www.softether.org/ and ask your question on the users forum.
+
+
+# DISCLAIMER
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THIS SOFTWARE IS DEVELOPED IN JAPAN, AND DISTRIBUTED FROM JAPAN,
+UNDER JAPANESE LAWS. YOU MUST AGREE IN ADVANCE TO USE, COPY, MODIFY,
+MERGE, PUBLISH, DISTRIBUTE, SUBLICENSE, AND/OR SELL COPIES OF THIS
+SOFTWARE, THAT ANY JURIDICAL DISPUTES WHICH ARE CONCERNED TO THIS
+SOFTWARE OR ITS CONTENTS, AGAINST US (SOFTETHER PROJECT, SOFTETHER
+CORPORATION, DAIYUU NOBORI OR OTHER SUPPLIERS), OR ANY JURIDICAL
+DISPUTES AGAINST US WHICH ARE CAUSED BY ANY KIND OF USING, COPYING,
+MODIFYING, MERGING, PUBLISHING, DISTRIBUTING, SUBLICENSING, AND/OR
+SELLING COPIES OF THIS SOFTWARE SHALL BE REGARDED AS BE CONSTRUED AND
+CONTROLLED BY JAPANESE LAWS, AND YOU MUST FURTHER CONSENT TO
+EXCLUSIVE JURISDICTION AND VENUE IN THE COURTS SITTING IN TOKYO,
+JAPAN. YOU MUST WAIVE ALL DEFENSES OF LACK OF PERSONAL JURISDICTION
+AND FORUM NON CONVENIENS. PROCESS MAY BE SERVED ON EITHER PARTY IN
+THE MANNER AUTHORIZED BY APPLICABLE LAW OR COURT RULE.
+
+USE ONLY IN JAPAN. DO NOT USE THIS SOFTWARE IN ANOTHER COUNTRY UNLESS
+YOU HAVE A CONFIRMATION THAT THIS SOFTWARE DOES NOT VIOLATE ANY
+CRIMINAL LAWS OR CIVIL RIGHTS IN THAT PARTICULAR COUNTRY. USING THIS
+SOFTWARE IN OTHER COUNTRIES IS COMPLETELY AT YOUR OWN RISK. THE
+SOFTETHER VPN PROJECT HAS DEVELOPED AND DISTRIBUTED THIS SOFTWARE TO
+COMPLY ONLY WITH THE JAPANESE LAWS AND EXISTING CIVIL RIGHTS INCLUDING
+PATENTS WHICH ARE SUBJECTS APPLY IN JAPAN. OTHER COUNTRIES' LAWS OR
+CIVIL RIGHTS ARE NONE OF OUR CONCERNS NOR RESPONSIBILITIES. WE HAVE
+NEVER INVESTIGATED ANY CRIMINAL REGULATIONS, CIVIL LAWS OR
+INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENTS IN ANY OF OTHER 200+
+COUNTRIES AND TERRITORIES. BY NATURE, THERE ARE 200+ REGIONS IN THE
+WORLD, WITH DIFFERENT LAWS. IT IS IMPOSSIBLE TO VERIFY EVERY
+COUNTRIES' LAWS, REGULATIONS AND CIVIL RIGHTS TO MAKE THE SOFTWARE
+COMPLY WITH ALL COUNTRIES' LAWS BY THE PROJECT. EVEN IF YOU WILL BE
+SUED BY A PRIVATE ENTITY OR BE DAMAGED BY A PUBLIC SERVANT IN YOUR
+COUNTRY, THE DEVELOPERS OF THIS SOFTWARE WILL NEVER BE LIABLE TO
+RECOVER OR COMPENSATE SUCH DAMAGES, CRIMINAL OR CIVIL
+RESPONSIBILITIES. NOTE THAT THIS LINE IS NOT LICENSE RESTRICTION BUT
+JUST A STATEMENT FOR WARNING AND DISCLAIMER.
+
+READ AND UNDERSTAND THE 'WARNING.TXT' FILE BEFORE USING THIS SOFTWARE.
+SOME SOFTWARE PROGRAMS FROM THIRD PARTIES ARE INCLUDED ON THIS SOFTWARE
+WITH LICENSE CONDITIONS WHICH ARE DESCRIBED ON THE 'THIRD_PARTY.TXT' FILE.
+
+