Where to Find Documentation for bannedbook/fanqiang: Complete Guide

The bannedbook/fanqiang documentation is distributed across a central README, platform-specific markdown guides in subdirectories, and a GitHub Wiki covering Windows, macOS, iOS, Android, routers, and V2Ray/Shadowsocks server construction.

The bannedbook/fanqiang repository is a curated collection of "翻墙" (anti-censorship) tutorials, scripts, and one-click packages. Unlike traditional software libraries with centralized docs, this project organizes its documentation as a distributed set of markdown files mapped to specific platforms and use cases. All documentation files are stored directly in the repository and accessible via standard GitHub blob URLs.

Main Entry Point: The Root README

The primary entry point for all bannedbook/fanqiang documentation is the top-level README.md file. This document provides a concise overview of the repository structure and acts as a directory map, linking to every sub-section of the documentation.

According to the source code structure, the README contains the master index that directs users to platform-specific guides. From this central file, you can navigate to individual tutorials for specific operating systems, devices, and server configurations.

Platform-Specific Documentation Structure

The repository follows a "documentation + code" organization model rather than a single monolithic manual. Each platform folder contains a self-contained markdown guide, often with screenshots and downloadable scripts.

Windows Documentation

Windows users should reference windows/readme.md as the starting point. This file serves as an index for Windows-specific tutorials including:

• ChromeGo one-click package setup
• V2RayN configuration
• Clash for Windows installation
• SSTAP and ShadowsocksR guides
• Tor + V2Ray combinations

Detailed ChromeGo instructions are located at windows/ChromeGo.md.

macOS Documentation

For macOS systems, the entry point is macos/readme.md. This guide covers:

• ChromeGo Mac edition
• V2RayU and V2rayX clients
• ClashX and Surge configurations
• Security settings for allowing applications from unknown sources ("MAC允许未知来源的应用")

Specific V2RayU configuration details are available in macos/V2RayU.md.

Mobile Platform Documentation

iOS / iPhone: Navigate to ios/readme.md for step-by-step setup instructions for iOS proxy apps including Shadowrocket, Quantumult X, Surge, and Potatso Lite.

Android: The android/readme.md file contains tutorials for V2RayNG, Clash, BifrostV, ShadowsocksR, and Surfboard configurations.

Router and Linux Documentation

Router: Users running OpenWRT or Merlin firmware should consult router/readme.md for router-specific proxy configurations.

Linux: General Linux proxy instructions are maintained in linux/readme.md.

Game Consoles: Setup guides for PS4/PS5, Nintendo Switch, Xbox, and Apple TV are located in game/readme.md.

Server Construction Guides

Users building their own V2Ray or Shadowsocks servers should reference v2ss/readme.md. This directory contains full guides for constructing V2Ray and Shadowsocks services on VPS providers like Vultr and 搬瓦工 (BandwagonHost). The specific one-click installation script documentation is located at v2ss/V2ray官方一键安装脚本.md.

Specialized Application Documentation

• FQNews Android App: Documentation for the "翻墙新闻" Android client is in fqnews2/README.md
• ChromeGo Package: Detailed package information is in ChromeGo/README.md
• EdgeGo Package: Edge browser-specific documentation is in EdgeGo/README.md
• Firefox Linux: Firefox-specific Linux instructions are in FirefoxFqLinux/README.md

GitHub Wiki Resources

Supplemental documentation is maintained in the repository's GitHub Wiki at https://github.com/bannedbook/fanqiang/wiki. The Wiki contains articles covering:

• Chrome 一键翻墙包 (Chrome one-click packages)
• Firefox Linux configurations
• Free SS account information
• V2Ray free account details

Practical Implementation Examples

The documentation includes executable code snippets stored within the repository. Below are typical usage patterns extracted from the guides.

Windows ChromeGo Installation

# 1️⃣ Download the archive (link shown in the ChromeGo README)

# 2️⃣ Extract it to a folder without spaces or Chinese characters

# 3️⃣ Run the start script

cd C:\Tools\ChromeGo
Start-Process .\ChromeGo.exe

Full steps are documented in windows/ChromeGo.md.

macOS V2RayU Configuration

# Clone the repo (or download the V2RayU package)

git clone https://github.com/bannedbook/fanqiang.git
cd fanqiang/macos

# Open the V2RayU config file

open V2RayU.conf

# Paste your V2Ray node details, then save and launch V2RayU.app

Complete instructions are available in macos/V2RayU.md.

V2Ray Server Deployment on VPS

# On the VPS

wget -O install_v2ray.sh https://raw.githubusercontent.com/bannedbook/fanqiang/master/v2ss/V2ray官方一键安装脚本.md
bash install_v2ray.sh

# After installation, edit the server config

nano /etc/v2ray/config.json

# Restart V2Ray

systemctl restart v2ray

The installation script source is located at v2ss/V2ray官方一键安装脚本.md.

Summary

• The root README.md serves as the master index for all bannedbook/fanqiang documentation
• Platform-specific guides are organized in dedicated folders: windows/, macos/, ios/, android/, router/, linux/, and game/
• Server setup instructions are concentrated in the v2ss/ directory
• Specialized applications like FQNews and ChromeGo maintain their own README files in subdirectories
• The GitHub Wiki provides supplemental articles and free account resources
• All documentation uses markdown format with embedded code examples and screenshot references

Frequently Asked Questions

Where is the main bannedbook/fanqiang documentation located?

The primary documentation entry point is the README.md file in the repository root. This file contains a directory map linking to all platform-specific guides and serves as the central hub for navigating the documentation structure.

Does the repository have a Wiki?

Yes. The bannedbook/fanqiang repository maintains a GitHub Wiki at github.com/bannedbook/fanqiang/wiki that contains supplemental articles not included in the main repository files, including guides for Chrome one-click packages and free account listings.

How do I find setup instructions for my specific operating system?

Navigate to the platform-specific subdirectory corresponding to your device: windows/readme.md for Windows, macos/readme.md for macOS, ios/readme.md for iPhone, or android/readme.md for Android devices. Each file contains an index of available tutorials for that platform.

Are there documentation files for building my own proxy server?

Yes. Server construction documentation is located in the v2ss/ directory, specifically in v2ss/readme.md and v2ss/V2ray官方一键安装脚本.md. These files provide complete instructions for deploying V2Ray and Shadowsocks services on VPS providers including Vultr and BandwagonHost.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}