mirror of
https://github.com/MaxiFan/TunnelX.git
synced 2026-05-17 21:14:37 +03:00
Document platform support and maintenance disclaimer
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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`.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user