aheh/TunnelX
1
0
Fork 0
mirror of https://github.com/MaxiFan/TunnelX.git synced 2026-05-17 21:14:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document standalone runtime behavior

Browse Source
This commit is contained in:
MaxFan
2026-05-11 16:52:08 +03:30
parent f157e6f100
commit b60d5401e4
2 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -2
View File
@@ -21,12 +21,16 @@ Public downloads should be attached to GitHub Releases after the checklist is co
## Build
Requirements:
End-user requirements for the recommended standalone release:
- 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
- No separate .NET Runtime installation is required for the self-contained standalone EXE.
Developer requirements for building from source:
- .NET 8 SDK
```powershell
dotnet build AppTunnel.sln -c Release
docs/BUILD.md
+8
View File
@@ -4,12 +4,16 @@
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.
Building from source requires the .NET 8 SDK. Running a framework-dependent developer build requires the .NET 8 Desktop Runtime or SDK on the machine.
```powershell
dotnet build AppTunnel.sln -c Release
```
## Standalone Compressed EXE
This is the recommended public release format. It is self-contained, so users do not need to install .NET 8 separately. Native components are bundled and extracted by the app at runtime when needed.
```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
```
@@ -30,3 +34,7 @@ TunnelX-v1.2.21-standalone-compressed.exe
- 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.
## Missing Runtime Behavior
The app cannot show a custom .NET missing-runtime message if it is built as framework-dependent and the target machine does not have the required .NET Desktop Runtime, because the .NET host fails before TunnelX code starts. For public releases, publish the self-contained standalone EXE instead of relying on runtime installation. If an installer is added in the future, the installer/bootstrapper can check and install prerequisites before launching the app.