aheh/TunnelX
1
0
Fork 0
mirror of https://github.com/MaxiFan/TunnelX.git synced 2026-05-18 23:54:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document platform support and maintenance disclaimer

Browse Source
This commit is contained in:
MaxFan
2026-05-11 16:40:37 +03:30
parent d7742f0af0
commit 16a7cbe356
7 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3
View File
@@ -24,6 +24,7 @@ Public downloads should be attached to GitHub Releases after the checklist is co
Requirements:
- Windows 10/11
- 64-bit Windows (`win-x64`). 32-bit Windows is not supported by the current release package.
- .NET 8 SDK
- Administrator privileges when running the app, because route and packet interception features need elevated access
@@ -52,3 +53,5 @@ TunnelX is free. Donations are optional and help keep the project maintained.
## Safety Notice
TunnelX is a networking and routing tool. Use it only where you are allowed to run VPN, proxy, packet capture, and route-management software. The project does not provide legal advice.
TunnelX is provided as-is, without warranty and without any obligation from the maintainer to provide updates, fixes, support, or continued availability.
SECURITY.md
+2
View File
@@ -13,3 +13,5 @@ Before the repository is public, report security issues privately to the maintai
## Sensitive Data
Do not include real VPN credentials, private configs, access tokens, wallet private keys, or private server addresses in issues, screenshots, logs, or pull requests.
Security reports are welcome, but publication of this project does not create a guaranteed response time or an obligation to ship a fix.
SUPPORT.md
+2
View File
@@ -7,3 +7,5 @@ For public support after GitHub publication:
- Remove server credentials, UUIDs, private keys, and private endpoints from logs before posting.
Commercial or private support is not defined yet.
TunnelX is provided for free, as-is. The maintainer has no obligation to provide updates, bug fixes, compatibility updates, release builds, or individual support.
THIRD_PARTY_NOTICES.md
+1
View File
@@ -15,6 +15,7 @@ TunnelX includes or works with third-party software. These notices are part of t
- Keep this file with every binary release.
- Keep `AppTunnel/NativeLibs/LICENSE` with WinDivert notices.
- The current repository bundles x64 native components only. Do not advertise 32-bit Windows support unless separate x86 binaries and tests are added.
- Do not remove upstream copyright or license notices.
- If native binaries are updated, refresh this table and the release checklist.
- If crypto, GeoIP, GeoSite, or core binaries are downloaded from upstream releases, record the exact version and source URL in the release notes.
docs/BUILD.md
+6
View File
@@ -2,6 +2,8 @@
## Local Build
TunnelX currently targets 64-bit Windows only. The project file sets `PlatformTarget` to `x64`, and the bundled native components under `AppTunnel/NativeLibs/x64` are required for the current build.
```powershell
dotnet build AppTunnel.sln -c Release
```
@@ -18,6 +20,10 @@ Rename the final executable with the app version:
TunnelX-v1.2.21-standalone-compressed.exe
```
## 32-bit Windows
32-bit Windows builds are not supported at this time. Supporting `win-x86` would require a separate compatibility pass, x86-compatible native binaries for every bundled network component, and separate testing for WinDivert/Wintun, Xray/sing-box, packet interception, route management, and the standalone extraction path.
## Before Publishing
- Run the leak test plan in `docs/PUBLISHING_CHECKLIST.md`.
docs/LEGAL.md
+8
View File
@@ -18,4 +18,12 @@ TunnelX is a network routing, VPN, proxy, and packet interception tool. Users ar
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.
## No Maintenance Obligation
Publishing TunnelX as free and open-source software does not create any obligation for MaxFan or other maintainers to provide updates, fixes, support, new releases, compatibility work, or continued availability. Contributions and maintenance are voluntary unless a separate written agreement says otherwise.
## Platform Support
The current release package is for 64-bit Windows only. 32-bit Windows is not supported unless a future release explicitly says otherwise.
This document is not legal advice.
docs/PUBLISHING_CHECKLIST.md
+3
View File
@@ -17,6 +17,8 @@ Use this checklist before making the repository public or attaching a release bu
- [ ] Verify current upstream licenses for Xray-core, sing-box, WinDivert, Wintun, GeoIP/GeoSite data, .NET, and NuGet packages.
- [ ] Keep third-party license files/notices in binary releases.
- [ ] Confirm donation text does not imply paid support unless that support exists.
- [ ] Confirm README/legal text says the app is provided as-is and maintainers have no obligation to update or support it.
- [ ] Confirm platform support is documented as Windows x64 only.
## App
@@ -31,6 +33,7 @@ Use this checklist before making the repository public or attaching a release bu
- [ ] Run `dotnet build AppTunnel.sln -c Release`.
- [ ] Run standalone publish command from `docs/BUILD.md`.
- [ ] Confirm final file name includes version, for example `TunnelX-v1.2.21-standalone-compressed.exe`.
- [ ] Do not publish a 32-bit build unless x86 native dependencies and the full networking test matrix have been verified.
## Network Test Matrix