diff --git a/README.md b/README.md index e5f649985..c09d92a68 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ [![Ask Zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/xixu-me/Xget) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/xixu-me/Xget) [![codecov](https://codecov.io/github/xixu-me/xget/graph/badge.svg?token=KDFMG9YX8G)](https://codecov.io/github/xixu-me/xget) -[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#-ecosystem-integration) -[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#-ecosystem-integration) +[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#ecosystem-integration) +[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#ecosystem-integration) [![Cloudflare](https://img.shields.io/badge/Cloudflare-F38020?&logo=cloudflare&logoColor=white)](#deploy-to-cloudflare-workers) [![EdgeOne](https://img.shields.io/badge/EdgeOne-006EFF?&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAACNklEQVR4nJ1W7XHbMAx96ul/lQnCDapOUG3gdIIkG6QjdINOUGeDNhNYmUDuBHIWiNQF/PqDYAxDoMUGdzx+AXgAAQGqSKKAOgAbma8BXMn5DGAv4wlAv6qJ5KVxR3LkOR3NWu9HkcnqzF0EkoMDcsysLd8oOooAb0lOF7wqpYnkzRrgZkVJ8mp0jLFzotscYOC6ZyNjjLbOnTZI7weSjQc4ZoQmkjuSneIdMoADyR9iVKuB0qglWYOT0n9Uys/qPAD4ZHgfAXwzfO/6LLyxcTxbJEdufFi1aEk32l6Z+1Lhep1lQa1aVwI2O3wBsTIFxOoUADzVspgzQp6S1pztATRyvpG5lTNLTUVykssJwF91OQP4bATuAGzVngBexJD0vJW51/u5VpZc4VSUgViMLX1xlIUCoERNLoYE8Ns579S6chTngGYZh1oWjRGoEGOjKSAGP/HovqblDoiJtAfwLPv5xHnqCrbNeK3K8qX9juQDMx3CVpoesXLop7DeATF+2rsKsbo8oizD3zzsjLWk30RHw7N7R5V68/AgMUpeWg9bLLOxL/AniOw1Yp58t/FZi5+mzuFrJJY/Sb6qFzmmV9PMgzBsHUW/eN5gJwdk54Rm4YTXgHPx00p24qEGydFElb3e09nUbpXVuZ+oS/88Z62rJLMelHAJSDqf6LxWSXvS35/+Vr0SlqrPHsBXxOw/o5IGHDLKE4AucS8A7hG7zAIMACryv371WxkfxYhZFD8jFvt+TdE/deK28xBAUlEAAAAASUVORK5CYII=)](#deploy-to-edgeone-pages) @@ -26,6 +26,33 @@ > [!TIP] > 欢迎加入“Xget 开源与 AI 交流群”,一起交流开源项目、AI 应用、工程实践、效率工具和独立开发;如果你也在做产品、写代码、折腾项目或者对开源和 AI 感兴趣,欢迎[**进群**](https://file.xi-xu.me/QR%20Codes/%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.png)认识更多认真做事、乐于分享的朋友。 +An ultra-high-performance, secure, all-in-one acceleration engine for developer +resources. It provides unified, efficient acceleration for code hosting, model +and dataset hubs, package registries, container registries, AI inference +providers, and more, while handling caching, retries, security headers, and +protocol-specific compatibility behavior for you. + +Technical deep dive: +**_[Deep Dive into Xget: A High-Performance, Multi-Protocol, and Secure Acceleration Engine for Developer Resources](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)_**. + +Xget was invited onto [GitCode](https://gitcode.com/xixu-me/xget) and +recognized as a G-Star graduation project. As "a widely used public project", +it receives support from OpenAI's +[Codex for Open Source](https://developers.openai.com/community/codex-for-oss) +and has also been spontaneously recommended by several tech creators, including +[Ruan Yifeng](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget), +[GitHubDaily](https://x.com/i/status/1956204203937829256), +[FishC](https://www.bilibili.com/video/BV1EeeBzVEop/), and +[Xuanli 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8). Thanks to every +individual, team, and community that supports, shares, recommends, or actively +uses Xget. + +## Supported Platforms + +> [!NOTE] +> The badges below point to the relevant usage or deployment sections in this +> README. + [![GitHub](https://img.shields.io/badge/GitHub-181717?&logo=github&logoColor=white)](#github) [![GitLab](https://img.shields.io/badge/GitLab-FC6D26?&logo=gitlab&logoColor=white)](#gitlab) [![Gitea](https://img.shields.io/badge/Gitea-609926?&logo=gitea&logoColor=white)](#gitea) @@ -62,31 +89,7 @@ [![Container Registries](https://img.shields.io/badge/Container%20Registries-262261?logo=opencontainersinitiative&logoColor=white)](#container-registries) [![AI Inference Providers](https://img.shields.io/badge/AI%20Inference%20Providers-94A3B8?logo=openrouter&logoColor=white)](#ai-inference-providers) -An ultra-high-performance, secure, all-in-one acceleration engine for -developer resources. It significantly outperforms traditional solutions and -provides unified, efficient acceleration for code hosting, model and dataset -hubs, package registries, container registries, AI inference providers, and -more, while handling caching, retries, security headers, and protocol-specific -compatibility behavior for you. - -Technical deep dive: -**_[Deep Dive into Xget: A High-Performance, Multi-Protocol, and Secure Acceleration Engine for Developer Resources](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)_**. - -Xget was invited to join the -[GitCode platform](https://gitcode.com/xixu-me/xget) and recognized as a G-Star -graduation project. As "a widely used public project", it is also supported by -OpenAI's -[Codex for Open Source](https://developers.openai.com/community/codex-for-oss). -It has also received spontaneous recommendations from several tech creators, -including -[Ruan Yifeng](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget), -[GitHubDaily](https://x.com/i/status/1956204203937829256), -[FishC](https://www.bilibili.com/video/BV1EeeBzVEop/), and -[Xuanli 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8). Thanks to every -individual, team, and community that supports, shares, recommends, or actively -uses Xget. - -## 🎯 Quick Start +## Quick Start **Pre-deployed Instance: `xget.xi-xu.me`** - For evaluation and trial only, deploy your own instance for production or availability-sensitive workloads @@ -100,23 +103,23 @@ supported platform URL to Xget's acceleration format with one click **Agent Skills: `npx skills add xixu-me/skills -s xget`** -## 🌟 Core Advantages - Why Choose Xget? +## Why Xget -### ⚡ Performance-Oriented Design +### Performance-Oriented Design -- **🌐 Global Edge Runtime**: Built on Cloudflare Workers and designed to run +- **Global Edge Runtime**: Built on Cloudflare Workers and designed to run close to users and upstream services -- **⚡ Protocol-Aware Handling**: Supports HTTP/3, range requests, Git traffic, +- **Protocol-Aware Handling**: Supports HTTP/3, range requests, Git traffic, container registry flows, and AI inference APIs -- **📦 Cache and Retry Pipeline**: Includes edge caching for compatible +- **Cache and Retry Pipeline**: Includes edge caching for compatible responses, retry logic for transient upstream failures, and request normalization for supported platforms -- **🔗 Connection Reuse**: Uses standard HTTP connection reuse and keep-alive +- **Connection Reuse**: Uses standard HTTP connection reuse and keep-alive behavior where the runtime and upstream allow it -- **📊 Request Timing Visibility**: Can expose timing data through +- **Request Timing Visibility**: Can expose timing data through `X-Performance-Metrics` headers where protocol compatibility allows -### 🌐 Deep Multi-Platform Integration +### Deep Multi-Platform Integration - **All-in-One Multi-Platform Support**: Unified support for mainstream platforms in various development scenarios @@ -125,7 +128,7 @@ supported platform URL to Xget's acceleration format with one click - **Consistent Acceleration Experience**: Enjoy unified and stable ultra-fast download experience regardless of file type or source -### 🔒 Enterprise-Grade Security +### Enterprise-Grade Security - **Multi-Layer Security Headers**: - `Strict-Transport-Security`: Enforces HTTPS transmission, prevents @@ -146,7 +149,7 @@ supported platform URL to Xget's acceleration format with one click - **Timeout Protection**: 30-second request timeout, prevents resource exhaustion and malicious requests -### 🚀 Modern Architecture and Reliability +### Modern Architecture and Reliability - **Intelligent Retry Mechanism**: - Maximum 3 retries with linear delay strategy (1000ms × retry count) @@ -164,7 +167,7 @@ supported platform URL to Xget's acceleration format with one click header - Cache hit rate statistics and optimization recommendations -### 🎯 Full Git Protocol Compatibility +### Full Git Protocol Compatibility - **Smart Protocol Detection**: - Automatically recognizes Git-specific endpoints (`/info/refs`, @@ -182,7 +185,7 @@ supported platform URL to Xget's acceleration format with one click - Smart User-Agent handling (default `git/2.34.1`) - Supports Git LFS large file transfer -### 📱 Ecosystem Integration +### Ecosystem Integration - **Dedicated Browser Extension**: [Xget Now](https://github.com/xixu-me/Xget-Now) provides seamless experience @@ -195,7 +198,7 @@ supported platform URL to Xget's acceleration format with one click - **CI/CD Integration**: Can be used directly in GitHub Actions, GitLab CI, and other environments -## 🏗️ System Architecture +## Architecture ### Request Processing Flow @@ -290,7 +293,7 @@ classDiagram PlatformRouting --> PlatformCatalog ``` -## 📖 URL Conversion Rules +## URL Conversion Rules Using the pre-deployed instance **`xget.xi-xu.me`** or your own deployed instance, simply replace the domain and add the platform prefix: @@ -933,7 +936,7 @@ https://xget.xi-xu.me/ip/huggingface/hf-inference/models/openai/whisper-large-v3 For use cases, see [AI Inference API Acceleration](#ai-inference-api-acceleration). -## 🎯 Use Cases +## Use Cases ### Git Operations and Configuration @@ -2569,7 +2572,7 @@ client = OpenAI( ) ``` -## 🚀 Deployment +## Deployment ### Deploy to Cloudflare Workers @@ -2878,7 +2881,7 @@ try Droplets, Kubernetes, App Platform, and more: acceleration. Performance depends on your server configuration and network environment. -## 🔧 Configuration +## Configuration ### Configuration Parameters @@ -2925,7 +2928,7 @@ const PLATFORM_PATH_TRANSFORMERS = { }; ``` -## 🚧 Development +## Development 1. **Repository Setup** @@ -2947,7 +2950,7 @@ const PLATFORM_PATH_TRANSFORMERS = { npm run deploy # Deploy to production ``` -## 🧪 Testing +## Testing The repository includes a complete test suite to ensure code quality and functional correctness. @@ -2977,7 +2980,7 @@ npm run test:watch - **Security Tests**: Input validation, security headers, permission control - **Performance Tests**: Response time, memory usage, concurrent processing -## 🔍 Troubleshooting +## Troubleshooting ### Common Issues @@ -3010,7 +3013,7 @@ Workers console: npx wrangler dev --log-level debug ``` -## ⚠️ Disclaimer +## Disclaimer - **Legal and Compliant Use**: This repository aims to provide unified acceleration services for code repositories, package registries, AI inference @@ -3062,27 +3065,34 @@ npx wrangler dev --log-level debug distribution, or modification of this repository constitutes acceptance of the latest version of this disclaimer -## 🤝 Contributing - -We welcome all forms of contribution! Please check the -[Contributing Guide](CONTRIBUTING.md) to learn how to participate in repository -development. +## Project Resources -Community and maintainer expectations are documented in: +We welcome all forms of contribution. Start with the +[Contributing Guide](CONTRIBUTING.md), and use these project documents when you +need the full collaboration and maintenance context: - [Code of Conduct](CODE_OF_CONDUCT.md) - [Security Policy](SECURITY.md) - [Governance](GOVERNANCE.md) +You can help by: + 1. **Report Issues**: Use [issue templates](https://github.com/xixu-me/Xget/issues/new/choose) to - report bugs or propose feature requests -2. **Submit Code**: Fork the repository, create a feature branch, submit a pull - request -3. **Improve Documentation**: Fix errors, add examples, improve descriptions -4. **Testing Feedback**: Test in different environments and provide feedback + report bugs or propose feature requests. +2. **Submit Code**: Fork the repository, create a feature branch, and open a + pull request. +3. **Improve Documentation**: Fix errors, add examples, and improve + explanations. +4. **Testing Feedback**: Validate Xget in different environments and share what + you learn. + +Copyright © Xi Xu. + +This repository is licensed under the AGPL-3.0 License. See +[`LICENSE`](LICENSE) for details. -## 🌟 Star History +## Star History @@ -3092,13 +3102,6 @@ Community and maintainer expectations are documented in: -## 📝 License - -Copyright © Xi Xu. - -This repository is licensed under the AGPL-3.0 License - see the -[`LICENSE`](LICENSE) file for details. - ---
diff --git a/README.zh-Hans.md b/README.zh-Hans.md index 49b9ce114..46933f022 100644 --- a/README.zh-Hans.md +++ b/README.zh-Hans.md @@ -7,8 +7,8 @@ [![Ask Zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/xixu-me/Xget) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/xixu-me/Xget) [![codecov](https://codecov.io/github/xixu-me/xget/graph/badge.svg?token=KDFMG9YX8G)](https://codecov.io/github/xixu-me/xget) -[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#-生态系统集成) -[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#-生态系统集成) +[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#生态系统集成) +[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#生态系统集成) [![Cloudflare](https://img.shields.io/badge/Cloudflare-F38020?&logo=cloudflare&logoColor=white)](#部署到-cloudflare-workers) [![EdgeOne](https://img.shields.io/badge/EdgeOne-006EFF?&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAACNklEQVR4nJ1W7XHbMAx96ul/lQnCDapOUG3gdIIkG6QjdINOUGeDNhNYmUDuBHIWiNQF/PqDYAxDoMUGdzx+AXgAAQGqSKKAOgAbma8BXMn5DGAv4wlAv6qJ5KVxR3LkOR3NWu9HkcnqzF0EkoMDcsysLd8oOooAb0lOF7wqpYnkzRrgZkVJ8mp0jLFzotscYOC6ZyNjjLbOnTZI7weSjQc4ZoQmkjuSneIdMoADyR9iVKuB0qglWYOT0n9Uys/qPAD4ZHgfAXwzfO/6LLyxcTxbJEdufFi1aEk32l6Z+1Lhep1lQa1aVwI2O3wBsTIFxOoUADzVspgzQp6S1pztATRyvpG5lTNLTUVykssJwF91OQP4bATuAGzVngBexJD0vJW51/u5VpZc4VSUgViMLX1xlIUCoERNLoYE8Ns579S6chTngGYZh1oWjRGoEGOjKSAGP/HovqblDoiJtAfwLPv5xHnqCrbNeK3K8qX9juQDMx3CVpoesXLop7DeATF+2rsKsbo8oizD3zzsjLWk30RHw7N7R5V68/AgMUpeWg9bLLOxL/AniOw1Yp58t/FZi5+mzuFrJJY/Sb6qFzmmV9PMgzBsHUW/eN5gJwdk54Rm4YTXgHPx00p24qEGydFElb3e09nUbpXVuZ+oS/88Z62rJLMelHAJSDqf6LxWSXvS35/+Vr0SlqrPHsBXxOw/o5IGHDLKE4AucS8A7hG7zAIMACryv371WxkfxYhZFD8jFvt+TdE/deK28xBAUlEAAAAASUVORK5CYII=)](#部署到-edgeone-pages) @@ -25,6 +25,21 @@ > [!TIP] > 欢迎加入“Xget 开源与 AI 交流群”,一起交流开源项目、AI 应用、工程实践、效率工具和独立开发;如果你也在做产品、写代码、折腾项目或者对开源和 AI 感兴趣,欢迎[**进群**](https://file.xi-xu.me/QR%20Codes/%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.png)认识更多认真做事、乐于分享的朋友。 +面向开发者资源的超高性能、安全、一体化加速引擎,为代码托管、模型和数据集中心、包管理存储库、容器注册表、AI 推理提供商等提供统一、高效的加速,同时替你处理缓存、重试、安全响应头以及协议相关兼容行为。 + +技术深度解析文章:**[《深入剖析 Xget:一个高性能、多协议、高安全性的开发者资源加速引擎》](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)**。 + +受邀入驻 +[GitCode](https://gitcode.com/xixu-me/xget),并被认证为 G-Star 毕业项目。作为“一个被广泛使用的公共项目”,获得 OpenAI 的 +[Codex for Open Source](https://developers.openai.com/community/codex-for-oss) +项目的支持。被多位技术博主自发推荐,包括[阮一峰](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget)、[GitHubDaily](https://x.com/i/status/1956204203937829256)、[鱼 C](https://www.bilibili.com/video/BV1EeeBzVEop/)、[玄离 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8) +等。感谢所有支持、分享、推荐和实际使用 Xget 的个人、团队与社区。 + +## 支持的平台 + +> [!NOTE] +> 下方徽章会跳转到 README 中对应的使用或部署章节。 + [![GitHub](https://img.shields.io/badge/GitHub-181717?&logo=github&logoColor=white)](#github) [![GitLab](https://img.shields.io/badge/GitLab-FC6D26?&logo=gitlab&logoColor=white)](#gitlab) [![Gitea](https://img.shields.io/badge/Gitea-609926?&logo=gitea&logoColor=white)](#gitea) @@ -61,17 +76,7 @@ [![容器注册表](https://img.shields.io/badge/容器注册表-262261?logo=opencontainersinitiative&logoColor=white)](#容器注册表) [![AI 推理提供商](https://img.shields.io/badge/AI%20推理提供商-94A3B8?logo=openrouter&logoColor=white)](#ai-推理提供商) -面向开发者资源的超高性能、安全、一体化加速引擎,其性能显著优于传统解决方案,为代码托管、模型和数据集中心、包管理存储库、容器注册表、AI 推理提供商等提供统一、高效的加速,同时替你处理缓存、重试、安全响应头以及协议相关兼容行为。 - -技术深度解析文章:**[《深入剖析 Xget:一个高性能、多协议、高安全性的开发者资源加速引擎》](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)**。 - -Xget 已受邀入驻 -[GitCode 平台](https://gitcode.com/xixu-me/xget),并被认证为 G-Star 毕业项目。作为“一个被广泛使用的公共项目”,Xget 也获得了 OpenAI -[Codex for Open Source](https://developers.openai.com/community/codex-for-oss) -项目的支持。同时,它也获得多位技术博主自发推荐,包括[阮一峰](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget)、[GitHubDaily](https://x.com/i/status/1956204203937829256)、[鱼 C](https://www.bilibili.com/video/BV1EeeBzVEop/)、[玄离 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8) -等。感谢所有支持、分享、推荐和实际使用 Xget 的个人、团队与社区。 - -## 🎯 快速使用 +## 快速使用 **预部署实例:`xget.xi-xu.me`** - 仅适合评估和试用,生产环境或对可用性敏感的场景建议自部署 @@ -82,25 +87,25 @@ Xget 已受邀入驻 **Agent Skills:`npx skills add xixu-me/skills -s xget`** -## 🌟 核心优势 - 为什么选择 Xget? +## 为什么选择 Xget -### ⚡ 面向性能的设计 +### 面向性能的设计 -- **🌐 全球边缘运行时**:基于 Cloudflare Workers,尽量让请求更靠近用户和上游服务 -- **⚡ 协议感知处理**:支持 HTTP/3、Range 请求、Git 流量、容器注册表流程和 AI 推理 API -- **📦 缓存与重试链路**:对可兼容响应提供边缘缓存,对临时性上游失败提供重试,并对支持的平台做请求规范化 -- **🔗 连接复用**:在运行时和上游允许的前提下,复用标准 HTTP +- **全球边缘运行时**:基于 Cloudflare Workers,尽量让请求更靠近用户和上游服务 +- **协议感知处理**:支持 HTTP/3、Range 请求、Git 流量、容器注册表流程和 AI 推理 API +- **缓存与重试链路**:对可兼容响应提供边缘缓存,对临时性上游失败提供重试,并对支持的平台做请求规范化 +- **连接复用**:在运行时和上游允许的前提下,复用标准 HTTP keep-alive 与连接复用能力 -- **📊 请求耗时可观测**:在协议兼容的情况下,可通过 `X-Performance-Metrics` +- **请求耗时可观测**:在协议兼容的情况下,可通过 `X-Performance-Metrics` 响应头暴露阶段性耗时信息 -### 🌐 多平台深度集成 +### 多平台深度集成 - **一站式多平台支持**:统一支持各种开发场景中的主流平台 - **智能识别与转换**:自动识别平台前缀并转换为目标平台的正确 URL 结构 - **一致的加速体验**:无论文件类型或来源,均可享受统一且稳定的极速下载体验 -### 🔒 企业级安全保障 +### 企业级安全保障 - **多层安全标头**: - `Strict-Transport-Security`:强制 HTTPS 传输,预防中间人攻击 @@ -116,7 +121,7 @@ Xget 已受邀入驻 - 输入清理:防止路径遍历和注入攻击 - **超时保护**:30 秒请求超时,防止资源耗尽和恶意请求 -### 🚀 现代架构与可靠性 +### 现代架构与可靠性 - **智能重试机制**: - 最大 3 次重试,线性延迟策略(1000ms × 重试次数) @@ -131,7 +136,7 @@ Xget 已受邀入驻 - 通过 `X-Performance-Metrics` 响应头提供详细性能数据 - 支持缓存命中率统计和优化建议 -### 🎯 Git 协议完全兼容 +### Git 协议完全兼容 - **智能协议检测**: - 自动识别 Git 特定端点(`/info/refs`、`/git-upload-pack`、`/git-receive-pack`) @@ -147,7 +152,7 @@ Xget 已受邀入驻 - 智能 User-Agent 处理(默认 `git/2.34.1`) - 支持 Git LFS 大文件传输 -### 📱 生态系统集成 +### 生态系统集成 - **专用浏览器扩展**:[Xget Now](https://github.com/xixu-me/Xget-Now) 提供无缝体验 @@ -158,7 +163,7 @@ Xget 已受邀入驻 - **下载工具兼容**:完美支持 wget、cURL、aria2、IDM 等主流下载工具 - **CI/CD 集成**:可直接在 GitHub Actions、GitLab CI 等环境中使用 -## 🏗️ 系统架构 +## 系统架构 ### 请求处理流程 @@ -253,7 +258,7 @@ classDiagram PlatformRouting --> PlatformCatalog ``` -## 📖 URL 转换规则 +## URL 转换规则 使用预部署实例 **`xget.xi-xu.me`** 或你自己部署的实例,只需简单替换域名并添加平台前缀: @@ -892,7 +897,7 @@ https://xget.xi-xu.me/ip/huggingface/hf-inference/models/openai/whisper-large-v3 应用场景见 [AI 推理 API 加速](#ai-推理-api-加速)。 -## 🎯 应用场景 +## 应用场景 ### Git 操作与配置 @@ -2527,7 +2532,7 @@ client = OpenAI( ) ``` -## 🚀 部署 +## 部署 ### 部署到 Cloudflare Workers @@ -2792,7 +2797,7 @@ Platform 等资源: **注意**:自托管部署不包括全球边缘网络加速,性能取决于你的服务器配置和网络环境。 -## 🔧 配置 +## 配置 ### 配置参数 @@ -2835,7 +2840,7 @@ const PLATFORM_PATH_TRANSFORMERS = { }; ``` -## 🚧 开发 +## 开发 1. **存储库设置** @@ -2857,7 +2862,7 @@ const PLATFORM_PATH_TRANSFORMERS = { npm run deploy # 部署到生产 ``` -## 🧪 测试 +## 测试 存储库包含完整的测试套件,确保代码质量和功能正确性。 @@ -2884,7 +2889,7 @@ npm run test:watch - **安全测试**: 输入验证、安全头、权限控制 - **性能测试**: 响应时间、内存使用、并发处理 -## 🔍 故障排除 +## 故障排除 ### 常见问题 @@ -2914,7 +2919,7 @@ A: 确认使用了正确的 URL 格式,且 Git 客户端版本支持 HTTPS 代 npx wrangler dev --log-level debug ``` -## ⚠️ 免责声明 +## 免责声明 - **合法合规使用**:本存储库旨在为代码存储库、软件包注册表、AI 推理 API、容器镜像、模型、数据集及更多合法开发者资源提供统一加速服务。使用者应严格遵守所在司法辖区法律法规及相关平台服务条款,任何非法用途的法律责任由使用者自行承担 - **非关联性与独立责任**:本存储库与各第三方平台不存在任何隶属、代理或合作关系。任何基于本存储库的 fork、二次开发、再分发或衍生版本均由其维护者独立承担全部责任;作者、维护者及贡献者不对衍生存储库的任何行为或后果承担法律或连带责任 @@ -2928,23 +2933,27 @@ npx wrangler dev --log-level debug - **名称使用规范**:严禁任何可能暗示作者或贡献者提供商业合作、技术支持、担保或背书的表述。涉及存储库名称或作者标识的使用应遵循相关法律法规及通用规范 - **免责声明更新**:本免责声明可能随存储库发展或法律环境变化进行更新修订。使用者继续使用、复制、分发或修改本存储库即视为接受最新版本的免责声明 -## 🤝 贡献 - -我们欢迎各种形式的贡献!请查看[贡献指南](CONTRIBUTING.md)了解如何参与存储库开发。 +## 项目资源 -社区协作与维护者职责说明请参考: +我们欢迎各种形式的贡献。开始前请先阅读[贡献指南](CONTRIBUTING.md),并在协作过程中参考这些项目文档: - [行为准则](CODE_OF_CONDUCT.md) - [安全策略](SECURITY.md) - [治理说明](GOVERNANCE.md) +你可以通过以下方式参与: + 1. **报告问题**: 使用 - [issue 模板](https://github.com/xixu-me/Xget/issues/new/choose)报告 bug 或提出功能请求 -2. **提交代码**: fork 存储库,创建功能分支,提交 pull request -3. **改进文档**: 修正错误、添加示例、完善说明 -4. **测试反馈**: 在不同环境下测试并提供反馈 + [issue 模板](https://github.com/xixu-me/Xget/issues/new/choose)报告 bug 或提出功能请求。 +2. **提交代码**: fork 存储库,创建功能分支并提交 pull request。 +3. **改进文档**: 修正错误、补充示例、完善说明。 +4. **测试反馈**: 在不同环境下测试并反馈结果。 + +版权所有 © Xi Xu。 -## 🌟 Star 历史 +本存储库采用 AGPL-3.0 许可证,详见 [`LICENSE`](LICENSE)。 + +## Star 历史 @@ -2954,12 +2963,6 @@ npx wrangler dev --log-level debug -## 📝 许可证 - -版权所有 © Xi Xu。 - -本存储库采用 AGPL-3.0 许可证 - 查看 [`LICENSE`](LICENSE) 文件了解详情。 - ---
diff --git a/README.zh-Hant.md b/README.zh-Hant.md index 568b7c0d0..7f9a2eb59 100644 --- a/README.zh-Hant.md +++ b/README.zh-Hant.md @@ -7,8 +7,8 @@ [![Ask Zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/xixu-me/Xget) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/xixu-me/Xget) [![codecov](https://codecov.io/github/xixu-me/xget/graph/badge.svg?token=KDFMG9YX8G)](https://codecov.io/github/xixu-me/xget) -[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#-生態系統整合) -[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#-生態系統整合) +[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#生態系統整合) +[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#生態系統整合) [![Cloudflare](https://img.shields.io/badge/Cloudflare-F38020?&logo=cloudflare&logoColor=white)](#部署到-cloudflare-workers) [![EdgeOne](https://img.shields.io/badge/EdgeOne-006EFF?&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAACNklEQVR4nJ1W7XHbMAx96ul/lQnCDapOUG3gdIIkG6QjdINOUGeDNhNYmUDuBHIWiNQF/PqDYAxDoMUGdzx+AXgAAQGqSKKAOgAbma8BXMn5DGAv4wlAv6qJ5KVxR3LkOR3NWu9HkcnqzF0EkoMDcsysLd8oOooAb0lOF7wqpYnkzRrgZkVJ8mp0jLFzotscYOC6ZyNjjLbOnTZI7weSjQc4ZoQmkjuSneIdMoADyR9iVKuB0qglWYOT0n9Uys/qPAD4ZHgfAXwzfO/6LLyxcTxbJEdufFi1aEk32l6Z+1Lhep1lQa1aVwI2O3wBsTIFxOoUADzVspgzQp6S1pztATRyvpG5lTNLTUVykssJwF91OQP4bATuAGzVngBexJD0vJW51/u5VpZc4VSUgViMLX1xlIUCoERNLoYE8Ns579S6chTngGYZh1oWjRGoEGOjKSAGP/HovqblDoiJtAfwLPv5xHnqCrbNeK3K8qX9juQDMx3CVpoesXLop7DeATF+2rsKsbo8oizD3zzsjLWk30RHw7N7R5V68/AgMUpeWg9bLLOxL/AniOw1Yp58t/FZi5+mzuFrJJY/Sb6qFzmmV9PMgzBsHUW/eN5gJwdk54Rm4YTXgHPx00p24qEGydFElb3e09nUbpXVuZ+oS/88Z62rJLMelHAJSDqf6LxWSXvS35/+Vr0SlqrPHsBXxOw/o5IGHDLKE4AucS8A7hG7zAIMACryv371WxkfxYhZFD8jFvt+TdE/deK28xBAUlEAAAAASUVORK5CYII=)](#部署到-edgeone-pages) @@ -25,6 +25,21 @@ > [!TIP] > 歡迎加入「Xget 開源與 AI 交流群」,一起交流開源專案、AI 應用、工程實踐、效率工具和獨立開發;如果你也在做產品、寫程式、折騰專案或者對開源和 AI 感興趣,歡迎[**進群**](https://file.xi-xu.me/QR%20Codes/%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.png)認識更多認真做事、樂於分享的朋友。 +面向開發者資源的超高效能、安全、一體化加速引擎,為程式碼託管、模型和資料集中心、軟體包管理儲存庫、容器註冊表、AI 推理供應商等提供統一、高效的加速,同時替你處理快取、重試、安全回應標頭,以及各種協定相容行為。 + +技術深度解析文章:**[《深入剖析 Xget:一個高效能、多協定、高安全性的開發者資源加速引擎》](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)**。 + +受邀入駐 +[GitCode](https://gitcode.com/xixu-me/xget),並被認證為 G-Star 畢業專案。作為「一個被廣泛使用的公共專案」,獲得 OpenAI 的 +[Codex for Open Source](https://developers.openai.com/community/codex-for-oss) +計畫支援,也獲得多位技術博主自發推薦,包括[阮一峰](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget)、[GitHubDaily](https://x.com/i/status/1956204203937829256)、[魚 C](https://www.bilibili.com/video/BV1EeeBzVEop/)、[玄離 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8) +等。感謝所有支持、分享、推薦和實際使用 Xget 的個人、團隊與社群。 + +## 支援的平台 + +> [!NOTE] +> 下方徽章會跳轉到 README 中對應的使用或部署章節。 + [![GitHub](https://img.shields.io/badge/GitHub-181717?&logo=github&logoColor=white)](#github) [![GitLab](https://img.shields.io/badge/GitLab-FC6D26?&logo=gitlab&logoColor=white)](#gitlab) [![Gitea](https://img.shields.io/badge/Gitea-609926?&logo=gitea&logoColor=white)](#gitea) @@ -61,17 +76,7 @@ [![容器註冊表](https://img.shields.io/badge/容器註冊表-262261?logo=opencontainersinitiative&logoColor=white)](#容器註冊表) [![AI 推理供應商](https://img.shields.io/badge/AI%20推理供應商-94A3B8?logo=openrouter&logoColor=white)](#ai-推理供應商) -面向開發者資源的超高效能、安全、一體化加速引擎,其效能顯著優於傳統解決方案,為程式碼託管、模型和資料集中心、軟體包管理儲存庫、容器註冊表、AI 推理供應商等提供統一、高效的加速,同時替你處理快取、重試、安全回應標頭,以及各種協定相容行為。 - -技術深度解析文章:**[《深入剖析 Xget:一個高效能、多協定、高安全性的開發者資源加速引擎》](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)**。 - -Xget 已受邀入駐 -[GitCode 平台](https://gitcode.com/xixu-me/xget),並被認證為 G-Star 畢業專案。作為「一個被廣泛使用的公共專案」,Xget 也獲得了 OpenAI -[Codex for Open Source](https://developers.openai.com/community/codex-for-oss) -計畫的支援。同時,它也獲得多位技術博主自發推薦,包括[阮一峰](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget)、[GitHubDaily](https://x.com/i/status/1956204203937829256)、[魚 C](https://www.bilibili.com/video/BV1EeeBzVEop/)、[玄離 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8) -等。感謝所有支持、分享、推薦和實際使用 Xget 的個人、團隊與社群。 - -## 🎯 快速開始 +## 快速開始 **預部署實例:`xget.xi-xu.me`** - 僅適合評估與試用,正式環境或對可用性敏感的場景建議自行部署。 @@ -82,26 +87,26 @@ Xget 已受邀入駐 **Agent Skills:`npx skills add xixu-me/skills -s xget`** -## 🌟 核心優勢 - 為什麼選擇 Xget? +## 為什麼選擇 Xget -### ⚡ 面向效能的設計 +### 面向效能的設計 -- **🌐 全球邊緣執行環境**:基於 Cloudflare +- **全球邊緣執行環境**:基於 Cloudflare Workers,盡量讓請求更靠近使用者與上游服務 -- **⚡ 協定感知處理**:支援 HTTP/3、Range 請求、Git 流量、容器註冊表流程與 AI 推理 API -- **📦 快取與重試鏈路**:對可相容回應提供邊緣快取,對暫時性上游失敗提供重試,並對支援的平台做請求規範化 -- **🔗 連線重用**:在執行環境與上游允許的前提下,重用標準 HTTP +- **協定感知處理**:支援 HTTP/3、Range 請求、Git 流量、容器註冊表流程與 AI 推理 API +- **快取與重試鏈路**:對可相容回應提供邊緣快取,對暫時性上游失敗提供重試,並對支援的平台做請求規範化 +- **連線重用**:在執行環境與上游允許的前提下,重用標準 HTTP keep-alive 與連線重用能力 -- **📊 請求耗時可觀測**:在協定相容的情況下,可透過 `X-Performance-Metrics` +- **請求耗時可觀測**:在協定相容的情況下,可透過 `X-Performance-Metrics` 回應標頭暴露階段性耗時資訊 -### 🌐 多平台深度整合 +### 多平台深度整合 - **一站式多平台支援**:統一支援各種開發場景中的主流平台 - **智慧識別與轉換**:自動識別平台前綴並轉換為目標平台的正確 URL 結構 - **一致的加速體驗**:無論檔案類型或來源,均可享受統一且穩定的極速下載體驗 -### 🔒 企業級安全保障 +### 企業級安全保障 - **多層安全標頭**: - `Strict-Transport-Security`:強制 HTTPS 傳輸,預防中間人攻擊 @@ -117,7 +122,7 @@ Xget 已受邀入駐 - 輸入清理:防止路徑遍歷和注入攻擊 - **逾時保護**:30 秒請求逾時,防止資源耗盡和惡意請求 -### 🚀 現代架構與可靠性 +### 現代架構與可靠性 - **智慧重試機制**: - 最大 3 次重試,線性延遲策略(1000ms × 重試次數) @@ -132,7 +137,7 @@ Xget 已受邀入駐 - 透過 `X-Performance-Metrics` 回應標頭提供詳細效能數據 - 支援快取命中率統計和最佳化建議 -### 🎯 Git 協定完全相容 +### Git 協定完全相容 - **智慧協定檢測**: - 自動識別 Git 特定端點(`/info/refs`、`/git-upload-pack`、`/git-receive-pack`) @@ -148,7 +153,7 @@ Xget 已受邀入駐 - 智慧 User-Agent 處理(預設 `git/2.34.1`) - 支援 Git LFS 大檔案傳輸 -### 📱 生態系統整合 +### 生態系統整合 - **專用瀏覽器擴充功能**:[Xget Now](https://github.com/xixu-me/Xget-Now) 提供無縫體驗 @@ -159,7 +164,7 @@ Xget 已受邀入駐 - **下載工具相容性**:完美支援 wget、cURL、aria2、IDM 等主流下載工具 - **CI/CD 整合**:可直接在 GitHub Actions、GitLab CI 等環境中使用 -## 🏗️ 系統架構 +## 系統架構 ### 請求處理流程 @@ -254,7 +259,7 @@ classDiagram PlatformRouting --> PlatformCatalog ``` -## 📖 URL 轉換規則 +## URL 轉換規則 使用預部署實例 **`xget.xi-xu.me`** 或您自己部署的實例,只需簡單替換網域並新增平台前綴: @@ -893,7 +898,7 @@ https://xget.xi-xu.me/ip/huggingface/hf-inference/models/openai/whisper-large-v3 應用場景見 [AI 推理 API 加速](#ai-推理-api-加速)。 -## 🎯 應用場景 +## 應用場景 ### Git 操作與配置 @@ -2527,7 +2532,7 @@ client = OpenAI( ) ``` -## 🚀 部署 +## 部署 ### 部署到 Cloudflare Workers @@ -2792,7 +2797,7 @@ Platform 等資源: **注意**:自託管部署不包括全球邊緣網路加速,效能取決於您的伺服器配置和網路環境。 -## 🔧 配置 +## 配置 ### 配置參數 @@ -2835,7 +2840,7 @@ const PLATFORM_PATH_TRANSFORMERS = { }; ``` -## 🚧 開發 +## 開發 1. **儲存庫設定** @@ -2857,7 +2862,7 @@ const PLATFORM_PATH_TRANSFORMERS = { npm run deploy # 部署到生產環境 ``` -## 🧪 測試 +## 測試 儲存庫包含完整的測試套件,確保程式碼品質和功能正確性。 @@ -2884,7 +2889,7 @@ npm run test:watch - **安全測試**: 輸入驗證、安全標頭、權限控制 - **效能測試**: 回應時間、記憶體使用、並行處理 -## 🔍 故障排除 +## 故障排除 ### 常見問題 @@ -2914,7 +2919,7 @@ A: 確認使用了正確的 URL 格式,且 Git 用戶端版本支援 HTTPS 代 npx wrangler dev --log-level debug ``` -## ⚠️ 免責聲明 +## 免責聲明 - **合法合規使用**:本儲存庫旨在為程式碼儲存庫、軟體包註冊表、AI 推理 API、容器鏡像、模型、資料集及更多合法開發者資源提供統一加速服務。使用者應嚴格遵守所在司法管轄區法律法規及相關平台服務條款,任何非法用途的法律責任由使用者自行承擔 - **非關聯性與獨立責任**:本儲存庫與各第三方平台不存在任何隸屬、代理或合作關係。任何基於本儲存庫的 fork、二次開發、再分發或衍生版本均由其維護者獨立承擔全部責任;作者、維護者及貢獻者不對衍生儲存庫的任何行為或後果承擔法律或連帶責任 @@ -2928,23 +2933,27 @@ npx wrangler dev --log-level debug - **名稱使用規範**:嚴禁任何可能暗示作者或貢獻者提供商業合作、技術支援、擔保或背書的表述。涉及儲存庫名稱或作者標識的使用應遵循相關法律法規及通用規範 - **免責聲明更新**:本免責聲明可能隨儲存庫發展或法律環境變化進行更新修訂。使用者繼續使用、複製、分發或修改本儲存庫即視為接受最新版本的免責聲明 -## 🤝 貢獻 - -我們歡迎各種形式的貢獻!請檢視[貢獻指南](CONTRIBUTING.md)了解如何參與儲存庫開發。 +## 專案資源 -社群協作與維護者職責說明請參考: +我們歡迎各種形式的貢獻。開始前請先閱讀[貢獻指南](CONTRIBUTING.md),並在協作過程中參考這些專案文件: - [行為準則](CODE_OF_CONDUCT.md) - [安全政策](SECURITY.md) - [治理說明](GOVERNANCE.md) +你可以透過以下方式參與: + 1. **報告問題**: 使用 - [issue 範本](https://github.com/xixu-me/Xget/issues/new/choose)報告 bug 或提出功能請求 -2. **提交程式碼**: fork 儲存庫,建立功能分支,提交 pull request -3. **改進文件**: 修正錯誤、新增範例、完善說明 -4. **測試反饋**: 在不同環境下測試並提供反饋 + [issue 範本](https://github.com/xixu-me/Xget/issues/new/choose)回報 bug 或提出功能請求。 +2. **提交程式碼**: fork 儲存庫,建立功能分支並提交 pull request。 +3. **改進文件**: 修正錯誤、新增範例、完善說明。 +4. **測試回饋**: 在不同環境下測試並分享結果。 + +版權所有 © Xi Xu。 -## 🌟 Star 歷史 +本儲存庫採用 AGPL-3.0 許可證,詳見 [`LICENSE`](LICENSE)。 + +## Star 歷史 @@ -2954,12 +2963,6 @@ npx wrangler dev --log-level debug -## 📝 許可證 - -版權所有 © Xi Xu。 - -本儲存庫採用 AGPL-3.0 許可證 - 檢視 [`LICENSE`](LICENSE) 檔案了解詳情。 - ---
diff --git a/package.json b/package.json index a1382437b..db91c636c 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ }, "name": "xget", "license": "AGPL-3.0-or-later", - "private": false, + "private": true, "scripts": { "commitlint": "commitlint --last --verbose", "commitmsg": "commitlint --edit",