### Example VPN Server Configuration File Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F3%2F3.3 This is an example of the SoftEther VPN Server configuration file in text format. It is structured hierarchically starting from 'root'. ```text # Software Configuration File # # You can edit this file when the program is not working. ``` -------------------------------- ### Start SoftEther VPN Bridge Service using net command Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F5%2F5.2 Use the `net start` command with the service name `sevpnbridge` to start the SoftEther VPN Bridge service. ```bash net start sevpnbridge ``` -------------------------------- ### Install SoftEther VPN Programs Source: https://www.softether.org/5-download/src/2.unix Installs the compiled vpnserver, vpnbridge, and vpnclient programs into the /usr/bin directory. Requires root privileges. ```bash make install ``` -------------------------------- ### Start SoftEther VPN Services Source: https://www.softether.org/5-download/src/2.unix Commands to start the SoftEther VPN Server, Bridge, or Client background services after installation. ```bash vpnserver start ``` ```bash vpnbridge start ``` ```bash vpnclient start ``` -------------------------------- ### Start VPN Server Service using net command Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F7%2F7.2 Use this command in the Windows command prompt to start the SoftEther VPN Server service. This is a reliable method for service management. ```bash > net start sevpnserver ``` -------------------------------- ### Enable SoftEther VPN Server to Start on Boot Source: https://www.softether.org/4-docs/1-manual/7._Installing_SoftEther_VPN_Server/7.3_Install_on_Linux_and_Initial_Configurations Enables the SoftEther VPN Server service to start automatically when the Linux system boots up. ```bash [root@machine vpnserver]# systemctl enable vpnserver ``` -------------------------------- ### Start SoftEther VPN Bridge Service Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F9%2F9.2 Execute this command in the command prompt to start the SoftEther VPN Bridge service. This is typically used after stopping it or if it fails to start automatically. ```bash > net start sevpnbridge ``` -------------------------------- ### Start SoftEther VPN Server Service Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F3%2F3.2 Use this command to start the SoftEther VPN Server service. The service name is 'sevpnserver'. ```bash net start sevpnserver ``` -------------------------------- ### Start SoftEther VPN Server Service Source: https://www.softether.org/4-docs/1-manual/7._Installing_SoftEther_VPN_Server/7.3_Install_on_Linux_and_Initial_Configurations Manually starts the SoftEther VPN Server service using systemctl. Requires root permissions. ```bash [root@machine vpnserver]# systemctl start vpnserver ``` -------------------------------- ### Start SoftEther VPN Server in User Mode Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F3%2F3.2 Launch the VPN Server in User Mode on Unix systems by appending the 'start' argument to the vpnserver executable. This method is used instead of registering it as a system daemon. ```bash $ ./vpnserver start SoftEther VPN Server Service Started. $ ``` -------------------------------- ### Create VPN Bridge Startup Script Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F9%2F9.3 This shell script defines actions to start, stop, and restart the VPN Bridge daemon. Ensure the DAEMON path is correct for your installation. ```shell #!/bin/sh # description: SoftEther VPN Server DAEMON=/usr/local/vpnbridge/vpnbridge LOCK=/var/lock/subsys/vpnbridge test -x $DAEMON || exit 0 case "$1" in start) $DAEMON start touch $LOCK ;; stop) $DAEMON stop rm $LOCK ;; restart) $DAEMON stop sleep 3 $DAEMON start ;; *) echo "Usage: $0 {start|stop|restart}" exit 1 esac exit 0 ``` -------------------------------- ### Install Build Dependencies on Fedora/CentOS Source: https://www.softether.org/5-download/src/2.unix Installs essential development tools and libraries required for building SoftEther VPN on Fedora or CentOS Linux. ```bash yum -y groupinstall "Development Tools" yum -y install readline-devel ncurses-devel openssl-devel ``` -------------------------------- ### Start vpncmd and Select Management Mode Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F6%2F6.1 When vpncmd is started, it prompts the user to select a management mode. This can be done interactively or via command-line arguments. ```bash vpncmd command - SoftEther VPN Command Line Management Utility SoftEther VPN Command Line Management Utility (vpncmd command) Version 1.00 Build 8971 Release Candidate 1 (English) Compiled 2013/02/14 21:42:00 by yagi at pc26 Copyright (c) SoftEther Project. All Rights Reserved. By using vpncmd program, the following can be achieved. 1. Management of VPN Server or VPN Bridge 2. Management of VPN Client 3. Use of VPN Tools (certificate creation and Network Traffic Speed Test Tool) Select 1, 2 or 3: ``` -------------------------------- ### AccountStartupSet Source: https://www.softether.org/4-docs/1-manual/6._Command_Line_Management_Utility_Manual/6.5_VPN_Client_Management_Command_Reference Sets a VPN connection setting as a startup connection. ```APIDOC ## AccountStartupSet ### Description Sets a VPN connection setting as a startup connection. ### Command `vpnclient AccountStartupSet` ``` -------------------------------- ### Start VPN Bridge in User Mode (Linux) Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2FA%2F10.B This command starts the VPN Bridge application in user mode on a Linux system. Ensure you have unpacked the installation package and created an executable file for vpnbridge. This is used when you only have general user access to the remote computer. ```bash ./vpnbridge start ``` -------------------------------- ### Install SoftEther VPN Server as a Windows Service Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F3%2F3.2 Use this command to register the vpnserver.exe as a Windows service. Administrator privileges are required. ```bash > vpnserver /install ``` -------------------------------- ### Start VPN Connection Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F6%2F6.5 Starts a VPN connection using a specific VPN connection setting. ```APIDOC ## Start VPN Connection ### Description Starts connection to VPN server using VPN connection setting. ### Method POST ### Endpoint /api/v1/connections/{connection_name}/connect ``` -------------------------------- ### Make Startup Script Executable Source: https://www.softether.org/4-docs/1-manual/7._Installing_SoftEther_VPN_Server/7.3_Install_on_Linux_and_Initial_Configurations Changes the permissions of the SoftEther VPN Server startup script to make it executable by the owner and readable/executable by others. ```bash [root@machine vpnserver]# chmod 755 /opt/vpnserver.sh ``` -------------------------------- ### Switching to Virtual Hub Management Mode Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F6%2F6.2 This example shows how to switch from VPN Server management mode to Virtual Hub management mode using the 'Hub' command. The prompt changes to reflect the selected Virtual Hub. ```shell VPN Server>Hub VPN Hub command - Select Virtual Hub to Manage The Virtual Hub "VPN" was selected. The command terminated normally. VPN Server/VPN> ``` -------------------------------- ### Build SoftEther VPN from Source Source: https://www.softether.org/5-download/src/2.unix Compiles the SoftEther VPN programs from the downloaded source code. Ensure all requirements are met before running. ```bash ./configure make ``` -------------------------------- ### Clone SoftEther VPN Repository and Build Source: https://www.softether.org/5-download/src Use git to clone the stable SoftEther VPN repository from GitHub, navigate into the directory, and then build and install the software using make commands. ```bash git clone https://github.com/SoftEtherVPN/SoftEtherVPN_Stable.git cd SoftEtherVPN make make install ``` -------------------------------- ### Start VPN Bridge Service Manually Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F9%2F9.3 Use this command to manually start the VPN Bridge service if it is not already running. Requires root permissions. ```shell [root@machine vpnbridge]# systemctl start vpnbridge ``` -------------------------------- ### Install SoftEther VPN Bridge as a Windows Service Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F5%2F5.2 Use this command to register `vpnbridge.exe` as a Windows service. Administrator privileges are required. ```bash > vpnbridge /install ``` -------------------------------- ### Enable VPN Bridge Service to Start on Boot Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F9%2F9.3 This command configures systemd to automatically start the VPN Bridge service when the Linux system boots up. This ensures the VPN Bridge is available after a system restart. ```shell [root@machine vpnserver]# systemctl enable vpnbridge ``` -------------------------------- ### Set Startup Connection Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F6%2F6.5 Sets a VPN connection setting as a startup connection. ```APIDOC ## Set Startup Connection ### Description Sets the VPN connection setting as a startup connection. ### Method POST ### Endpoint /api/v1/connections/{connection_name}/startup/set ``` -------------------------------- ### Display List of Available Commands Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F6%2F6.2 Type 'help' in the VPN Server management mode to display a list of all available commands. This output includes the command name and a brief description. ```bash VPN Server>help You can use the following 178 commands: About - Display the version information AcAdd - Add Rule to IP Access Control List AcDel - Delete Rule from IP Access Control List AcList - Get List of Rule Items of IP Access Control List AccessAdd - Add Access List Rules AccessDelete - Delete Rule from Access List . .(Abbreviation ) . UserSet - Change User Information UserSignedSet - Set Signed Certificate Authentication for User A uthentication Method To reference the usage for each respective command, input "command name /?" to d isplay help. VPN Server> ``` -------------------------------- ### BridgeCreate Command Example with Arguments Source: https://www.softether.org/index.php?action=source&title=4-docs%2F1-manual%2F6%2F6.2 This example demonstrates calling the BridgeCreate command with specific arguments: [TEST] for hubname, [Intel(R) PRO/1000 MT Desktop Adapter] for DEVICE, and [no] for TAP. Arguments can be named or unnamed and their order can be changed. ```text >BridgeCreate TEST /DEVICE:"Intel(R) PRO/1000 MT Desktop Adapter" /TAP:no ``` ```text >BridgeCreate /DEVICE:"Intel(R) PRO/1000 MT Desktop Adapter" /TAP:no TEST ``` -------------------------------- ### RouterStart Source: https://www.softether.org/4-docs/1-manual/6._Command_Line_Management_Utility_Manual/6.3_VPN_Server_//_VPN_Bridge_Management_Command_Reference_%28For_Entire_Server%29 Starts the operation of a virtual Layer 3 switch. ```APIDOC ## RouterStart ### Description Starts the operation of a virtual Layer 3 switch. ### Command `RouterStart` ``` -------------------------------- ### Create SoftEther VPN Server Startup Script Source: https://www.softether.org/4-docs/1-manual/7._Installing_SoftEther_VPN_Server/7.3_Install_on_Linux_and_Initial_Configurations This shell script is used to manage the SoftEther VPN Server process as a daemon. It supports starting, stopping, and restarting the service. ```shell #!/bin/sh # chkconfig: 2345 99 01 # description: SoftEther VPN Server DAEMON=/usr/local/vpnserver/vpnserver LOCK=/var/lock/subsys/vpnserver test -x $DAEMON || exit 0 case "$1" in start) $DAEMON start touch $LOCK ;; stop) $DAEMON stop rm $LOCK ;; restart) $DAEMON stop sleep 3 $DAEMON start ;; *) echo "Usage: $0 {start|stop|restart}" exit 1 esac exit 0 ``` -------------------------------- ### ListenerEnable Source: https://www.softether.org/4-docs/1-manual/6._Command_Line_Management_Utility_Manual/6.3_VPN_Server_//_VPN_Bridge_Management_Command_Reference_%28For_Entire_Server%29 Enables a TCP listener to start accepting connections. ```APIDOC ## ListenerEnable ### Description Enables a TCP listener to start accepting connections. ### Command `ListenerEnable` ``` -------------------------------- ### IPsecGet Source: https://www.softether.org/4-docs/1-manual/6._Command_Line_Management_Utility_Manual/6.3_VPN_Server_//_VPN_Bridge_Management_Command_Reference_%28For_Entire_Server%29 Get the Current IPsec VPN Server Settings. ```APIDOC ## IPsecGet ### Description Retrieves the current configuration settings for the IPsec VPN server. ### Method Not specified (command-line utility) ### Endpoint Not applicable (command-line utility) ### Parameters None explicitly defined in the provided text. ### Request Example ``` vpncmd server list IPsecGet ``` ### Response Current IPsec VPN server settings. ``` -------------------------------- ### ServerStatusGet Source: https://www.softether.org/4-docs/1-manual/6._Command_Line_Management_Utility_Manual/6.3_VPN_Server_//_VPN_Bridge_Management_Command_Reference_%28For_Entire_Server%29 Gets the current operational status of the VPN server. ```APIDOC ## ServerStatusGet ### Description Gets the current operational status of the VPN server. ### Command `ServerStatusGet` ```