add README

This commit is contained in:
Kay Faraday 2022-06-12 02:07:49 +00:00
parent 853b308696
commit dd3b20bbae
1 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# replacer
A reverse proxy that applies string replacements to response bodies.
This was developed for [Freak University's onion](http://freakuup7twznw6ri3e246fooe4ctw66rt7chbxcbc3p63lfky7dkvid.onion/)
in order to replace clearnet links (such as images and the websocket URL) with onion links, ensuring that no clearnet requests are made to the site.
## Usage
```
$ pip install -r requirements.txt
$ cp config.example.toml config.toml
$ # edit as necessary
$ ./replacer.py
$ # now configure your reverse proxy to proxy to replacer
```