GitHub Accelerator Proxy User Guide

GitHub Proxy is a high-performance GitHub acceleration and proxy service built specifically for developers. Powered by distributed global Anycast CDN edge nodes and intelligent route scheduling, it solves common network bottlenecks when accessing GitHub across regions—including connection timeouts, slow git clone speeds, broken downloads of large asset files, and API rate limits.

---

Quick Start

Simply prepend the proxy domain before any valid GitHub resource URL to start an accelerated download:

https://gh-proxy.org/https://github.com/AdguardTeam/AdGuardHome/releases/download/v0.107.43/AdGuardHome_linux_amd64.tar.gz

---

Supported Resource Types & Comprehensive Specification

This service natively supports all major GitHub resource types, covering release assets, source code archives, raw script files, Actions artifacts, Git protocols, commit patches, and official APIs. Click or copy the URLs below to use:

1. Repository Home & Releases Auto-Inspection (Repo Releases)

• Description: Enter any GitHub repository homepage or releases URL directly; the service automatically identifies it and redirects to the web converter to query all release versions and downloadable assets.
• URL Patterns:
  • https://github.com/{owner}/{repo}
  • https://github.com/{owner}/{repo}/releases
• Complete Examples (Note: Uses the main site domain to trigger the web UI converter):

  # Example 1: Accelerate repository homepage directly
  https://gh-proxy.com/https://github.com/dyang886/Game-Cheats-Manager
  
  # Example 2: Accelerate repository Releases page
  https://gh-proxy.com/https://github.com/dyang886/Game-Cheats-Manager/releases
  

• Key Inspection Features:
  • Automatic Recognition & Inspection: Accessing or pasting a repository homepage link automatically opens the home converter and queries all published releases.
  • Multi-Node Direct Download for Every File: Lists all compiled assets (.exe, .zip, .apk, .tar.gz, etc.) and source packages for each release version, providing multi-line download links and 1-click clipboard copy buttons.
  • Inline Changelog Toggle: View formatted release notes and update logs directly in the panel.
  • Fallback for Repositories without Releases: If no release exists, fallback download buttons for the main branch archive (main.zip) and Git Clone commands are automatically provided.

---

2. Release Assets & Source Code Archives

2.1 Release Software Assets (Release Assets)

• Description: Binaries, installers, firmware, ROMs, archives, and checksum files uploaded to a Release page.
• URL Patterns:
  • https://github.com/{owner}/{repo}/releases/download/{tag}/{filename}
  • https://github.com/{owner}/{repo}/releases/latest/download/{filename} (Direct latest version link)
• Complete Examples:

  # Specific release asset
  https://gh-proxy.org/https://github.com/AdguardTeam/AdGuardHome/releases/download/v0.107.43/AdGuardHome_linux_amd64.tar.gz
  
  # Automatic redirection to the latest release asset
  https://gh-proxy.org/https://github.com/docker/compose/releases/latest/download/docker-compose-linux-x86_64
  

• Use Cases: Automated shell installation scripts, Dockerfile builds, and server software distributions.
• Acceleration Features: Follows GitHub’s 302 redirects automatically and streams data from global CDN edges with 200 OK, supporting chunked transfers and resumable downloads.

2.2 Branch / Tag Source Code Archive (Source Code Archive)

• Description: GitHub-generated source code archives (zip / tar.gz) for specific tags or branches.
• URL Patterns:
  • https://github.com/{owner}/{repo}/archive/refs/tags/{tag}.tar.gz
  • https://github.com/{owner}/{repo}/archive/refs/tags/{tag}.zip
  • https://github.com/{owner}/{repo}/archive/refs/heads/{branch}.tar.gz
  • https://github.com/{owner}/{repo}/archive/{tag}.tar.gz (Shortened path)
• Complete Examples:

  # Tag source archive (tar.gz)
  https://gh-proxy.org/https://github.com/torvalds/linux/archive/refs/tags/v6.6.tar.gz
  
  # Branch source archive (zip)
  https://gh-proxy.org/https://github.com/facebook/react/archive/refs/heads/main.zip
  

• Use Cases: Local compilation of open-source software and CI/CD automated dependency packaging.

---

3. Raw Source Code & Script Files

3.1 Official Raw Direct Links

• Description: Fetch plain text or binary content of repository files directly (without HTML wrapping).
• URL Patterns:
  • https://raw.githubusercontent.com/{owner}/{repo}/{branch}/{filepath}
• Complete Examples:

  # Homebrew official installer
  https://gh-proxy.org/https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh
  
  # Common Shell install scripts
  https://gh-proxy.org/https://raw.githubusercontent.com/v2fly/fhs-install-v2ray/master/install-release.sh
  

• Use Cases: curl -fsSL ... | bash one-line installation, remote configuration files, or certificates.

3.2 Legacy Raw Domain Compatibility

• Description: Older scripts or documentation referencing the legacy raw.github.com domain.
• URL Patterns:
  • https://raw.github.com/{owner}/{repo}/{branch}/{filepath}
• Complete Examples:

  https://gh-proxy.org/https://raw.github.com/BTBaseNetwork/AdsAssets/master/BTAdsVideo/StairRush.mp4
  

• Acceleration Features: Pre-normalized to raw.githubusercontent.com automatically, saving 1 cross-domain 301 redirection round-trip.

3.3 In-Repository Raw Paths

• Description: Raw paths accessed directly through github.com.
• URL Patterns:
  • https://github.com/{owner}/{repo}/raw/{branch}/{filepath}
• Complete Examples:

  https://gh-proxy.org/https://github.com/neovim/neovim/raw/master/CMakeLists.txt
  

3.4 Web Blob View Links (Intelligent Rewrite)

• Description: Viewing URLs copied directly from browser address bars containing /blob/.
• URL Patterns:
  • https://github.com/{owner}/{repo}/blob/{branch}/{filepath}
• Complete Examples:

  https://gh-proxy.org/https://github.com/v2fly/fhs-install-v2ray/blob/master/install-release.sh
  

• Acceleration Features: Intelligently rewritten to the raw download path, ensuring pure file content is returned rather than full HTML navigation pages.

---

4. GitHub Actions Workflow Artifacts

4.1 Workflow Run Artifacts (No Login Required)

• Description: Build artifacts produced by completed GitHub Actions runs.
• URL Patterns:
  • https://github.com/{owner}/{repo}/actions/runs/{run_id}/artifacts/{artifact_id}
• Complete Examples:

  https://gh-proxy.org/https://github.com/oprypin/nightly.link/actions/runs/39804786735/artifacts/12436972061
  

• Use Cases: Download CI/CD artifacts directly via curl / wget or browser without requiring a GitHub account login.
• Acceleration Features: While standard GitHub links return 404 if not logged in, our service utilizes the GitHub REST API and token rotation pool to fetch signed storage URLs, streaming with 200 OK while preserving original filenames (Content-Disposition).

4.2 Suites Artifact Jump Links

• Description: Check Suites artifact links generated internally by GitHub.
• URL Patterns:
  • https://github.com/{owner}/{repo}/suites/{suite_id}/artifacts/{artifact_id}
• Complete Examples:

  https://gh-proxy.org/https://github.com/oprypin/nightly.link/suites/107881443291/artifacts/12436972061
  

• Acceleration Features: Automatically converted for login-free extraction and high-speed streaming.

4.3 Nightly.link Automated Artifacts

• Description: Public download links provided by the open-source nightly.link service for Actions artifacts.
• URL Patterns:
  • https://nightly.link/{owner}/{repo}/workflows/{workflow_file}/{branch}/{artifact_name}.zip
• Complete Examples:

  https://gh-proxy.org/https://nightly.link/crystal-lang/crystal/workflows/win/master/crystal.zip
  

---

5. Git Repository Cloning & Sync (Smart Git Protocol)

5.1 Git Clone / Fetch / Pull

• Description: Standard Git version control URLs (supporting both .git and non-.git endpoints).
• URL Patterns:
  • https://github.com/{owner}/{repo}.git
  • https://github.com/{owner}/{repo}
• Command Usage:

  # Clone a large repository
  git clone https://gh-proxy.org/https://github.com/torvalds/linux.git
  
  # Configure remote acceleration for an existing repository
  git remote set-url origin https://gh-proxy.org/https://github.com/owner/repo.git
  

5.2 Smart Git Protocol Subpaths

• Description: Low-level Git client negotiation and data exchange endpoints.
• URL Patterns:
  • https://github.com/{owner}/{repo}/info/refs
  • https://github.com/{owner}/{repo}/git-upload-pack
  • https://github.com/{owner}/{repo}/HEAD
• Acceleration Features: Automatically detects application/x-git-* payloads and disables caching (no-cache) to ensure full repository integrity; transparently returns 301 if a repository has been renamed.

---

6. Commit / PR Patches & Atom Feeds

6.1 Commit & Pull Request Patches (Patch / Diff)

• Description: Unified difference patch files provided by GitHub for specific commits or pull requests.
• URL Patterns:
  • https://github.com/{owner}/{repo}/commit/{commit_hash}.patch
  • https://github.com/{owner}/{repo}/commit/{commit_hash}.diff
  • https://github.com/{owner}/{repo}/pull/{pr_number}.patch
  • https://github.com/{owner}/{repo}/pull/{pr_number}.diff
• Complete Examples:

  # Commit patch file
  https://gh-proxy.org/https://github.com/torvalds/linux/commit/ffc253263a1375a65fa6c9f62a893e9767fbebfa.patch
  
  # Pull Request patch file
  https://gh-proxy.org/https://github.com/facebook/react/pull/26000.patch
  

• Use Cases: Code review, offline patch application, or direct pipeline execution:

  curl -fsSL https://gh-proxy.org/https://github.com/torvalds/linux/commit/ffc253263a1375a65fa6c9f62a893e9767fbebfa.patch | git apply
  

6.2 Commit History Atom Feeds

• Description: XML Atom feeds for commits on specific branches or files.
• URL Patterns:
  • https://github.com/{owner}/{repo}/commits/{branch}.atom
  • https://github.com/{owner}/{repo}/commits/{branch}/{filepath}.atom
  • https://github.com/{owner}/{repo}/commits.atom
• Complete Examples:

  https://gh-proxy.org/https://github.com/vernesong/OpenClash/commits/core/master/core_version.atom
  https://gh-proxy.org/https://github.com/vernesong/OpenClash/commits/package/master/version.atom
  

• Use Cases: Router firmware or automation scripts tracking version bumps and rule changes.
• Acceleration Features: Explicitly whitelisted for .atom extensions and XML content types to avoid firewall false-positives.

6.3 Release & Tag Atom Feeds

• Description: Atom/RSS feeds tracking new project releases and tags.
• URL Patterns:
  • https://github.com/{owner}/{repo}/releases.atom
  • https://github.com/{owner}/{repo}/tags.atom
• Use Cases: Subscribing to software updates via RSS readers.

---

7. Gist Snippets (Gist Raw)

• Description: Direct access to raw text files in GitHub Gists.
• URL Patterns:
  • https://gist.githubusercontent.com/{user}/{gist_id}/raw/{filename}
  • https://gist.github.com/{user}/{gist_id}/raw/{filename}
• Complete Examples:

  https://gh-proxy.org/https://gist.githubusercontent.com/octocat/1169852/raw/test.cs
  

• Acceleration Features: Automatically normalizes gist.github.com to gist.githubusercontent.com to eliminate redirect latency.

---

8. GitHub Official Short Links (gh.io)

• Description: Official short URLs used by GitHub services and campaigns.
• URL Patterns:
  • https://gh.io/{slug}
  • http://gh.io/{slug}
• Complete Examples:

  https://gh-proxy.org/https://gh.io/copilot-install
  

• Use Cases: Official CLI installation instructions, e.g.:

  curl -fsSL https://gh-proxy.org/https://gh.io/copilot-install | bash
  

• Acceleration Features: Follows redirects internally at the edge node and proxies the final landing resource directly, preventing multiple round-trips.

---

9. GitHub Official REST API

• Description: GitHub REST API endpoints.
• URL Patterns:
  • https://api.github.com/{endpoint}
• Complete Examples:

  # Query repository latest release metadata
  https://gh-proxy.org/https://api.github.com/repos/cli/cli/releases/latest
  
  # Query repository tags
  https://gh-proxy.org/https://api.github.com/repos/torvalds/linux/tags
  

• Use Cases: Scripts retrieving repository metadata, detecting updates, or locating asset URLs.
• Acceleration Features:
  • Token Rotation Pool: Incorporates multiple GitHub PAT tokens to eliminate the 60 req/hour limit for unauthenticated IPs;
  • Header Passthrough: If the client provides an Authorization header, it is prioritized over the built-in pool.

---

10. Static Assets & Client Binaries

• User / Org Avatars:
  • Pattern: https://avatars.githubusercontent.com/u/{user_id}
  • Example: https://gh-proxy.org/https://avatars.githubusercontent.com/u/9919?v=4
• Project OpenGraph Preview Images & Static Assets:
  • Pattern: https://opengraph.githubassets.com/{token}/{owner}/{repo}
  • Pattern: https://github.githubassets.com/assets/...
• GitHub Desktop Client Installers:
  • Pattern: https://desktop.githubusercontent.com/...
  • Example: https://gh-proxy.org/https://desktop.githubusercontent.com/releases/3.6.2-beta1-f62b1c7a/GitHubDesktop-x64.zip

---

Command Line Integration Guide

Fast Downloads with Wget

wget -c "https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy/releases/download/4.3.4/ghproxy-linux-amd64.tar.gz"

cURL Downloads & Piped Execution

# Download and save as local file
curl -L -C - -O "https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy/releases/download/4.3.4/ghproxy-linux-amd64.tar.gz"

# Piped execution for remote installation scripts (e.g. Homebrew / Rustup / Copilot)
curl -fsSL "https://gh-proxy.org/https://raw.githubusercontent.com/homebrew/install/HEAD/install.sh" | bash

Git Global URL Rewrite (insteadOf)

By configuring Git’s insteadOf mechanism, you can transparently accelerate all GitHub operations locally without manual prefixing:

# Enable global acceleration
git config --global url."https://gh-proxy.org/https://github.com/".insteadOf "https://github.com/"

# Now standard git commands automatically utilize the proxy
git clone https://github.com/torvalds/linux.git

# Remove acceleration configuration
git config --global --unset url."https://gh-proxy.org/https://github.com/".insteadOf

---

Key Features

• Full GitHub Ecosystem Coverage: Comprehensive acceleration for Release assets, Raw code, Source archives, Actions artifacts, Git clone, Patch/Diff, Atom Feeds, Gist, gh.io shortlinks, and REST API.
• Login-Free Actions Artifact Extraction: Proprietary API & token rotation technology allows downloading CI/CD build artifacts without logging in to GitHub.
• Repository Home & Releases Auto-Inspection: Enter a repository homepage to automatically inspect release versions and generate multi-node direct download links and copy buttons.
• Global Anycast CDN Edge Caching: Popular Release packages and Raw scripts are cached at the edge to minimize latency.
• Seamless Large File Streaming: No artificial file size limits, with full support for chunked transfer and resumable downloads.
• Zero Configuration & Instant Use: No client software or complex proxy setup required—just prepend the domain prefix.
• End-to-End Secure Transmission: Completely encrypted via TLS/HTTPS; we never decrypt, alter, or retain private user credentials.
• Multi-Region Intelligent Failover: Globally distributed backup nodes automatically reroute traffic within 15 minutes if any node encounters issues.

---

Important Notes

1. Compliance: This service is intended strictly for learning, research, and legitimate open-source software downloads. Abuse, spamming, or malicious crawling is prohibited.
2. Public Resources: This proxy is designed for public GitHub resources. For security and privacy, private repositories require custom credentials.
3. Protocol Handling: The web converter automatically detects and handles the https:// protocol prefix. Please ensure your input URL is well-formed.
4. Bookmark Recommended: Add https://gh-proxy.org to your bookmarks for quick reference during daily development and server deployments.