From e7592db9631e9bba2b8e3e4e7ec889732821eb0d Mon Sep 17 00:00:00 2001 From: Jef LeCompte Date: Fri, 9 Oct 2020 16:48:10 -0500 Subject: [PATCH] chore: add missing env Signed-off-by: Jef LeCompte --- .env-example | 17 +++++++++++------ README.md | 24 ++++++++++++------------ 2 files changed, 23 insertions(+), 18 deletions(-) diff --git a/.env-example b/.env-example index 1825d52..4792404 100644 --- a/.env-example +++ b/.env-example @@ -4,16 +4,19 @@ BROWSER_TRUSTED= COUNTRY= +DESKTOP_NOTIFICATIONS= DISCORD_NOTIFY_GROUP= DISCORD_WEB_HOOK= -EMAIL_USERNAME= -EMAIL_TO= EMAIL_PASSWORD= +EMAIL_TO= +EMAIL_USERNAME= HEADLESS= IN_STOCK_WAIT_TIME= LOG_LEVEL= LOW_BANDWIDTH= -MAX_PRICE= +MAX_PRICE_SERIES_3070= +MAX_PRICE_SERIES_3080= +MAX_PRICE_SERIES_3090= MICROCENTER_LOCATION= NVIDIA_ADD_TO_CART_ATTEMPTS= NVIDIA_SESSION_TTL= @@ -23,8 +26,8 @@ PAGE_BACKOFF_MAX= PAGE_SLEEP_MIN= PAGE_SLEEP_MAX= PAGE_TIMEOUT= -PHONE_NUMBER= PHONE_CARRIER= +PHONE_NUMBER= PLAY_SOUND= PROXY_ADDRESS= PROXY_PORT= @@ -38,6 +41,8 @@ SHOW_ONLY_MODELS= SHOW_ONLY_SERIES= SLACK_CHANNEL= SLACK_TOKEN= +SMTP_ADDRESS= +SMTP_PORT= STORES= TELEGRAM_ACCESS_TOKEN= TELEGRAM_CHAT_ID= @@ -45,9 +50,9 @@ TWILIO_ACCOUNT_SID= TWILIO_AUTH_TOKEN= TWILIO_FROM_NUMBER= TWILIO_TO_NUMBER= -TWITTER_CONSUMER_KEY= -TWITTER_CONSUMER_SECRET= TWITTER_ACCESS_TOKEN_KEY= TWITTER_ACCESS_TOKEN_SECRET= +TWITTER_CONSUMER_KEY= +TWITTER_CONSUMER_SECRET= TWITTER_TWEET_TAGS= USER_AGENT= diff --git a/README.md b/README.md index 915ca39..d783ba5 100644 --- a/README.md +++ b/README.md @@ -84,9 +84,9 @@ Here is a list of variables that you can use to customize your newly copied `.en | `DESKTOP_NOTIFICATIONS` | Display desktop notifications using [node-notifier](https://www.npmjs.com/package/node-notifier) | Default: `false` | | `DISCORD_NOTIFY_GROUP` | Discord group you would like to notify | Can be comma separated, use role ID, E.g.: `<@2834729847239842>` | | `DISCORD_WEB_HOOK` | Discord Web Hook URL | Can be comma separated, use whole webhook URL | -| `EMAIL_USERNAME` | Gmail address | E.g.: `jensen.robbed.us@gmail.com` | -| `EMAIL_TO` | Destination Email | Defaults to username if not set. Can be comma separated | | `EMAIL_PASSWORD` | Gmail password | See below if you have MFA | +| `EMAIL_TO` | Destination Email | Defaults to username if not set. Can be comma separated | +| `EMAIL_USERNAME` | Gmail address | E.g.: `jensen.robbed.us@gmail.com` | | `HEADLESS` | Puppeteer to run headless or not | Debugging related, default: `true` | | `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](https://github.com/winstonjs/winston#logging-levels) | Debugging related, default: `info` | @@ -98,20 +98,20 @@ Here is a list of variables that you can use to customize your newly copied `.en | `NVIDIA_ADD_TO_CART_ATTEMPTS` | The maximum number of times the `nvidia-api` add to cart feature will be attempted before failing | Default: `10` | | `NVIDIA_SESSION_TTL` | The time in milliseconds to keep the cart active while using `nvidia-api` | Default: `60000` | | `OPEN_BROWSER` | Toggle for whether or not the browser should open when item is found | Default: `true` | -| `PAGE_TIMEOUT` | Navigation Timeout in milliseconds | `0` for infinite, default: `30000` | -| `PHONE_NUMBER` | 10 digit phone number | E.g.: `1234567890`, email configuration required | -| `PHONE_CARRIER` | [Supported carriers](#supported-carriers) for SMS | Email configuration required | -| `PLAY_SOUND` | Play this sound notification if a card is found | Relative path accepted, valid formats: wav, mp3, flac, E.g.: `path/to/notification.wav`, [free sounds available](https://notificationsounds.com/) | -| `PUSHBULLET` | PushBullet API key | Generate at https://www.pushbullet.com/#settings/account | | -| `PUSHOVER_TOKEN` | Pushover access token | Generate at https://pushover.net/apps/build | | -| `PUSHOVER_USER` | Pushover username | | -| `PUSHOVER_PRIORITY` | Pushover message priority | | `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 store | In milliseconds, default: `5000` | | `PAGE_SLEEP_MAX` | Maximum sleep time between queries of the same store | In milliseconds, default: `10000` | +| `PAGE_TIMEOUT` | Navigation Timeout in milliseconds | `0` for infinite, default: `30000` | +| `PHONE_CARRIER` | [Supported carriers](#supported-carriers) for SMS | Email configuration required | +| `PHONE_NUMBER` | 10 digit phone number | E.g.: `1234567890`, email configuration required | +| `PLAY_SOUND` | Play this sound notification if a card is found | Relative path accepted, valid formats: wav, mp3, flac, E.g.: `path/to/notification.wav`, [free sounds available](https://notificationsounds.com/) | | `PROXY_ADDRESS` | IP Address or fqdn of proxy server | | `PROXY_PORT` | TCP Port number on which the proxy is listening for connections | Default: `80` | +| `PUSHBULLET` | PushBullet API key | Generate at https://www.pushbullet.com/#settings/account | | +| `PUSHOVER_TOKEN` | Pushover access token | Generate at https://pushover.net/apps/build | | +| `PUSHOVER_USER` | Pushover username | | +| `PUSHOVER_PRIORITY` | Pushover message priority | | `SCREENSHOT` | Capture screenshot of page if a card is found | Default: `true` | | `SHOW_ONLY_BRANDS` | Filter to show specified brands | Comma separated, e.g.: `evga,zotac` | | `SHOW_ONLY_MODELS` | Filter to show specified models | Comma separated, e.g.: `founders edition,rog strix` | @@ -128,10 +128,10 @@ Here is a list of variables that you can use to customize your newly copied `.en | `TWILIO_AUTH_TOKEN` | Twilio Auth Token | Can be found on twilio.com/console | | `TWILIO_FROM_NUMBER` | Twilio provided phone number to send messages from | Include country code e.g +4401234567890 | | `TWILIO_TO_NUMBER` | Mobile number to send SMS to | Include country code e.g +4401234567890 | -| `TWITTER_CONSUMER_KEY` | Twitter Consumer Key | Generate all Twitter keys at: https://developer.twitter.com/ | -| `TWITTER_CONSUMER_SECRET` | Twitter Consumer Secret | | | `TWITTER_ACCESS_TOKEN_KEY` | Twitter Token Key | | | `TWITTER_ACCESS_TOKEN_SECRET` | Twitter Token Secret | | +| `TWITTER_CONSUMER_KEY` | Twitter Consumer Key | Generate all Twitter keys at: https://developer.twitter.com/ | +| `TWITTER_CONSUMER_SECRET` | Twitter Consumer Secret | | | `TWITTER_TWEET_TAGS` | Optional list of hashtags to append to the tweet message | E.g.: `#nvidia #nvidiastock` | | `USER_AGENT` | Custom User-Agent header for HTTP requests | Default: `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36` |