Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 3.81 KB

README.md

File metadata and controls

87 lines (65 loc) · 3.81 KB
Raw
roxy logo

Deploy Self-Hosted Proxy to unblock websites through Heroku in one click

Contents

Introduction

  • 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

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 to www.google.com then www.google.com should be entered as DOMAIN

  • KEEP_DYNO_ALIVE (Default: false) - Should Roxy keep heroku free dyno alive

  • HEROKU_APP_URL - Full Heroku App URL (required if KEEP_DYNO_ALIVE is true)

(back to top)

One-Click Deploy

  • Click Deploy
  • Enter the environment variables as explained
  • Deploy and Visit the heroku app url

(back to top)

Deploy using Local Machine

  1. Clone the project git clone https://github.com/CoolFool/roxy
  2. Go to the project directory cd Roxy
  3. Install Heroku CLI and Git for your platform
  4. Use the heroku login command to log in to the Heroku CLI:
  5. Create an app on Heroku using heroku create and note the URL Generated
  6. Add the required buildpacks as follows:
  • heroku buildpacks:set heroku/python
  • heroku buildpacks:set https://github.com/CoolFool/heroku-buildpack-nginx.git
  1. Set DOMAIN environment variable using heroku config:set DOMAIN=example.org
  2. 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)
  3. Now deploy Roxy using git push heroku main
  4. Visit Roxy at the URL generated while creating the app or run heroku open
  5. View Logs for the app using heroku logs --tail

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Authors

(back to top)

License

MIT

(back to top)