Files
streetmerchant/docs/reference/application.md
T
2020-12-07 00:18:43 -05:00

2.6 KiB

Application

Environment variable Description
AUTO_ADD_TO_CART Enable auto add to cart on support stores, default: true
BROWSER_TRUSTED Skip Chromium Sandbox. Useful for containerized environments, default: false
HEADLESS Puppeteer to run headless or not. Debugging related, default: true
INCOGNITO Puppeteer to run incognito or not. Debugging related, default: false
IN_STOCK_WAIT_TIME Time to wait between requests to the same link if it has that card in stock. In seconds, default: 0
LOG_LEVEL Logging levels. Debugging related, default: info
LOW_BANDWIDTH Blocks images/fonts to reduce traffic. Disables ad blocker, default: false
OPEN_BROWSER Toggle for whether or not the browser should open when item is found. Default: true
PAGE_BACKOFF_MIN Minimum backoff time between retrying requests for the same store when a forbidden response is received. Default: 10000
PAGE_BACKOFF_MAX Maximum backoff time between retrying requests for the same store when a forbidden response is received. Default: 3600000
PAGE_SLEEP_MIN Minimum sleep time between queries of the same product page. In milliseconds, default: 5000
PAGE_SLEEP_MAX Maximum sleep time between queries of the same product page. In milliseconds, default: 10000
PAGE_TIMEOUT Navigation Timeout in milliseconds. 0 for infinite, default: 30000
PROXY_PROTOCOL protocol of proxy server, such as socks5. Default: http
PROXY_ADDRESS IP Address or fqdn of proxy server
PROXY_PORT TCP Port number on which the proxy is listening for connections. Default: 80
SCREENSHOT Capture screenshot of page if a card is found. Default: true
USER_AGENT Custom User-Agents headers for HTTP requests. Newline separated, e.g.: USER_AGENT_STRING1 \n USER_AGENT_STRING2. Default: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36
WEB_PORT Starts a webserver to be able to control the bot while it is running. Setting this value starts this service. Default: ``

???+ note You can find your computer's user agent by searching google for "my user agent"

???+ tip Data usage is known to be high. This is expected as the program scrapes many websites in parallel 24/7. To help reduce this, use LOW_BANDWIDTH="true". We are looking into other solutions as well, but is low priority.