Microsoft-Rewards-Script

mgrimace 9a144b2e60 Docker with env var support and containerized cron scheduling (#107 )

* Script will run on container start, and continue to run daily at 5:00 am.

The goal of this update was to add in-built cronjob support so that the script runs immediately on container start, then will schedule the script to run the daily at 5:00 am without requiring the user to manually create a cronjob. After starting the container and completing the first run, the container should remain active (running) but idle until the next scheduled run. Ideally, the next step will be to include support for environmental variables that will allow the user to customize when the script scheduled runs occur within the docker compose.yaml.

* added --build to docker compose command instructions

building/rebuilding the image (and the script) may reduce problems if folks make changes to their configs

* Updated the crontab default to run twice daily by default, 5am and 11am

* Update crontab

Newline needed

* Environmental variable support, custom scheduling

This is a massive update that includes docker environmental variable support for all config options. If specified, the custom env var value will supersede the default values in the config.json. You do not need to change the values in the config.json if you set a custom env var. For example, if you have headless=false in the config.json, but set it as true in the compose.yaml, it will run as HEADLESS=true. If you do not specify a particular env var, the script will automatically use the default value. Please test and contribute wherever possible!

* Fix scheduled runs, tidied up readme

* timezone support

Minor adjustment to attempt to fix timezone env var support

* Run on start, npm script env

Hopefully two fixes here, the container should again, by default, run on start, then continue per schedule. This defaults to true; however, can be optionally over-ridden in the compose.yaml with the env var RUN_ON_START=false. If set to false, the script should only run on the specified cron schedule. I also passed the TZ write into the npm start command, rather than just the container overall so it should show the proper time.

* Keep docker running after run_on_start to wait for cron

Accidentally set it up like a run_once, this should keep the container active after run_on_start to wait for the next schedule.

* improve order of cmd

This should (1) set time zone for script, (2) run once if set, then (3) idle for scheduled cron job. It was a little hacky before, this should be tidier.

* updated compose to auto-restart container

Noticed the container was exited this am, likely after automated updated to system, adding restart: unless-stopped to compose should keep container running in such circumstances.

* Update env vars in readme

2024-05-16 19:28:55 +02:00

src

Docker with env var support and containerized cron scheduling (#107 )

2024-05-16 19:28:55 +02:00

.eslintrc.js

1.0

2023-09-25 12:16:40 +02:00

.gitignore

Clarify docker instructions, add basic compose.yaml support

2024-04-03 17:59:16 -04:00

compose.yaml

Docker with env var support and containerized cron scheduling (#107 )

2024-05-16 19:28:55 +02:00

Dockerfile

Docker with env var support and containerized cron scheduling (#107 )

2024-05-16 19:28:55 +02:00

package.json

1.4.6

2024-05-09 10:04:11 +02:00

README.md

Docker with env var support and containerized cron scheduling (#107 )

2024-05-16 19:28:55 +02:00

tsconfig.json

1.2.2

2023-10-26 15:31:35 +02:00

Setting	Description	Default	Docker Environmental Variable
baseURL	MS Rewards page	`https://rewards.bing.com`	BASE_URL
sessionPath	Path to where you want sessions/fingerprints to be stored	`sessions` (In ./browser/sessions)	SESSION_PATH
headless	If the browser window should be visible be ran in the background	`false` (Browser is visible)	HEADLESS (must be set to `=true` for docker)
runOnZeroPoints	Run the rest of the script if 0 points can be earned	`false` (Will not run on 0 points)	RUN_ON_ZERO_POINTS
clusters	Amount of instances ran on launch, 1 per account	`1` (Will run 1 account at the time)	CLUSTERS
saveFingerprint	Re-use the same fingerprint each time	`false` (Will generate a new fingerprint each time)	SAVE_FINGERPRINT
workers.doDailySet	Complete daily set items	`true`	WORKERS_DO_DAILY_SET
workers.doMorePromotions	Complete promotional items	`true`	WORKERS_DO_MORE_PROMOTIONS
workers.doPunchCards	Complete punchcards	`true`	WORKERS_DO_PUNCH_CARDS
workers.doDesktopSearch	Complete daily desktop searches	`true`	WORKERS_DO_DESKTOP_SEARCH
workers.doMobileSearch	Complete daily mobile searches	`true`	WORKERS_DO_MOBILE_SEARCH
globalTimeout	The length before the action gets timeout	`30000` (30 seconds)	GLOBAL_TIMEOUT
searchSettings.useGeoLocaleQueries	Generate search queries based on your geo-location	`false` (Uses EN-US generated queries)	SEARCH_SETTINGS_USE_GEO_LOCALE_QUERIES
scrollRandomResults	Scroll randomly in search results	`true`	SEARCH_SETTINGS_SCROLL_RANDOM_RESULTS
searchSettings.clickRandomResults	Visit random website from search result	`true`	SEARCH_SETTINGS_CLICK_RANDOM_RESULTS
searchSettings.searchDelay	Minimum and maximum time in miliseconds between search queries	`min: 10000` (10 seconds) `max: 20000` (20 seconds)	SEARCH_DELAY_MIN SEARCH_DELAY_MAX
searchSettings.retryMobileSearch	Keep retrying mobile searches until completed (indefinite)	`false`	SEARCH_SETTINGS_RETRY_MOBILE_SEARCH
webhook.enabled	Enable or disable your set webhook	`false`	WEBHOOK_ENABLED
webhook.url	Your Discord webhook URL	`null`	WEBHOOK_URL=""
cronStartTime	Scheduled script run-time, only available for docker implementation	`0 5,11 * * *` (5:00 am, 11:00 am daily)	CRON_START_TIME=""
	Run the script immediately when the Docker container starts	`true`	RUN_ON_START

README.md

Microsoft-Rewards-Script

How to setup

Notes

Docker (Experimental)

Option 1: build and run with docker run

Option 2: use docker compose

Config

Features

Disclaimer