Byparr/README.md

# Byparr

An alternative to [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) as a drop-in replacement, build with [nodriver](https://github.com/ultrafunkamsterdam/nodriver) and [FastAPI](https://fastapi.tiangolo.com).

> [!IMPORTANT]
> Currenly, due to [bug in nodriver](https://github.com/ultrafunkamsterdam/undetected-chromedriver/issues/1954), if you want to run this project ouside of prebuild container, you have to run `python fix_nodriver.py` after creating venv to patch the library.

> [!NOTE]
> Thanks to FastAPI implementation, now you can also see the API documentation at `/docs` or `/` (redirect to `/docs`) endpoints.

## Early Development

Long story short, I created it in like 3 days, so if you get any bugs/hangs etc. please report it, so both of us can enjoy unblocked websites!

I focus maily on Cloudflare, which is tested daily, any other anti-bot challenges should pass out of the box, but if any issues, please report these providers with an example website ❤️

## Troubleshooting

1. Clone repo to the host that has the container has issues on.
2. Using vscode and `SSH extention`, connect to the host and open repo in it.
3. Download `devcontainers` extention and reopen repo in container (with `CTRL + SHIFT + P` -> `Reopen in devcontainer`)
4. Write down the port in `Ports` tab in vscode
5. Open <https://novnc.com/noVNC/vnc.html> in your pc's browser and using settings on left under websocket, set host to `localhost` nad port to the port you wrote down
6. Check if `chromium` works by running in VNCs terminal command `chromium --no-sandbox`
7. If chrome works, run API by pressing F5 in vscode
8. In Prowlarr (or target client) change port byparr's port to `8181` instead of `8191` (Port opened by and pointing to devcontainer)
9. Check if everything works by testing byparr and observing VNC in browser

## Usage

### Docker Compose

```yaml
services:
  byparr:
    image: ghcr.io/thephaseless/byparr
    environment:
      - LOG_LEVEL=INFO # optional
    ports:
      - "8191:8191" # Optional if used with *arr network
```

## Need help with / TODO

- [ ] Slimming container (~3GB bruh)
- [ ] Add more anti-bot challenges
- [x] Add docstrings
- [ ] Implement versioning
- [ ] Proxy support
- [ ] Add more architectures support
[skip ci] Create readme 2024-07-25 00:52:06 +00:00			`# Byparr`

grammar 2024-10-01 11:22:12 +02:00			`An alternative to [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) as a drop-in replacement, build with [nodriver](https://github.com/ultrafunkamsterdam/nodriver) and [FastAPI](https://fastapi.tiangolo.com).`
[skip ci] Create readme 2024-07-25 00:52:06 +00:00
			`> [!IMPORTANT]`
grammar 2024-10-01 11:22:12 +02:00			> Currenly, due to [bug in nodriver](https://github.com/ultrafunkamsterdam/undetected-chromedriver/issues/1954), if you want to run this project ouside of prebuild container, you have to run `python fix_nodriver.py` after creating venv to patch the library.
[skip ci] Add more info 2024-07-25 01:02:04 +00:00
			`> [!NOTE]`
			> Thanks to FastAPI implementation, now you can also see the API documentation at `/docs` or `/` (redirect to `/docs`) endpoints.
[skip ci] Create readme 2024-07-25 00:52:06 +00:00
			`## Early Development`

grammar 2024-10-01 11:22:12 +02:00			`Long story short, I created it in like 3 days, so if you get any bugs/hangs etc. please report it, so both of us can enjoy unblocked websites!`
Add troubeshooting steps 2024-10-01 11:03:07 +02:00
			`I focus maily on Cloudflare, which is tested daily, any other anti-bot challenges should pass out of the box, but if any issues, please report these providers with an example website ❤️`

			`## Troubleshooting`
update troubleshooting 2024-10-18 13:34:30 +00:00
Add troubeshooting steps 2024-10-01 11:03:07 +02:00			`1. Clone repo to the host that has the container has issues on.`
			2. Using vscode and `SSH extention`, connect to the host and open repo in it.
			3. Download `devcontainers` extention and reopen repo in container (with `CTRL + SHIFT + P` -> `Reopen in devcontainer`)
update troubleshooting 2024-10-18 13:34:30 +00:00			4. Write down the port in `Ports` tab in vscode
			5. Open <https://novnc.com/noVNC/vnc.html> in your pc's browser and using settings on left under websocket, set host to `localhost` nad port to the port you wrote down
			6. Check if `chromium` works by running in VNCs terminal command `chromium --no-sandbox`
			`7. If chrome works, run API by pressing F5 in vscode`
			8. In Prowlarr (or target client) change port byparr's port to `8181` instead of `8191` (Port opened by and pointing to devcontainer)
			`9. Check if everything works by testing byparr and observing VNC in browser`
[skip ci] Add more info 2024-07-25 01:02:04 +00:00
			`## Usage`

			`### Docker Compose`

			```yaml
			`services:`
			`byparr:`
			`image: ghcr.io/thephaseless/byparr`
			`environment:`
			`- LOG_LEVEL=INFO # optional`
			`ports:`
			`- "8191:8191" # Optional if used with *arr network`
			```

[skip ci] Updated header 2024-07-25 01:03:12 +00:00			`## Need help with / TODO`
[skip ci] Add more info 2024-07-25 01:02:04 +00:00
[skip ci] Update README.md 2024-07-25 14:46:36 +02:00			`- [ ] Slimming container (~3GB bruh)`
[skip ci] Add more info 2024-07-25 01:02:04 +00:00			`- [ ] Add more anti-bot challenges`
grammar 2024-10-01 11:22:12 +02:00			`- [x] Add docstrings`
[skip ci] Added info about versioning 2024-07-25 01:04:59 +00:00			`- [ ] Implement versioning`
[skip ci] Update README.md 2024-07-25 14:46:36 +02:00			`- [ ] Proxy support`
			`- [ ] Add more architectures support`