mirror of
https://github.com/gnh1201/caterpillar.git
synced 2024-11-26 15:31:45 +00:00
63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
# 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. See the [Stateful mode (github.com/gnh1201/caterpillar wiki)](https://github.com/gnh1201/caterpillar/wiki/Stateful-mode).
|
|
|
|
## (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
|
|
1. Write a file `.env`(Linux) or `settings.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
|
|
```
|
|
|
|
- (Optional) Install RootCA for SSL decryption ([Download CA Certificate](ca.crt))
|
|
|
|
```bash
|
|
sudo apt-get install -y ca-certificates
|
|
sudo cp ca.crt /usr/local/share/ca-certificates/caterpillar-ca.crt
|
|
sudo update-ca-certificates
|
|
```
|
|
|
|
2. Run `python3 server.py` and set HTTP(S) proxy in your web browser (e.g. Firefox)
|
|
|
|
3. Test [100MB](http://speed.hetzner.de/100MB.bin)/[SSL](https://speed.hetzner.de/100MB.bin), [1GB](http://speed.hetzner.de/1GB.bin)/[SSL](https://speed.hetzner.de/1GB.bin), [10GB](http://speed.hetzner.de/10GB.bin)/[SSL](http://speed.hetzner.de/10GB.bin) download and check the speed (e.g. https://speed.hetzner.de/1GB.bin)
|
|
|
|
3. Enjoy it
|
|
|
|
4. (Optional) With [Cloudflare](https://cloudflare.com), we can expect to accelerate the 4x speed and reduce the network stuck.
|
|
|
|
## Fediverse support
|
|
See the [Fediverse (github.com/gnh1201/caterpillar wiki)](https://github.com/gnh1201/caterpillar/wiki/Fediverse).
|
|
|
|
## Thanks to
|
|
|
|
### Pan Art by [@yeohangdang@i.peacht.art](https://i.peacht.art/@yeohangdang)
|
|
|
|
|
|
## Report abuse
|
|
* ActivityPub [@gnh1201@catswords.social](https://catswords.social/@gnh1201)
|
|
* abuse@catswords.net
|