mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
100 lines
5.3 KiB
Markdown
100 lines
5.3 KiB
Markdown
|
|
# Home assistant add-on: Flaresolver
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) is a proxy server to bypass Cloudflare protection. It starts a proxy server that waits for user requests in an idle state using few resources. When a request arrives, it uses Puppeteer with the stealth plugin to create a headless browser (Firefox) that solves Cloudflare challenges.
|
|
|
|
Key features:
|
|
- Bypasses Cloudflare protection automatically
|
|
- Headless browser automation with Firefox
|
|
- RESTful API for integration with other tools
|
|
- Cookie extraction for subsequent requests
|
|
- Support for various Cloudflare challenge types
|
|
|
|
**Note**: Web browsers consume significant memory. Avoid making many concurrent requests on systems with limited RAM.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
|
|
## Configuration
|
|
|
|
Web interface can be found at <http://homeassistant:8191>.
|
|
This addon has no configuration options - it works out of the box.
|
|
|
|
### API Usage
|
|
|
|
FlareSolverr provides a REST API for integration with other applications:
|
|
|
|
**Endpoint**: `http://homeassistant:8191/v1`
|
|
|
|
**Example Request**:
|
|
```json
|
|
{
|
|
"cmd": "request.get",
|
|
"url": "https://example.com",
|
|
"maxTimeout": 60000
|
|
}
|
|
```
|
|
|
|
### Integration with *arr Apps
|
|
|
|
Configure your indexers to use FlareSolverr:
|
|
- **Prowlarr/Jackett**: Set FlareSolverr URL to `http://homeassistant:8191`
|
|
- **Sonarr/Radarr**: Configure indexers to use the FlareSolverr proxy
|
|
|
|
### Options
|
|
|
|
No configuration options are available - FlareSolverr works automatically with default settings.
|
|
|
|
### Resource Requirements
|
|
|
|
- **Memory**: 512MB+ recommended
|
|
- **CPU**: Moderate usage during challenge solving
|
|
- **Network**: Requires internet access to function
|
|
|
|
### Environment variables
|
|
|
|
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|