Aggregator

The Apple ruleset is designed to balance direct connections with proxying based on service availability in China.

• Direct Connection: Known Apple domains are included in China.list and set to a direct connection strategy. Unless you have a specific requirement, you do not need to add these manually.
• Proxying: Services that are blocked or restricted (e.g., App Store Preview, Moveis Trailers, Foreign Exchange queries, Spotlight international flight queries, and Dictionary Wikipedia queries) are included in Global.list for proxying.
• Granular Control: This directory provides specific sub-domain rules (e.g., TestFlight.list, FindMy.list) for users experiencing issues with Apple services in their specific region. Instead of proxying all Apple traffic, it is recommended to use these granular rules for specific tasks like App Store downloads or System Updates.

To use features like GitHub Gist storage or GitHub crawling, you need a GitHub token:

1. Visit GitHub Settings > Personal Access Tokens.
2. Click "Generate new token (classic)".
3. Set the following permissions:
   • gist: To create and edit Gists.
   • repo: To access repositories (if required).
4. Copy the generated token.

The aggregator provides several rule files for Telegram services in Surge. Choose the one that matches your specific routing needs:

• Telegram.list: This is the main Telegram rule file. It is already included in Global.list. Use this if you want to route all Telegram traffic through specific nodes for general acceleration. Only add this separately if you have a specific reason to override Global.list.
• TelegramNL.list, TelegramSG.list, and TelegramUS.list: These are specialized rule files targeting specific Telegram data centers (Netherlands, Singapore, and United States). Use these if you need to optimize large file transfers by routing traffic to nodes in those specific geographic regions.

The rulesets in this directory are designed to be used by referencing them in your Surge configuration to route game traffic through proxies.

For optimal performance, it is recommended to first test and optimize your connection using UsbEAm Hosts Editor or UsbEAm Consoles DNS.

If you find that specific download servers (e.g., origin-a.akamaihd.net) perform well via direct connection after applying suitable hosts, you can add those hosts to your Surge [Host] section and create corresponding rules to use a direct connection instead of a proxy.

To run only the crawling phase without the full processing/pushing workflow, set the WORKFLOW_MODE environment variable to 1 before running process.py.

# Set environment variable
export WORKFLOW_MODE=1

# Run crawling only
python subscribe/process.py -s config.json

The process.py method is recommended for advanced users who need fine-grained control over crawling rules, multi-group output management, custom storage backends, and automated scheduled runs.

To use it:

1. Prepare a configuration file by copying the default template.
2. Set the PUSH_TOKEN environment variable with your GitHub token.
3. Run the processing script pointing to your config file.

Common flags:

• --check: Only check proxy activity without full processing.
• -n <number>: Set the number of threads for high-performance mode.

System Requirements

• Python: 3.10 or higher
• OS: Windows, Linux, or macOS
• Storage: At least 100MB available space

Installation Steps

1. Clone the repository:

git clone https://github.com/wzdnzd/aggregator.git
cd aggregator

2. Install dependencies using pip or conda:

# Using pip
pip install -r requirements.txt

# Or using conda
conda install --file requirements.txt

3. Verify the installation:

# Check Python version
python --version

# Test imports
python -c "import yaml, requests; print('依赖安装成功')"

To ensure correct routing for Apple services, place the rule files in the following order within your configuration:

1. Global.list: Handles proxying for Apple services that are unavailable in mainland China.
2. Apple.list: A general collection of Apple services. If you want to proxy all Apple services, use this file. Crucial: Place Apple.list between Global.list and China.list to prevent Global.list rules from being overridden by direct connection rules.
3. Granular Apple Lists (e.g., TestFlight.list): Use these for specific proxying needs. These must be placed before China.list to ensure they take precedence over the default direct connection strategy.

# Recommended Rule Order

Global.list
Apple.list
[Other Apple Sub-lists]
China.list

You can use the streaming media split tunneling files located in this directory to route traffic based on geographic regions.

Note: Streaming services with broad geographic coverage or those that do not implement strict regional restrictions (such as YouTube, Netflix, or Amazon Prime Video) are not included in these specific regional rulesets.

To start the standard processing workflow, prepare a configuration file from the default template, edit it with your settings, and run process.py.

1. Prepare Configuration: Copy the default config to your local directory.
2. Edit: Modify my-config.json with your specific settings.
3. Run: Execute the processing script pointing to your config file.

Results will be automatically uploaded to your configured storage backend.