• Overview
• Key Features
• Repository Structure
• Quick Start
• Interactive Sample Browser
• Sample Catalog
• UI Framework Samples
• Related Repositories
• Documentation
• Requirements
• Contributing
• Support
• License

GeneralUpdate-Samples is the official sample repository for the GeneralUpdate project, an Apache 2.0 licensed, cross-platform application automatic update component built on .NET. This repository provides a unified interactive sample browser (Hub) that lets you explore and test every major feature through a clean console menu — no manual project setup required.

GeneralUpdate supports a wide range of update mechanisms:

• ✅ Resume Download
• ✅ Version-by-Version Update
• ✅ Binary Differential Update
• ✅ Incremental Update
• ✅ Forced Update
• ✅ Multi-Branch Update
• ✅ OSS (Object Storage Service) Updates
• ✅ Rollback and Backup
• ✅ AOT (Ahead-of-Time) Compilation Support
• ✅ Driver Update (via Drivelution)

This repository provides self-contained, runnable samples for all major features of GeneralUpdate:

GeneralUpdate-Samples/
├── src/                              # Source code and samples
│   ├── Hub/                          # Interactive sample browser (main entry point)
│   │   ├── Program.cs                # Menu loop, server lifecycle, sample discovery
│   │   ├── AppConfig.cs              # Configuration model (appsettings.json)
│   │   └── Samples/                  # Individual sample implementations
│   │       ├── ISample.cs            # Sample interface (auto-discovered by Hub)
│   │       ├── CompleteUpdateSample.cs
│   │       ├── SilentUpdateSample.cs
│   │       ├── OssSample.cs
│   │       ├── DifferentialSample.cs
│   │       ├── PushSample.cs
│   │       ├── BowlSample.cs
│   │       ├── ExtensionSample.cs
│   │       ├── ImDiskQuickInstallSample.cs
│   │       └── CompressSample.cs
│   ├── Server/                       # Minimal API server for update delivery
│   │   ├── Program.cs                # Verification, report & file download endpoints
│   │   ├── DTOs/                     # Request/response data transfer objects
│   │   └── wwwroot/packages/         # Update package storage
│   ├── content/                      # Intermediate version content (v1.0.0.1, v1.0.0.2)
│   ├── content_client/               # Client app base content (v1.0.0.0, v2.0.0.0)
│   ├── content_upgrade/              # Upgrade app base content (v1.0.0.0, v2.0.0.0)
│   ├── ImDiskDriver/                 # ImDisk driver binaries (for driver update demo)
│   ├── gen_packages.ps1              # Script to generate test update packages
│   ├── Run.cmd                       # Windows launcher (double-click to start)
│   ├── Run.ps1                       # PowerShell launcher with -BuildLibs support
│   └── GeneralUpdate-Samples.slnx    # Solution file (new .slnx format)
├── UI/                               # UI framework integration samples
│   ├── AntdUI/                       # AntdUI framework sample (WinForms)
│   ├── LayUI/                        # LayUI framework sample (WPF)
│   ├── SemiUrsa/                     # Semi Ursa sample (Avalonia, cross-platform)
│   └── WPFDevelopers/                # WPF with custom developer controls
├── website/                          # Official website source (Docusaurus)
├── .github/workflows/                # CI/CD pipelines
│   ├── dotnet.yml                    # .NET build workflow
│   └── az-swa-deploy.yml            # Azure Static Web App deployment (docs site)
├── imgs/                             # Documentation images
├── global.json                       # .NET SDK version pinning
├── Directory.Build.props             # Shared MSBuild properties
├── LICENSE                           # Apache 2.0 License
└── README.md                         # This file

• .NET 10.0 SDK or later
• Windows, Linux, or macOS (Windows recommended for driver and UI samples)

1. Clone the repository

   git clone https://github.com/GeneralLibrary/GeneralUpdate-Samples.git
   cd GeneralUpdate-Samples/src

2. Run the interactive sample browser

   On Windows (double-click or terminal):

   Run.cmd

   On any platform (PowerShell):

   .\Run.ps1

   For contributors who need to rebuild component DLLs from source:

   .\Run.ps1 -BuildLibs

3. What happens next:

   • The Hub builds and starts the Server automatically
   • An interactive menu appears with numbered samples
   • Select a sample by number to run it
   • The Hub manages server lifecycle: starts before each server-dependent sample, stops afterward
   • Type 0 or q to exit

Before running update-dependent samples for the first time, generate test packages:

cd src
.\gen_packages.ps1

This creates update packages in src/Server/wwwroot/packages/ with a versions.json manifest.

The Hub (src/Hub/) is the central entry point. Instead of launching separate projects manually, you interact with a single console menu:

  ╔══════════════════════════════════════╗
  ║    GeneralUpdate 示例浏览器          ║
  ╚══════════════════════════════════════╝

  ═══════════════════════════════════
    1. 完整更新 — 版本发现→下载→应用
    2. 静默更新 — 后台轮询·退出前准备
    3. OSS 模式 — 对象存储更新
    4. 二进制差分 — 生成·应用·校验
    5. SignalR 推送 — 实时消息接收
    6. 进程守护 — 崩溃监控·Dump导出
    7. 插件系统 — 安装·管理·兼容性
    8. Driver Update
    9. 压缩工具 — 压缩·解压·校验
  ───────────────────────────────────
    0. 退出 (Exit)
  ═══════════════════════════════════

• Samples implement ISample and are auto-discovered via reflection — no wiring needed
• Server lifecycle is automatic: RequiresServer = true samples get an isolated Server process started/stopped on demand
• Clean paths are reset before each run, ensuring reproducible demos
• Configuration is centralized in src/Hub/appsettings.json

var request = new UpdateRequest
{
    UpdateUrl = $"{config.ServerUrl}/Upgrade/Verification",
    ReportUrl = $"{config.ServerUrl}/Upgrade/Report",
    AppSecretKey = config.AppSecretKey,
    InstallPath = mockAppDir,
    ClientVersion = config.ClientVersion,
    MainAppName = config.MainAppName,
    ProductId = config.ProductId
};

var bootstrap = new GeneralUpdateBootstrap()
    .SetConfig(request)
    .SetOption(Option.AppType, AppType.Client)
    .AddListenerUpdateInfo((_, e) => { /* handle version discovery */ })
    .AddListenerMultiDownloadStatistics((_, e) => { /* handle progress */ })
    .AddListenerMultiDownloadCompleted((_, e) => { /* handle completion */ })
    .AddListenerException((_, e) => { /* handle errors */ });

await bootstrap.LaunchAsync();

The UI/ directory contains integration examples for popular UI frameworks:

Each UI sample demonstrates how to integrate GeneralUpdate's upgrade workflow with specific UI frameworks and design patterns.

The GeneralUpdate ecosystem consists of multiple repositories:

• 🌐 Official Website: https://www.justerzhu.cn/
• 📖 Quick Start Guide: https://www.justerzhu.cn/docs/quickstart/quickstart
• 🎥 Video Tutorial: Bilibili

The website/ directory contains the full documentation source built with Docusaurus:

cd website

# Install dependencies
npm install

# Start local development server
npm run start

# Build for production
npm run build

Documentation Structure:

• website/docs/doc/ - Component documentation
• website/docs/quickstart/ - Quick start guides
• website/docs/guide/ - Advanced guides
• website/docs/releaselog/ - Release notes
• website/i18n/ - Internationalization (English, Chinese)

• .NET 10.0 Runtime or later
• Operating Systems: Windows, Linux, macOS, Android (with MAUI)
• Supported Platforms: x64, ARM64, LoongArch

• .NET 8.0+
• .NET Framework 4.6.1+

• WPF (Windows Presentation Foundation)
• WinForms (Windows Forms)
• Avalonia (Cross-platform)
• MAUI (Android)
• WinUI 3
• Console Applications

• ✅ Windows 10/11
• ✅ Windows Server 2016+
• ✅ Linux (Ubuntu, Debian, CentOS)
• ✅ macOS (including M1/M2)
• ✅ Android (via MAUI)
• ✅ Kylin V10 (ARM and x64)
• ✅ UOS (Union Operating System)
• ✅ Huawei EulerOS
• ✅ Loongson (LoongArch)

Contributions are welcome! Here's how you can help:

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/your-feature-name

3. Commit your changes

   git commit -am 'Add some feature'

4. Push to the branch

   git push origin feature/your-feature-name

5. Open a Pull Request

• Add new samples by implementing ISample (see src/Hub/Samples/ISample.cs)
• Give your sample a unique Index number and descriptive Name
• Set RequiresServer appropriately
• Specify CleanPaths to ensure reproducible runs
• Follow existing code style and patterns
• Update documentation as needed

• 🐛 Issues: GitHub Issues
• 💬 Discussion Group: QQ Group 748744489 (GeneralUpdate Discussion)
• 🛠️ Technical Exchange: QQ Group 341349660 (.NET Technical Exchange)

• 📧 Email: zhuzhen723723@outlook.com
• 🌐 Official Website: https://www.justerzhu.cn/

For customized development, technical consultation, or sponsorship opportunities, please contact the author via email or official website.

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Copyright 2025 Juster Zhu

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Special thanks to all contributors and the community for their support and contributions to the GeneralUpdate project.

• Juster Zhu - Initial work and maintenance - GitHub