Docs Navigation (Current: GitHub Accelerator Proxy User Guide)

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, and broken downloads of large asset files.


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/username/repository/releases/download/v1.0.0/file.zip

Supported Resource Types & Examples

This service natively supports all major GitHub resource types. Click or copy the URLs below to use:

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

Enter any GitHub repository homepage or releases URL directly; the service automatically queries the acceleration API and lists all release versions and downloadable assets:

# 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
  • Automatic Recognition & Inspection: Accessing or pasting a repository homepage link automatically opens the home converter and queries all published releases.
  • 5-Node Direct Download for Every File: Lists all compiled assets (.exe, .zip, .apk, etc.) and source packages for each release version, providing 5 distinct high-speed node 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 5-node git clone commands are automatically provided.

2. Branch Source Archive (Archive)

Download the latest source code of a specific branch packaged in Zip or Tar.gz:

# Example: main branch source Zip package
https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy/archive/refs/heads/main.zip

3. Raw Source Files

Supports both web browser blob view paths (/blob/) and raw protocol paths (raw.githubusercontent.com):

# Web blob path (automatically converted to raw download)
https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy/blob/main/config/config.toml

# Native raw domain link
https://gh-proxy.org/https://raw.githubusercontent.com/WJQSERVER-STUDIO/ghproxy/refs/heads/main/config/config.toml

4. Release Source Code (Tags)

Download source code snapshots for a specific Release Tag:

# Example: Version 4.3.4 source code
https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy/archive/refs/tags/4.3.4.zip

5. Release Binary Assets (Assets)

Fast downloads for binary release packages, installers, executables, and checksum files of open source projects:

# Example: Linux binary release archive
https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy/releases/download/4.3.4/ghproxy-linux-amd64.tar.gz

6. Gist Raw Snippets

Fetch the original raw text file of public Gist code snippets directly:

# Example: Gist raw text
https://gh-proxy.org/https://gist.githubusercontent.com/oopsunix/2dbf20f64984773da6740d1d1cf7c2d4/raw/github-blacklist

7. GitHub REST API Endpoints

Accelerate calls to GitHub’s public REST APIs to mitigate latency and connection limits:

# Example: Repository metadata API
https://gh-proxy.org/https://api.github.com/repos/umami-software/umami

8. GitHub User Avatars

Speed up loading static user and organization profile avatars:

# Example: User avatar
https://gh-proxy.org/https://avatars.githubusercontent.com/u/10000?v=4

9. GitHub Desktop Client & Installers

Download official GitHub Desktop client binaries and installation packages:

# Example: GitHub Desktop x64 installation package
https://gh-proxy.org/https://desktop.githubusercontent.com/releases/3.6.2-beta1-f62b1c7a/GitHubDesktop-x64.zip

10. Git Repository Clone (Git Clone)

Rapidly clone full Git repositories in your terminal:

# Example: Clone ghproxy repository
git clone https://gh-proxy.org/https://github.com/WJQSERVER-STUDIO/ghproxy.git

Accelerate downloads of automated nightly builds generated by GitHub Actions:

# Visit nightly.link to browse automated release artifacts
https://nightly.link/

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)
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 support for GitHub Releases, Raw files, Archive tarballs, Git Clone, Gist, and API endpoints.
  • Repository Home & Releases Auto-Inspection: Accelerate repository homepages directly to automatically inspect release versions and generate 5-node direct download and copy buttons for every asset.
  • 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.

💬 Community Feedback