Skip to content

Latest commit

 

History

History
127 lines (79 loc) · 3.67 KB

README.md

File metadata and controls

127 lines (79 loc) · 3.67 KB
Raw

crawler

A gRPC web indexer turbo charged for performance.

This project is capable of handling millions of pages per second efficiently.

Getting Started

Make sure to have Rust installed or Docker.

This project requires that you start up another gRPC server on port 50051 following the proto spec.

The user agent is spoofed on each crawl to a random agent and the indexer extends spider as the base.

  1. cargo run or docker compose up

Installation

You can install easily with the following:

Cargo

The crate is available to setup a gRPC server within rust projects.

cargo install website_crawler

Docker

You can use also use the docker image at a11ywatch/crawler.

Set the CRAWLER_IMAGE env var to darwin-arm64 to get the native m1 mac image.

crawler:
  container_name: crawler
  image: "a11ywatch/crawler:${CRAWLER_IMAGE:-latest}"
  ports:
    - 50055

Node / Bun

We also release the package to npm @a11ywatch/crawler.

npm i @a11ywatch/crawler

After import at the top of your project to start the gRPC server or run node directly against the module.

import "@a11ywatch/crawler";

Example

This is a basic example crawling a web page, add spider to your Cargo.toml:

[dependencies]
website_crawler = "0.9.4"

A basic example can also be done with:

One terminal run the server

cargo run --example server --release

Another terminal run the client/server

cargo run --example client --release
Screen.Recording.2023-02-24.at.10.38.21.AM.mov

Dependencies

In order to build crawler locally >= 0.5.0, you need the protoc Protocol Buffers compiler, along with Protocol Buffers resource files.

Ubuntu

proto compiler needs to be at v3 in order to compile. Ubuntu 18+ auto installs.

sudo apt update && sudo apt upgrade -y
sudo apt install -y protobuf-compiler libprotobuf-dev

Alpine Linux

sudo apk add protoc protobuf-dev

macOS

Assuming Homebrew is already installed. (If not, see instructions for installing Homebrew on the Homebrew website.)

brew install protobuf

Features

  1. jemalloc - use jemalloc memory allocator (default disabled).
  2. regex - use the regex crate for blacklist urls validation.
  3. ua_generator - use the ua_generator crate to spoof random user agent.
  4. smart - use smart mode to run HTTP request first and chrome when JS is needed.
  5. chrome: Enables chrome headless rendering, use the env var CHROME_URL to connect remotely.

About

This crawler is optimized for reduced latency and uses isolated based concurrency as it can handle over 10,000 pages within several milliseconds. In order to receive the links found for the crawler you need to add the website.proto to your server. This is required since every request spawns a thread. Isolating the context drastically improves performance (preventing shared resources / communication ).

Help

If you need help implementing the gRPC server to receive the pages or links when found check out the gRPC node example for a starting point .

LICENSE

Check the license file in the root of the project.