github/FlareSolverr
1
1
Fork 0
mirror of https://github.com/FlareSolverr/FlareSolverr.git synced 2025-06-08 04:25:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
ngosang 2022-09-23 02:18:59 +02:00
parent 613e49e6cb
commit 5257f47d34
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -13,9 +13,9 @@ FlareSolverr is a proxy server to bypass Cloudflare and DDoS-GUARD protection.
## How it works ## How it works
FlareSolverr starts a proxy server, and it waits for user requests in an idle state using few resources. FlareSolverr starts a proxy server, and it waits for user requests in an idle state using few resources.
When some request arrives, it uses [puppeteer](https://github.com/puppeteer/puppeteer) with the When some request arrives, it uses [Selenium](https://www.selenium.dev) with the
[stealth plugin](https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth) [undetected-chromedriver](https://github.com/ultrafunkamsterdam/undetected-chromedriver)
to create a headless browser (Firefox). It opens the URL with user parameters and waits until the Cloudflare challenge to create a web browser (Chrome). It opens the URL with user parameters and waits until the Cloudflare challenge
is solved (or timeout). The HTML code and the cookies are sent back to the user, and those cookies can be used to is solved (or timeout). The HTML code and the cookies are sent back to the user, and those cookies can be used to
bypass Cloudflare using other HTTP clients. bypass Cloudflare using other HTTP clients.
@ -37,11 +37,12 @@ Docker images are available in:
* DockerHub => https://hub.docker.com/r/flaresolverr/flaresolverr * DockerHub => https://hub.docker.com/r/flaresolverr/flaresolverr
Supported architectures are: Supported architectures are:
| Architecture | Tag |
| :----: | --- | | Architecture | Tag |
| x86-64 | linux/amd64 | |--------------|--------------|
| ARM64 | linux/arm64 | | x86-64 | linux/amd64 |
| ARM32 | linux/arm/v7 | | ARM64 | linux/arm64 |
| ARM32 | linux/arm/v7 |
We provide a `docker-compose.yml` configuration file. Clone this repository and execute `docker-compose up -d` to start We provide a `docker-compose.yml` configuration file. Clone this repository and execute `docker-compose up -d` to start
the container. the container.
@ -70,13 +71,11 @@ This is the recommended way for Windows users.
### From source code ### From source code
This is the recommended way for macOS users and for developers. This is the recommended way for macOS users and for developers.
* Install [NodeJS](https://nodejs.org/) 16. * Install [Python 3.10](https://www.python.org/downloads/).
* Install [Chrome](https://www.google.com/intl/en_us/chrome/) or [Chromium](https://www.chromium.org/getting-involved/download-chromium/) web browser.
* Clone this repository and open a shell in that path. * Clone this repository and open a shell in that path.
* Run `export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true` (Linux/macOS) or `set PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true` (Windows). * Run `pip install -r requirements.txt` command to install FlareSolverr dependencies.
* Run `npm install` command to install FlareSolverr dependencies. * Run `python src/flaresolverr.py` command to start FlareSolverr.
* Run `npm start` command to compile TypeScript code and start FlareSolverr.
If you get errors related to firefox not installed try running `node install.js` to install Firefox.
### Systemd service ### Systemd service