1
0
mirror of https://github.com/SoftEtherVPN/SoftEtherVPN.git synced 2024-11-23 01:49:53 +03:00

build documentation refactoring (#395)

BUILD_WINDOWS.TXT, BUILD_UNIX.TXT removed from root folder

src/BUILD_WINDOWS.TXT, src/BUILD_UNIX.TXT converted to "md"

BUILD_WINDOWS.TXT, BUILD_UNIX.TXT are now hyperlinks in README.md
This commit is contained in:
Ilya Shipitsin 2017-12-05 17:17:14 +05:00 committed by Moataz Elmasry
parent 671407dcfa
commit bed99f9a56
5 changed files with 25 additions and 171 deletions

View File

@ -114,7 +114,7 @@ installers from:
http://www.softether-download.com/ http://www.softether-download.com/
To build from the source, To build from the source,
see "BUILD_UNIX.TXT" or "BUILD_WINDOWS.TXT" files. see [BUILD_UNIX](src/BUILD_UNIX.md) or [BUILD_WINDOWS](src/BUILD_WINDOWS.md) files.
# HOW TO DOWNLOAD THE LATEST SOURCE CODE PACKAGE # HOW TO DOWNLOAD THE LATEST SOURCE CODE PACKAGE

View File

@ -1,125 +0,0 @@
How to build SoftEther VPN for UNIX
===================================
Requirements
------------
You need to install the following software to build SoftEther VPN for UNIX.
- Linux, FreeBSD, Solaris or Mac OS X.
- GNU Compiler Collectipon (gcc) and binary utilities.
- GNU Make (gmake).
- GNU C Library (glibc).
- POSIX Threads (pthread).
- OpenSSL (crypto, ssl).
- libiconv.
- readline.
- ncurses.
For example, the following commands help you to install the above programs
on Fedora or CentOS Linux:
$ yum -y groupinstall "Development Tools"
$ yum -y install readline-devel ncurses-devel openssl-devel
How to Build
------------
To build the programs from the source code, run the following commands:
$ ./configure
$ make
If any error occurs, please check the above requirements.
How to Install SoftEther VPN Server, Bridge or Client
-----------------------------------------------------
To install the vpnserver, vpnbridge and vpnclient programs into the
/usr/bin directory, run the following as the root user:
# make install
After the installation will complete successfully:
- Execute 'vpnserver start' to run the SoftEther VPN Server background service.
- Execute 'vpnbridge start' to run the SoftEther VPN Bridge background service.
- Execute 'vpnclient start' to run the SoftEther VPN Client background service.
- Execute 'vpncmd' to run SoftEther VPN Command-Line Utility to configure
VPN Server, VPN Bridge or VPN Client.
- You can also use VPN Server/Client Manager GUI Tool on other Windows PC to
connect to VPN services remotely.
You can download the GUI Tools from http://www.softether-download.com/.
How to Run SoftEther VPN Server for Test
----------------------------------------
To start the SoftEther VPN Server background service, run the following:
$ bin/vpnserver/vpnserver start
To stop the service, run the following:
$ bin/vpnserver/vpnserver stop
To configure the running SoftEther VPN Server service,
you can use SoftEther VPN Command Line Management Utility as following:
$ bin/vpncmd/vpncmd
Or you can also use VPN Server Manager GUI Tool on other Windows PC to
connect to the VPN Server remotely. You can download the GUI Tool
from http://www.softether-download.com/.
How to Run SoftEther VPN Bridge for Test
----------------------------------------
To start the SoftEther VPN Bridge background service, run the following:
$ bin/vpnbridge/vpnbridge start
To stop the service, run the following:
$ bin/vpnbridge/vpnbridge stop
To configure the running SoftEther VPN Bridge service,
you can use SoftEther VPN Command Line Management Utility as following:
$ bin/vpncmd/vpncmd
Or you can also use VPN Server Manager GUI Tool on other Windows PC to
connect to the VPN Bridge remotely. You can download the GUI Tool
from http://www.softether-download.com/.
How to Run SoftEther VPN Client for Test
----------------------------------------
To start the SoftEther VPN Client background service, run the following:
$ bin/vpnclient/vpnclient start
To stop the service, run the following:
$ bin/vpnclient/vpnclient stop
To configure the running SoftEther VPN Client service,
you can use SoftEther VPN Command Line Management Utility as following:
$ bin/vpncmd/vpncmd
Or you can also use VPN Client Manager GUI Tool on other Windows PC to
connect to the VPN Client remotely. You can download the GUI Tool
from http://www.softether-download.com/.
************************************
Thank You Using SoftEther VPN !
By SoftEther VPN Open-Source Project
http://www.softether.org/

View File

@ -19,9 +19,10 @@ You need to install the following software to build SoftEther VPN for UNIX.
For example, the following commands help you to install the above programs For example, the following commands help you to install the above programs
on Fedora or CentOS Linux: on Fedora or CentOS Linux:
```
$ yum -y groupinstall "Development Tools" $ yum -y groupinstall "Development Tools"
$ yum -y install readline-devel ncurses-devel openssl-devel $ yum -y install readline-devel ncurses-devel openssl-devel
```
How to Build How to Build
@ -29,8 +30,10 @@ How to Build
To build the programs from the source code, run the following commands: To build the programs from the source code, run the following commands:
```
$ ./configure $ ./configure
$ make $ make
```
If any error occurs, please check the above requirements. If any error occurs, please check the above requirements.
@ -41,7 +44,9 @@ How to Install SoftEther VPN Server, Bridge or Client
To install the vpnserver, vpnbridge and vpnclient programs into the To install the vpnserver, vpnbridge and vpnclient programs into the
/usr/bin directory, run the following as the root user: /usr/bin directory, run the following as the root user:
```
# make install # make install
```
After the installation will complete successfully: After the installation will complete successfully:
@ -61,16 +66,22 @@ How to Run SoftEther VPN Server for Test
To start the SoftEther VPN Server background service, run the following: To start the SoftEther VPN Server background service, run the following:
```
$ bin/vpnserver/vpnserver start $ bin/vpnserver/vpnserver start
```
To stop the service, run the following: To stop the service, run the following:
```
$ bin/vpnserver/vpnserver stop $ bin/vpnserver/vpnserver stop
```
To configure the running SoftEther VPN Server service, To configure the running SoftEther VPN Server service,
you can use SoftEther VPN Command Line Management Utility as following: you can use SoftEther VPN Command Line Management Utility as following:
```
$ bin/vpncmd/vpncmd $ bin/vpncmd/vpncmd
```
Or you can also use VPN Server Manager GUI Tool on other Windows PC to Or you can also use VPN Server Manager GUI Tool on other Windows PC to
connect to the VPN Server remotely. You can download the GUI Tool connect to the VPN Server remotely. You can download the GUI Tool
@ -82,16 +93,22 @@ How to Run SoftEther VPN Bridge for Test
To start the SoftEther VPN Bridge background service, run the following: To start the SoftEther VPN Bridge background service, run the following:
```
$ bin/vpnbridge/vpnbridge start $ bin/vpnbridge/vpnbridge start
```
To stop the service, run the following: To stop the service, run the following:
```
$ bin/vpnbridge/vpnbridge stop $ bin/vpnbridge/vpnbridge stop
```
To configure the running SoftEther VPN Bridge service, To configure the running SoftEther VPN Bridge service,
you can use SoftEther VPN Command Line Management Utility as following: you can use SoftEther VPN Command Line Management Utility as following:
```
$ bin/vpncmd/vpncmd $ bin/vpncmd/vpncmd
```
Or you can also use VPN Server Manager GUI Tool on other Windows PC to Or you can also use VPN Server Manager GUI Tool on other Windows PC to
connect to the VPN Bridge remotely. You can download the GUI Tool connect to the VPN Bridge remotely. You can download the GUI Tool
@ -103,16 +120,22 @@ How to Run SoftEther VPN Client for Test
To start the SoftEther VPN Client background service, run the following: To start the SoftEther VPN Client background service, run the following:
```
$ bin/vpnclient/vpnclient start $ bin/vpnclient/vpnclient start
```
To stop the service, run the following: To stop the service, run the following:
```
$ bin/vpnclient/vpnclient stop $ bin/vpnclient/vpnclient stop
```
To configure the running SoftEther VPN Client service, To configure the running SoftEther VPN Client service,
you can use SoftEther VPN Command Line Management Utility as following: you can use SoftEther VPN Command Line Management Utility as following:
```
$ bin/vpncmd/vpncmd $ bin/vpncmd/vpncmd
```
Or you can also use VPN Client Manager GUI Tool on other Windows PC to Or you can also use VPN Client Manager GUI Tool on other Windows PC to
connect to the VPN Client remotely. You can download the GUI Tool connect to the VPN Client remotely. You can download the GUI Tool

View File

@ -1,44 +0,0 @@
How to build SoftEther VPN for Windows
======================================
Requirements
------------
You need to install the following software to build SoftEther VPN for Windows.
- Microsoft Windows XP, Vista, 7, 8 or later.
- Microsoft Visual Studio 2008 with the latest SP (SP1 9.0.30729.4462 QFE).
Make sure that you installed the x64 compiler and build tools.
* Note:
Visual Studio 2008 SP1 is required to build SoftEther VPN on Windows.
Please make sure that VS2008 'SP1' is installed.
Visual Studio 2010, 2012 or 2013 is currently not supported.
Visual Studio 2008 Express Edition is not supported.
Standard Edition, Professional Edition, Team System or Team Suite is
required.
Full Build Instructions
-----------------------
The following steps will build all SoftEther VPN program files, and also build
the installer packages of SoftEther VPN. It is very easy.
1. Run the "BuildAll.cmd" batch file in the "src" directory.
2. Wait until the building process will complete.
3. The built files are stored on the "output" directory.
Partly Build, Debug or Development Instructions on Visual Studio 2008
---------------------------------------------------------------------
If you are a programmer, you can open the SoftEther VPN solution file
with Visual Studio 2008 to customize. Open "src\SEVPN.sln" and enjoy it.
************************************
Thank You Using SoftEther VPN !
By SoftEther VPN Open-Source Project
http://www.softether.org/