Compare commits

..
Author SHA1 Message Date
ThePhaseless 471f17a0d3 Merge pull request #20 from ThePhaseless/seleniumbase
Seleniumbase
2024-11-25 00:07:12 +01:00
ThePhaseless c81b93a161 add title parsing 2024-11-24 23:04:19 +00:00
ThePhaseless f2532385d6 run test on x64 and build with buildx 2024-11-24 22:50:04 +00:00
ThePhaseless 8d9f433aca use chromium 2024-11-24 22:28:08 +00:00
ThePhaseless 52ad4c74c7 add xvfb to devcontainer 2024-11-24 22:27:01 +00:00
ThePhaseless b64ff25ad2 build on arm 2024-11-24 22:17:35 +00:00
ThePhaseless 8b9ef2604a fix dockerfile and add arm for testing 2024-11-24 22:13:47 +00:00
ThePhaseless 57dbc43697 add sudo 2024-11-24 22:02:28 +00:00
ThePhaseless 77fd2a47f7 remaster 2024-11-24 22:00:58 +00:00
ThePhaseless 0e75f2a3d1 cleanup devcontainer 2024-11-24 20:14:04 +00:00
ThePhaseless d0a1489898 spellcheck fixes 2024-11-24 12:29:06 +00:00
ThePhaseless 583f5fcebc Merge pull request #17 from Vrtak-CZ/log-err
log error when exception
2024-11-23 11:38:20 +01:00
Patrik Votoček 3c25ce471b log error when exception 2024-11-22 02:16:59 +01:00
ThePhaseless b01ee50444 skip tests on github arm 2024-11-21 22:59:27 +00:00
ThePhaseless f117e4705a add platform label 2024-11-21 22:38:34 +00:00
ThePhaseless b19b1b852c add armv8 2024-11-21 22:33:47 +00:00
ThePhaseless 70d78859ad add platform 2024-11-21 22:00:38 +00:00
ThePhaseless f5c3cae846 use latest package versions 2024-10-28 17:20:37 +00:00
ThePhaseless db18c01f51 Update bug_report.md 2024-10-27 20:14:34 +01:00
ThePhaseless 3991a0bceb Update issue templates 2024-10-27 20:11:56 +01:00
ThePhaseless 88abca13c5 Update README.md 2024-10-27 20:03:07 +01:00
ThePhaseless 3b7f501404 Add info about conditional passing and updated troubleshooting 2024-10-27 20:01:09 +01:00
ThePhaseless e41c831c73 separated github dependent websites 2024-10-27 18:46:19 +00:00
ThePhaseless c409ca22f9 remove untestable websites from github 2024-10-27 18:43:36 +00:00
ThePhaseless 8e5b7061e8 test if cloudflare blocks after 2 requests 2024-10-27 18:40:21 +00:00
ThePhaseless aabff0a65f do not skip challenged 2024-10-27 18:32:06 +00:00
ThePhaseless 58f230dce3 first stop, then throw exception 2024-10-27 19:13:15 +01:00
ThePhaseless 0535c5d9bd add logger even if passing 2024-10-21 13:46:26 +00:00
ThePhaseless d26ddf3bcf add healthcheck 2024-10-21 13:34:07 +00:00
ThePhaseless 361e11cda2 skip if test if client cant reach 2024-10-21 13:19:31 +00:00
ThePhaseless e33d7ab77b fix addon passing all websites 2024-10-21 13:12:09 +00:00
ThePhaseless 4e3876e0b7 skip test if rate limited 2024-10-19 21:47:16 +00:00
ThePhaseless f4dcaf453e dont use async tests 2024-10-19 20:55:03 +00:00
ThePhaseless 95b5b1375f path fixes 2024-10-19 20:49:50 +00:00
ThePhaseless b3d7060431 async tests 2024-10-19 20:48:32 +00:00
ThePhaseless 2dfc5b2201 refactor and test in dockerfile 2024-10-19 20:35:11 +00:00
ThePhaseless 55a557468e add display to env 2024-10-18 16:52:19 +00:00
ThePhaseless 2da2d08718 fix run sh 2024-10-18 16:47:31 +00:00
ThePhaseless a12594b11a move to entrypoint 2024-10-18 16:43:41 +00:00
ThePhaseless 8c249fbbbd Merge pull request #6 from ThePhaseless/chromium
Chromium
2024-10-18 18:35:05 +02:00
ThePhaseless 8b0caf6adc dont test (fck it) 2024-10-18 16:33:27 +00:00
ThePhaseless dbc91bc982 reduce max time to 30 sec 2024-10-18 16:03:17 +00:00
ThePhaseless e0a2a2a035 update packages and new build method 2024-10-18 15:59:52 +00:00
ThePhaseless 5003544d5b handle rate limiting 2024-10-18 15:53:36 +00:00
ThePhaseless a2fd8a056b use only new click method 2024-10-18 15:53:36 +00:00
ThePhaseless 4bc53e5311 add sysadmin for devcontainer 2024-10-18 15:53:36 +00:00
ThePhaseless 23a5d53e9a do not test on arm 2024-10-18 15:53:36 +00:00
ThePhaseless b924d27d26 typo fix 2024-10-18 15:53:36 +00:00
ThePhaseless ca80bd0285 logic refactor 2024-10-18 15:53:36 +00:00
ThePhaseless 464a618f29 print current html on error 2024-10-18 15:53:36 +00:00
ThePhaseless 093d318dbc add default display 2024-10-18 15:53:36 +00:00
ThePhaseless d452d43ee8 do not override previous 2024-10-18 15:53:36 +00:00
ThePhaseless b7f9c1467c upload screenshot if action failed 2024-10-18 15:53:36 +00:00
ThePhaseless 2e819c9adf skip if rate limited 2024-10-18 15:53:36 +00:00
ThePhaseless d77dc06b35 add exception handling 2024-10-18 15:53:36 +00:00
ThePhaseless 29a5432684 increase timeout in tests 2024-10-18 15:53:36 +00:00
ThePhaseless b204acb826 update lock file 2024-10-18 15:53:36 +00:00
ThePhaseless 8a90428f4b update troubleshooting 2024-10-18 15:53:36 +00:00
ThePhaseless 5424ea0ab7 remove pytest from entrypoint 2024-10-18 15:53:36 +00:00
ThePhaseless 718e6da2b6 fix devcontainer 2024-10-18 15:53:36 +00:00
ThePhaseless 60bf8332d0 remake dockerfile 2024-10-18 15:53:36 +00:00
ThePhaseless d2f7f3448d auto python version 2024-10-18 15:53:36 +00:00
ThePhaseless 7d530daf88 Merge pull request #8 from ThePhaseless/dependabot/github_actions/dot-github/workflows/docker/setup-buildx-action-3.7.1
Bump docker/setup-buildx-action from 3.0.0 to 3.7.1 in /.github/workflows
2024-10-18 17:51:30 +02:00
ThePhaseless 7dc16dfe7c Merge pull request #9 from ThePhaseless/dependabot/github_actions/dot-github/workflows/sigstore/cosign-installer-3.7.0
Bump sigstore/cosign-installer from 3.5.0 to 3.7.0 in /.github/workflows
2024-10-18 17:51:26 +02:00
ThePhaseless 87db1a3955 Merge pull request #10 from ThePhaseless/dependabot/github_actions/dot-github/workflows/docker/login-action-3.3.0
Bump docker/login-action from 3.0.0 to 3.3.0 in /.github/workflows
2024-10-18 17:51:20 +02:00
ThePhaseless bf0648e49b Merge pull request #11 from ThePhaseless/dependabot/github_actions/dot-github/workflows/docker/metadata-action-5.5.1
Bump docker/metadata-action from 5.0.0 to 5.5.1 in /.github/workflows
2024-10-18 17:51:15 +02:00
ThePhaseless 70b75f4db4 Merge pull request #7 from ThePhaseless/dependabot/github_actions/dot-github/workflows/docker/build-push-action-6.9.0
Bump docker/build-push-action from 5.0.0 to 6.9.0 in /.github/workflows
2024-10-18 17:51:06 +02:00
dependabot[bot] 2ab91102b0 Bump docker/metadata-action from 5.0.0 to 5.5.1 in /.github/workflows
Bumps [docker/metadata-action](https://github.com/docker/metadata-action) from 5.0.0 to 5.5.1.
- [Release notes](https://github.com/docker/metadata-action/releases)
- [Commits](https://github.com/docker/metadata-action/compare/96383f45573cb7f253c731d3b3ab81c87ef81934...8e5442c4ef9f78752691e2d8f8d19755c6f78e81)

---
updated-dependencies:
- dependency-name: docker/metadata-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-18 15:50:46 +00:00
dependabot[bot] 5c87b29599 Bump docker/login-action from 3.0.0 to 3.3.0 in /.github/workflows
Bumps [docker/login-action](https://github.com/docker/login-action) from 3.0.0 to 3.3.0.
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](https://github.com/docker/login-action/compare/343f7c4344506bcbf9b4de18042ae17996df046d...9780b0c442fbb1117ed29e0efdff1e18412f7567)

---
updated-dependencies:
- dependency-name: docker/login-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-18 15:50:44 +00:00
dependabot[bot] 76a93f44a1 Bump sigstore/cosign-installer from 3.5.0 to 3.7.0 in /.github/workflows
Bumps [sigstore/cosign-installer](https://github.com/sigstore/cosign-installer) from 3.5.0 to 3.7.0.
- [Release notes](https://github.com/sigstore/cosign-installer/releases)
- [Commits](https://github.com/sigstore/cosign-installer/compare/59acb6260d9c0ba8f4a2f9d9b48431a222b68e20...dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da)

---
updated-dependencies:
- dependency-name: sigstore/cosign-installer
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-18 15:50:41 +00:00
dependabot[bot] 9dff932766 Bump docker/setup-buildx-action in /.github/workflows
Bumps [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) from 3.0.0 to 3.7.1.
- [Release notes](https://github.com/docker/setup-buildx-action/releases)
- [Commits](https://github.com/docker/setup-buildx-action/compare/f95db51fddba0c2d1ec667646a06c2ce06100226...c47758b77c9736f4b2ef4073d4d51994fabfe349)

---
updated-dependencies:
- dependency-name: docker/setup-buildx-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-18 15:50:39 +00:00
dependabot[bot] 749fab3ff1 Bump docker/build-push-action from 5.0.0 to 6.9.0 in /.github/workflows
Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 5.0.0 to 6.9.0.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](https://github.com/docker/build-push-action/compare/0565240e2d4ab88bba5387d719585280857ece09...4f58ea79222b3b9dc2c8bbdd6debcef730109a75)

---
updated-dependencies:
- dependency-name: docker/build-push-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-18 15:50:37 +00:00
ThePhaseless 77290081b7 update actions 2024-10-18 15:49:50 +00:00
ThePhaseless 843fe88e5a build arm64 2024-10-18 13:17:19 +02:00
ThePhaseless 0c2206911d grammar 2024-10-01 11:22:12 +02:00
ThePhaseless cbce34366b update ports 2024-10-01 11:07:13 +02:00
ThePhaseless 29a31ab757 Add troubeshooting steps 2024-10-01 11:03:07 +02:00
ThePhaseless ee9e8ca98f disable invalid websites 2024-09-13 19:22:37 +00:00
ThePhaseless e25415012a quick check 2024-09-13 19:13:37 +00:00
ThePhaseless b518904196 change the discovery of shadow dom 2024-09-13 19:07:43 +00:00
ThePhaseless a633a91dcf tweaks 2024-09-13 19:00:20 +00:00
ThePhaseless 22fba55373 adjustments 2024-09-13 18:48:31 +00:00
ThePhaseless 6e825e15a4 use python 3.12 2024-09-13 18:40:34 +00:00
ThePhaseless ac4eadea9d test in dockerfile 2024-09-13 18:30:48 +00:00
ThePhaseless 0d79b22ceb build if tests pass 2024-09-13 18:30:14 +00:00
ThePhaseless d8d92ec3de use fastapi to test 2024-09-13 18:28:36 +00:00
ThePhaseless 79fb20082f add timed tests 2024-09-13 18:04:37 +00:00
ThePhaseless 2844f51fb1 fix new issue 2024-09-13 18:04:22 +00:00
ThePhaseless 092b9fb492 add test deps 2024-09-13 18:04:13 +00:00
ThePhaseless b1a67da658 update packages 2024-09-13 18:04:01 +00:00
ThePhaseless 40b790ceee fix deprecation 2024-09-13 18:03:38 +00:00
ThePhaseless 312ea474d9 switch to python 3.12 2024-09-13 18:03:09 +00:00
ThePhaseless 98719476c4 use shadow roots and fix HTTP request failed: [500:InternalServerError] #2 2024-08-25 15:24:27 +00:00
ThePhaseless e05c34aa8a format 2024-08-25 15:11:03 +00:00
ThePhaseless 76502ee508 add docker labels 2024-07-25 21:07:10 +00:00
ThePhaseless fb905a251a add github extention parsing and use clean approach 2024-07-25 21:01:22 +00:00
ThePhaseless ed71354e19 refactor + docstrings 2024-07-25 21:00:31 +00:00
ThePhaseless 8c8b7e3324 add gracefull errors 2024-07-25 21:00:11 +00:00
ThePhaseless d9c26877ec [skip ci] Update README.md 2024-07-25 14:46:36 +02:00
ThePhaseless d377d63400 ensure caps for loglevel 2024-07-25 01:17:40 +00:00
ThePhaseless 7c61d37ea8 [skip ci] Added info about versioning 2024-07-25 01:04:59 +00:00
ThePhaseless 3fa2b49b6d [skip ci] Updated header 2024-07-25 01:03:12 +00:00
ThePhaseless 1d9740cdd8 [skip ci] Add more info 2024-07-25 01:02:04 +00:00
ThePhaseless d5a1680b4e [skip ci] remove screenshots volume 2024-07-25 01:01:49 +00:00
ThePhaseless 58200970de [skip ci] Create readme 2024-07-25 00:52:06 +00:00
ThePhaseless 8311b7b148 remove screenshots, improve logging and add timeout for button 2024-07-25 00:39:29 +00:00
ThePhaseless 86fd1e2c5f bring tab to front 2024-07-25 00:39:06 +00:00
ThePhaseless bccd8c8401 add browser crash gitignore 2024-07-25 00:38:55 +00:00
ThePhaseless 51f01e2f97 Create docker-publish.yml 2024-07-25 02:08:26 +02:00
ThePhaseless 7a47e446a0 packages cleanup 2024-07-25 00:07:23 +00:00
ThePhaseless 9808c42a8a use venv in proj 2024-07-25 00:07:18 +00:00
ThePhaseless f4c13957bf remove novnc 2024-07-25 00:07:08 +00:00
ThePhaseless 25d708de01 use const for logging level 2024-07-25 00:06:56 +00:00
ThePhaseless 6e45f4c316 adjust file path checking 2024-07-25 00:04:22 +00:00
ThePhaseless 4f225438a7 final touches 2024-07-25 00:04:00 +00:00
ThePhaseless eaf83e62ff uncomment dockerfile 2024-07-24 23:09:03 +00:00
ThePhaseless 336d20a3a5 added virtual desktop 2024-07-24 23:00:51 +00:00
ThePhaseless 6c124dcfd0 expose novnc 2024-07-24 23:00:15 +00:00
ThePhaseless 2ad7ee262e fix arg 2024-07-24 23:00:07 +00:00
ThePhaseless 75bac7e203 swtich to dummy test 2024-07-24 20:42:23 +00:00
ThePhaseless 8501e28f85 fix downloading 2024-07-24 20:42:06 +00:00
ThePhaseless 3682ccc0fa changed to path type 2024-07-24 20:41:57 +00:00
ThePhaseless b0c8d5d387 fix logger 2024-07-24 20:41:15 +00:00
ThePhaseless 8c428276d6 add debug for debugging 2024-07-24 20:41:01 +00:00
ThePhaseless 003e7d0139 expose port for solverr 2024-07-24 20:39:30 +00:00
ThePhaseless 2d1b2964af get lib path from env 2024-07-24 20:39:10 +00:00
ThePhaseless 427c758de6 added screenshots and debug env 2024-07-24 20:38:23 +00:00
ThePhaseless 031235dba1 change project name 2024-07-24 20:37:39 +00:00
ThePhaseless 2a3a76b6ef fix chromium download on devcontainer 2024-07-24 17:51:35 +00:00
ThePhaseless 104ef5968a use default folder 2024-07-24 17:51:26 +00:00
ThePhaseless 2341ad5887 docker and example usage 2024-07-24 17:51:01 +00:00
ThePhaseless a5c2355f21 ensure venv in project 2024-07-24 17:50:47 +00:00
ThePhaseless d3617797e6 added script that fixes nodriver 2024-07-24 17:15:13 +00:00
ThePhaseless e449a183ae allow more types in cookies 2024-07-24 15:53:14 +00:00
ThePhaseless 335e9e486f move to dockerfile instead of compose 2024-07-24 15:53:02 +00:00
ThePhaseless 70cb18ae81 ignore explicit return type 2024-07-24 15:52:41 +00:00
ThePhaseless d8fb8feaeb create base dockerfile 2024-07-24 15:52:30 +00:00
ThePhaseless 4831e1247b Add override initial url 2024-07-24 15:41:41 +00:00
ThePhaseless 87ee96ef5c use preferred method for cookies (stuck) 2024-07-24 15:41:37 +00:00
ThePhaseless 2a50a019e1 fix string path 2024-07-24 15:41:20 +00:00
ThePhaseless 0ddf1e03c0 added default logger 2024-07-24 15:16:46 +00:00
ThePhaseless b6c51470ff remove extentions from repo 2024-07-24 13:59:07 +00:00
ThePhaseless 640a4bd8d8 first commit 2024-07-24 13:57:40 +00:00
41 changed files with 2949 additions and 3344 deletions
+5
View File
@@ -0,0 +1,5 @@
FROM python:3.12
RUN apt update && apt upgrade -y && apt install -y chromium xvfb
RUN curl -sSL https://install.python-poetry.org | python3 -
+19 -10
View File
@@ -3,26 +3,35 @@
{
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"build": {
"dockerfile": "../Dockerfile",
"target": "devcontainer"
"dockerfile": "Dockerfile"
},
"runArgs": ["--security-opt", "label=disable", "--privileged"],
"customizations": {
"vscode": {
"extensions": [
"charliermarsh.ruff",
"ms-python.python",
"tamasfe.even-better-toml"
"-ms-python.autopep8",
"-ms-python.vscode-pylance"
],
"settings": {
"python.venvPath": "./venv"
}
}
},
"postCreateCommand": "uv sync --group test",
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "pip3 install --user -r requirements.txt",
// Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
"name": "Byparr Dev Container",
"runArgs": [
"-p",
"8181:8191"
],
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:2": {
"moby": false
}
"ghcr.io/devcontainers-extra/features/act:1": {}
}
}
}
-1
View File
@@ -1 +0,0 @@
.gitignore
+164
View File
@@ -0,0 +1,164 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
.extentions/
+24
View File
@@ -0,0 +1,24 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**I've:**
- [ ] - read Loop Warning on Readme.
- [ ] - done the troubleshooting from Readme.
- [ ] - checked if such issue already exists.
**Docker host (please complete the following information):**
- OS: [e.g. Ubuntu Linux]
- Platform and model: [Synology, PC, Laptop, RPi 3]
- Architecture [e.g. ARM64]
**Additional context**
Add any other context about the problem here.
-88
View File
@@ -1,88 +0,0 @@
name: Bug report
description: Create a bug report
assignees: ThePhaseless
labels: bug
body:
- type: checkboxes
attributes:
label: "I've completed the following steps:"
options:
- label: Read Loop Warning on Readme
- label: "Used --init/init: true in docker run/compose.yaml"
- label: Done the troubleshooting from Readme
- label: Checked if such issue already exists
- label: Checked other websites with Cloudflare Turnstile
- label: I am able to access the webpage from my browser
- label: (Docker only) Checked that the problem does also occur on main tag
- type: checkboxes
attributes:
label: "If checked other websites with Cloudflare Turnstile:"
options:
- label: Other websites do work.
- label: Other websites do not work.
- type: checkboxes
attributes:
label: "The issue is still present in the latest main tag:"
options:
- label: "Yes"
- label: "No"
- type: input
id: docker-host
attributes:
label: OS/Docker Host
placeholder: e.g. Docker, WSL2, Ubuntu, Windows
- type: input
id: platform-model
attributes:
label: Platform and model
placeholder: e.g. Synology, PC, Laptop, RPi 3
- type: input
id: architecture
attributes:
label: Architecture
placeholder: e.g. ARM64
- type: input
id: website
attributes:
label: Example website/URL that does not work
placeholder: e.g. https://nowsecure.nl
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: "Example: The application crashes when trying to load a new file"
- type: textarea
id: config
attributes:
label: Docker Compose config
placeholder: |
```yaml
services:
...
```
- type: textarea
id: prowlarr-logs
attributes:
label: Prowlarr Logs
placeholder: |
```
put logs between 3x `
```
- type: textarea
id: byparr-logs
attributes:
label: Byparr Logs
placeholder: |
```
put logs between 3x `
```
-1
View File
@@ -1 +0,0 @@
blank_issues_enabled: false
@@ -1,29 +0,0 @@
name: Feature request
description: Suggest a new feature or improvement
assignees:
- ThePhaseless
labels: enhancement
body:
- type: checkboxes
attributes:
label: "Before submitting, I've done the following:"
options:
- label: Checked the existing feature requests to avoid duplicates
- type: textarea
attributes:
label: Describe the problem this feature would solve
description: Clearly explain the issue or need that this feature addresses.
placeholder: "Example: It's difficult to manage multiple configurations because..."
- type: textarea
attributes:
label: Alternatives considered
description: Have you considered any alternative solutions or workarounds? If so, please describe them.
placeholder: "Example: As a workaround, I've been manually editing the config files, but this is error-prone."
- type: textarea
attributes:
label: Additional context
description: Add any other context or information that might be helpful in understanding your request. This could include use cases, mockups, or links to relevant discussions.
+16
View File
@@ -0,0 +1,16 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for more information:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
# https://containers.dev/guide/dependabot
version: 2
updates:
- package-ecosystem: "devcontainers"
directory: "/"
schedule:
interval: weekly
- package-ecosystem: github-actions
directory: ".github/workflows/"
schedule:
interval: weekly
-107
View File
@@ -1,107 +0,0 @@
name: Cleanup PR Docker Images
on:
pull_request:
types: [closed]
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
cleanup:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
steps:
- name: Delete PR Docker images
uses: actions/github-script@v8
with:
script: |
const owner = context.repo.owner.toLowerCase();
const repo = context.repo.repo.toLowerCase();
const prNumber = context.payload.pull_request.number;
// Get the package
const packageName = `${repo}`;
console.log(`Cleaning up images for PR #${prNumber}`);
// Check if owner is an org or user
let isOrg = false;
try {
await github.rest.orgs.get({ org: owner });
isOrg = true;
console.log(`Repository owner is an organization`);
} catch (error) {
console.log(`Repository owner is a user account`);
}
try {
// Get all versions of the package
let versions;
if (isOrg) {
versions = await github.rest.packages.getAllPackageVersionsForPackageOwnedByOrg({
package_type: 'container',
package_name: packageName,
org: owner,
per_page: 100
});
} else {
versions = await github.rest.packages.getAllPackageVersionsForPackageOwnedByUser({
package_type: 'container',
package_name: packageName,
username: owner,
per_page: 100
});
}
// Filter versions that match this PR (pr-123, pr-123-amd64, pr-123-arm64)
const prVersions = versions.data.filter(version => {
const tags = version.metadata?.container?.tags || [];
// Match tags like: pr-123, pr-123-amd64, pr-123-arm64
return tags.some(tag =>
tag === `pr-${prNumber}` ||
tag === `pr-${prNumber}-amd64` ||
tag === `pr-${prNumber}-arm64`
);
});
console.log(`Found ${prVersions.length} image version(s) to delete`);
// Delete each version
for (const version of prVersions) {
console.log(`Deleting version ${version.id} with tags: ${version.metadata?.container?.tags?.join(', ')}`);
try {
if (isOrg) {
await github.rest.packages.deletePackageVersionForOrg({
package_type: 'container',
package_name: packageName,
org: owner,
package_version_id: version.id
});
} else {
await github.rest.packages.deletePackageVersionForUser({
package_type: 'container',
package_name: packageName,
username: owner,
package_version_id: version.id
});
}
console.log(`✓ Deleted version ${version.id}`);
} catch (error) {
console.error(`Failed to delete version ${version.id}:`, error.message);
}
}
console.log('Cleanup completed');
} catch (error) {
if (error.status === 404) {
console.log('No package found - nothing to clean up');
} else {
console.error('Error during cleanup:', error.message);
throw error;
}
}
+78 -160
View File
@@ -9,30 +9,11 @@ on:
schedule:
- cron: "25 0 * * *"
push:
branches: ["*"]
branches: ["main"]
# Publish semver tags as releases.
tags: ["v*.*.*"]
paths:
- "src/**"
- "main.py"
- "tests/**"
- "Dockerfile"
- "pyproject.toml"
- "uv.lock"
- "compose.yaml"
- ".github/workflows/docker-publish.yml"
pull_request:
branches: ["main"]
paths:
- "src/**"
- "main.py"
- "tests/**"
- "Dockerfile"
- "pyproject.toml"
- "uv.lock"
- "compose.yaml"
- ".github/workflows/docker-publish.yml"
workflow_dispatch:
env:
# Use docker.io for Docker Hub if empty
@@ -40,139 +21,85 @@ env:
# github.repository as <account>/<repo>
IMAGE_NAME: ${{ github.repository }}
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v4
- name: Test
id: test
uses: docker/build-push-action@v7
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
context: .
platforms: linux/amd64
cache-from: type=gha,scope=x64
pull: true
cache-to: type=gha,mode=max,scope=x64
target: test
python-version: "3.12"
- name: Set up Poetry
run: pip install poetry
- name: Setup a local virtual environment (if no poetry.toml file)
run: |
poetry config virtualenvs.create true --local
poetry config virtualenvs.in-project true --local
- uses: actions/cache@v4
name: Define a cache for the virtual environment based on the dependencies lock file
with:
path: ./.venv
key: venv-${{ hashFiles('poetry.lock') }}
- name: Install dependencies
run: |
poetry install
sudo apt update
sudo apt install -y xvfb scrot python3-tk
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
sudo apt install -y ./google-chrome-stable_current_amd64.deb
rm ./google-chrome-stable_current_amd64.deb
- name: Run tests
run: poetry run pytest
build:
needs: test
# Skip build for Renovate PRs
if: github.event.pull_request.user.login != 'renovate[bot]'
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
# This is used to complete the identity challenge
# with sigstore/fulcio when running outside of PRs.
id-token: write
strategy:
matrix:
platform: [linux/amd64, linux/arm64]
steps:
- name: Checkout repository
uses: actions/checkout@v6
uses: actions/checkout@v4
- name: Prepare variables
id: vars
run: |
SURFIX=$(echo ${{ matrix.platform }} | cut -d'/' -f2)
echo "SURFIX=$SURFIX" >> $GITHUB_OUTPUT
# Install the cosign tool except on PR
# https://github.com/sigstore/cosign-installer
- name: Install cosign
if: github.event_name != 'pull_request'
uses: sigstore/cosign-installer@dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da #v3.7.0
with:
cosign-release: "v2.2.4"
# Use PR number for PRs, SHA for everything else
if [ "${{ github.event_name }}" == "pull_request" ]; then
echo "LOCAL_TAG=pr-${{ github.event.pull_request.number }}-$SURFIX" >> $GITHUB_OUTPUT
else
echo "LOCAL_TAG=${{ github.sha }}-$SURFIX" >> $GITHUB_OUTPUT
fi
- name: Set up QEMU
uses: docker/setup-qemu-action@v4
# Set up BuildKit Docker container builder
# Set up BuildKit Docker container builder to be able to build
# multi-platform images and export cache
# https://github.com/docker/setup-buildx-action
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v4
uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
# Log into registry
# Login against a Docker registry except on PR
# https://github.com/docker/login-action
- name: Log into registry ${{ env.REGISTRY }}
uses: docker/login-action@v4
if: github.event_name != 'pull_request'
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# Extract metadata (tags, labels) for Docker
# https://github.com/docker/metadata-action
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@v6
with:
tags: type=raw,value=${{ steps.vars.outputs.LOCAL_TAG }}
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
# Build and push Docker image for each platform
- name: Build Docker image
id: build
uses: docker/build-push-action@v7
with:
context: .
pull: true
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
platforms: ${{ matrix.platform }}
cache-from: type=gha,scope=${{ matrix.platform }}
cache-to: type=gha,mode=max,scope=${{ matrix.platform }}
build-args: |
GITHUB_BUILD=true
VERSION=${{ github.ref_type == 'tag' && github.ref_name || github.sha }}
merge-and-push:
needs: build
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v6
# Install the cosign tool
- name: Install cosign
uses: sigstore/cosign-installer@v3
# Set up Docker Buildx
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v4
# Log into registry
- name: Log into registry ${{ env.REGISTRY }}
uses: docker/login-action@v4
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# Extract Docker metadata for tagging
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@v6
uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
with:
tags: |
type=ref,event=branch
@@ -180,44 +107,35 @@ jobs:
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=raw,enable=${{ github.event_name != 'pull_request' && github.ref_name == 'main' }}, value=latest
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
# Create manifest lists and push
- name: Create and push manifest lists
run: |
TAGS="${{ steps.meta.outputs.tags }}"
args=""
# Build and push Docker image with Buildx (don't push on PR)
# https://github.com/docker/build-push-action
- name: Build and push Docker image
id: build-and-push
uses: docker/build-push-action@4f58ea79222b3b9dc2c8bbdd6debcef730109a75 # v6.9.0
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
platforms: linux/amd64,linux/arm64
cache-from: type=gha
cache-to: type=gha,mode=max
build-args: GITHUB_BUILD=true
image=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
image=${image,,}
# Create tag arguments
for tag in $TAGS; do
args="$args -t $tag"
done
if [ "${{ github.ref_type }}" == "tag" ]; then
args="$args -t ${image}:latest"
fi
echo $args
# Use PR-based tags for PRs, SHA-based tags for everything else
if [ "${{ github.event_name }}" == "pull_request" ]; then
docker buildx imagetools create $args \
${image}:pr-${{ github.event.pull_request.number }}-amd64 \
${image}:pr-${{ github.event.pull_request.number }}-arm64
else
docker buildx imagetools create $args \
${image}:${{github.sha}}-amd64 \
${image}:${{github.sha}}-arm64
fi
# Sign the manifest
- name: Sign the manifests
# Sign the resulting Docker image digest except on PRs.
# This will only write to the public Rekor transparency log when the Docker
# repository is public to avoid leaking data. If you would like to publish
# transparency data even for private images, pass --force to cosign below.
# https://github.com/sigstore/cosign
- name: Sign the published Docker image
if: ${{ github.event_name != 'pull_request' }}
env:
# https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
TAGS: ${{ steps.meta.outputs.tags }}
run: |
for TAG in $TAGS; do
cosign sign --yes $TAG
done
DIGEST: ${{ steps.build-and-push.outputs.digest }}
# This step uses the identity token to provision an ephemeral certificate
# against the sigstore community Fulcio instance.
run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}
+2 -5
View File
@@ -165,10 +165,7 @@ cython_debug/
core
# Screenshots
screenshots/
*.png
# Downloaded files
downloaded_files/
# Browser Data
browser_data/
downloaded_files/
+26 -16
View File
@@ -1,17 +1,27 @@
{
"version": "0.2.0",
"configurations": [
{
"console": "integratedTerminal",
"env": {
"LOG_LEVEL": "DEBUG"
},
"purpose": ["debug-test", "debug-in-terminal"],
"justMyCode": false,
"name": "Python Debugger: Main",
"program": "main.py",
"request": "launch",
"type": "debugpy"
}
]
}
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python Debugger: Main",
"type": "debugpy",
"justMyCode": false,
"env": {
"LOG_LEVEL": "DEBUG",
},
"request": "launch",
"program": "main.py",
"console": "integratedTerminal"
},
{
"name": "Python Debugger: Current File",
"justMyCode": false,
"type": "debugpy",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal"
}
]
}
+19 -17
View File
@@ -1,18 +1,20 @@
{
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff"
},
"python.analysis.autoImportCompletions": true,
"python.analysis.packageIndexDepths": [
{
"depth": 5,
"includeAllSymbols": true,
"name": ""
}
],
"python.terminal.activateEnvironment": true,
"python.testing.pytestArgs": ["tests", "-n", "auto", "--retries=3"],
"python.testing.pytestEnabled": true,
"python.testing.unittestEnabled": false,
"cSpell.words": ["camoufox", "domcontentloaded", "networkidle"]
}
"python.testing.pytestArgs": [
"tests"
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"python.analysis.autoImportCompletions": true,
"python.analysis.typeCheckingMode": "basic",
"python.terminal.activateEnvironment": true,
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
},
"python.analysis.packageIndexDepths": [
{
"name": "",
"depth": 5,
"includeAllSymbols": true,
}
],
}
-37
View File
@@ -1,37 +0,0 @@
# Copilot Instructions
## Project overview
- FastAPI service that mimics FlareSolverr-style API for bypassing anti-bot pages using Camoufox + Playwright captcha solver.
- Entry point: main app in main.py; routes and request flow defined in src/endpoints.py and src/models.py.
- Browser lifecycle is owned by get_camoufox() in src/utils.py, which yields a page, solver, and context for each request.
## Architecture and data flow
- Request flow: POST /v1 -> read_item() -> browser.goto() -> wait for load states -> detect challenge title -> solve captcha -> return LinkResponse.
- Challenge detection uses CHALLENGE_TITLES from src/consts.py; update this map when adding providers.
- Health check hits /v1 internally with <https://google.com> and fails if status is not OK.
- Logging: LogRequest middleware logs only POST /v1 timing and outcome; other paths pass through.
## Key modules and patterns
- Models use Pydantic v2 with camelCase aliasing for responses (see src/models.py).
- LinkResponse.invalid() is the standard error response shape; keep fields consistent with FlareSolverr style.
- get_camoufox() constructs AsyncCamoufox with addons and optional proxy config from env vars.
## Config and environment
- Core env vars in src/consts.py: HOST, PORT, PROXY_SERVER, PROXY_USERNAME, PROXY_PASSWORD, LOG_LEVEL, VERSION.
- VERSION strips leading "v" for tag-style values.
## Developer workflows
- Local run: uv sync && uv run main.py
- Init mode: uv run main.py --init (pre-warms health check via browser setup)
- Tests: uv sync --group test && uv run pytest --retries 3
- Docker troubleshooting: docker build --target test .
## Tests and external dependencies
- tests/main_test.py calls real websites; tests are network-dependent and may be skipped based on upstream status.
- HTTP client tests use starlette.testclient + httpx; avoid mocking unless needed for local-only changes.
+19 -50
View File
@@ -1,61 +1,30 @@
# Ubuntu is required by playwright
FROM ubuntu:latest AS base
FROM python:3.12-slim
ARG GITHUB_BUILD=false \
VERSION
# Inspired by https://github.com/Hudrolax/uc-docker-alpine/
ENV GITHUB_BUILD=${GITHUB_BUILD}\
VERSION=${VERSION}\
ARG GITHUB_BUILD=false
ENV GITHUB_BUILD=${GITHUB_BUILD}
ENV HOME=/root
ENV \
DEBIAN_FRONTEND=noninteractive \
PYTHONUNBUFFERED=1 \
# prevents python creating .pyc files
PYTHONDONTWRITEBYTECODE=1 \
UV_LINK_MODE=copy \
PORT=8191 \
XDG_CACHE_HOME=/cache \
HOME=/tmp
# do not ask any interactive question
POETRY_NO_INTERACTION=1 \
POETRY_VIRTUALENVS_IN_PROJECT=true \
DISPLAY=:0
RUN apt-get update &&\
apt-get install -y --no-install-recommends curl ca-certificates &&\
apt-get clean &&\
rm -rf /var/lib/apt/lists/*
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
FROM base AS devcontainer
RUN apt-get update &&\
apt-get install -y --no-install-recommends git &&\
uvx playwright install-deps firefox &&\
uvx camoufox fetch &&\
apt-get clean &&\
rm -rf /var/lib/apt/lists/*
ENTRYPOINT [ "sleep", "infinity" ]
FROM base AS app
WORKDIR /app
EXPOSE 8191
RUN apt update &&\
apt install -y xvfb scrot python3-tk curl chromium
COPY pyproject.toml uv.lock ./
RUN mkdir -p /cache &&\
uv sync &&\
uv run camoufox fetch &&\
apt-get update &&\
uv run playwright install-deps firefox &&\
uv cache clean &&\
apt-get clean &&\
rm -rf /var/lib/apt/lists/*
RUN curl -sSL https://install.python-poetry.org | python3 -
ENV PATH="${HOME}/.local/bin:$PATH"
COPY pyproject.toml poetry.lock ./
RUN poetry install
COPY . .
# Make app and cache world-readable; addon scripts dir world-writable (runtime writes)
RUN chmod -R o+rX /app /cache &&\
find /app/.venv -path "*/camoufox_add_init_script/addon" -type d -exec chmod -R o+rwX {} +
FROM app AS test
RUN \
uv sync --group test &&\
uv run pytest --retries 3
FROM app
USER 1000
EXPOSE $PORT
HEALTHCHECK --interval=15m --timeout=30s --start-period=5s --retries=3 CMD curl "http://localhost:${PORT}/health"
ENTRYPOINT ["/app/.venv/bin/python", "main.py"]
CMD [". .venv/bin/activate && python3 main.py"]
-674
View File
@@ -1,674 +0,0 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
+42 -72
View File
@@ -1,86 +1,56 @@
# Byparr
<p align="center">
<img src="icon/logo-byparr.svg" alt="Byparr logo" width="120" />
</p>
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).
> [!WARNING]
> Due to recent challenge changes, this software does not guarantee that the Cloudflare challenge will be bypassed. Cloudflare likely requires valid network traffic originating from the user’s public IP address to mark a connection as legitimate. While this tool may bypass the initial browser check, it does not ensure that requests will consistently pass Cloudflare's validation. More testing and data are required to understand how Cloudflare identifies connections and requests as valid. Invalid requests will result in Byparr's looping and eventually timeouting.
> [!IMPORTANT]
> This software does not **guarantee** (only greatly increases the chance) that any challenge will be bypassed. While this tool passes the initial browser check, Cloudflare and other captcha providers likely require valid network traffic originating from the user’s public IP address to mark a connection as legitimate. If any website does not pass the challenge, please run troubleshooting steps and check if other websites work before you create an GitHub issue.
> 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.
## Options
> [!NOTE]
> Thanks to FastAPI implementation, now you can also see the API documentation at `/docs` or `/` (redirect to `/docs`) endpoints.
| Environment Variable | Default | Description |
| -------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HOST` | `0.0.0.0` | Host address to bind the server to. Use `0.0.0.0` to bind to all IPv4 interfaces, `::` for all IPv6 interfaces, or `127.0.0.1`/`localhost` for local access only. |
| `PORT` | `8191` | Port to bind the server to. |
| `PROXY_SERVER` | None | Proxy to use in format: `protocol://host:port`. |
| `PROXY_USERNAME` | None | Username for proxy authentication. |
| `PROXY_PASSWORD` | None | Password for proxy authentication. |
## Early Development
## Proxy Recommendation
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!
Recently I've partnered with a _new in town_ proxy service - ProxyBase - to offer affordable proxy services that seems to work seamlessly with Byparr! Using my affiliate code `byparr` (case sensitive!) when signing up will not only get you access to their cost-effective (**$0.69/GB with occasional promotions** _at the time of writing_) proxy network but will also help support the continued development of this project. ProxyBase's proxies can significantly improve your success rate when bypassing anti-bot challenges. [Check out ProxyBase](https://client.proxybase.org/signup?ref=byparr) and enhance your Byparr experience!
## Tags
- `v*.*.*`/`latest` - Releases considered stable
- `main` - Latest release from main branch (untested)
- `pr-{number}` - Pull request images for testing (automatically cleaned up when PR closes)
## Usage
> [!IMPORTANT]
> Support for NAS devices (like Synology) is minimal. Please report issues, but do not expect it to be fixed quickly. The only ARM device I have is a free Ampere Oracle VM, so I can only test ARM support on that. See [#22](https://github.com/ThePhaseless/Byparr/issues/22) and [#3](https://github.com/ThePhaseless/Byparr/issues/3)
### Docker Compose setup
1. Review settings in `compose.yaml`.
2. Start the service:
```bash
docker compose up -d
```
### Docker install
1. Pull and run the image:
```bash
docker run -p 8191:8191 ghcr.io/thephaseless/byparr:latest
```
2. Optional: set env vars using `-e` or `--env-file`.
### Local install
1. Install ([or update when Python version changes](https://github.com/astral-sh/uv/issues/17887)) [uv](https://docs.astral.sh/uv/getting-started/installation/).
2. Clone this repo - `git clone https://github.com/ThePhaseless/Byparr`
3. Run `uv run main.py`
4. Enjoy!
### API Docs
Once running, open:
- `http://localhost:8191/docs`
- `http://localhost:8191/` (redirects to `/docs`)
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
### Docker 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.
4. Download `devcontainers` extention and reopen repo in container (with `CTRL + SHIFT + P` -> `Reopen in devcontainer`)
3. Open vscode terminal (`` CTRL + ` ``) and run `./run_vnc.sh` script.
5. Write down the port from `Forwarded Address` in `Ports` tab in vscode (probably 5900).
6. 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 and disable encryption.
7. Connect to the VNC server on container.
8. Check if `chromium` works by running in VNC's terminal command `chromium --no-sandbox`
9. If chromium works, run (or run debug) tests from VS Code.
10. Check if everything works by observing VNC in the browser as code is being tested.
11. If code works, congrats! (/s) You are on your own.
12. If it does not, try another host or network and try again.
1. Clone repo to the host that has issues with Byparr.
2. Run `docker build --target test .`
3. Depending of the build success:
1. If run successfully, try updating container or if already on newest stable release create an issue for creating new release with new dependencies
2. If build fails, try troubleshooting on another host/using other method
## Usage
### Local troubleshooting
### Docker Compose
1. Download [uv](https://docs.astral.sh/uv/getting-started/installation/)
2. Download dependencies using `uv sync --group test`
3. Run tests with `uv run pytest --retries 3` (You can add `-n auto` for parallelization)
4. If you see any `F` character in terminal, that means test failed even after retries.
5. Depending of the test success:
1. If run successfully, try updating container or if already on newest stable release create an issue for creating new release with new dependencies
2. If test fails, try troubleshooting on another host/using other method
```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
-11
View File
@@ -1,11 +0,0 @@
services:
byparr:
image: ghcr.io/thephaseless/byparr:latest
restart: unless-stopped
init: true
build:
context: .
dockerfile: Dockerfile
# Uncomment below to use byparr outside of internal network
# ports:
# - "8191:8191"
+10
View File
@@ -0,0 +1,10 @@
services:
byparr:
image: ghcr.io/thephaseless/byparr
build:
context: .
dockerfile: Dockerfile
environment:
- LOG_LEVEL=INFO
ports:
- "8191:8191"
+65
View File
@@ -0,0 +1,65 @@
# https://github.com/ultrafunkamsterdam/undetected-chromedriver/issues/1954
# Fix for nodriver in .venv/lib/python3.11/site-packages/nodriver/core/browser.py
from __future__ import annotations
import logging
import os
from pathlib import Path
from platform import python_version
env_path = os.getenv("VIRTUAL_ENV")
if env_path is None:
env_path = Path(os.__file__).parent.parent.parent.as_posix()
python_version = python_version().split(".")[0:2]
nodriver_path = Path(env_path + f"/lib/python{'.'.join(python_version)}/site-packages/nodriver/cdp/network.py")
if not nodriver_path.exists():
msg = f"{nodriver_path} not found"
raise FileNotFoundError(msg)
new_cookie_partition_key = """\
if isinstance(json, str):
return cls(top_level_site=json, has_cross_site_ancestor=False)
elif isinstance(json, dict):
return cls(
top_level_site=str(json["topLevelSite"]),
has_cross_site_ancestor=bool(json["hasCrossSiteAncestor"]),
)
"""
logger = logging.getLogger(__name__)
handler = logging.StreamHandler()
logger.addHandler(handler)
logger.setLevel(logging.INFO)
logger.info(f"Fixing nodriver in {nodriver_path}")
# delete CookiePartitionKey declaration
with nodriver_path.open("r+") as f:
lines = f.readlines()
found_def = False
found_body = False
i = -1
while i < len(lines):
i += 1
line = lines[i]
strip_line = line.strip("\n")
if not found_def and line.startswith("class CookiePartitionKey:"):
logger.info(f"Found line {i}: {strip_line}")
found_def = True
continue
if found_def:
if line.startswith(" def from_json"):
logger.info(f"Found line {i}: {strip_line}")
found_body = True
continue
if found_body:
if line.startswith(("\t\t", " ")):
logger.info(f"Removing line {i}: {strip_line}")
lines.pop(i)
i -= 1
continue
else:
lines = lines[:i] + [new_cookie_partition_key] + lines[i:]
break
with nodriver_path.open("w") as f:
f.writelines(lines)
Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

-1
View File
@@ -1 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 512 512"><path d="M243.9 511.9c-58.1-3.2-110.4-24-155-61.8-7-5.9-21.2-20.1-27.2-27.2-20-23.7-35.2-49.2-45.4-76.5-8.3-22-13-42.6-15.5-67.3-1.1-10.8-1.1-35.7 0-46.5 5.6-54.9 25.6-101.9 61-143.8 5.9-7 20.1-21.2 27.2-27.2 23.7-20 49.2-35.2 76.5-45.4 22-8.3 42.7-13 67.3-15.5 10.8-1.1 35.7-1.1 46.5 0 29.1 3 55.1 9.7 80 20.7 39.2 17.3 72.8 43.6 99.6 78 5.3 6.7 14.8 21 19.4 29.1 15.8 27.6 26.4 58.3 31.1 89.8 2 13.6 2.5 21.5 2.5 37.5s-.5 23.9-2.5 37.5c-7.1 47.8-27.1 91.6-59.2 129.5-5.9 7-20.1 21.2-27.2 27.2-16.4 13.8-34.2 25.8-51.8 34.6-28.8 14.5-59.1 23.1-91.7 26.3-7.4.8-28.9 1.3-35.6 1" style="fill:#fff"/><path d="M246.5 395.1c-1.7-.2-3.9-.3-5-.2-1 .1-3.5 0-5.5-.2-2-.3-6.1-.8-9.3-1.2s-6.7-.9-7.8-1.2c-1.2-.3-7.7-3.2-14.5-6.6s-14.3-7-16.8-8.1c-8.5-3.7-14.5-8.1-18.1-13.4-2.1-3.1-3.7-4.4-8.2-6.7-4-2-6-4.1-10.9-11-2-2.9-5-6.8-6.6-8.7-10.9-12.9-11.1-13.3-12.4-19.5-.5-2.5-1.6-5.4-2.9-7.8-4-7.4-5.4-10.8-6.4-14.9-.5-2.3-1.7-6.6-2.6-9.6-1.5-5.1-1.7-6.1-2.1-15.8-.4-9.4-.4-10.9.5-16.1.5-3.2 1.1-7.4 1.2-9.4.2-2 .6-5.4 1-7.6s.9-6.5 1.2-9.5c1-9.8 2.6-14.1 9.1-23.8 4.2-6.2 5.2-8.5 6-13.5.6-3.9 1.4-5.7 4.1-8.9 1.2-1.5 3.5-5.4 5.1-8.6 3.1-6.4 3.2-6.5 8.2-9.9 1.9-1.3 5.8-4 8.6-6s6.3-4.4 7.6-5.4c1.7-1.2 3.1-2.7 4.3-4.6 4.1-6.6 6.1-8 16.3-11.7 3.1-1.1 7.5-3.1 9.8-4.5 5.3-3.1 9-4.4 15-5 2.8-.3 6.8-1.2 9.8-2.1 4.5-1.4 5.6-1.6 10.4-1.6 5.7 0 6.4-.2 13.2-3.1 4.8-2.1 8.9-2.5 14.8-1.5 2.7.5 7.2 1.1 10.1 1.5 6.2.8 6.1.8 11.2 3.1 3.4 1.5 4.9 1.9 9.3 2.3 7 .7 7.9 1 16.1 5.1 3.9 2 9.5 4.5 12.4 5.7 9.8 3.9 14.3 7.2 22.1 15.7 3.3 3.6 8.6 9.2 11.9 12.5 14.5 14.5 14.9 15 16.5 19.4.8 2.2 2.6 6 3.9 8.3 5.2 9.2 12.2 23.8 13.4 28 .7 2.3 1.9 6.5 2.7 9.3 2.1 6.9 2.4 14.2 1 23.6-1.2 8-1.2 11.9-.3 18 .6 3.6.6 5.5.3 9.4-.7 6.7-1.6 10-4.1 14.1-1.3 2.2-2.4 4.7-2.9 6.6-1.8 7.8-5.6 16.3-10.7 24.3-1.4 2.2-3.4 5.5-4.3 7.4-2.2 4.3-4.2 6.6-8.2 9.6-3.7 2.7-14.5 14-17.7 18.4-2.2 3.1-7.1 7.4-10.6 9.4-1.1.6-4.3 1.8-7.2 2.6s-7.1 2.5-9.5 3.7c-3.6 1.8-5 3-8.6 6.6-2.3 2.4-4.9 4.7-5.7 5.1-1.6.8-5.5 1.5-10.7 2-1.7.2-4.6.8-6.4 1.5-7 2.6-7.3 2.6-16.1 2.7-6.9.1-9.3.3-12.3 1.2-4.9.9-8.8 1.2-12.7.6" style="fill:#cc7a3d"/><path d="M237.7 473.6c-42-3.8-79.9-18.3-113-43.2C56 378.7 24.1 291.7 43.1 207.6c6.6-29.2 19.8-57.8 37.7-81.9 47.7-64.1 126.8-97.1 205.8-85.9 36 5.1 70.5 19.3 99.7 41C455.7 132.5 488 220 468.9 304.4c-11.4 50.4-40.9 95.7-82.6 126.8-29.1 21.7-63.7 35.9-99.7 41-15.1 2.2-34.5 2.7-48.9 1.4m33.7-5.2c29-2.5 54.4-9.5 79-21.8 41.4-20.6 75.5-54.8 96.1-96.1 16.9-34 24.9-74.2 21.8-109.9-3.7-42.4-17.6-79.2-42.3-112-34.4-45.8-84.7-75.5-141.4-83.5-25.2-3.6-49.5-2.5-75.2 3.3-49.6 11.2-93.7 40-124.4 81.2-21.3 28.7-35 62-40.1 97.8-2.8 19.4-2.8 38 0 57.4 8.1 56.7 37.7 107 83.5 141.4 11.1 8.3 21 14.5 33 20.5 34.1 16.9 74.4 24.8 110 21.7" style="fill:#b1b1b1"/><path d="M253.9 367.3c-2.9-.7-4.3-1.4-6-2.9-2.9-2.6-3.9-4.9-3.9-8.9 0-3.9 1-6.3 3.9-8.9 6-5.4 15.8-3.1 19 4.3 1.1 2.6 1 7-.3 9.6-1.2 2.4-3.7 4.9-6 5.8-1.7.8-5.3 1.3-6.7 1m68.4-29.3c-9.2-3.4-11-15.4-3.1-21.1 8.1-5.9 20 1 18.8 11-.5 4-3 7.6-6.7 9.5-2.4 1.2-6.6 1.5-9 .6m-139.8-.2c-3.4-1.1-6.2-3.5-7.9-6.7-1.3-2.4-1.2-7.7.2-10.2 1.2-2.3 3.9-4.8 6.3-5.8 2.6-1.1 7-1 9.6.3 4.2 2.1 6.7 6 6.7 10.7 0 6.5-4.7 11.5-11 11.9-1.5.1-3.3 0-3.9-.2m43.2-22.8c-2.4-.8-4.1-1.9-5.8-3.8-5.4-6-3.1-15.8 4.3-19 2.6-1.1 7-1 9.6.3 2.5 1.2 4.9 3.7 5.9 6.2.9 2.1 1 6.3.1 8.8-.8 2.3-3.5 5.3-5.9 6.6-1.9 1-6.3 1.5-8.2.9m54.6 0c-2.4-.8-4.1-1.9-5.8-3.8-5.4-6-3.1-15.8 4.3-19 2.6-1.1 7-1 9.6.3 2.5 1.2 4.9 3.7 5.9 6.2.9 2.1 1 6.3.1 8.8-.8 2.3-3.5 5.3-5.9 6.6-1.9 1-6.3 1.5-8.2.9m-27.6-47c-2.2-.7-4-1.9-5.5-3.5-2.5-2.7-3.2-4.5-3.2-8.5 0-3.9.7-5.8 3.2-8.5s4.8-3.6 8.8-3.6 6.3.9 8.8 3.6 3.2 4.5 3.2 8.5c0 2.5-.3 4-.9 5.2-1.2 2.3-3.5 4.7-5.7 5.8-1.9 1.1-6.7 1.6-8.7 1m99.7 0c-2.4-.8-4.1-1.9-5.8-3.8-5.4-6-3.1-15.8 4.3-19 2.6-1.1 7-1 9.6.3 2.5 1.2 4.9 3.7 5.9 6.2.9 2.1 1 6.3.1 8.8-.8 2.3-3.5 5.3-5.9 6.6-1.9 1-6.3 1.5-8.2.9m-198.9-.7c-8.9-2.5-11.8-13.8-5.1-20.1 2.6-2.5 4.5-3.2 8.2-3.2 3.9 0 6.3 1 8.9 3.9 2.1 2.3 3 4.7 2.9 8.2 0 7.6-7.5 13.2-14.9 11.2m42.9-.4c-2.3-1.2-5.2-4.1-6.1-6.4-1-2.4-.9-7.1.3-9.5 1.1-2.3 4.1-5.2 6.4-6.2 2.4-1 7.1-.9 9.5.3 2.3 1.1 5.2 4.1 6.2 6.4 1 2.4.9 7.1-.3 9.5-1.1 2.3-4.1 5.2-6.4 6.2-2.5 1.1-7.2.9-9.6-.3m109-.3c-11.1-5.6-7-22.5 5.5-22.4 3.7 0 6.1 1.1 8.6 3.9 2.2 2.4 3.2 4.9 3.2 8s-1 5.6-3.2 8c-2.5 2.8-5 3.9-8.6 3.9-2.3-.1-3.5-.4-5.5-1.4m-79.7-46.3c-8.9-2.5-11.8-13.8-5.1-20.1 2.6-2.5 4.5-3.2 8.2-3.2 3.9 0 6.3 1 8.9 3.9 2.1 2.3 3 4.7 2.9 8.2-.1 7.6-7.6 13.3-14.9 11.2m54.5 0c-8-2.2-11.3-12-6.4-18.5 5.7-7.5 16.1-6.4 20.5 2 1.3 2.4 1.2 7.7-.2 10.2-2.6 5.1-8.6 7.8-13.9 6.3m43.2-22.8c-8-2.2-11.3-12-6.4-18.5 5.7-7.5 16.1-6.4 20.5 2 1.3 2.4 1.2 7.7-.2 10.2-2.6 5.2-8.6 7.8-13.9 6.3m-140.6-.5c-8.7-2.4-11.6-13-5.4-19.7 2.5-2.6 4.8-3.6 8.6-3.6 3.9 0 6.3 1.1 8.8 3.8 2.2 2.5 3 4.7 3 8 .1 8-7.3 13.6-15 11.5m70.3-28.9c-8-2.2-11.3-12-6.4-18.5 5.7-7.5 16.1-6.4 20.5 2 1.3 2.4 1.2 7.7-.2 10.2-2.6 5.1-8.5 7.8-13.9 6.3" style="fill:#884717"/></svg>

Before

Width:  |  Height:  |  Size: 4.8 KiB

+72 -29
View File
@@ -1,41 +1,84 @@
from __future__ import annotations
import asyncio
import logging
import sys
import time
import uvicorn
from fastapi import FastAPI
from fastapi.middleware.gzip import GZipMiddleware
import uvicorn.config
from bs4 import BeautifulSoup
from fastapi import FastAPI, HTTPException
from fastapi.responses import RedirectResponse
from sbase import SB, BaseCase
from src.consts import HOST, LOG_LEVEL, PORT, VERSION
from src.endpoints import health_check, router
from src.middlewares import LogRequest
from src.utils import get_camoufox, logger
logger.info("Using version %s", VERSION)
logger.info("Log level set to %s", logging.getLevelName(LOG_LEVEL))
import src
import src.utils
import src.utils.consts
from src.models.requests import LinkRequest, LinkResponse, Solution
from src.utils import logger
from src.utils.consts import LOG_LEVEL
app = FastAPI(debug=LOG_LEVEL == logging.DEBUG, log_level=LOG_LEVEL)
app.add_middleware(GZipMiddleware)
app.add_middleware(LogRequest)
app.include_router(router=router)
async def init():
"""Initialize the application."""
async for browser in get_camoufox():
await health_check(browser)
@app.get("/")
def read_root():
"""Redirect to /docs."""
logger.info("Redirecting to /docs")
return RedirectResponse(url="/docs", status_code=301)
@app.get("/health")
async def health_check():
"""Health check endpoint."""
logger.info("Health check")
# browser: Chrome = await new_browser()
# browser.get("https://google.com")
# browser.stop()
return {"status": "ok"}
@app.post("/v1")
def read_item(request: LinkRequest):
"""Handle POST requests."""
start_time = int(time.time() * 1000)
# request.url = "https://nowsecure.nl"
logger.info(f"Request: {request}")
response: LinkResponse
# start_time = int(time.time() * 1000)
with SB(uc=True, locale_code="en", test=False, xvfb=True, ad_block=True) as sb:
sb: BaseCase
sb.uc_open_with_reconnect(request.url)
sb.uc_gui_click_captcha()
logger.info(f"Got webpage: {request.url}")
sb.save_screenshot("screenshot.png")
logger.info(f"Got webpage: {request.url}")
source = sb.get_page_source()
source_bs = BeautifulSoup(source, "html.parser")
title_tag = source_bs.title
if title_tag is None:
raise HTTPException(status_code=500, detail="Title tag not found")
if title_tag.string in src.utils.consts.CHALLENGE_TITLES:
raise HTTPException(status_code=500, detail="Could not bypass challenge")
title = title_tag.string
logger.info(f"Title: {title}")
response = LinkResponse(
message="Success",
solution=Solution(
userAgent=sb.get_user_agent(),
url=sb.get_current_url(),
status=200,
cookies=sb.get_cookies(),
headers={},
response=source,
),
startTimestamp=start_time,
)
return response
if __name__ == "__main__":
# Check for --init flag to run the app in development mode
if "--init" in sys.argv:
logger.info("Running initialization script...")
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
loop.run_until_complete(init())
logger.info("Initialization complete.")
else:
uvicorn.run(app, host=HOST, port=PORT)
uvicorn.run(app, host="0.0.0.0", port=8191, log_level=LOG_LEVEL) # noqa: S104
Generated
+2168
View File
File diff suppressed because it is too large Load Diff
+3
View File
@@ -0,0 +1,3 @@
[virtualenvs]
in-project = true
create = true
+25 -29
View File
@@ -1,33 +1,27 @@
# cspell:disable
[project]
authors = [{ name = "ThePhaseless", email = "kukubaorch@gmail.com" }]
license = { text = "LICENSE" }
requires-python = "==3.14.*"
name = "Byparr"
[tool.poetry]
name = "byparr"
version = "0.1.0"
description = "API for getting cookies for Cloudflare challenges"
description = ""
package-mode = false
authors = ["Your Name <you@example.com>"]
readme = "README.md"
dependencies = [
"camoufox[geoip]==0.4.*",
"fastapi[standard]==0.135.*",
"playwright-captcha==0.1.*",
"pydantic==2.*",
]
urls = { repository = "https://github.com/ThePhaseless/Byparr" }
[dependency-groups]
test = [
"httpx==0.28.*",
"pytest==9.0.*",
"pytest-asyncio==1.3.*",
"pytest-retry==1.7.*",
"pytest-xdist==3.8.*",
"setuptools>=80.9.0",
]
dev = ["deptry==0.25.*", "ruff==0.15.*"]
[tool.poetry.dependencies]
python = "^3.12"
pytest = "^8"
fastapi = { extras = ["standard"], version = "^0" }
requests = "^2"
httpx = "^0.27"
pytest-asyncio = "^0"
ruff = "^0.8.0"
seleniumbase = "^4.32.12"
pyautogui = "^0.9.54"
beautifulsoup4 = "^4.12.3"
[tool.deptry.per_rule_ignores]
DEP002 = ["pyautogui"]
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
[tool.ruff.lint]
ignore = [
@@ -58,6 +52,8 @@ ignore = [
select = ["ALL"]
extend-safe-fixes = ["D415"]
[tool.pyright]
reportMissingTypeStubs = false
typeCheckingMode = "strict"
[tool.pytest]
log_cli = "True"
[tool.pytest.ini_options]
asyncio_default_fixture_loop_scope = "function"
-11
View File
@@ -1,11 +0,0 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:recommended"],
"forkProcessing": "enabled",
"packageRules": [
{
"automerge": true,
"matchUpdateTypes": ["minor", "patch"]
}
]
}
View File
-32
View File
@@ -1,32 +0,0 @@
import logging
import os
import sys
from pathlib import Path
from playwright_captcha import CaptchaType
from playwright_captcha.utils.camoufox_add_init_script.add_init_script import (
get_addon_path,
)
LOG_LEVEL = logging.getLevelNamesMapping()[os.getenv("LOG_LEVEL", "INFO").upper()]
VERSION = os.getenv("VERSION", "unknown").removeprefix("v")
ADDON_PATH = str(Path(get_addon_path()).absolute())
MAX_ATTEMPTS = sys.maxsize
PROXY_SERVER = os.getenv("PROXY_SERVER")
PROXY_USERNAME = os.getenv("PROXY_USERNAME")
PROXY_PASSWORD = os.getenv("PROXY_PASSWORD")
HOST = os.getenv("HOST", "0.0.0.0") # noqa: S104
PORT = int(os.getenv("PORT", "8191"))
CHALLENGE_TITLES_MAP: dict[CaptchaType, list[str]] = {
# Cloudflare
CaptchaType.CLOUDFLARE_INTERSTITIAL: ["Just a moment..."],
}
CHALLENGE_TITLES = [
title for titles in CHALLENGE_TITLES_MAP.values() for title in titles
]
-106
View File
@@ -1,106 +0,0 @@
import time
import warnings
from asyncio import wait_for
from http import HTTPStatus
from typing import Annotated
from fastapi import APIRouter, Depends, HTTPException
from fastapi.responses import RedirectResponse
from playwright_captcha import CaptchaType
from src.consts import CHALLENGE_TITLES
from src.models import (
HealthcheckResponse,
LinkRequest,
LinkResponse,
Solution,
)
from src.utils import CamoufoxDepClass, TimeoutTimer, get_camoufox, logger
warnings.filterwarnings("ignore", category=SyntaxWarning)
router = APIRouter()
CamoufoxDep = Annotated[CamoufoxDepClass, Depends(get_camoufox)]
@router.get("/", include_in_schema=False)
def read_root():
"""Redirect to /docs."""
logger.debug("Redirecting to /docs")
return RedirectResponse(url="/docs", status_code=301)
@router.get("/health")
async def health_check(sb: CamoufoxDep):
"""Health check endpoint."""
health_check_request = await read_item(
LinkRequest.model_construct(url="https://google.com"),
sb,
)
if health_check_request.solution.status != HTTPStatus.OK:
raise HTTPException(
status_code=500,
detail="Health check failed",
)
return HealthcheckResponse(user_agent=health_check_request.solution.user_agent)
@router.post("/v1")
async def read_item(request: LinkRequest, dep: CamoufoxDep) -> LinkResponse:
"""Handle POST requests."""
start_time = int(time.time() * 1000)
timer = TimeoutTimer(duration=request.max_timeout)
request.url = request.url.replace('"', "").strip()
try:
page_request = await dep.page.goto(
request.url, timeout=timer.remaining() * 1000
)
status = page_request.status if page_request else HTTPStatus.OK
await dep.page.wait_for_load_state(
state="domcontentloaded", timeout=timer.remaining() * 1000
)
await dep.page.wait_for_load_state(
"networkidle", timeout=timer.remaining() * 1000
)
if await dep.page.title() in CHALLENGE_TITLES:
logger.info("Challenge detected, attempting to solve...")
# Solve the captcha
await wait_for(
dep.solver.solve_captcha( # pyright: ignore[reportUnknownMemberType,reportUnknownArgumentType]
captcha_container=dep.page,
captcha_type=CaptchaType.CLOUDFLARE_INTERSTITIAL,
wait_checkbox_attempts=1,
wait_checkbox_delay=0.5,
),
timeout=timer.remaining(),
)
status = HTTPStatus.OK
logger.debug("Challenge solved successfully.")
except TimeoutError as e:
logger.error("Timed out while solving the challenge")
raise HTTPException(
status_code=408,
detail="Timed out while solving the challenge",
) from e
cookies = await dep.context.cookies()
return LinkResponse(
message="Success",
solution=Solution(
user_agent=await dep.page.evaluate("navigator.userAgent"),
url=dep.page.url,
status=status,
cookies=cookies,
headers=page_request.headers if page_request else {},
response=await dep.page.content(),
),
start_timestamp=start_time,
)
-30
View File
@@ -1,30 +0,0 @@
import time
from http import HTTPStatus
from fastapi import Request
from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
from src.models import LinkRequest
from src.utils import logger
class LogRequest(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
"""Log requests."""
if request.url.path != "/v1" or request.method != "POST":
return await call_next(request)
start_time = time.perf_counter()
request_body = LinkRequest.model_validate(await request.json())
logger.info(
f"From: {request.client.host if request.client else 'unknown'} at {time.strftime('%Y-%m-%d %H:%M:%S')}: {request_body.url}"
)
response = await call_next(request)
process_time = time.perf_counter() - start_time
if response.status_code == HTTPStatus.OK:
logger.info(f"Done {request_body.url} in {process_time:.2f}s")
else:
logger.warning(f"Failed {request_body.url} in {process_time:.2f}s")
return response
-64
View File
@@ -1,64 +0,0 @@
from __future__ import annotations
import time
from http.client import INTERNAL_SERVER_ERROR
from typing import Any
from playwright.sync_api import Cookie
from pydantic import BaseModel, Field
from pydantic.alias_generators import to_camel
from src import consts
class LinkRequest(BaseModel):
cmd: str = Field(
default="request.get",
description="Type of request, currently only supports GET requests. This string is purely for compatibility with FlareSolverr.",
)
url: str = Field(pattern=r"^https?://", default="https://")
max_timeout: int = Field(
default=60,
description="Maximum timeout in seconds for resolving the anti-bot challenge.",
)
class HealthcheckResponse(BaseModel):
model_config = {"alias_generator": to_camel, "populate_by_name": True}
msg: str = "Byparr is working!"
version: str = consts.VERSION
user_agent: str
class Solution(BaseModel):
model_config = {"alias_generator": to_camel, "populate_by_name": True}
url: str
status: int
cookies: list[Cookie] = []
user_agent: str = ""
headers: dict[str, Any] = {}
response: str = ""
class LinkResponse(BaseModel):
model_config = {"alias_generator": to_camel, "populate_by_name": True}
status: str = "ok"
message: str
solution: Solution
start_timestamp: int
end_timestamp: int = Field(default_factory=lambda: int(time.time() * 1000))
version: str = consts.VERSION
@classmethod
def invalid(cls, url: str):
"""
Return an invalid LinkResponse with default error values.
This method is used to generate a response indicating an invalid request.
"""
return cls(
status="error",
message="Invalid request",
solution=Solution(url=url, status=INTERNAL_SERVER_ERROR),
start_timestamp=int(time.time() * 1000),
)
View File
+95
View File
@@ -0,0 +1,95 @@
from __future__ import annotations
from pydantic import BaseModel
class Author(BaseModel):
login: str
id: int
node_id: str
avatar_url: str
gravatar_id: str
url: str
html_url: str
followers_url: str
following_url: str
gists_url: str
starred_url: str
subscriptions_url: str
organizations_url: str
repos_url: str
events_url: str
received_events_url: str
type: str
site_admin: bool
class Uploader(BaseModel):
login: str
id: int
node_id: str
avatar_url: str
gravatar_id: str
url: str
html_url: str
followers_url: str
following_url: str
gists_url: str
starred_url: str
subscriptions_url: str
organizations_url: str
repos_url: str
events_url: str
received_events_url: str
type: str
site_admin: bool
class Asset(BaseModel):
url: str
id: int
node_id: str
name: str
label: str | None
uploader: Uploader
content_type: str
state: str
size: int
download_count: int
created_at: str
updated_at: str
browser_download_url: str
class Reactions(BaseModel):
url: str
total_count: int
laugh: int
hooray: int
confused: int
heart: int
rocket: int
eyes: int
class GithubResponse(BaseModel):
url: str
assets_url: str
upload_url: str
html_url: str
id: int
author: Author
node_id: str
tag_name: str
target_commitish: str
name: str
draft: bool
prerelease: bool
created_at: str
published_at: str
assets: list[Asset]
tarball_url: str
zipball_url: str
body: str
reactions: Reactions
+61
View File
@@ -0,0 +1,61 @@
from __future__ import annotations
import time
from http import HTTPStatus
from typing import Any
from pydantic import BaseModel
class LinkRequest(BaseModel):
cmd: str
url: str
maxTimeout: int # noqa: N815 # Ignore to preserve compatibility
class ProtectionTriggeredError(Exception):
pass
class Solution(BaseModel):
url: str
status: int
cookies: list
userAgent: str # noqa: N815 # Ignore to preserve compatibility
headers: dict[str, Any]
response: str
@classmethod
def empty(cls):
return cls(
url="",
status=HTTPStatus.INTERNAL_SERVER_ERROR,
cookies=[],
userAgent="",
headers={},
response="",
)
class LinkResponse(BaseModel):
status: str = "ok"
message: str
solution: Solution
startTimestamp: int # noqa: N815 # Ignore to preserve compatibility
endTimestamp: int = int(time.time() * 1000) # noqa: N815 # Ignore to preserve compatibility
version: str = "3.3.21" # TODO: Implement versioning
@classmethod
def invalid(cls):
return cls(
status="error",
message="Invalid request",
solution=Solution.empty(),
startTimestamp=int(time.time() * 1000),
endTimestamp=int(time.time() * 1000),
version="3.3.21",
)
class NoChromeExtensionError(Exception):
"""No chrome extention found."""
-116
View File
@@ -1,116 +0,0 @@
import logging
import time
from collections.abc import AsyncGenerator
from typing import Annotated, NamedTuple, cast
from camoufox import AsyncCamoufox
from fastapi import Header
from playwright.async_api import Browser, BrowserContext, Page
from playwright_captcha import (
ClickSolver,
FrameworkType,
)
from pydantic import BaseModel, Field
from src.consts import (
ADDON_PATH,
LOG_LEVEL,
MAX_ATTEMPTS,
PROXY_PASSWORD,
PROXY_SERVER,
PROXY_USERNAME,
)
solver_logger = logging.getLogger("playwright_captcha")
solver_logger.handlers.clear()
if LOG_LEVEL == logging.DEBUG:
solver_logger.addHandler(logging.StreamHandler())
solver_logger.setLevel(LOG_LEVEL)
else:
solver_logger.handlers.append(logging.NullHandler())
logger = logging.getLogger("uvicorn.error")
logger.setLevel(LOG_LEVEL)
if len(logger.handlers) == 0:
logger.addHandler(logging.StreamHandler())
class TimeoutTimer(BaseModel):
duration: int # in seconds
start_time: float = Field(default_factory=time.perf_counter)
def remaining(self) -> float:
"""Get remaining time in seconds."""
return max(0, self.duration - (time.perf_counter() - self.start_time))
class CamoufoxDepClass(NamedTuple):
page: Page
solver: ClickSolver
context: BrowserContext
async def get_camoufox(
x_proxy_server: Annotated[
str | None,
Header(
alias="X-Proxy-Server",
description="Override proxy server for this request in protocol://host:port format.",
),
] = None,
x_proxy_username: Annotated[
str | None,
Header(
alias="X-Proxy-Username",
),
] = None,
x_proxy_password: Annotated[
str | None,
Header(
alias="X-Proxy-Password",
),
] = None,
) -> AsyncGenerator[CamoufoxDepClass]:
"""Get Camoufox instance."""
header_server = x_proxy_server
header_username = x_proxy_username
header_password = x_proxy_password
proxy_config = None
if header_server:
proxy_config = {
"server": header_server,
"username": header_username,
"password": header_password,
}
elif PROXY_SERVER:
proxy_config = {
"server": PROXY_SERVER,
"username": PROXY_USERNAME,
"password": PROXY_PASSWORD,
}
async with AsyncCamoufox(
main_world_eval=True,
addons=[ADDON_PATH],
geoip=True,
proxy=proxy_config,
locale="en-US",
headless=True,
humanize=True,
i_know_what_im_doing=True,
config={"forceScopeAccess": True}, # add this when creating Camoufox instance
disable_coop=True, # add this when creating Camoufox instance
) as browser_raw:
# Cast to Browser since AsyncCamoufox always returns a Browser, not BrowserContext
browser = cast("Browser", browser_raw)
context = await browser.new_context()
page = await context.new_page()
async with ClickSolver(
framework=FrameworkType.CAMOUFOX,
page=page,
max_attempts=MAX_ATTEMPTS,
attempt_delay=1,
) as solver:
yield CamoufoxDepClass(page, solver, context)
+8
View File
@@ -0,0 +1,8 @@
import logging
from src.utils.consts import LOG_LEVEL
logger = logging.getLogger("uvicorn.error")
logger.setLevel(LOG_LEVEL)
if len(logger.handlers) == 0:
logger.addHandler(logging.StreamHandler())
+12
View File
@@ -0,0 +1,12 @@
import logging
import os
LOG_LEVEL = os.getenv("LOG_LEVEL") or "INFO"
LOG_LEVEL = logging.getLevelNamesMapping()[LOG_LEVEL.upper()]
CHALLENGE_TITLES = [
# Cloudflare
"Just a moment...",
# DDoS-GUARD
"DDoS-Guard",
]
-3
View File
@@ -1,3 +0,0 @@
#!/bin/sh
uv run pytest --retries 3 -n auto
+16 -27
View File
@@ -1,61 +1,50 @@
from http import HTTPStatus
from json import JSONDecodeError
import httpx
import pytest
from starlette.testclient import TestClient
from main import app
from src.models import LinkRequest
from src.models.requests import LinkRequest
client = TestClient(app)
test_websites = [
"https://btmet.com/",
"https://ext.to/",
# "https://www.ygg.re/",
"https://extratorrent.st/",
"https://speed.cd/login",
'https://www.yggtorrent.top/engine/search?do=search&order=desc&sort=publish_date&name="UNESCAPED"+"DOUBLEQUOTES"&category=2145',
"https://1337x.to/home/",
]
# Not testable on github actions
github_restricted = [
"https://www.ygg.re/",
"https://extratorrent.st/",
"https://idope.se/",
"https://speed.cd/login",
]
# if os.getenv("GITHUB_ACTIONS") != "true":
test_websites.extend(github_restricted)
@pytest.mark.parametrize("website", test_websites)
def test_bypass(website: str):
"""
Tests if the service can bypass cloudflare/DDOS-GUARD on given websites.
This test is skipped if the website is not reachable or does not have cloudflare/DDOS-GUARD.
"""
test_request = httpx.get(
website,
)
if (
test_request.status_code >= HTTPStatus.INTERNAL_SERVER_ERROR
test_request.status_code != HTTPStatus.OK
and "Just a moment..." not in test_request.text
):
try:
error_details = test_request.json()
except JSONDecodeError:
error_details = test_request.text
pytest.skip(
f"Skipping {website} - ({test_request.status_code}) {error_details}"
)
pytest.skip(f"Skipping {website} due to {test_request.status_code}")
response = client.post(
"/v1",
json=LinkRequest.model_construct(url=website, cmd="request.get").model_dump(),
json=LinkRequest(url=website, maxTimeout=30, cmd="request.get").model_dump(),
)
assert response.status_code == HTTPStatus.OK
def test_health_check():
"""
Tests the health check endpoint.
This test ensures that the health check
endpoint returns HTTPStatus.OK.
"""
response = client.get("/health")
assert response.status_code == HTTPStatus.OK
Generated
-1618
View File
File diff suppressed because it is too large Load Diff