SoftEtherVPN

(β˜… 13,487)

Cross-platform multi-protocol VPN software. Pull requests are welcome. The stable version is available at https://github.com/SoftEtherVPN/SoftEtherVPN_Stable.

  • .gitattributes
  • .gitignore
  • .gitlab-ci.yml
  • .gitmodules
  • .travis.yml
  • ANTIVIRUS.md
  • AUTHORS.TXT
  • CMakeLists.txt
  • CMakeSettings.json
  • CODE_OF_CONDUCT.md
  • configure
  • configure.cmd
  • ContainerREADME.md
  • Declaration_Switch_License_from_GPL_to_Apache.pdf
  • description
  • DISCLAIMER.md
  • docker-compose.vpnclient.yaml
  • docker-compose.yaml
  • Dockerfile
  • FUNDING.yml
  • LICENSE
  • README.md
  • SECURITY.md
  • TRANSLATION_GUIDE.md
  • tsan_suppressions.txt
  • vcpkg.json
  • version.py
  • WINDOWS_README.txt

# Installation Guide

1. Get the code
git clone https://github.com/SoftEtherVPN/SoftEtherVPN

Downloads the entire project code from GitHub to your computer.

cd SoftEtherVPN

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.vpnclient.yaml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd developer_tools/stbchecker

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

βœ… After dotnet run, check the message or address shown in the terminal.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd developer_tools/vpnserver-jsonrpc-clients/vpnserver-jsonrpc-client-nodejs-package

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation