/toshiki-proxypool

🧸 A magical scraper that automatically crawl SS, SSR, vmess, trojan node info from web, Telegram Channels, and localize/integrate into a web panel for convenient usages.

Primary LanguageGoGNU General Public License v3.0GPL-3.0

logo

俊樹のProxypool

simple and fast
Explore the docs »

English · 简体中文

The all-in-one crawler/scraper for crunching free proxy nodes of SS, SSR, vmess, trojan!


wakatime status chat on telegram go built stats Github Actions release codeql docker build github issues FOSSA Status codecov

展开目录
  1. 先看我！！！
  2. 我是谁？
  3. 安装
  4. 修改配置文件
  5. 启动程序
  6. Clash配置文件
  7. 本地检查节点可用性
  8. 截图
  9. License

Read Before You Proceed

Note: Note that this project was originally released by sansui233 licensed under GNU for project derivational development and distribution; As required by original developers, project content contained under proxypool and its affiliates MUST be copyleft yet pointing the credit of the original developer. Hence this project and its assets in contained is a new branch & version published and secondarily developed from the original project, please understand and ensure copywrites are pointing the original author for your own development.

What is toshiki-proxypool?

Toshiki's proxypool contains a complete suite of SS, SSR, vmess, trojan node crawler written in GoLang and compiled into a compiled into a Linux image for VPS deployment, you can also try deployment for Heroku, completely free to use, see the next section for further info.

  • The original author is no longer maintaining the original project, thus this project exists.

What does it support?

  • 🧩 Extensible: Support SSS, SSR, vmess, trojan & a variable types of nodes.
  • 💬 Telegram: Telegram channel sniffer & crawling.
  • 🎲 Featured: Support address subscription sniffer, analysis & crawling.
  • 🌐 Web: Open network vague crawling.
  • 🕒 Cron: Timed crawling & updates supported via cron job.
  • 🎨 Customizable: Customizable crawl source via configuration yaml file.
  • 🎀 Automated: Automatically detect uptime and availability of nodes.
  • 🎯 Convenient: Serve direct config files for clash, surge for importation.
  • 🔮 Subscription: Provide direct SS, SSR, vmess, sip002 subscription.
  • 🎠 Deployable: Easy deployment, VPS/Heroku/Local/Docker deployment supported.
  • 🍔 Customizable: Allowed to whitelist the countries to your demand.
  • ...

Installation

Heroku

Click the button below and fill in the basic information

Where DOMAIN needs to be filled in as the domain name you need to bind, and "CONFIG _ FILE" need to be filled in as the path of the configuration file.

heroku app域名为appname.herokuapp.com。项目内配置文件为./config/config.yaml

configuration file template can be found in the the config / config.yaml file, while optional fields can be retained. For full configuration options, see Profile Description。

Deploy

因为爬虫程序需要持续运行，所以至少选择 $7/月 的配置 免费配置长时间无人访问会被heroku强制停止

从源码编译

需要安装Golang

$ go get -u -v github.com/andatoshiki/toshiki-proxypool

运行

$ go run main.go -c ./config/config.yaml

编译

make

下载预编译程序

从这里下载预编译好的程序 GitHub release

use docker

docker pull docker.pkg.github.com/andatoshiki/toshiki-proxypool/proxypool:latest

使用

运行该程序需要具有访问完整互联网的能力。

修改配置文件

首先修改 config.yaml 中的必要配置信息。带有默认值的字段均可不填写。完整的配置选项见配置文件说明

启动程序

使用 -c 参数指定配置文件路径，支持http链接

proxypool -c ./config/config.yaml

如果需要部署到VPS，更多细节请查看wiki。

Clash配置文件

远程部署时Clash配置文件访问：https://domain/clash/config

本地运行时Clash配置文件访问：http://127.0.0.1:[端口]/clash/localconfig

本地检查节点可用性

此项非必须。为了提高实际可用性，可选择增加一个本地服务器，检测远程proxypool节点在本地的可用性并提供配置，见proxypoolCheck。

screenshot

License

FOSSA Status

FOSSA Status