aladex/softethervpn_bridge repository overview

⁠Versioning:

• latest: Always points to the latest stable version from the official SoftetherVPN repository.
• x.x.xxxxx: An example of a version tag (e.g., 5.02.5181), indicating a specific stable release.
• nightly: The most current build from the latest commit in the SoftetherVPN repository.
• commit-hash: Example dc2b11918abe0566de69b7ae7bf5450cfbaa3b6d, denotes an image built from a specific commit for exact version requirements.

⁠Running via Docker

Basic Launch:

docker run -d --restart=always --name softether-vpn-bridge --network host --privileged -v /opt/softetherdata:/mnt aladex/softethervpn_bridge:latest

Note: The primary function of the SoftetherVPN Bridge, bridging to a physical Ethernet adapter, may not work. This feature is crucial for the software's main purpose. It's recommended to run in privileged mode and host network, which might help, but there are no guarantees.

Enhanced Security Launch: To improve security, use --cap-add NET_ADMIN instead of --privileged to grant only necessary network administration privileges.

docker run -d --restart=always --name softether-vpn-bridge --network host --cap-add NET_ADMIN -v /opt/softetherdata:/mnt aladex/softethervpn_bridge:latest

Temporary Run (Auto-Remove after Stop): For temporary or test deployments, add the --rm flag for automatic removal after stopping.

docker run --rm -d --name softether-vpn-bridge --network host --cap-add NET_ADMIN -v /opt/softetherdata:/mnt aladex/softethervpn_bridge:latest

Using Docker Compose: For a managed setup, use Docker Compose. Example docker-compose.yml:

version: '3.8'
services:
  softether-vpn-bridge:
    image: aladex/softethervpn_bridge:latest
    container_name: softether-vpn-bridge
    network_mode: host
    cap_add:
      - NET_ADMIN
    volumes:
      - /opt/softetherdata:/mnt
    restart: always

⁠Initial Configuration of SoftetherVPN Bridge Using vpncmd

To configure the SoftetherVPN Bridge from the console, you can use vpncmd. Here's how to start:

1. Access vpncmd: Access the vpncmd tool within the running container by executing:

   docker exec -it softether-vpn-bridge vpncmd
   

   Copy

2. GUI Management: For comprehensive bridge management, download the SoftetherVPN Server Manager GUI from the official Softether Download Page⁠. This GUI will allow you to connect to your new bridge and perform configurations.

Alternatively, all configurations can be performed using vpncmd, but users are encouraged to explore and understand the commands on their own.