- Notifications
You must be signed in to change notification settings - Fork845
Proxy server to bypass Cloudflare protection
License
FlareSolverr/FlareSolverr
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
FlareSolverr is a proxy server to bypass Cloudflare and DDoS-GUARD protection.
FlareSolverr starts a proxy server, and it waits for user requests in an idle state using few resources.When some request arrives, it usesSelenium with theundetected-chromedriverto create a web browser (Chrome). It opens the URL with user parameters and waits until the Cloudflare challengeis solved (or timeout). The HTML code and the cookies are sent back to the user, and those cookies can be used tobypass Cloudflare using other HTTP clients.
NOTE: Web browsers consume a lot of memory. If you are running FlareSolverr on a machine with few RAM, do not makemany requests at once. With each request a new browser is launched.
It is also possible to use a permanent session. However, if you use sessions, you should make sure to close them assoon as you are done using them.
It is recommended to install using a Docker container because the project depends on an external browser that isalready included within the image.
Docker images are available in:
- GitHub Registry =>https://github.com/orgs/FlareSolverr/packages/container/package/flaresolverr
- DockerHub =>https://hub.docker.com/r/flaresolverr/flaresolverr
Supported architectures are:
Architecture | Tag |
---|---|
x86 | linux/386 |
x86-64 | linux/amd64 |
ARM32 | linux/arm/v7 |
ARM64 | linux/arm64 |
We provide adocker-compose.yml
configuration file. Clone this repository and executedocker-compose up -d
(Compose V1) ordocker compose up -d
(Compose V2) to startthe container.
If you prefer thedocker cli
execute the following command.
docker run -d \ --name=flaresolverr \ -p 8191:8191 \ -e LOG_LEVEL=info \ --restart unless-stopped \ ghcr.io/flaresolverr/flaresolverr:latest
If your host OS is Debian, make surelibseccomp2
version is 2.5.x. You can check the version withsudo apt-cache policy libseccomp2
and update the package withsudo apt install libseccomp2=2.5.1-1~bpo10+1
orsudo apt install libseccomp2=2.5.1-1+deb11u1
.Remember to restart the Docker daemon and the container after the update.
WarningPrecompiled binaries are only available for x64 architecture. For other architectures see Docker images.
This is the recommended way for Windows users.
- Download theFlareSolverr executable from the release's page. It is available for Windows x64 and Linux x64.
- Execute FlareSolverr binary. In the environment variables section you can find how to change the configuration.
WarningInstalling from source code only works for x64 architecture. For other architectures see Docker images.
- InstallPython 3.11.
- InstallChrome (all OS) orChromium (just Linux, it doesn't work in Windows) web browser.
- (Only in Linux) InstallXvfb package.
- (Only in macOS) InstallXQuartz package.
- Clone this repository and open a shell in that path.
- Run
pip install -r requirements.txt
command to install FlareSolverr dependencies. - Run
python src/flaresolverr.py
command to start FlareSolverr.
- Run
pkg install chromium python311 py311-pip xorg-vfbserver
command to install the required dependencies. - Clone this repository and open a shell in that path.
- Run
python3.11 -m pip install -r requirements.txt
command to install FlareSolverr dependencies. - Run
python3.11 src/flaresolverr.py
command to start FlareSolverr.
We provide an example Systemd unit fileflaresolverr.service
as reference. You have to modify the file to suit your needs: paths, user and environment variables.
Example Bash request:
curl -L -X POST'http://localhost:8191/v1' \-H'Content-Type: application/json' \--data-raw'{ "cmd": "request.get", "url": "http://www.google.com/", "maxTimeout": 60000}'
Example Python request:
importrequestsurl="http://localhost:8191/v1"headers= {"Content-Type":"application/json"}data= {"cmd":"request.get","url":"http://www.google.com/","maxTimeout":60000}response=requests.post(url,headers=headers,json=data)print(response.text)
Example PowerShell request:
$body=@{cmd="request.get"url="http://www.google.com/"maxTimeout=60000}|ConvertTo-Jsonirm-UseBasicParsing'http://localhost:8191/v1'-Headers@{"Content-Type"="application/json"}-Method Post-Body$body
This will launch a new browser instance which will retain cookies until you destroy it withsessions.destroy
.This comes in handy, so you don't have to keep solving challenges over and over and you won't need to keep sendingcookies for the browser to use.
This also speeds up the requests since it won't have to launch a new browser instance for every request.
Parameter | Notes |
---|---|
session | Optional. The session ID that you want to be assigned to the instance. If isn't set a random UUID will be assigned. |
proxy | Optional, default disabled. Eg:"proxy": {"url": "http://127.0.0.1:8888"} . You must include the proxy schema in the URL:http:// ,socks4:// orsocks5:// . Authorization (username/password) is supported. Eg:"proxy": {"url": "http://127.0.0.1:8888", "username": "testuser", "password": "testpass"} |
Returns a list of all the active sessions. More for debugging if you are curious to see how many sessions are running.You should always make sure to properly close each session when you are done using them as too many may slow yourcomputer down.
Example response:
{"sessions": ["session_id_1","session_id_2","session_id_3..." ]}
This will properly shutdown a browser instance and remove all files associated with it to free up resources for a newsession. When you no longer need to use a session you should make sure to close it.
Parameter | Notes |
---|---|
session | The session ID that you want to be destroyed. |
Parameter | Notes |
---|---|
url | Mandatory |
session | Optional. Will send the request from and existing browser instance. If one is not sent it will create a temporary instance that will be destroyed immediately after the request is completed. |
session_ttl_minutes | Optional. FlareSolverr will automatically rotate expired sessions based on the TTL provided in minutes. |
maxTimeout | Optional, default value 60000. Max timeout to solve the challenge in milliseconds. |
cookies | Optional. Will be used by the headless browser. Eg:"cookies": [{"name": "cookie1", "value": "value1"}, {"name": "cookie2", "value": "value2"}] . |
returnOnlyCookies | Optional, default false. Only returns the cookies. Response data, headers and other parts of the response are removed. |
proxy | Optional, default disabled. Eg:"proxy": {"url": "http://127.0.0.1:8888"} . You must include the proxy schema in the URL:http:// ,socks4:// orsocks5:// . Authorization (username/password) is not supported. (When thesession parameter is set, the proxy is ignored; a session specific proxy can be set insessions.create .) |
WarningIf you want to use Cloudflare clearance cookie in your scripts, make sure you use the FlareSolverr User-Agent too. If they don't match you will see the challenge.
Example response from running thecurl
above:
{"solution": {"url":"https://www.google.com/?gws_rd=ssl","status":200,"headers": {"status":"200","date":"Thu, 16 Jul 2020 04:15:49 GMT","expires":"-1","cache-control":"private, max-age=0","content-type":"text/html; charset=UTF-8","strict-transport-security":"max-age=31536000","p3p":"CP=\"This is not a P3P policy! See g.co/p3phelp for more info.\"","content-encoding":"br","server":"gws","content-length":"61587","x-xss-protection":"0","x-frame-options":"SAMEORIGIN","set-cookie":"1P_JAR=2020-07-16-04; expires=Sat..." },"response":"<!DOCTYPE html>...","cookies": [ {"name":"NID","value":"204=QE3Ocq15XalczqjuDy52HeseG3zAZuJzID3R57...","domain":".google.com","path":"/","expires":1610684149.307722,"size":178,"httpOnly":true,"secure":true,"session":false,"sameSite":"None" }, {"name":"1P_JAR","value":"2020-07-16-04","domain":".google.com","path":"/","expires":1597464949.307626,"size":19,"httpOnly":false,"secure":true,"session":false,"sameSite":"None" } ],"userAgent":"Windows NT 10.0; Win64; x64) AppleWebKit/5..." },"status":"ok","message":"","startTimestamp":1594872947467,"endTimestamp":1594872949617,"version":"1.0.0"}
This is the same asrequest.get
but it takes one more param:
Parameter | Notes |
---|---|
postData | Must be a string withapplication/x-www-form-urlencoded . Eg:a=b&c=d |
Name | Default | Notes |
---|---|---|
LOG_LEVEL | info | Verbosity of the logging. UseLOG_LEVEL=debug for more information. |
LOG_HTML | false | Only for debugging. Iftrue all HTML that passes through the proxy will be logged to the console indebug level. |
CAPTCHA_SOLVER | none | Captcha solving method. It is used when a captcha is encountered. See the Captcha Solvers section. |
TZ | UTC | Timezone used in the logs and the web browser. Example:TZ=Europe/London . |
LANG | none | Language used in the web browser. Example:LANG=en_GB . |
HEADLESS | true | Only for debugging. To run the web browser in headless mode or visible. |
TEST_URL | https://www.google.com | FlareSolverr makes a request on start to make sure the web browser is working. You can change that URL if it is blocked in your country. |
PORT | 8191 | Listening port. You don't need to change this if you are running on Docker. |
HOST | 0.0.0.0 | Listening interface. You don't need to change this if you are running on Docker. |
PROMETHEUS_ENABLED | false | Enable Prometheus exporter. See the Prometheus section below. |
PROMETHEUS_PORT | 8192 | Listening port for Prometheus exporter. See the Prometheus section below. |
Environment variables are set differently depending on the operating system. Some examples:
- Docker: Take a look at the Docker section in this document. Environment variables can be set in the
docker-compose.yml
file or in the Docker CLI command. - Linux: Run
export LOG_LEVEL=debug
and then runflaresolverr
in the same shell. - Windows: Open
cmd.exe
, runset LOG_LEVEL=debug
and then runflaresolverr.exe
in the same shell.
The Prometheus exporter for FlareSolverr is disabled by default. It can be enabled with the environment variablePROMETHEUS_ENABLED
. If you are using Docker make sure you expose thePROMETHEUS_PORT
.
Example metrics:
# HELP flaresolverr_request_total Total requests with result# TYPE flaresolverr_request_total counterflaresolverr_request_total{domain="nowsecure.nl",result="solved"} 1.0# HELP flaresolverr_request_created Total requests with result# TYPE flaresolverr_request_created gaugeflaresolverr_request_created{domain="nowsecure.nl",result="solved"} 1.690141657157109e+09# HELP flaresolverr_request_duration Request duration in seconds# TYPE flaresolverr_request_duration histogramflaresolverr_request_duration_bucket{domain="nowsecure.nl",le="0.0"} 0.0flaresolverr_request_duration_bucket{domain="nowsecure.nl",le="10.0"} 1.0flaresolverr_request_duration_bucket{domain="nowsecure.nl",le="25.0"} 1.0flaresolverr_request_duration_bucket{domain="nowsecure.nl",le="50.0"} 1.0flaresolverr_request_duration_bucket{domain="nowsecure.nl",le="+Inf"} 1.0flaresolverr_request_duration_count{domain="nowsecure.nl"} 1.0flaresolverr_request_duration_sum{domain="nowsecure.nl"} 5.858# HELP flaresolverr_request_duration_created Request duration in seconds# TYPE flaresolverr_request_duration_created gaugeflaresolverr_request_duration_created{domain="nowsecure.nl"} 1.6901416571570296e+09
WarningAt this time none of the captcha solvers work. You can check the status in the open issues. Any help is welcome.
Sometimes CloudFlare not only gives mathematical computations and browser tests, sometimes they also require the user tosolve a captcha.If this is the case, FlareSolverr will return the errorCaptcha detected but no automatic solver is configured.
FlareSolverr can be customized to solve the CAPTCHA automatically by setting the environment variableCAPTCHA_SOLVER
to the file name of one of the adapters inside the/captcha
directory.
- C# implementation =>https://github.com/FlareSolverr/FlareSolverrSharp
About
Proxy server to bypass Cloudflare protection
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.