aladex/softethervpn_client 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 (Not Recommended due to Privileges):

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

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-client --network host --cap-add NET_ADMIN -v /opt/softetherdata:/mnt aladex/softethervpn_client: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-client --network host --cap-add NET_ADMIN -v /opt/softetherdata:/mnt aladex/softethervpn_client:latest

⁠Using Docker Compose

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

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

This Docker Compose configuration runs the SoftetherVPN Client with necessary network capabilities and mounts the appropriate volume.

⁠Initial Configuration of SoftetherVPN Client Using vpncmd

With the latest releases, vpncmd is directly available within the container, allowing you to configure the SoftetherVPN Client after the container is running. Here's how to start:

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

   docker exec -it softether-vpn-client vpncmd
   

   Copy

2. Set a Password for Remote Management: In the vpncmd console, you can set a password for remote management by entering:

   PasswordSet
   

   Copy

   Follow the prompts to create a new password.

3. Enable Remote Access: To enable remote access to the client for further configuration, use the command:

   RemoteEnable
   

   Copy

4. Download GUI for Further Configuration: For more comprehensive configuration, you can use the SoftetherVPN GUI. Download it from the official Softether Download Page⁠.

5. Restart the Container to Apply Changes: To ensure the remote access settings take effect, restart the Docker container with the following commands:

   docker stop softether-vpn-client
   docker start softether-vpn-client
   

   Copy

With these steps, you can initially configure the SoftetherVPN Client and enable remote management for further settings adjustments using the GUI.