diff --git a/nodes/heimdall/byparr/README.md b/nodes/heimdall/byparr/README.md new file mode 100644 index 0000000..658da8a --- /dev/null +++ b/nodes/heimdall/byparr/README.md @@ -0,0 +1,101 @@ +# Byparr - Cloudflare & Anti-Bot Bypass + +Byparr is a self-hosted service that helps bypass anti-bot challenges and Cloudflare protection, making it easier for your *arr stack (Prowlarr, Radarr, Sonarr) to access indexers and trackers. + +## Service Information + +- **Image**: `ghcr.io/thephaseless/byparr:latest` +- **Port**: 8191 +- **API Docs**: http://localhost:8191/docs + +## Configuration + +### Basic Setup + +The service is configured with default settings and exposed on port 8191. It's connected to the heimdall_core_homelab network for access by other services. + +### Environment Variables + +- `HOST`: Bind address (default: 0.0.0.0) +- `PORT`: Service port (default: 8191) +- `PROXY_SERVER`: Optional proxy in format `protocol://host:port` +- `PROXY_USERNAME`: Optional proxy username +- `PROXY_PASSWORD`: Optional proxy password + +## Integration with *arr Apps + +To use Byparr with Prowlarr, Radarr, Sonarr, etc.: + +1. In the *arr app, go to Settings → Indexers +2. When adding/editing an indexer that requires Cloudflare bypass: + - Look for "FlareSolverr" or similar bypass options + - Set the FlareSolverr URL to: `http://byparr:8191` +3. Save and test the indexer + +### Prowlarr Configuration + +1. Settings → Indexers → Add Indexer +2. Select an indexer (e.g., 1337x, EZTV, etc.) +3. In the indexer settings: + - Enable "Use FlareSolverr" + - FlareSolverr URL: `http://byparr:8191` + +### Testing + +Visit http://heimdall-ip:8191/docs to access the API documentation and test the service. + +## Deployment + +```bash +cd /path/to/homelab/nodes/heimdall/byparr +docker compose up -d +``` + +## Monitoring + +Check logs: +```bash +docker compose logs -f byparr +``` + +Check status: +```bash +docker compose ps +``` + +## Troubleshooting + +### Service Not Working + +1. Check if the container is running: + ```bash + docker compose ps + ``` + +2. View logs for errors: + ```bash + docker compose logs byparr + ``` + +3. Test the API directly: + ```bash + curl http://localhost:8191/docs + ``` + +### *arr Apps Can't Connect + +- Ensure Byparr and the *arr apps are on the same Docker network (heimdall_core_homelab) +- Use `http://byparr:8191` (container name) not `localhost:8191` +- Check if the FlareSolverr option is enabled in the indexer settings + +### Challenges Still Not Bypassed + +- This tool increases chances but doesn't guarantee bypass +- Some sites may require additional network-level traffic validation +- Consider configuring a proxy if available (see environment variables) + +## Links + +- [GitHub Repository](https://github.com/ThePhaseless/Byparr) +- [Docker Image](https://ghcr.io/thephaseless/byparr) +- [API Documentation](http://localhost:8191/docs)