mirror of
https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
synced 2026-01-10 01:06:17 +00:00
Enhance documentation with new sections on notifications and troubleshooting
- Updated index.md to improve structure and navigation, added new guides for getting started and feature explanations. - Created notifications.md detailing setup for Discord webhooks and NTFY mobile alerts, including examples and troubleshooting tips. - Added troubleshooting.md covering common issues, installation problems, login issues, account problems, browser issues, configuration problems, performance issues, and diagnostic log retrieval.
This commit is contained in:
188
README.md
188
README.md
@@ -4,90 +4,95 @@
|
|||||||
|
|
||||||
# Microsoft Rewards Bot
|
# Microsoft Rewards Bot
|
||||||
|
|
||||||
**Automate your Microsoft Rewards points collection effortlessly**
|
**Automate your Microsoft Rewards points collection**
|
||||||
|
|
||||||
[](https://discord.gg/k5uHkx9mne)
|
[](https://discord.gg/k5uHkx9mne)
|
||||||
[](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot)
|
[](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot)
|
||||||
[](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/releases)
|
[](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/releases)
|
||||||
[](LICENSE)
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## About
|
## 💡 What is this?
|
||||||
|
|
||||||
This TypeScript-based automation bot helps you maximize your **Microsoft Rewards** points by automatically completing daily tasks, searches, quizzes, and promotional offers. Designed with sophisticated anti-detection measures and human-like behavior patterns to ensure safe, reliable operation.
|
A **TypeScript bot** that automatically earns Microsoft Rewards points by completing:
|
||||||
|
|
||||||
### ✨ Key Features
|
- 🔍 Desktop & mobile Bing searches
|
||||||
|
- 📋 Daily quizzes, polls, and activities
|
||||||
|
- 🎁 Promotional offers and punch cards
|
||||||
|
- 📚 Read-to-earn tasks
|
||||||
|
|
||||||
- 🔍 **Automated Searches** — Desktop and mobile Bing searches with natural patterns
|
**Built with anti-detection** to work safely and reliably.
|
||||||
- 📅 **Daily Activities** — Quizzes, polls, daily sets, and punch cards
|
|
||||||
- 🤖 **Human-like Behavior** — Advanced humanization system to avoid detection
|
---
|
||||||
- 🛡️ **Risk Management** — Built-in ban detection and prediction with ML algorithms
|
|
||||||
- ⏰ **Automatic Scheduling** — Easy configuration for cron (Linux/Raspberry Pi) and Windows Task Scheduler
|
## ✨ Features
|
||||||
- 🔔 **Notifications** — Discord webhooks and NTFY push alerts
|
|
||||||
- 🐳 **Docker Support** — Easy containerized deployment
|
- 🤖 **Human-like behavior** — Natural search patterns
|
||||||
- 🔐 **Multi-Account** — Manage multiple accounts with parallel execution
|
- ⏰ **Auto-scheduling** — Set it and forget it
|
||||||
- 🌐 **Proxy Support** — Optional proxy configuration for enhanced privacy
|
- <EFBFBD> **Multi-account support** — Manage multiple accounts
|
||||||
|
- 🔔 **Notifications** — Discord webhooks & mobile alerts
|
||||||
|
- 🐳 **Docker ready** — Easy containerized deployment
|
||||||
|
- 🌐 **Proxy support** — Enhanced privacy (optional)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
### ⚡ Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- **Node.js 20+** (v22 recommended) — [Download here](https://nodejs.org/)
|
- **Node.js 20+** (v22 recommended) — [Download](https://nodejs.org/)
|
||||||
- **Git** (optional) — [Download here](https://git-scm.com/) or download project as ZIP
|
- **Microsoft account(s)** with email + password
|
||||||
|
|
||||||
### 🎯 3-Step Setup
|
### Installation
|
||||||
|
|
||||||
1. **Get the project:**
|
```bash
|
||||||
```bash
|
# 1. Download the project
|
||||||
git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git
|
git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git
|
||||||
cd Microsoft-Rewards-Bot
|
cd Microsoft-Rewards-Bot
|
||||||
```
|
|
||||||
Or download ZIP: [Code → Download ZIP](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/archive/refs/heads/main.zip)
|
|
||||||
|
|
||||||
2. **Install dependencies:**
|
# 2. Install dependencies
|
||||||
```bash
|
npm install
|
||||||
npm i
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Create accounts & configure:**
|
# 3. Setup and run
|
||||||
```bash
|
npm run setup
|
||||||
# Use our account creator (recommended - earn +7,500 points/month!)
|
```
|
||||||
npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com
|
|
||||||
|
|
||||||
# Or use setup wizard
|
|
||||||
npm run setup
|
|
||||||
```
|
|
||||||
|
|
||||||
**📖 Need detailed instructions? See [Getting Started Guide](docs/getting-started.md)**
|
**That's it!** The wizard will guide you through account setup and start earning points.
|
||||||
|
|
||||||
|
### 📖 Need Help?
|
||||||
|
|
||||||
|
**First time using the bot?** → [📘 Getting Started Guide](docs/getting-started.md)
|
||||||
|
|
||||||
|
The complete guide covers:
|
||||||
|
- ✅ Detailed installation steps
|
||||||
|
- ✅ Creating Microsoft accounts with referrals (+7,500 points/month!)
|
||||||
|
- ✅ Setting up 2FA authentication
|
||||||
|
- ✅ Configuration options
|
||||||
|
- ✅ Troubleshooting common issues
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📚 Documentation
|
## 📚 Documentation
|
||||||
|
|
||||||
For detailed configuration, advanced features, and troubleshooting, visit our comprehensive documentation:
|
**New to the bot?** Start here: **[📘 Getting Started Guide](docs/getting-started.md)**
|
||||||
|
|
||||||
**👉 [Complete Documentation](docs/index.md)**
|
**Need specific info?** Check the **[📖 Documentation Hub](docs/index.md)**
|
||||||
|
|
||||||
### Quick Links
|
<details>
|
||||||
|
<summary><strong>📑 Quick Links</strong></summary>
|
||||||
|
|
||||||
| Topic | Description |
|
| Guide | Description |
|
||||||
|-------|-------------|
|
|-------|-------------|
|
||||||
| **[Getting Started](docs/getting-started.md)** | Detailed installation and first-run guide |
|
| **[Getting Started](docs/getting-started.md)** | Complete installation tutorial |
|
||||||
| **[Configuration](docs/config.md)** | Complete configuration options reference |
|
| **[Accounts & 2FA](docs/accounts.md)** | Setup accounts with authentication |
|
||||||
| **[Accounts & 2FA](docs/accounts.md)** | Setting up accounts with TOTP authentication |
|
| **[Configuration](docs/config.md)** | Customize bot behavior |
|
||||||
| **[Dashboard](src/dashboard/README.md)** | 🆕 Local web dashboard for monitoring and control |
|
| **[Scheduling](docs/schedule.md)** | Automate with cron/Task Scheduler |
|
||||||
| **[External Scheduling](docs/schedule.md)** | Use OS schedulers for automation |
|
| **[Notifications](docs/notifications.md)** | Discord & mobile alerts |
|
||||||
| **[Docker Deployment](docs/docker.md)** | Running in containers |
|
| **[Troubleshooting](docs/troubleshooting.md)** | Fix common issues |
|
||||||
| **[Humanization](docs/humanization.md)** | Anti-detection and natural behavior |
|
|
||||||
| **[Notifications](docs/conclusionwebhook.md)** | Discord webhooks and NTFY setup |
|
</details>
|
||||||
| **[Error Reporting](docs/ERROR_REPORTING.md)** | 🆕 Automatic error reporting to help improve the project |
|
|
||||||
| **[Proxy Setup](docs/proxy.md)** | Configuring proxies for privacy |
|
|
||||||
| **[Troubleshooting](docs/diagnostics.md)** | Debug common issues and capture logs |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -127,17 +132,9 @@ Automatically create new Microsoft accounts with advanced security features:
|
|||||||
# Interactive mode (asks everything)
|
# Interactive mode (asks everything)
|
||||||
npm run creator
|
npm run creator
|
||||||
|
|
||||||
# With referral link (earn rewards credit)
|
|
||||||
npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE
|
|
||||||
|
|
||||||
# Auto-accept mode (enables recovery + 2FA automatically)
|
|
||||||
npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y
|
|
||||||
|
|
||||||
# With specific recovery email (auto-detected, no flag needed!)
|
# With specific recovery email (auto-detected, no flag needed!)
|
||||||
npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com
|
npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com
|
||||||
|
|
||||||
# Just recovery email, no referral
|
|
||||||
npm run creator -y myrecovery@gmail.com
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**✨ Features:**
|
**✨ Features:**
|
||||||
@@ -210,7 +207,7 @@ Configure automatic task scheduling directly from `config.jsonc` - **perfect for
|
|||||||
|
|
||||||
**Then simply run:**
|
**Then simply run:**
|
||||||
```bash
|
```bash
|
||||||
npm run start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
The bot will automatically configure cron (Linux/Raspberry Pi) or Task Scheduler (Windows) for you!
|
The bot will automatically configure cron (Linux/Raspberry Pi) or Task Scheduler (Windows) for you!
|
||||||
@@ -315,74 +312,39 @@ All while maintaining **natural behavior patterns** to minimize detection risk.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🆘 Getting Help
|
## 🆘 Need Help?
|
||||||
|
|
||||||
- 💬 **[Join our Discord](https://discord.gg/k5uHkx9mne)** — Community support and updates
|
- 💬 **[Discord Community](https://discord.gg/k5uHkx9mne)** — Get support & updates
|
||||||
- 📖 **[Documentation Hub](docs/index.md)** — Complete guides and references
|
- 📖 **[Documentation](docs/index.md)** — Complete guides
|
||||||
- 🐛 **[Report Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Bug reports and feature requests
|
- 🐛 **[Report Bug](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found an issue?
|
||||||
- 📧 **[Troubleshooting Guide](docs/diagnostics.md)** — Debug common issues
|
- <EFBFBD> **[Troubleshooting](docs/troubleshooting.md)** — Fix common problems
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚠️ Disclaimer
|
## ⚠️ Disclaimer
|
||||||
|
|
||||||
**Use at your own risk.** This script automates interactions with Microsoft Rewards, which may violate [Microsoft's Terms of Service](https://www.microsoft.com/en-us/servicesagreement/). Using automation tools can result in:
|
This bot automates Microsoft Rewards interactions, which **may violate their Terms of Service**.
|
||||||
|
|
||||||
- ⚠️ Account suspension or permanent ban
|
**Risks:**
|
||||||
- 🚫 Loss of accumulated points and rewards
|
- ⚠️ Account suspension or ban
|
||||||
- 🔒 Restriction from future participation
|
- 🚫 Loss of points and rewards
|
||||||
|
|
||||||
**This project is provided for educational and research purposes only.** The developers and contributors:
|
**Educational purposes only.** Use at your own risk.
|
||||||
- Are **not responsible** for any actions taken by Microsoft against your account
|
|
||||||
- Do **not encourage** violating terms of service
|
|
||||||
- Provide **no guarantees** regarding account safety
|
|
||||||
|
|
||||||
**Use responsibly and at your own discretion.**
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
|
|
||||||
This project is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License**.
|
**CC BY-NC-SA 4.0** — Personal use only, no commercial use.
|
||||||
|
|
||||||
**You may:**
|
See [LICENSE](LICENSE) for details.
|
||||||
- ✅ Use for personal, non-commercial purposes
|
|
||||||
- ✅ Modify the code for your own use
|
|
||||||
- ✅ Share with others (with same restrictions)
|
|
||||||
- ✅ Submit improvements via pull requests
|
|
||||||
|
|
||||||
**You may NOT:**
|
|
||||||
- ❌ Use for commercial purposes
|
|
||||||
- ❌ Sell or monetize this software
|
|
||||||
- ❌ Remove license/copyright notices
|
|
||||||
|
|
||||||
See [LICENSE](LICENSE) for complete terms.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🙏 Acknowledgments
|
|
||||||
|
|
||||||
- Built with [Playwright](https://playwright.dev/) and [ReBrowser](https://github.com/rebrowser/rebrowser-playwright)
|
|
||||||
- Thanks to all [contributors](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/graphs/contributors)
|
|
||||||
- Community support via [Discord](https://discord.gg/k5uHkx9mne)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🌟 Support the Project
|
|
||||||
|
|
||||||
If you find this project helpful:
|
|
||||||
|
|
||||||
- ⭐ **Star the repository** on GitHub
|
|
||||||
- 💬 **Join our Discord** community
|
|
||||||
- 🐛 **Report bugs** and suggest features
|
|
||||||
- 📖 **Contribute** to documentation
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
**Made with ❤️ by the community**
|
**⭐ Star the repo** • **💬 [Join Discord](https://discord.gg/k5uHkx9mne)** • **<EFBFBD> [Documentation](docs/index.md)**
|
||||||
|
|
||||||
[Documentation](docs/index.md) • [Discord](https://discord.gg/k5uHkx9mne) • [Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)
|
Made with ❤️ by the community
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
268
docs/index.md
268
docs/index.md
@@ -1,52 +1,228 @@
|
|||||||
|
<div align="center"><div align="center">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<img src="../assets/logo.png" alt="Microsoft Rewards Bot Logo" width="150"/># 📚 Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# 📚 Documentation Hub**Complete guide for Microsoft Rewards Bot**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**Complete guides for Microsoft Rewards Bot**[← Back to Main](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[← Back to Main](../README.md)</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div>---
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
---## 🚀 Quick Start (3 Steps)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🚀 Getting Started1. **[Setup Accounts](accounts.md)** — Add credentials + 2FA
|
||||||
|
|
||||||
|
2. **[Configure Bot](config.md)** — Essential settings
|
||||||
|
|
||||||
|
**New to the bot?** Start with these guides in order:3. **[Schedule Runs](schedule.md)** — Use OS-level automation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Step | Guide | What You'll Learn |**Done!** The bot will run automatically.
|
||||||
|
|
||||||
|
|------|-------|-------------------|
|
||||||
|
|
||||||
|
| **1** | **[📘 Getting Started](getting-started.md)** | Installation, account setup, first run |---
|
||||||
|
|
||||||
|
| **2** | **[👤 Accounts & 2FA](accounts.md)** | Add accounts, enable TOTP authentication |
|
||||||
|
|
||||||
|
| **3** | **[⚙️ Configuration](config.md)** | Customize bot behavior and features |## ✨ Feature Guides
|
||||||
|
|
||||||
|
| **4** | **[⏰ Scheduling](schedule.md)** | Automate daily runs with cron/Task Scheduler |
|
||||||
|
|
||||||
|
| Feature | Description |
|
||||||
|
|
||||||
|
**That's all you need to get started!** The guides above cover everything for basic usage.|---------|-------------|
|
||||||
|
|
||||||
|
| **[Configuration](config.md)** | All settings explained |
|
||||||
|
|
||||||
|
---| **[External Scheduling](schedule.md)** | Automate with cron or Task Scheduler |
|
||||||
|
|
||||||
|
| **[Humanization](humanization.md)** | Anti-detection system |
|
||||||
|
|
||||||
|
## 📖 Feature Guides| **[Webhooks](conclusionwebhook.md)** | Discord notifications |
|
||||||
|
|
||||||
|
| **[Error Reporting](ERROR_REPORTING.md)** | 🆕 Automatic error reporting |
|
||||||
|
|
||||||
|
Explore advanced features and customization options:| **[NTFY Alerts](ntfy.md)** | Mobile push notifications |
|
||||||
|
|
||||||
|
| **[Proxy Setup](proxy.md)** | IP rotation (optional) |
|
||||||
|
|
||||||
|
### Core Features| **[Docker](docker.md)** | Container deployment |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Guide | Description |---
|
||||||
|
|
||||||
|
|-------|-------------|
|
||||||
|
|
||||||
|
| **[🔔 Notifications](notifications.md)** | Discord webhooks and mobile push alerts |## 🆘 Troubleshooting
|
||||||
|
|
||||||
|
| **[📊 Dashboard](../src/dashboard/README.md)** | Web interface for monitoring and control |
|
||||||
|
|
||||||
|
| **[🌐 Proxy Setup](proxy.md)** | Configure proxies for privacy || Issue | Solution |
|
||||||
|
|
||||||
|
| **[🤖 Humanization](humanization.md)** | Anti-detection and natural behavior patterns ||-------|----------|
|
||||||
|
|
||||||
|
| **Bot not working?** | [Troubleshooting Guide](diagnostics.md) |
|
||||||
|
|
||||||
|
### Deployment| **Login failed?** | [Accounts & 2FA](accounts.md#troubleshooting) |
|
||||||
|
|
||||||
|
| **Account banned?** | [Security Guide](security.md) |
|
||||||
|
|
||||||
|
| Guide | Description || **Git conflicts?** | [Conflict Resolution](git-conflict-resolution.md) |
|
||||||
|
|
||||||
|
|-------|-------------|| **General questions?** | [FAQ](FAQ.md) |
|
||||||
|
|
||||||
|
| **[🐳 Docker](docker.md)** | Containerized deployment with Docker Compose |
|
||||||
|
|
||||||
|
| **[☁️ Cloud Deployment](cloud-deployment.md)** | Deploy to VPS, Raspberry Pi, or cloud services |**Need help?** → [Discord Community](https://discord.gg/k5uHkx9mne)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Advanced---
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Guide | Description |[← Back to Main](../README.md)
|
||||||
|
|
||||||
|
|-------|-------------|
|
||||||
|
| **[🔧 Advanced Configuration](advanced-config.md)** | Power user settings and optimization |
|
||||||
|
| **[🛡️ Security Best Practices](security.md)** | Account protection and risk management |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🆕 Account Creator
|
||||||
|
|
||||||
|
**Create new Microsoft accounts with the built-in account creator:**
|
||||||
|
|
||||||
|
| Guide | Description |
|
||||||
|
|-------|-------------|
|
||||||
|
| **[🎯 Account Creator Guide](../src/account-creation/README.md)** | Create accounts with 2FA and referral links |
|
||||||
|
| **[💰 Referral System](referrals.md)** | Earn 7,500 points/month per referral |
|
||||||
|
|
||||||
|
**Quick command:**
|
||||||
|
```bash
|
||||||
|
npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🆘 Help & Troubleshooting
|
||||||
|
|
||||||
|
Having issues? Check these resources:
|
||||||
|
|
||||||
|
### Common Issues
|
||||||
|
|
||||||
|
| Problem | Solution |
|
||||||
|
|---------|----------|
|
||||||
|
| **Bot not starting** | [Troubleshooting Guide](troubleshooting.md) |
|
||||||
|
| **Login failures** | [Accounts & 2FA Setup](accounts.md#troubleshooting) |
|
||||||
|
| **Account banned** | [Security Guide](security.md) |
|
||||||
|
| **Configuration errors** | [Config Reference](config.md) |
|
||||||
|
|
||||||
|
### Support Resources
|
||||||
|
|
||||||
|
- 💬 **[Discord Community](https://discord.gg/k5uHkx9mne)** — Get help from the community
|
||||||
|
- 🐛 **[GitHub Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Report bugs
|
||||||
|
- 📖 **[FAQ](FAQ.md)** — Frequently asked questions
|
||||||
|
- 🔍 **[Diagnostics Guide](diagnostics.md)** — Debug and capture logs
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 Reference Documentation
|
||||||
|
|
||||||
|
Technical references and detailed information:
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
| Document | Description |
|
||||||
|
|----------|-------------|
|
||||||
|
| **[Config Reference](config.md)** | Complete `config.jsonc` options |
|
||||||
|
| **[Accounts Reference](accounts.md)** | Complete `accounts.jsonc` schema |
|
||||||
|
| **[Environment Variables](environment-variables.md)** | Available env vars for CI/Docker |
|
||||||
|
|
||||||
|
### Technical
|
||||||
|
|
||||||
|
| Document | Description |
|
||||||
|
|----------|-------------|
|
||||||
|
| **[API Documentation](../src/dashboard/README.md)** | Dashboard REST API endpoints |
|
||||||
|
| **[Error Reporting](ERROR_REPORTING.md)** | Automatic error reporting system |
|
||||||
|
| **[Changelog](../CHANGELOG.md)** | Version history and changes |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎓 Guides by Topic
|
||||||
|
|
||||||
|
### For Beginners
|
||||||
|
|
||||||
|
1. [Getting Started](getting-started.md) — Start here!
|
||||||
|
2. [Accounts & 2FA](accounts.md) — Setup your accounts
|
||||||
|
3. [First Run](getting-started.md#-first-run) — Test the bot
|
||||||
|
4. [Scheduling](schedule.md) — Automate daily runs
|
||||||
|
|
||||||
|
### For Raspberry Pi Users
|
||||||
|
|
||||||
|
1. [Getting Started](getting-started.md) — Installation steps
|
||||||
|
2. [Scheduling](schedule.md) — Setup cron for daily runs
|
||||||
|
3. [Notifications](notifications.md) — Get mobile alerts
|
||||||
|
4. [Cloud Deployment](cloud-deployment.md) — Run 24/7
|
||||||
|
|
||||||
|
### For Docker Users
|
||||||
|
|
||||||
|
1. [Docker Guide](docker.md) — Setup Docker Compose
|
||||||
|
2. [Environment Variables](environment-variables.md) — Configure via env vars
|
||||||
|
3. [Notifications](notifications.md) — Monitor container runs
|
||||||
|
|
||||||
|
### For Multiple Accounts
|
||||||
|
|
||||||
|
1. [Accounts & 2FA](accounts.md) — Manage multiple accounts
|
||||||
|
2. [Proxy Setup](proxy.md) — Use different IPs per account
|
||||||
|
3. [Advanced Config](advanced-config.md) — Parallel execution
|
||||||
|
4. [Referrals](referrals.md) — Earn bonus points
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔗 External Resources
|
||||||
|
|
||||||
|
- **[Microsoft Rewards](https://rewards.bing.com/)** — Official Microsoft Rewards site
|
||||||
|
- **[Playwright Docs](https://playwright.dev/)** — Browser automation framework
|
||||||
|
- **[Node.js](https://nodejs.org/)** — JavaScript runtime
|
||||||
|
- **[TypeScript](https://www.typescriptlang.org/)** — Programming language
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🤝 Contributing
|
||||||
|
|
||||||
|
Want to help improve the bot?
|
||||||
|
|
||||||
|
- 📖 **[Contributing Guide](../CONTRIBUTING.md)** — How to contribute
|
||||||
|
- 🐛 **[Report Bugs](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found an issue?
|
||||||
|
- 💡 **[Feature Requests](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Suggest new features
|
||||||
|
- 📝 **[Improve Docs](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/tree/main/docs)** — Help with documentation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
# 📚 Documentation
|
**Need help?** [Join our Discord](https://discord.gg/k5uHkx9mne)
|
||||||
|
|
||||||
**Complete guide for Microsoft Rewards Bot**
|
|
||||||
|
|
||||||
[← Back to Main](../README.md)
|
[← Back to Main](../README.md)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🚀 Quick Start (3 Steps)
|
|
||||||
|
|
||||||
1. **[Setup Accounts](accounts.md)** — Add credentials + 2FA
|
|
||||||
2. **[Configure Bot](config.md)** — Essential settings
|
|
||||||
3. **[Schedule Runs](schedule.md)** — Use OS-level automation
|
|
||||||
|
|
||||||
**Done!** The bot will run automatically.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ✨ Feature Guides
|
|
||||||
|
|
||||||
| Feature | Description |
|
|
||||||
|---------|-------------|
|
|
||||||
| **[Configuration](config.md)** | All settings explained |
|
|
||||||
| **[External Scheduling](schedule.md)** | Automate with cron or Task Scheduler |
|
|
||||||
| **[Humanization](humanization.md)** | Anti-detection system |
|
|
||||||
| **[Webhooks](conclusionwebhook.md)** | Discord notifications |
|
|
||||||
| **[Error Reporting](ERROR_REPORTING.md)** | 🆕 Automatic error reporting |
|
|
||||||
| **[NTFY Alerts](ntfy.md)** | Mobile push notifications |
|
|
||||||
| **[Proxy Setup](proxy.md)** | IP rotation (optional) |
|
|
||||||
| **[Docker](docker.md)** | Container deployment |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🆘 Troubleshooting
|
|
||||||
|
|
||||||
| Issue | Solution |
|
|
||||||
|-------|----------|
|
|
||||||
| **Bot not working?** | [Troubleshooting Guide](diagnostics.md) |
|
|
||||||
| **Login failed?** | [Accounts & 2FA](accounts.md#troubleshooting) |
|
|
||||||
| **Account banned?** | [Security Guide](security.md) |
|
|
||||||
| **Git conflicts?** | [Conflict Resolution](git-conflict-resolution.md) |
|
|
||||||
| **General questions?** | [FAQ](FAQ.md) |
|
|
||||||
|
|
||||||
**Need help?** → [Discord Community](https://discord.gg/k5uHkx9mne)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[← Back to Main](../README.md)
|
|
||||||
|
|||||||
358
docs/notifications.md
Normal file
358
docs/notifications.md
Normal file
@@ -0,0 +1,358 @@
|
|||||||
|
# 🔔 Notifications
|
||||||
|
|
||||||
|
**Get alerts when the bot completes its run**
|
||||||
|
|
||||||
|
[← Back to Documentation](index.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📋 Table of Contents
|
||||||
|
|
||||||
|
- [Discord Webhooks](#-discord-webhooks)
|
||||||
|
- [NTFY Mobile Alerts](#-ntfy-mobile-alerts)
|
||||||
|
- [Comparison](#-comparison)
|
||||||
|
- [Examples](#-examples)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 💬 Discord Webhooks
|
||||||
|
|
||||||
|
Get detailed run summaries sent to your Discord server.
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
#### 1. Create Webhook in Discord
|
||||||
|
|
||||||
|
1. Open your Discord server
|
||||||
|
2. Go to **Server Settings** → **Integrations** → **Webhooks**
|
||||||
|
3. Click **New Webhook**
|
||||||
|
4. Name it (e.g., "Microsoft Rewards Bot")
|
||||||
|
5. Choose a channel
|
||||||
|
6. Click **Copy Webhook URL**
|
||||||
|
|
||||||
|
#### 2. Add to Configuration
|
||||||
|
|
||||||
|
Edit `src/config.jsonc`:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "https://discord.com/api/webhooks/123456789/AbCdEfGhIjKlMnOpQrStUvWxYz"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### What You'll Receive
|
||||||
|
|
||||||
|
**Rich embeds with**:
|
||||||
|
- ✅ Total points earned
|
||||||
|
- 📊 Per-account breakdown
|
||||||
|
- ⏱️ Run duration
|
||||||
|
- 🎯 Completion status
|
||||||
|
- ⚠️ Errors and warnings
|
||||||
|
|
||||||
|
**Example message**:
|
||||||
|
```
|
||||||
|
🎉 Microsoft Rewards Summary
|
||||||
|
|
||||||
|
Total Points: 450
|
||||||
|
Duration: 12 minutes
|
||||||
|
Accounts Processed: 3/3
|
||||||
|
|
||||||
|
✅ account1@outlook.com: 150 points (45s)
|
||||||
|
✅ account2@outlook.com: 150 points (48s)
|
||||||
|
✅ account3@outlook.com: 150 points (42s)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Advanced Options
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "YOUR_WEBHOOK_URL",
|
||||||
|
"username": "Rewards Bot", // Custom bot name
|
||||||
|
"avatar": "https://example.com/avatar.png", // Custom avatar
|
||||||
|
"color": 3447003, // Embed color (decimal)
|
||||||
|
"onlyOnError": false, // Send only when errors occur
|
||||||
|
"pingOnError": true // @mention on errors
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Multiple Webhooks
|
||||||
|
|
||||||
|
Send to different channels:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "WEBHOOK_FOR_SUCCESS",
|
||||||
|
"errorWebhookUrl": "WEBHOOK_FOR_ERRORS" // Separate channel for errors
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📱 NTFY Mobile Alerts
|
||||||
|
|
||||||
|
Get **instant push notifications** on your phone with [ntfy.sh](https://ntfy.sh/).
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
#### 1. Install NTFY App
|
||||||
|
|
||||||
|
- **Android**: [Google Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy)
|
||||||
|
- **iOS**: [App Store](https://apps.apple.com/us/app/ntfy/id1625396347)
|
||||||
|
- **Web**: https://ntfy.sh/app
|
||||||
|
|
||||||
|
#### 2. Choose a Topic
|
||||||
|
|
||||||
|
Pick a **unique topic name** (acts as your channel):
|
||||||
|
- Examples: `rewards-bot-john`, `msrewards-12345`
|
||||||
|
- Keep it secret to avoid spam!
|
||||||
|
|
||||||
|
#### 3. Subscribe in App
|
||||||
|
|
||||||
|
1. Open NTFY app
|
||||||
|
2. Tap **+** or **Subscribe**
|
||||||
|
3. Enter your topic name
|
||||||
|
4. Save
|
||||||
|
|
||||||
|
#### 4. Add to Configuration
|
||||||
|
|
||||||
|
Edit `src/config.jsonc`:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"ntfy": {
|
||||||
|
"enabled": true,
|
||||||
|
"topic": "your-unique-topic-name", // From step 2
|
||||||
|
"priority": 3, // 1-5 (3 = default, 5 = urgent)
|
||||||
|
"tags": ["robot", "money"] // Optional emojis
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### What You'll Receive
|
||||||
|
|
||||||
|
**Simple push notifications**:
|
||||||
|
- ✅ Bot completion status
|
||||||
|
- 📊 Total points earned
|
||||||
|
- ⚠️ Error alerts
|
||||||
|
- ⏱️ Run duration
|
||||||
|
|
||||||
|
**Example notification**:
|
||||||
|
```
|
||||||
|
🤖 Rewards Bot Complete
|
||||||
|
|
||||||
|
✅ 3 accounts processed
|
||||||
|
💰 450 points earned
|
||||||
|
⏱️ 12 minutes
|
||||||
|
```
|
||||||
|
|
||||||
|
### Priority Levels
|
||||||
|
|
||||||
|
| Priority | Behavior | When to Use |
|
||||||
|
|----------|----------|-------------|
|
||||||
|
| 1 | Min | Background only, no sound |
|
||||||
|
| 2 | Low | Vibrate only |
|
||||||
|
| 3 | **Default** | Normal notification |
|
||||||
|
| 4 | High | Makes sound |
|
||||||
|
| 5 | Max | Critical alert, repeats |
|
||||||
|
|
||||||
|
**Recommended**: Priority 3 or 4 for most use cases.
|
||||||
|
|
||||||
|
### Custom NTFY Server
|
||||||
|
|
||||||
|
Using your own NTFY server:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"ntfy": {
|
||||||
|
"enabled": true,
|
||||||
|
"server": "https://ntfy.yourdomain.com", // Your server
|
||||||
|
"topic": "your-topic",
|
||||||
|
"priority": 3
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Advanced Options
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"ntfy": {
|
||||||
|
"enabled": true,
|
||||||
|
"topic": "your-topic",
|
||||||
|
"priority": 4,
|
||||||
|
"tags": ["robot", "chart_increasing"], // Emojis in notification
|
||||||
|
"title": "Rewards Bot", // Custom title
|
||||||
|
"clickUrl": "https://rewards.bing.com", // URL to open on click
|
||||||
|
"attachUrl": "https://example.com/image.png", // Attach image
|
||||||
|
"onlyOnError": false, // Send only on errors
|
||||||
|
"email": "you@example.com" // Also send email
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Available Tags (Emojis)
|
||||||
|
|
||||||
|
Common ones:
|
||||||
|
- `robot`, `money`, `chart`, `check`, `warning`, `fire`
|
||||||
|
- Full list: https://ntfy.sh/docs/emojis/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚖️ Comparison
|
||||||
|
|
||||||
|
| Feature | Discord Webhooks | NTFY |
|
||||||
|
|---------|------------------|------|
|
||||||
|
| **Setup** | Medium (need server) | Easy (just install app) |
|
||||||
|
| **Detail** | Rich embeds with full stats | Simple text notifications |
|
||||||
|
| **Speed** | Fast | Instant |
|
||||||
|
| **Mobile** | Requires Discord app | Dedicated notifications app |
|
||||||
|
| **Free** | ✅ Yes | ✅ Yes |
|
||||||
|
| **Privacy** | Data goes to Discord | Self-hostable |
|
||||||
|
| **Best For** | Detailed reports | Quick alerts |
|
||||||
|
|
||||||
|
**Recommendation**: Use **both**!
|
||||||
|
- Discord for detailed daily reports
|
||||||
|
- NTFY for instant mobile alerts
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📝 Examples
|
||||||
|
|
||||||
|
### Both Enabled (Recommended)
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "YOUR_DISCORD_WEBHOOK"
|
||||||
|
},
|
||||||
|
"ntfy": {
|
||||||
|
"enabled": true,
|
||||||
|
"topic": "your-unique-topic",
|
||||||
|
"priority": 3,
|
||||||
|
"tags": ["robot", "money"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Errors Only
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "YOUR_DISCORD_WEBHOOK",
|
||||||
|
"onlyOnError": true // Only send when something goes wrong
|
||||||
|
},
|
||||||
|
"ntfy": {
|
||||||
|
"enabled": true,
|
||||||
|
"topic": "your-topic",
|
||||||
|
"priority": 5, // Max priority for errors
|
||||||
|
"onlyOnError": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Different Priorities for Success/Error
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"ntfy": {
|
||||||
|
"enabled": true,
|
||||||
|
"topic": "your-topic",
|
||||||
|
"priority": 3, // Normal for success
|
||||||
|
"priorityOnError": 5, // Urgent for errors
|
||||||
|
"tags": ["robot"],
|
||||||
|
"tagsOnError": ["warning", "fire"] // Different emoji on error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom Formatting
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "YOUR_WEBHOOK",
|
||||||
|
"username": "🤖 Rewards Bot",
|
||||||
|
"color": 3066993, // Green color (decimal)
|
||||||
|
"footer": "Powered by Microsoft Rewards Bot",
|
||||||
|
"timestamp": true // Show timestamp
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔧 Troubleshooting
|
||||||
|
|
||||||
|
### Discord webhook not working
|
||||||
|
|
||||||
|
**Check**:
|
||||||
|
1. Webhook URL is correct (starts with `https://discord.com/api/webhooks/`)
|
||||||
|
2. Webhook still exists in Discord server settings
|
||||||
|
3. Bot has permissions to send webhooks
|
||||||
|
4. Check console for error messages
|
||||||
|
|
||||||
|
**Test manually**:
|
||||||
|
```bash
|
||||||
|
curl -X POST "YOUR_WEBHOOK_URL" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"content": "Test message"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
### NTFY notifications not arriving
|
||||||
|
|
||||||
|
**Check**:
|
||||||
|
1. Topic name is correct (case-sensitive!)
|
||||||
|
2. Subscribed in app with same topic
|
||||||
|
3. App has notification permissions
|
||||||
|
4. Internet connection is stable
|
||||||
|
5. Not using a banned/common topic name
|
||||||
|
|
||||||
|
**Test manually**:
|
||||||
|
```bash
|
||||||
|
curl -d "Test notification" "https://ntfy.sh/your-topic"
|
||||||
|
```
|
||||||
|
|
||||||
|
Or visit in browser: https://ntfy.sh/your-topic
|
||||||
|
|
||||||
|
### Rate limiting
|
||||||
|
|
||||||
|
If sending too many notifications:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"conclusionWebhook": {
|
||||||
|
"enabled": true,
|
||||||
|
"webhookUrl": "YOUR_WEBHOOK",
|
||||||
|
"debounceMs": 5000 // Wait 5s between messages
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🆘 Need Help?
|
||||||
|
|
||||||
|
- 💬 **[Discord Community](https://discord.gg/k5uHkx9mne)** — Get support
|
||||||
|
- 📖 **[Configuration Guide](config.md)** — All config options
|
||||||
|
- 🐛 **[Report Issue](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found a bug?
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
[← Back to Documentation](index.md)
|
||||||
|
|
||||||
|
</div>
|
||||||
402
docs/troubleshooting.md
Normal file
402
docs/troubleshooting.md
Normal file
@@ -0,0 +1,402 @@
|
|||||||
|
# 🔧 Troubleshooting
|
||||||
|
|
||||||
|
**Common issues and how to fix them**
|
||||||
|
|
||||||
|
[← Back to Documentation](index.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📋 Table of Contents
|
||||||
|
|
||||||
|
- [Installation Issues](#-installation-issues)
|
||||||
|
- [Login Problems](#-login-problems)
|
||||||
|
- [Account Issues](#-account-issues)
|
||||||
|
- [Browser Issues](#-browser-issues)
|
||||||
|
- [Configuration Problems](#-configuration-problems)
|
||||||
|
- [Performance Issues](#-performance-issues)
|
||||||
|
- [Getting Diagnostic Logs](#-getting-diagnostic-logs)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📦 Installation Issues
|
||||||
|
|
||||||
|
### "npm install" fails
|
||||||
|
|
||||||
|
**Problem**: Dependencies won't install
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
```bash
|
||||||
|
# Clear npm cache
|
||||||
|
npm cache clean --force
|
||||||
|
|
||||||
|
# Delete node_modules and try again
|
||||||
|
rm -rf node_modules package-lock.json
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Try with legacy peer deps
|
||||||
|
npm install --legacy-peer-deps
|
||||||
|
```
|
||||||
|
|
||||||
|
### "npm run build" fails
|
||||||
|
|
||||||
|
**Problem**: TypeScript compilation errors
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
```bash
|
||||||
|
# Make sure you have the latest dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Check Node.js version (needs 20+)
|
||||||
|
node --version
|
||||||
|
|
||||||
|
# Try cleaning build cache
|
||||||
|
npm run build --clean
|
||||||
|
```
|
||||||
|
|
||||||
|
### Permission denied (Linux/Mac)
|
||||||
|
|
||||||
|
**Problem**: Can't run setup scripts
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
```bash
|
||||||
|
chmod +x setup/setup.sh
|
||||||
|
bash setup/setup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Execution policy error (Windows)
|
||||||
|
|
||||||
|
**Problem**: PowerShell blocks scripts
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
```powershell
|
||||||
|
# Run as Administrator
|
||||||
|
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
|
||||||
|
|
||||||
|
# Then run setup
|
||||||
|
.\setup\setup.bat
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔐 Login Problems
|
||||||
|
|
||||||
|
### "Account credentials are invalid"
|
||||||
|
|
||||||
|
**Cause**: Wrong email/password or missing TOTP
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Verify credentials** in `src/accounts.jsonc`
|
||||||
|
2. **Test manually** at https://login.live.com/
|
||||||
|
3. **Check TOTP** if 2FA enabled (see [Accounts Guide](accounts.md))
|
||||||
|
4. **Check for typos** in email/password (copy-paste recommended)
|
||||||
|
|
||||||
|
### "TOTP challenge still present after multiple attempts"
|
||||||
|
|
||||||
|
**Cause**: Invalid TOTP secret or time sync issue
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Verify TOTP secret** format (Base32, no spaces)
|
||||||
|
2. **Check system time** is accurate (use NTP)
|
||||||
|
3. **Re-setup 2FA** and get new secret
|
||||||
|
4. **Test with authenticator app** first
|
||||||
|
|
||||||
|
Example of valid TOTP:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"email": "test@outlook.com",
|
||||||
|
"password": "password123",
|
||||||
|
"totp": "JBSWY3DPEHPK3PXP" // ✅ Valid Base32
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### "Login timeout" or "Page did not load"
|
||||||
|
|
||||||
|
**Cause**: Network issues or slow connection
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Check internet connection**
|
||||||
|
2. **Increase timeout** in `config.jsonc`:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"browserConfig": {
|
||||||
|
"timeout": 60000 // Increase to 60 seconds
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
3. **Use proxy** if connection is unreliable
|
||||||
|
4. **Disable VPN** temporarily to test
|
||||||
|
|
||||||
|
### "Recovery email mismatch detected"
|
||||||
|
|
||||||
|
**Cause**: Recovery email in config doesn't match Microsoft's records
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Check recovery email** on https://account.microsoft.com/
|
||||||
|
2. **Update `accounts.jsonc`** with correct recovery email
|
||||||
|
3. **Leave empty** if no recovery email set:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"recoveryEmail": ""
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚫 Account Issues
|
||||||
|
|
||||||
|
### "Account suspended" or "Ban detected"
|
||||||
|
|
||||||
|
**Cause**: Microsoft detected automation
|
||||||
|
|
||||||
|
**Prevention**:
|
||||||
|
- ✅ **Always enable humanization** in config
|
||||||
|
- ✅ **Run once per day maximum**
|
||||||
|
- ✅ **Use different proxies** per account
|
||||||
|
- ✅ **Don't run multiple accounts** from same IP
|
||||||
|
|
||||||
|
**Recovery Steps**:
|
||||||
|
1. **Wait 24-48 hours** before trying again
|
||||||
|
2. **Use account recovery** with birthdate/recovery code from `accounts-created/`
|
||||||
|
3. **Contact Microsoft support** if permanently banned
|
||||||
|
4. **Check [Security Guide](security.md)** for best practices
|
||||||
|
|
||||||
|
### "Account locked" message
|
||||||
|
|
||||||
|
**Cause**: Too many failed login attempts
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
1. Go to https://account.live.com/acsr
|
||||||
|
2. Follow the account recovery process
|
||||||
|
3. Use birthdate from `accounts-created/` file
|
||||||
|
4. Wait 24 hours before running bot again
|
||||||
|
|
||||||
|
### "Verify it's you" security challenge
|
||||||
|
|
||||||
|
**Cause**: Microsoft wants additional verification
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Complete manually** at https://account.microsoft.com/
|
||||||
|
2. **Add recovery email** if not set
|
||||||
|
3. **Enable 2FA** for better trust
|
||||||
|
4. **Use proxy** to avoid location inconsistencies
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🌐 Browser Issues
|
||||||
|
|
||||||
|
### "Browser launch failed" or "Executable doesn't exist"
|
||||||
|
|
||||||
|
**Cause**: Playwright browser not installed
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
```bash
|
||||||
|
npx playwright install chromium
|
||||||
|
|
||||||
|
# Or install all browsers
|
||||||
|
npx playwright install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Browser crashes or freezes
|
||||||
|
|
||||||
|
**Cause**: Memory issues or system resources
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Close other applications**
|
||||||
|
2. **Reduce clusters** in config:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"execution": {
|
||||||
|
"clusters": 1 // Run one at a time
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
3. **Increase system RAM** if possible
|
||||||
|
4. **Check disk space** (needs ~500MB free)
|
||||||
|
|
||||||
|
### "Chrome error://chromewebdata/" errors
|
||||||
|
|
||||||
|
**Cause**: Browser navigation interrupted
|
||||||
|
|
||||||
|
**Solution**: The bot automatically handles this with retry logic. If it persists:
|
||||||
|
1. **Check internet stability**
|
||||||
|
2. **Clear browser cache**:
|
||||||
|
```bash
|
||||||
|
rm -rf sessions/
|
||||||
|
```
|
||||||
|
3. **Reinstall Playwright**:
|
||||||
|
```bash
|
||||||
|
npx playwright install --force chromium
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚙️ Configuration Problems
|
||||||
|
|
||||||
|
### "config.jsonc not found"
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
```bash
|
||||||
|
# Copy from example
|
||||||
|
cp src/config.example.jsonc src/config.jsonc
|
||||||
|
|
||||||
|
# Or use setup wizard
|
||||||
|
npm run setup
|
||||||
|
```
|
||||||
|
|
||||||
|
### "accounts.jsonc not found"
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
```bash
|
||||||
|
# Copy from example
|
||||||
|
cp src/accounts.example.jsonc src/accounts.jsonc
|
||||||
|
|
||||||
|
# Edit with your credentials
|
||||||
|
```
|
||||||
|
|
||||||
|
### "Invalid JSON" error
|
||||||
|
|
||||||
|
**Cause**: Syntax error in JSON file
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Use a JSON validator**: https://jsonlint.com/
|
||||||
|
2. **Check for**:
|
||||||
|
- Missing commas
|
||||||
|
- Trailing commas before `}`
|
||||||
|
- Unescaped quotes in strings
|
||||||
|
- Missing closing brackets
|
||||||
|
|
||||||
|
### Settings not applying
|
||||||
|
|
||||||
|
**Solution**:
|
||||||
|
1. **Rebuild after config changes**:
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
2. **Restart bot** completely
|
||||||
|
3. **Check file is saved** before running
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚡ Performance Issues
|
||||||
|
|
||||||
|
### Bot runs very slowly
|
||||||
|
|
||||||
|
**Causes & Solutions**:
|
||||||
|
|
||||||
|
1. **Too many accounts running in parallel**:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"execution": {
|
||||||
|
"clusters": 1 // Reduce from higher number
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Slow internet connection**:
|
||||||
|
- Use wired connection instead of WiFi
|
||||||
|
- Increase timeouts in config
|
||||||
|
- Run during off-peak hours
|
||||||
|
|
||||||
|
3. **System resources low**:
|
||||||
|
- Close other applications
|
||||||
|
- Check CPU/RAM usage
|
||||||
|
- Consider running on better hardware
|
||||||
|
|
||||||
|
### Searches taking too long
|
||||||
|
|
||||||
|
**Solution**: Adjust search delays:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"search": {
|
||||||
|
"settings": {
|
||||||
|
"searchDelay": {
|
||||||
|
"min": 2000, // Reduce if too slow
|
||||||
|
"max": 3000
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### High memory usage
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Run fewer accounts in parallel**
|
||||||
|
2. **Close browser between accounts**:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"execution": {
|
||||||
|
"closeBrowserOnError": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
3. **Clear sessions regularly**:
|
||||||
|
```bash
|
||||||
|
rm -rf sessions/
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 Getting Diagnostic Logs
|
||||||
|
|
||||||
|
### Capture full logs
|
||||||
|
|
||||||
|
**Linux/Mac**:
|
||||||
|
```bash
|
||||||
|
npm start > logs.txt 2>&1
|
||||||
|
```
|
||||||
|
|
||||||
|
**Windows**:
|
||||||
|
```powershell
|
||||||
|
npm start > logs.txt 2>&1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Enable debug mode
|
||||||
|
|
||||||
|
Add to `config.jsonc`:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"debug": true,
|
||||||
|
"headless": false // See browser in action
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Check dashboard logs
|
||||||
|
|
||||||
|
If dashboard is enabled:
|
||||||
|
1. Go to http://localhost:3000
|
||||||
|
2. Click "Logs" tab
|
||||||
|
3. View real-time logs
|
||||||
|
4. Download log file if needed
|
||||||
|
|
||||||
|
### Useful log locations
|
||||||
|
|
||||||
|
- **Main logs**: Console output
|
||||||
|
- **Error logs**: `reports/` folder (if error reporting enabled)
|
||||||
|
- **Screenshots**: `reports/screenshots/` (on errors)
|
||||||
|
- **Session data**: `sessions/` folder
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🆘 Still Need Help?
|
||||||
|
|
||||||
|
If none of these solutions work:
|
||||||
|
|
||||||
|
1. **💬 [Join Discord](https://discord.gg/k5uHkx9mne)** — Get community support
|
||||||
|
2. **🐛 [Open GitHub Issue](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Report the bug
|
||||||
|
3. **📖 [Check FAQ](FAQ.md)** — Common questions answered
|
||||||
|
|
||||||
|
**When asking for help, include**:
|
||||||
|
- Operating system (Windows/Linux/Mac)
|
||||||
|
- Node.js version (`node --version`)
|
||||||
|
- Error message (full text or screenshot)
|
||||||
|
- Relevant config (remove sensitive data!)
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
[← Back to Documentation](index.md)
|
||||||
|
|
||||||
|
</div>
|
||||||
Reference in New Issue
Block a user