diff --git a/README.md b/README.md new file mode 100644 index 0000000..5325393 --- /dev/null +++ b/README.md @@ -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 +```