Microsoft-Rewards-Bot/docs/index.md

# 📚 Documentation

📚 Documentation HubComplete guide for Microsoft Rewards Bot

Complete guides for Microsoft Rewards Bot← Back to Main

← Back to Main

---

---## 🚀 Quick Start (3 Steps)

🚀 Getting Started1. Setup Accounts — Add credentials + 2FA

2. Configure Bot — Essential settings

New to the bot? Start with these guides in order:3. Schedule Runs — Use OS-level automation

| Step | Guide | What You'll Learn |Done! The bot will run automatically.

|------|-------|-------------------|

| 1 | 📘 Getting Started | Installation, account setup, first run |---

| 2 | 👤 Accounts & 2FA | Add accounts, enable TOTP authentication |

| 3 | ⚙️ Configuration | Customize bot behavior and features |## ✨ Feature Guides

| 4 | ⏰ Scheduling | 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 | All settings explained |

---| External Scheduling | Automate with cron or Task Scheduler |

| Humanization | Anti-detection system |

📖 Feature Guides| Webhooks | Discord notifications |

| Error Reporting | 🆕 Automatic error reporting |

Explore advanced features and customization options:| NTFY Alerts | Mobile push notifications |

| Proxy Setup | IP rotation (optional) |

Core Features| Docker | Container deployment |

| Guide | Description |---

|-------|-------------|

| 🔔 Notifications | Discord webhooks and mobile push alerts |## 🆘 Troubleshooting

| 📊 Dashboard | Web interface for monitoring and control |

| 🌐 Proxy Setup | Configure proxies for privacy || Issue | Solution |

| 🤖 Humanization | Anti-detection and natural behavior patterns ||-------|----------|

| Bot not working? | Troubleshooting Guide |

Deployment| Login failed? | Accounts & 2FA |

| Account banned? | Security Guide |

| Guide | Description || Git conflicts? | Conflict Resolution |

|-------|-------------|| General questions? | FAQ |

| 🐳 Docker | Containerized deployment with Docker Compose |

| ☁️ Cloud Deployment | Deploy to VPS, Raspberry Pi, or cloud services |Need help? → Discord Community

Advanced---

| Guide | Description |← Back to Main

|-------|-------------| | 🔧 Advanced Configuration | Power user settings and optimization | | 🛡️ Security Best Practices | Account protection and risk management |

---

🆕 Account Creator

Create new Microsoft accounts with the built-in account creator:

Guide	Description
🎯 Account Creator Guide	Create accounts with 2FA and referral links
💰 Referral System	Earn 7,500 points/month per referral

Quick command:

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
Login failures	Accounts & 2FA Setup
Account banned	Security Guide
Configuration errors	Config Reference

Support Resources

• 💬 Discord Community — Get help from the community
• 🐛 GitHub Issues — Report bugs
• 📖 FAQ — Frequently asked questions
• 🔍 Diagnostics Guide — Debug and capture logs

---

📚 Reference Documentation

Technical references and detailed information:

Configuration

Document	Description
Config Reference	Complete config.jsonc options
Accounts Reference	Complete accounts.jsonc schema
Environment Variables	Available env vars for CI/Docker

Technical

Document	Description
API Documentation	Dashboard REST API endpoints
Error Reporting	Automatic error reporting system
Changelog	Version history and changes

---

🎓 Guides by Topic

For Beginners

1. Getting Started — Start here!
2. Accounts & 2FA — Setup your accounts
3. First Run — Test the bot
4. Scheduling — Automate daily runs

For Raspberry Pi Users

1. Getting Started — Installation steps
2. Scheduling — Setup cron for daily runs
3. Notifications — Get mobile alerts
4. Cloud Deployment — Run 24/7

For Docker Users

1. Docker Guide — Setup Docker Compose
2. Environment Variables — Configure via env vars
3. Notifications — Monitor container runs

For Multiple Accounts

1. Accounts & 2FA — Manage multiple accounts
2. Proxy Setup — Use different IPs per account
3. Advanced Config — Parallel execution
4. Referrals — Earn bonus points

---

🔗 External Resources

• Microsoft Rewards — Official Microsoft Rewards site
• Playwright Docs — Browser automation framework
• Node.js — JavaScript runtime
• TypeScript — Programming language

---

🤝 Contributing

Want to help improve the bot?

• 📖 Contributing Guide — How to contribute
• 🐛 Report Bugs — Found an issue?
• 💡 Feature Requests — Suggest new features
• 📝 Improve Docs — Help with documentation

---

Need help? Join our Discord

← Back to Main