Prepare TunnelX for open-source release

This commit is contained in:
MaxFan
2026-05-11 16:27:14 +03:30
commit 3726d36902
108 changed files with 84390 additions and 0 deletions
+26
View File
@@ -0,0 +1,26 @@
# Build and Release
## Local Build
```powershell
dotnet build AppTunnel.sln -c Release
```
## Standalone Compressed EXE
```powershell
dotnet publish AppTunnel\AppTunnel.csproj -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true -p:EnableCompressionInSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None -p:DebugSymbols=false -o publish\TunnelX-standalone-compressed-exe
```
Rename the final executable with the app version:
```powershell
TunnelX-v1.2.21-standalone-compressed.exe
```
## Before Publishing
- Run the leak test plan in `docs/PUBLISHING_CHECKLIST.md`.
- Confirm third-party license notices are current.
- Confirm the app version in `AppTunnel/AppTunnel.csproj`.
- Attach release artifacts only to GitHub Releases; do not commit generated `publish/` or `Releases/` output.
+25
View File
@@ -0,0 +1,25 @@
# Donate
TunnelX is free and open-source. Donations are optional.
## PayPal
- PayPal email: `gallafan@gmail.com`
- Donation link: https://www.paypal.com/donate/?business=gallafan%40gmail.com&currency_code=USD
If you do not want your personal PayPal identity to be associated with the project, use a project-specific PayPal account before the first public release.
## Crypto Wallets
| Network / Asset | Address |
| --- | --- |
| TRON / USDT-TRC20 / TRX | `TNWV867fQDT6zpLunHgbeMjrN6ic63LQSu` |
| Bitcoin | `bc1qgx3g47c458fu6smnpqpu0l05hha82rq2xjet4y` |
| Ethereum / USDT-ERC20 | `0x72d94Bb250E8802441a0ED05686Ee925BC99Fef5` |
| TON | `UQD65oL2Vu2OJDSrwQ0wLLSw3g668SREMJ3VPW9k8b6Sy-Yf` |
| BNB Smart Chain | `0xE2a5b01cE2b3713D435Bc16d92eAdd88A82159f0` |
| Dogecoin | `DSZRNY65yF679uvjAh6sUAt6YiEEQHwKGb` |
Always verify the network before sending funds. Sending assets to the wrong network can permanently lose the donation.
Blockchain donations are public. These wallet addresses should ideally be project-specific wallets, not personal long-term wallets, if contributor privacy matters.
+21
View File
@@ -0,0 +1,21 @@
# Legal and Compliance Notes
TunnelX is published as free/open-source software by MaxFan.
## Project License
The project is marked as `GPL-3.0-or-later` to stay compatible with bundled GPL components, especially sing-box. If the release packaging changes and no GPL binary is bundled, the maintainer can revisit the license choice.
## Third-Party Components
Review `THIRD_PARTY_NOTICES.md` before every public release. Native binaries and data files must keep their upstream license notices.
## Usage
TunnelX is a network routing, VPN, proxy, and packet interception tool. Users are responsible for complying with their local rules, workplace policies, network policies, and service terms.
## No Warranty
TunnelX is provided without warranty. It can change routes, DNS behavior, local proxy behavior, and packet handling, so users should test carefully before relying on it.
This document is not legal advice.
+21
View File
@@ -0,0 +1,21 @@
# Privacy
TunnelX is designed as a local desktop app.
## Data Stored Locally
The app may store profiles, selected apps, include/exclude destinations, connection history, and logs on the user's Windows machine, typically under `%LOCALAPPDATA%\TunnelX` or the app directory depending on the feature.
## Network Data
TunnelX handles local routing and packet metadata to decide what should use the tunnel. It does not intentionally send analytics or telemetry to the maintainer.
## Logs
Logs can contain hostnames, IP addresses, process names, ports, and connection state. Users should sanitize logs before posting them publicly.
## Donations
Donation links open external services such as PayPal. Those services have their own privacy policies.
Crypto wallet addresses are public receiving addresses. On-chain transactions may be publicly visible and can connect the project identity with wallet activity. For stronger maintainer privacy, use wallets created specifically for TunnelX.