Skip to content
This repository was archived by the owner on Jun 7, 2024. It is now read-only.

guide.md

Latest commit

 

History

History
84 lines (56 loc) · 3.52 KB

guide.md

File metadata and controls

84 lines (56 loc) · 3.52 KB

User Guide

Please read and accept our Term of Service and Privacy Statement then go to the next step. Once you done so, it means that you agree with our Term of Service and Privacy Statement.

::: danger Due to irreversible factors, we have updated our hub link from hub.fastgit.org to hub.fgit.cf. :::

The usage of FastGit is basically relied on git . For common GitHub operations, you can use the command clone like:

git clone https://github.com/author/repo

To use FastGit, you need to change it into:

git clone https://hub.fgit.cf/author/repo

Just like what you see, FastGit is physically a proxy of GitHub, and what you need to do is just replacing the URL.

You can also edit git configurations to take an easier way to use our service.

You can also change the configuration of git directly, replacing the link of GitHub entirely with FastGit:

git config --global url."https://hub.fgit.cf/".insteadOf "https://github.com/"
git config protocol.https.allow always

:::warning Note Don't forget to check if FastGit is down when you are troubleshooting network errors, even though we offer SLA guarantees of up to 0% availability. :::

:::warning Note We do NOT support that clone repositories which are over 2GiB. Read more FastGitORG/nginx-conf#14 and https://github.com/FastGitORG/nginx-conf/commit/61a41bc0bbb012fc9a6e54b198a10874eeaf9309. :::

With the growth of FastGit, we will deploy more resources to support our speed-up service. You can find the list of our nodes in the chapter Nodes.

The Usage of Web

FastGit also supplies basic supports for the common GitHub Web operations. You can directly access nodes with Web supports.

Due to the safety concerns, we banned sensitive things, like Cookie and Session . That means you are not able to do sensitive operations such as signing in GitHub via FastGit.

Download Releases or Source Code Archives

For common clone and push operations, FastGit already has provided perfect support. We can use the command below to download releases & source code archives.

# Release
# If your downalod link is: https://github.com/A/A/releases/download/1.0/1.0.tar.gz , then you use:
wget https://hub.fgit.cf/A/A/releases/download/1.0/1.0.tar.gz

# Codeload
# If your download link is: https://hub.fgit.cf/A/A/archive/master.zip
# or https://codeload.github.com/A/A/zip/master
wget https://hub.fgit.cf/A/A/archive/master.zip

SSH Operation

Due to some unresistible factors, we are no longer to provide SSH clone service.

For the Raw Proxy

We also have proxy for https://raw.githubusercontent.com/.
The URL is: https://raw.fgit.cf/.

What to do if you have problems with FastGit

  1. Make sure your network and DNS are working properly
  2. Please check https://status.fastgit.org and https://github.com/FastGitORG/uptime to confirm if FastGit is facing potential service unavailability
  3. Change your DNS to AliPublic public DNS to avoid potential DNS pollution issues
  4. Try to communicate with the FastGit IP via Tcpping

When you have confirm that FastGit is or is potentially unavailable, please contact us. You can communicate us by sending an email to admin@fastgit.org, opening an issue to our discussion https://github.com/FastGitORG/discussion, or via the Telegram instant messaging group @FastGit.

:::tip Tip It is important to note that PING does not determine if a server is unavailable. We recommend using Tcpping to detect port 443. :::