mirror of
https://github.com/TheNetsky/Microsoft-Rewards-Script.git
synced 2026-01-17 05:23:57 +00:00
15f62963f8
* first commit * Addition of a personalized activity manager and refactoring of the logic of activities * Adding diagnostics management, including screenshot and HTML content, as well as improvements to humanize page interactions and +. * Adding the management of newspapers and webhook settings, including filtering messages and improving the structure of the summaries sent. * Adding a post-execution auto-date functionality, including options to update via Git and Docker, as well as a new configuration interface to manage these parameters. * Adding accounts in Docker, with options to use an environmental file or online JSON data, as well as minimum validations for responsible accounts. * Improving the Microsoft Rewards script display with a new headband and better log management, including colors and improved formatting for the console. * v2 * Refactor ESLint configuration and scripts for improved TypeScript support and project structure * Addition of the detection of suspended accounts with the gesture of the improved errors and journalization of banishment reasons * Adding an integrated planner for programmed task execution, with configuration in Config.json and + * Edit * Remove texte * Updating of documentation and adding the management of humanization in the configuration and +. * Adding manual purchase method allowing users to spend points without automation, with monitoring of expenses and notifications. * Correction of documentation and improvement of configuration management for manual purchase mode, adding complete documentation and appropriate banner display. * Add comprehensive documentation for job state persistence, NTFY notifications, proxy configuration, scheduling, and auto-update features - Introduced job state persistence documentation to track progress and resume tasks. - Added NTFY push notifications integration guide for real-time alerts. - Documented proxy configuration options for enhanced privacy and network management. - Included scheduling configuration for automated script execution. - Implemented auto-update configuration to keep installations current with Git and Docker options. * Ajout d'Unt Système de Rapport d'Erreurs Communautaire pour Améliorerer le Débogage, incluant la Configuration et l'Envoi de Résumés D'Erreurs Anonyés à un webhook Discord. * Mini Edit * Mise à Jour du Readme.md pour Améliorerer la Présentation et La Claté, Ajout d'Un section sur les notifications en Temps Raine et Mise à Jour des badges pour la meille unibilité. * Documentation update * Edit README.md * Edit * Update README with legacy version link * Improvement of location data management and webhooks, adding configurations normalization * Force update for PR * Improvement of documentation and configuration options for Cron integration and Docker use * Improvement of planning documentation and adding a multi-pan-pancake in the daily execution script * Deletion of the CommunityReport functionality in accordance with the project policy * Addition of randomization of start -up schedules and surveillance time for planner executions * Refactor Docker setup to use built-in scheduler, removing cron dependencies and simplifying configuration options * Adding TOTP support for authentication, update of interfaces and configuration files to include Totp secret, and automatic generation of the Totp code when connecting. * Fix [LOGIN-NO-PROMPT] No dialogs (xX) * Reset the Totp field for email_1 in the accounts.example.json file * Reset the Totp field for email_1 in the Readme.md file * Improvement of Bing Research: Use of the 'Attacked' method for the research field, management of overlays and adding direct navigation in the event of entry failure. * Adding a complete security policy, including directives on vulnerability management, coordinated disclosure and user security advice. * Remove advanced environment variables section from README * Configuration and dockerfile update: Passage to Node 22, addition of management of the purchase method, deletion of obsolete scripts * Correction of the order of the sections in the Readme.md for better readability * Update of Readm and Security Policy: Addition of the method of purchase and clarification of security and confidentiality practices. * Improvement of the readability of the Readm and deletion of the mention of reporting of vulnerabilities in the security document. * Addition of humanization management and adaptive throttling to simulate more human behavior in bot activities. * Addition of humanization management: activation/deactivation of human gestures, configuration update and adding documentation on human mode. * Deletion of community error report functionality to respect the privacy policy * Addition of immediate banning alerts and vacation configuration in the Microsoft Rewards bot * Addition of immediate banning alerts and vacation configuration in the Microsoft Rewards bot * Added scheduling support: support for 12h and 24h formats, added options for time zone, and immediate execution on startup. * Added window size normalization and page rendering to fit typical screens, with injected CSS styles to prevent excessive zooming. * Added security incident management: detection of hidden recovery emails, automation blocking, and global alerts. Updated configuration files and interfaces to include recovery emails. Improved security incident documentation. * Refactor incident alert handling: unified alert sender * s * Added security incident management: detect recovery email inconsistencies and send unified alerts. Implemented helper methods to manage alerts and compromised modes. * Added heartbeat management for the scheduler: integrated a heartbeat file to report liveliness and adjusted the watchdog configuration to account for heartbeat updates. * Edit webook * Updated security alert management: fixed the recovery email hidden in the documentation and enabled the conclusion webhook for notifications. * Improved security alert handling: added structured sending to webhooks for better visibility and updated callback interval in compromised mode. * Edit conf * Improved dependency installation: Added the --ignore-scripts option for npm ci and npm install. Updated comments in compose.yaml for clarity. * Refactor documentation structure and enhance logging: - Moved documentation files from 'information' to 'docs' directory for better organization. - Added live logging configuration to support webhook logs with email redaction. - Updated file paths in configuration and loading functions to accommodate new structure. - Adjusted scheduler behavior to prevent immediate runs unless explicitly set. - Improved error handling for account and config file loading. - Enhanced security incident documentation with detailed recovery steps. * Fix docs * Remove outdated documentation on NTFY, Proxy, Scheduling, Security, and Auto-Update configurations; update Browser class to prioritize headless mode based on environment variable. * Addition of documentation for account management and Totp, Docker Guide, and Update of the Documentation Index. * Updating Docker documentation: simplification of instructions and adding links to detailed guides. Revision of configuration options and troubleshooting sections. * Edit * Edit docs * Enhance documentation for Scheduler, Security, and Auto-Update features - Revamped the Scheduler documentation to include detailed features, configuration options, and usage examples. - Expanded the Security guide with comprehensive incident response strategies, privacy measures, and monitoring practices. - Updated the Auto-Update section to clarify configuration, methods, and best practices for maintaining system integrity. * Improved error handling and added crash recovery in the Microsoft Rewards bot. Added configuration for automatic restart and handling of local search queries when trends fail. * Fixed initial point counting in MicrosoftRewardsBot and improved error handling when sending summaries to webhooks. * Added unified support for notifications and improved handling of webhook configurations in the normalizeConfig and log functions. * UPDATE LOGIN * EDIT LOGIN * Improved login error handling: added recovery mismatch detection and the ability to switch to password authentication. * Added a full reference to configuration in the documentation and improved log and error handling in the code. * Added context management for conclusion webhooks and improved user configuration for notifications. * Mini edit * Improved logic for extracting masked emails for more accurate matching during account recovery.
85 lines
2.8 KiB
Markdown
85 lines
2.8 KiB
Markdown
# 🐳 Docker Guide
|
||
|
||
<div align="center">
|
||
|
||
**⚡ Lightweight containerized deployment**
|
||
*Automated Microsoft Rewards with minimal Docker footprint*
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
## 🚀 Quick Start
|
||
|
||
### **Prerequisites**
|
||
- ✅ `src/accounts.json` configured with your Microsoft accounts
|
||
- ✅ `src/config.json` exists (uses defaults if not customized)
|
||
- ✅ Docker & Docker Compose installed
|
||
|
||
### **Launch**
|
||
```bash
|
||
# Build and start the container
|
||
docker compose up -d
|
||
|
||
# Monitor the automation
|
||
docker logs -f microsoft-rewards-script
|
||
|
||
# Stop when needed
|
||
docker compose down
|
||
```
|
||
|
||
**That's it!** The container runs the built-in scheduler automatically.uide
|
||
|
||
This project ships with a Docker setup tailored for headless runs. It uses Playwright’s Chromium Headless Shell to keep the image small.
|
||
|
||
## Quick Start
|
||
- Ensure you have `src/accounts.json` and `src/config.json` in the repo
|
||
- Build and start:
|
||
- `docker compose up -d`
|
||
- Follow logs:
|
||
- `docker logs -f microsoft-rewards-script`
|
||
|
||
## Volumes & Files
|
||
The compose file mounts:
|
||
- `./src/accounts.json` → `/usr/src/microsoft-rewards-script/accounts.json` (read‑only)
|
||
- `./src/config.json` → `/usr/src/microsoft-rewards-script/config.json` (read‑only)
|
||
- `./sessions` → `/usr/src/microsoft-rewards-script/sessions` (persist login sessions)
|
||
|
||
You can also use env overrides supported by the app loader:
|
||
- `ACCOUNTS_FILE=/path/to/accounts.json`
|
||
- `ACCOUNTS_JSON='[ {"email":"...","password":"..."} ]'`
|
||
|
||
## Environment
|
||
Useful variables:
|
||
- `TZ` — container time zone (e.g., `Europe/Paris`)
|
||
- `NODE_ENV=production`
|
||
- `FORCE_HEADLESS=1` — ensures headless mode inside the container
|
||
- Scheduler knobs (optional):
|
||
- `SCHEDULER_DAILY_JITTER_MINUTES_MIN` / `SCHEDULER_DAILY_JITTER_MINUTES_MAX`
|
||
- `SCHEDULER_PASS_TIMEOUT_MINUTES`
|
||
- `SCHEDULER_FORK_PER_PASS`
|
||
|
||
## Headless Browsers
|
||
The Docker image installs only Chromium Headless Shell via:
|
||
- `npx playwright install --with-deps --only-shell`
|
||
|
||
This dramatically reduces image size vs. installing all Playwright browsers.
|
||
|
||
## One‑shot vs. Scheduler
|
||
- Default command runs the built‑in scheduler: `npm run start:schedule`
|
||
- For one‑shot run, override the command:
|
||
- `docker run --rm ... node ./dist/index.js`
|
||
|
||
## Tips
|
||
- If you see 2FA prompts, add your TOTP Base32 secret to `accounts.json` so the bot can auto‑fill codes.
|
||
- Use a persistent `sessions` volume to avoid re‑logging every run.
|
||
- For proxies per account, fill the `proxy` block in your `accounts.json` (see [Proxy](./proxy.md)).
|
||
|
||
---
|
||
|
||
## 🔗 Related Guides
|
||
|
||
- **[Getting Started](./getting-started.md)** — Initial setup before containerization
|
||
- **[Accounts & 2FA](./accounts.md)** — Configure accounts for Docker
|
||
- **[Scheduler](./schedule.md)** — Alternative to Docker cron automation
|
||
- **[Proxy Configuration](./proxy.md)** — Network routing in containers |