VPN/TrustTunnel
1
0
Fork 0
mirror of https://github.com/TrustTunnel/TrustTunnel.git synced 2026-04-18 17:04:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0cfeb55bd5617ec0f2bb6fa2b97dfd4a3e23ef29
TrustTunnel/endpoint/README.md
Andrey Meshkov d7273ea729 Pull request 94: Added auto-formatting and pre-commit hook 
Squashed commit of the following:

commit 0dc9600ff3bd8573d805e4de4d85290b1052a222
Author: Andrey Meshkov <am@adguard.com>
Date:   Sun Dec 21 20:53:02 2025 +0300

    Rollback to the old changelog

commit fb56f619d5f703d712dbfdb95ab093a211dc0c58
Author: Andrey Meshkov <am@adguard.com>
Date:   Sun Dec 21 20:36:24 2025 +0300

    Improve the dev doc

commit afd44a5e2bebd51b07dcb587cf39ada925a42db9
Author: Andrey Meshkov <am@adguard.com>
Date:   Sun Dec 21 20:32:49 2025 +0300

    Added auto-formatting and pre-commit hook
2025-12-21 20:54:46 +03:00

1.9 KiB
Raw Blame History

TrustTunnel Endpoint Binary

A standalone application that allows any user to easily set up their own VPN server.

Configuration

  • Configuration via TOML Files: The VPN endpoint binary utilizes TOML formatted files for configuration. The following files are used:

    • Library Settings File: This file contains the configuration of the underlying library and reflects the Settings struct.
    • TLS Hosts Settings File: This file defines the TLS hosts that the endpoint can represent to the client side. Different types of hosts are available, each serving a specific purpose. It reflects the TlsHostsSettings struct.

  • Additional Configuration Requirements: In addition to the TOML files, two additional items are required for configuration:

    • Credentials File: This file contains user authentication data.
    • Certificate Files: These files correspond to the TLS hosts defined in the TLS hosts settings.

  • Setup Wizard Tool: A setup wizard tool is provided within the repository, located in a separate directory. This tool simplifies the process of generating the required settings and files mentioned above. Refer to the usage instructions for quick setup instructions.

  • Command Line Configuration: The VPN endpoint binary supports additional configuration options through command line arguments. Users can customize the behavior of the endpoint according to their specific requirements. To view the available options, run the following command in the Terminal:

    trusttunnel_endpoint -h

Additional Features

Dynamic Reloading of TLS Host Settings

The endpoint supports dynamic reloading of TLS host settings. When the SIGHUP signal is sent to the endpoint process, it will update and reload the TLS host settings on-the-fly without requiring a restart of the binary.