- Introduction
- Environment Variables
- One-Click Deploy
- Deploy using Local Machine
- Contributing
- Authors
- License
- Roxy is a simple self-hosted proxy on Heroku to unblock websites
- Complex websites which require various domains to function properly will break as they require indiviually written custom rewrite rules
- Roxy is tested on common websites read piracy such as
1337x.to
,nyaa.si
,thepiratebay.org
etc. - Heroku Free dyno auto-sleeps after 20 minutes to prevent that Roxy can keep itself alive but it should be enabled manually through environment variables
To deploy and use Roxy the following Environment Variables are required:
-
DOMAIN
- The domain to proxy through heroku ( Only domain name e.g. example.com)- Note:
- If a websites redirects to different domain then redirected domain should be entered.
- Example:
google.com
will redirect towww.google.com
thenwww.google.com
should be entered asDOMAIN
- Note:
-
KEEP_DYNO_ALIVE
(Default:false
) - Should Roxy keep heroku free dyno alive -
HEROKU_APP_URL
- Full Heroku App URL (required ifKEEP_DYNO_ALIVE
istrue
)
- Clone the project
git clone https://github.com/CoolFool/roxy
- Go to the project directory
cd Roxy
- Install Heroku CLI and Git for your platform
- Use the
heroku login
command to log in to the Heroku CLI: - Create an app on Heroku using
heroku create
and note the URL Generated - Add the required buildpacks as follows:
heroku buildpacks:set heroku/python
heroku buildpacks:set https://github.com/CoolFool/heroku-buildpack-nginx.git
- Set
DOMAIN
environment variable usingheroku config:set DOMAIN=example.org
- Heroku Free Dyno sleeps after 20 minutes.
If you want to keep the Dyno alive set the following environment values using
heroku config:set KEEP_DYNO_ALIVE=true
heroku config:set HEROKU_APP_URL=https://example-app-123.herokuapp.com
(Set the generated URL as its value)
- Now deploy Roxy using
git push heroku main
- Visit Roxy at the URL generated while creating the app or run
heroku open
- View Logs for the app using
heroku logs --tail
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request