https://github.com/hackclub/proxyparty

🎊 An Nginx redirector and proxier for all of Hack Club's needs!
https://github.com/hackclub/proxyparty

Last synced: 5 days ago
JSON representation

🎊 An Nginx redirector and proxier for all of Hack Club's needs!

• Host: GitHub
• URL: https://github.com/hackclub/proxyparty
• Owner: hackclub
• License: mit
• Created: 2021-10-13T19:49:33.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T16:03:49.000Z (14 days ago)
• Last Synced: 2024-11-05T15:48:30.433Z (8 days ago)
• Language: Nix
• Homepage: https://proxyparty.hackclub.com
• Size: 89.8 KB
• Stars: 50
• Watchers: 7
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# proxy server + NixOS = proxyparty!



Ever need to redirect one URL to another? Ever need to proxy a website to a different domain? Hate manually configuring nginx?

This is Hack Club's proxy server, which we rely on to make sure our old links keep working, that certain domains are proxied to different domains to get around school filters, and that any needed redirects are easy to set up and manage.

Here's how it works:

1. Open up `rules.nix` and add a new rule to either redirect, permanently redirect, or proxy one URL to another

2. Make sure the domain you want to redirect from / proxy to points to `proxyparty.hackclub.com` (most Hack Club domains have a subdomain wildcard that points to this server, see [`hackclub/dns`](https://github.com/hackclub/dns))

3. Submit a pull request with your changes



And that's it! Once your pull request is merged, a new nginx configuration with your changes is automatically generated, and the server at `proxyparty.hackclub.com` is automatically updated using GitHub Actions.

It’ll even get an SSL certificate if one doesn’t already exist for the domain, and automatically renew any SSL certificates when it’s time. It's almost like magic, thanks to the power of NixOS!

## License

proxyparty is licensed under the [MIT License](LICENSE.md)!