ngx_http_google_filter_module: Simplify Google Mirror Deployment with Nginx

Module Overview

ngx_http_google_filter_module is an Nginx filter module designed to make deploying a Google mirror site extremely simple. It automates most of the complex challenges encountered when proxying Google services through built-in regular expressions, URI location matching, and other sophisticated configuration logic.

As a native Nginx module, it provides higher efficiency and stability than external scripts or complex configurations when handling cookies, Google static resources (gstatic), and various redirects.

Key Advantages

• Out-of-the-box functionality: Includes complete rules for proxying Google Search, Maps, Translate, and other services, eliminating the need to manually write complex regex or location configurations.
• High-performance native code: Written in C and integrated directly into the Nginx request processing pipeline, offering superior performance over external handlers.
• Automated processing: Automatically corrects links in HTML, rewrites cookie paths, and handles resource proxying to ensure full mirror site functionality.
• Minimal configuration: Enabled with just a few lines, significantly lowering the barrier to deployment and maintenance.

Quick Start

Here is a basic configuration example to quickly set up a Google Search mirror.

# Load the module in the http block (assuming compiled installation)
load_module modules/ngx_http_google_filter_module.so;

server {
    listen 80;
    server_name google.yourdomain.com;

    # Enable the Google filter module
    google on;
    # Set the source domain for Google Scholar (optional, default is www.google.com)
    google_scholar "scholar.google.com";
    google_language "en";

    location / {
        # Proxy to Google
        proxy_pass https://www.google.com;
        proxy_set_header Host "www.google.com";
        proxy_redirect off;
        # The module automatically handles content filtering and rewriting
    }
}

Note: The module must be compiled into Nginx before use. Refer to the project's GitHub repository for specific compilation and installation instructions.

Project Source

This is an open-source project. The source code is hosted on GitHub:

https://github.com/cuber/ngx_http_google_filter_module

You can find the latest source code, detailed installation guides, full configuration parameter documentation, and usage examples in the repository.

Important Notes

• Legal Compliance: Ensure you understand and comply with local laws and Google's Terms of Service before deploying and using a Google mirror service.
• Nginx Version Compatibility: Check the module's compatibility with your Nginx version by reviewing the project repository's Issues and Release notes.
• Performance Considerations: While the module itself is efficient, proxying high traffic volumes can strain server bandwidth and resources. Plan accordingly.
• Functional Scope: The module primarily simplifies proxying for web search and similar services. Complex interactive scenarios like Google Account login may require additional configuration.

With ngx_http_google_filter_module, developers can deploy fully-functional Google mirrors with unprecedented ease, freeing their focus from tedious proxy configuration.