.github | ||
assets | ||
plugins | ||
.gitignore | ||
ca.crt | ||
ca.key | ||
caterpillar.service | ||
cert.key | ||
LICENSE | ||
README.md | ||
requirements.txt | ||
server.py | ||
smtp.py |
gnh1201/caterpillar
Caterpillar Proxy - The simple and parasitic web proxy with SPAM filter (formerly, php-httpproxy)
How it 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.
Stateful mode
This project supports two modes of connection. The default is stateless. You can use the stateful mode to avoid being constrained by transfer capacity limits (e.g., max_upload_size
). See the stateful mode compatibility.
(Optional) Before to use
If you have a server that will be parasitized and you want to proxy it, you should upload the index.php
file to a shared server. The index.php file is located in the assets/php
directory within this repository.
How to use
- Write a file
.env
(Linux) orsettings.ini
(Windows). Like this:
[settings]
PORT=5555
SERVER_URL=http://example.org
SERVER_CONNECTION_TYPE=stateless
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
DICTIONARY_FILE=
TRUECAPTCHA_USERID=
TRUECAPTCHA_APIKEY=
LIBREY_APIURL=
- (Optional) Install RootCA for SSL decryption (Download CA Certificate)
sudo apt-get install -y ca-certificates
sudo cp ca.crt /usr/local/share/ca-certificates/caterpillar-ca.crt
sudo update-ca-certificates
-
Run
python3 server.py
and set HTTP(S) proxy in your web browser (e.g. Firefox) -
Test 100MB/SSL, 1GB/SSL, 10GB/SSL download and check the speed (e.g. https://speed.hetzner.de/1GB.bin)
-
Enjoy it
-
(Optional) With Cloudflare, we can expect to accelerate the 4x speed and reduce the network stuck.
(Optional) For Mastodon users
In [Caterpillar installed directory]/settings.ini or .env
- set
SERVER_URL
variable tolocalhost
in.env
(e.g.SERVER_URL=localhost
) - set
PROXY_PASS
variable to Mastodon backend URI (e.g.http://127.0.0.1:3000
) - if you want use notification, set
MASTODON_SERVER
(server domain) andMASTODON_USER_TOKEN
(access token) variables
In [Mastodon installed directory]/env.production
- set
http_proxy
variable tohttp://localhost:5555
(e.g.http_proxy=http://localhost:5555
)
In NGINX configuration
- Check your port number of Caterpillar (default: 5555)
- In NGINX configuration (e.g.
/etc/nginx/conf.d/mastodon.conf
), edit theproxy_pass
like aproxy_pass http://localhost:5555
References
Thanks to
Pan Art by @yeohangdang@i.peacht.art
Report abuse
- ActivityPub @gnh1201@catswords.social
- abuse@catswords.net