caterpillar/README.md
2024-02-19 13:50:07 +09:00

1.9 KiB

gnh1201/caterpillar

Caterpillar - The simple and parasitic web debugging proxy

How to works

You <-> Proxy client (Python) <-> Server-side scripting file (Optional, e.g. PHP) <-> On the Web

Build a simple web debugging proxy on the shared servers!

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
USER_TOKEN=

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