Home

Awesome

OD-Database Crawler 🕷

Build Status CodeFactor

https://od-db.the-eye.eu/

Usage

Deploys

  1. With Config File (if config.yml found in working dir)

    • Download default config
    • Set server.url and server.token
    • Start with ./od-database-crawler server --config <file>
  2. With Flags or env

    • Override config file if it exists
    • --help for list of flags
    • Every flag is available as an environment variable: --server.crawl_stats ➡️ OD_SERVER_CRAWL_STATS
    • Start with ./od-database-crawler server <flags>
  3. With Docker

    docker run \
        -e OD_SERVER_URL=xxx \
        -e OD_SERVER_TOKEN=xxx \
        terorie/od-database-crawler
    

Flag reference

Here are the most important config flags. For more fine control, take a look at /config.yml.

Flag/EnvironmentDescriptionExample
server.url<br />OD_SERVER_URLOD-DB Server URLhttps://od-db.mine.the-eye.eu/api
server.token<br />OD_SERVER_TOKENOD-DB Server Access TokenAsk Hexa TM
server.recheck<br />OD_SERVER_RECHECKJob Fetching Interval3s
output.crawl_stats<br />OD_OUTPUT_CRAWL_STATSCrawl Stats Logging Interval (0 = disabled)500ms
output.resource_stats<br />OD_OUTPUT_RESORUCE_STATSResource Stats Logging Interval (0 = disabled)8s
output.log<br />OD_OUTPUT_LOGLog File (none = disabled)crawler.log
crawl.tasks<br />OD_CRAWL_TASKSMax number of sites to crawl concurrently500
crawl.connections<br />OD_CRAWL_CONNECTIONSHTTP connections per site1
crawl.retries<br />OD_CRAWL_RETRIESHow often to retry after a temporary failure (e.g. HTTP 429 or timeouts)5
crawl.dial_timeout<br />OD_CRAWL_DIAL_TIMEOUTTCP Connect timeout5s
crawl.timeout<br />OD_CRAWL_TIMEOUTHTTP request timeout20s
crawl.user-agent<br />OD_CRAWL_USER_AGENTHTTP Crawler User-Agentgooglebot/1.2.3
crawl.job_buffer<br />OD_CRAWL_JOB_BUFFERNumber of URLs to keep in memory/cache, per job. The rest is offloaded to disk. Decrease this value if the crawler uses too much RAM. (0 = Disable Cache, -1 = Only use Cache)5000