aquatic-crawler/README.md

aquatic-crawler

Crawler/aggregation tool for the Aquatic BitTorrent tracker API.

Note

Project in development!

Roadmap

• Targets supported
  • IPv4/IPv6 info-hash JSON/API (requires PR#233)
    • local file path
    • remote URL
• Storage
  • File system (dump as .torrent)
    • V1
    • V2
  • Manticore full text search
  • SQLite

Install

1. git clone https://github.com/YGGverse/aquatic-crawler.git && cd aquatic-crawler
2. cargo build --release
3. sudo install target/release/aquatic-crawler /usr/local/bin/aquatic-crawler

Usage

aquatic-crawler --infohash-source /path/to/info-hash-ipv4.json\
                --infohash-source /path/to/info-hash-ipv6.json\
                --infohash-source /path/to/another-source.json\
                --torrent-tracker udp://host1:port\
                --torrent-tracker udp://host2:port\
                --torrents-path   /path/to/storage

• all arguments are optional, to support multiple source and target drivers
• running without arguments does nothing!

Options

-d, --debug <DEBUG>
        Debug level

        * `e` - error * `i` - info

        [default: ei]

-c, --clear
        Clear previous index collected on crawl session start

-i, --infohash-source <INFOHASH_SOURCE>
        Filepath(s) to the Aquatic tracker info-hash JSON/API

        * PR#233 feature

--torrents-path <TORRENTS_PATH>
        Directory path to store the `.torrent` files

--torrent-tracker <TORRENT_TRACKER>
        Define custom tracker(s) to preload the `.torrent` files info

--initial-peers <INITIAL_PEERS>
        Define initial peer(s) to preload the `.torrent` files info

--enable-dht
        Enable DHT resolver

--enable-upnp-port-forwarding
        Enable UPnP

--enable-upload
        Enable upload

--socks-proxy-url <SOCKS_PROXY_URL>
        Use `socks5://[username:password@]host:port`

-s <SLEEP>
        Crawl loop delay in seconds

        [default: 300]

-h, --help
        Print help (see a summary with '-h')

-V, --version
        Print version