gnh1201/caterpillar
1
0
Fork 0
mirror of https://github.com/gnh1201/caterpillar.git synced 2025-11-29 02:50:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Caterpillar Proxy - The simple and parasitic web proxy with SPAM filter (formerly, php-httpproxy)
173 Commits 12 Branches 75 Tags 6.4 MiB
PHP 36.4%
Python 35.6%
HTML 19.6%
Java 7.4%
Batchfile 0.5%
Other 0.5%
b2993d623a
Go to file
Namhyeon, Go b2993d623a
Update README.md
2024-02-19 16:30:43 +09:00
.gitignore Create .gitignore 2022-11-25 21:40:24 +09:00
ca.crt Add HTTPS decryption (Experimental) 2022-11-25 17:12:58 +09:00
ca.key Add HTTPS decryption (Experimental) 2022-11-25 17:12:58 +09:00
cert.key Add HTTPS decryption (Experimental) 2022-11-25 17:12:58 +09:00
index.php Update index.php 2024-02-19 13:53:46 +09:00
LICENSE Initial commit 2022-10-06 02:16:30 +09:00
README.md Update README.md 2024-02-19 16:30:43 +09:00
requirements.txt Create requirements.txt 2022-10-06 13:29:24 +09:00
server.py Update server.py 2024-02-19 16:25:07 +09:00
title.jfif Add files via upload 2024-02-19 14:16:06 +09:00

README.md

gnh1201/caterpillar

Caterpillar - The simple and parasitic web proxy with spam filter

title image

How to works

Basic structure

You <-> Proxy client (Python) <-> Parasitized proxy server (Optional, PHP) <-> On the Web

For example, build a simple web debugging proxy on the shared servers.

Spam filters

  • K-Anonymity test based filter (use pwnedpasswords.com)
  • image spam

(Optional) Before to use

If you have an will be parasitize server that you want to proxy, you can install the index.php file.

How to use

  1. Write a file .env(Linux) or settings.ini(Windows). Like this:
[settings]
PORT=5555
SERVER_URL=http://example.org
CA_KEY=ca.key
CA_CERT=ca.crt
CERT_KEY=cert.key
CERT_DIR=certs/
OPENSSL_BINPATH=openssl
CLIENT_ENCODING=utf-8
LOCAL_DOMAIN=example.org
PROXY_PASS=http://127.0.0.1:3000
MASTODON_SERVER=
MASTODON_USER_TOKEN=
TRUECAPTCHA_USERID=
TRUECAPTCHA_APIKEY=

1.1. (Optional) Install RootCA

sudo apt-get install -y ca-certificates
sudo cp ca.crt /usr/local/share/ca-certificates/caterpillar-ca.crt
sudo update-ca-certificates

  1. Run python3 server.py and set HTTP(S) proxy in your web browser (e.g. Firefox)

  2. Test 100MB/SSL, 1GB/SSL, 10GB/SSL download and check the speed (e.g. https://speed.hetzner.de/1GB.bin)

  3. Enjoy it

  4. (Optional) With Cloudflare, we can expect to accelerate the 4x speed and reduce the network stuck.

(Optional) For Mastodon users

  1. In [php-httpproxy installed directory]/settings.ini or .env, set SERVER_URL variable to localhost in .env (e.g. SERVER_URL=localhost)
  2. In [mastodon installed directory]/env.production, set http_proxy variable to http://localhost:5555 (e.g. http_proxy=http://localhost:5555)

References

Contact