All apps Β· 0 apps
Scraperr---API
Docker app from grtgbln's Repository
Overview
Readme
View on GitHub
A powerful self-hosted web scraping solution
π Overview
Scrape websites without writing a single line of code.
π Check out the docs for a comprehensive quickstart guide and detailed information.
β¨ Key Features
- XPath-Based Extraction: Precisely target page elements
- Queue Management: Submit and manage multiple scraping jobs
- Domain Spidering: Option to scrape all pages within the same domain
- Custom Headers: Add JSON headers to your scraping requests
- Media Downloads: Automatically download images, videos, and other media
- Results Visualization: View scraped data in a structured table format
- Data Export: Export your results in markdown and csv formats
- Notifcation Channels: Send completion notifcations, through various channels
π Getting Started
Docker
make up
Helm
Refer to the docs for helm deployment: https://scraperr-docs.pages.dev/guides/helm-deployment
βοΈ Legal and Ethical Guidelines
When using Scraperr, please remember to:
- Respect
robots.txt: Always check a website'srobots.txtfile to verify which pages permit scraping - Terms of Service: Adhere to each website's Terms of Service regarding data extraction
- Rate Limiting: Implement reasonable delays between requests to avoid overloading servers
Disclaimer: Scraperr is intended for use only on websites that explicitly permit scraping. The creator accepts no responsibility for misuse of this tool.
π¬ Join the Community
Get support, report bugs, and chat with other users and contributors.
π Join the Scraperr Discord
π License
This project is licensed under the MIT License. See the LICENSE file for details.
π Contributions
Development made easier with the webapp template.
To get started, simply run make build up-dev.
Media gallery
1 / 6Install Scraperr---API on Unraid in a few clicks.
Find Scraperr---API in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allLinks
Details
jpyles0524/scraperr_api:latestRuntime arguments
- Network
bridge- Privileged
- true
Template configuration
Container Port: 8000
- Target
- 8000
- Default
- 8000
- Value
- 8000
Used to encode authentication tokens, can be a random string
- Target
- SECRET_KEY
API key for OpenAI, used for chat functionality
- Target
- OPENAI_KEY
Path to store media files
- Target
- /project/app/media
- Value
- /mnt/user/appdata/scraperr/media
Path to store application data
- Target
- /project/app/data
- Default
- /mnt/user/appdata/scraperr/api_data
- Value
- /mnt/user/appdata/scraperr/api_data
Log level for the application
- Target
- LOG_LEVEL
- Default
- INFO|DEBUG|ERROR
Algorithm used to encode authentication tokens
- Target
- ALGORITHM
- Default
- HS256
- Value
- HS256
Time in minutes before access tokens expire
- Target
- ACCESS_TOKEN_EXPIRE_MINUTES
- Default
- 600
- Value
- 600
Path to the Docker socket
- Target
- /var/run/docker.sock
- Default
- /var/run/docker.sock
- Value
- /var/run/docker.sock