LightZirconite/Microsoft-Rewards-Bot
1
1
Fork 0
mirror of https://github.com/LightZirconite/Microsoft-Rewards-Bot.git synced 2026-01-09 17:06:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor project structure and update references from Light60-1 to Obsidian-wtf

Browse Source 
- Changed working directory in Dockerfile from /usr/src/microsoft-rewards-script to /app
- Updated Docker container name and service name from microsoft-rewards-script to microsoft-rewards-bot
- Modified LICENSE, NOTICE, README.md, and other documentation files to reflect new project ownership
- Updated package.json and package-lock.json to change project name and repository links
- Adjusted entrypoint script and Docker Compose configurations for new paths
- Updated security and login handling in source code to reflect new documentation URLs
- Changed logo asset to reflect new branding
This commit is contained in:
LightZirconite
2025-11-03 15:17:06 +01:00
parent 8ccfdd23c9
commit 2cc9df5278
18 changed files with 146 additions and 357 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/FAQ.md
View File

@@ -174,7 +174,7 @@ See [Accounts Troubleshooting](accounts.md#troubleshooting).
### Docker container exits immediately
1. **Check logs:** `docker logs microsoft-rewards-script`
1. **Check logs:** `docker logs microsoft-rewards-bot`
2. **Verify mounts:** Ensure `accounts.jsonc` exists and is mounted
3. **Check config:** `headless` must be `true` for Docker
4. **Review environment variables:** Timezone, cron settings
@@ -311,14 +311,14 @@ See [Configuration Guide](config.md#risk-management--security).
- 💬 **[Join our Discord](https://discord.gg/h6Z69ZPPCz)** — Ask the community
- 📖 **[Documentation Hub](index.md)** — Browse all guides
- 🐛 **[GitHub Issues](https://github.com/Light60-1/Microsoft-Rewards-Bot/issues)** — Report problems
- 🐛 **[GitHub Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Report problems
- 📧 **[Diagnostics Guide](diagnostics.md)** — Debug issues
---
<div align="center">
**Didn't find your answer?** [Ask on Discord](https://discord.gg/h6Z69ZPPCz) or [open an issue](https://github.com/Light60-1/Microsoft-Rewards-Bot/issues)!
**Didn't find your answer?** [Ask on Discord](https://discord.gg/h6Z69ZPPCz) or [open an issue](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)!
[← Back to Documentation](index.md)

103
docs/README.md
View File

@@ -1,103 +0,0 @@
# 📚 Documentation Directory
This folder contains comprehensive documentation for the Microsoft Rewards Script project.
## 📋 Documentation Structure
### 🚀 Getting Started
- **[index.md](index.md)** — Documentation hub and navigation
- **[getting-started.md](getting-started.md)** — Complete setup guide for beginners
- **[FAQ.md](FAQ.md)** — Frequently asked questions
### ⚙️ Configuration
- **[config.md](config.md)** — Complete configuration reference
- **[accounts.md](accounts.md)** — Account setup and 2FA/TOTP configuration
- **[schedule.md](schedule.md)** — Automated scheduling setup
### 🔧 Features
- **[humanization.md](humanization.md)** — Anti-detection and natural behavior
- **[jobstate.md](jobstate.md)** — Job state management
- **[buy-mode.md](buy-mode.md)** — Manual purchase monitoring
### 🔔 Integrations
- **[conclusionwebhook.md](conclusionwebhook.md)** — Discord webhook setup
- **[ntfy.md](ntfy.md)** — NTFY push notification setup
- **[proxy.md](proxy.md)** — Proxy configuration
### 🐳 Deployment
- **[docker.md](docker.md)** — Docker deployment guide
- **[update.md](update.md)** — Update and upgrade guide
### 🛠️ Maintenance
- **[diagnostics.md](diagnostics.md)** — Troubleshooting and debugging
- **[security.md](security.md)** — Security and privacy guidelines
- **[git-conflict-resolution.md](git-conflict-resolution.md)** — Resolving Git conflicts
## 🎯 Quick Navigation by Use Case
### "I just installed the script"
1. [Getting Started](getting-started.md)
2. [Accounts Setup](accounts.md)
3. [Basic Configuration](config.md#quick-start)
### "I want automated daily runs"
1. [Scheduling](schedule.md)
2. [Docker Deployment](docker.md) (optional)
3. [Humanization](humanization.md)
### "I need notifications"
- [Discord Webhooks](conclusionwebhook.md)
- [NTFY Push Alerts](ntfy.md)
### "Something's not working"
1. [FAQ](FAQ.md)
2. [Diagnostics](diagnostics.md)
3. [Security Guide](security.md) (if banned)
## 📝 Documentation Standards
All documentation in this project follows these principles:
- **Clear and concise** — No unnecessary jargon
- **Example-driven** — Code samples for every feature
- **Up-to-date** — Reflects current functionality
- **Well-structured** — Easy navigation with TOC
- **Beginner-friendly** — Assumes minimal technical knowledge
## 🤝 Contributing to Documentation
Documentation improvements are always welcome! See [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines.
### How to Help
- Fix typos or unclear instructions
- Add missing examples
- Improve explanations
- Translate to other languages
- Update outdated information
## 📖 Documentation Format
All docs use **Markdown** format with:
- Clear hierarchical headings
- Code blocks with syntax highlighting
- Tables for configuration options
- Emojis for visual navigation
- Internal links for cross-references
## 🔗 External Resources
- **[Main README](../README.md)** — Project overview
- **[Contributing Guide](../CONTRIBUTING.md)** — How to contribute
- **[Security Policy](../SECURITY.md)** — Security and privacy
- **[Changelog](../CHANGELOG.md)** — Version history
---
<div align="center">
**[Start Reading →](index.md)**
Need help? [Join our Discord](https://discord.gg/h6Z69ZPPCz)
</div>

18
docs/docker.md
View File

@@ -21,7 +21,7 @@ docker compose up -d
### 3. View Logs
```bash
docker logs -f microsoft-rewards-script
docker logs -f microsoft-rewards-bot
```
**That's it!** Script runs automatically.
@@ -80,7 +80,7 @@ docker run -e ACCOUNTS_FILE=/custom/path/accounts.json ...
docker compose up -d
# View logs
docker logs -f microsoft-rewards-script
docker logs -f microsoft-rewards-bot
# Stop container
docker compose down
@@ -108,16 +108,16 @@ docker compose restart
```bash
# Enter container shell
docker exec -it microsoft-rewards-script /bin/bash
docker exec -it microsoft-rewards-bot /bin/bash
# Check Node.js version
docker exec -it microsoft-rewards-script node --version
docker exec -it microsoft-rewards-bot node --version
# View config (mounted in /src/)
docker exec -it microsoft-rewards-script cat src/config.jsonc
docker exec -it microsoft-rewards-bot cat src/config.jsonc
# Check if cron is enabled
docker exec -it microsoft-rewards-script printenv | grep USE_CRON
docker exec -it microsoft-rewards-bot printenv | grep USE_CRON
```
---
@@ -197,12 +197,12 @@ docker compose up -d
4. **Verify cron is running:**
```bash
# Check container logs
docker logs -f microsoft-rewards-script
docker logs -f microsoft-rewards-bot
# Should see: "==> Cron mode enabled"
# View cron logs inside container
docker exec microsoft-rewards-script tail -f /var/log/cron.log
docker exec microsoft-rewards-bot tail -f /var/log/cron.log
```
### Option 3: Single Run (Manual)
@@ -244,7 +244,7 @@ services:
```bash
# Enter container
docker exec -it microsoft-rewards-script /bin/bash
docker exec -it microsoft-rewards-bot /bin/bash
# Check cron is running
ps aux | grep cron

4
docs/getting-started.md
View File

@@ -99,7 +99,7 @@ If you prefer containers:
docker compose up -d
# Follow logs
docker logs -f microsoft-rewards-script
docker logs -f microsoft-rewards-bot
```
**[Full Docker Guide →](./docker.md)**
@@ -125,7 +125,7 @@ Once running, explore these guides:
**Login issues?** → [Accounts & 2FA Setup](./accounts.md)
**Want Docker?** → [Container Guide](./docker.md)
**Found a bug?** [Report it here](https://github.com/Light60-1/Microsoft-Rewards-Bot/issues)
**Found a bug?** [Report it here](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)
**Need support?** [Join our Discord](https://discord.gg/KRBFxxsU)
---

2
docs/git-conflict-resolution.md
View File

@@ -168,7 +168,7 @@ cp src/accounts.json ~/backup-accounts.json
# Nuclear option: fresh clone
cd ..
rm -rf Microsoft-Rewards-Bot
git clone https://github.com/Light60-1/Microsoft-Rewards-Bot.git
git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git
cd Microsoft-Rewards-Bot
# Restore your files

96
docs/index.md
View File

@@ -1,90 +1,52 @@
<div align="center">
<img src="../assets/logo.png" alt="Microsoft Rewards Script Logo" width="150"/>
# 📚 Documentation
# 📚 Documentation Hub
**Complete guide for Microsoft Rewards Bot**
**Complete guide to automate Microsoft Rewards**
[← Back to README](../README.md)
[← Back to Main](../README.md)
</div>
---
## 🚀 Start Here (In Order)
## 🚀 Quick Start (3 Steps)
### For Complete Beginners
1. **[Setup Accounts](accounts.md)** — Add credentials + 2FA
2. **[Configure Bot](config.md)** — Essential settings
3. **[Enable Scheduler](schedule.md)** — Daily automation
1. **[Accounts & 2FA](./accounts.md)** — Add your Microsoft accounts
2. **[Basic Config](./config.md#quick-start)** — 5 essential options
3. **[Scheduler](./schedule.md#quick-start)** — Automate daily runs
**You're all set! 🎉**
**Done!** The bot will run automatically.
---
## 🔥 Popular Features
## <EFBFBD> Feature Guides
### Notifications & Monitoring
- **[Discord Webhooks](./conclusionwebhook.md)** — Get run summaries
- **[NTFY Push](./ntfy.md)** — Mobile alerts
### Anti-Ban & Privacy
- **[Humanization](./humanization.md)** — Natural behavior simulation
- **[Proxy Setup](./proxy.md)** — Change your IP (optional)
### Deployment
- **[Docker](./docker.md)** — Container deployment
- **[Diagnostics](./diagnostics.md)** — Troubleshooting
| Feature | Description |
|---------|-------------|
| **[Configuration](config.md)** | All settings explained |
| **[Scheduler](schedule.md)** | Automated daily runs |
| **[Humanization](humanization.md)** | Anti-detection system |
| **[Webhooks](conclusionwebhook.md)** | Discord notifications |
| **[NTFY Alerts](ntfy.md)** | Mobile push notifications |
| **[Proxy Setup](proxy.md)** | IP rotation (optional) |
| **[Docker](docker.md)** | Container deployment |
| **[Buy Mode](buy-mode.md)** | Manual purchase monitoring |
---
## 📖 All Documentation
## 🆘 Troubleshooting
### Quick References
- [❓ FAQ (Frequently Asked Questions)](./FAQ.md) — Quick answers to common questions
| Issue | Solution |
|-------|----------|
| **Bot not working?** | [Diagnostics 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) |
### Configuration & Setup
- [Complete Configuration Reference](./config.md) — All options explained
- [Scheduler Setup](./schedule.md) — Automated timing
- [Job State](./jobstate.md) — Progress tracking
- [Auto-Update](./update.md) — Keep script current
### Advanced Features
- [Buy Mode](./buy-mode.md) — Manual purchase monitoring
- [Security Guide](./security.md) — Privacy & incident response
**Need help?** → [Discord Community](https://discord.gg/h6Z69ZPPCz)
---
## 🆘 Need Help?
**Technical issue?** → [Diagnostics Guide](./diagnostics.md)
**Login problem?** → [Accounts & 2FA](./accounts.md#troubleshooting)
**Banned?** → [Security Guide](./security.md)
**Want to contribute?** → [Contributing Guide](../CONTRIBUTING.md)
**Join Discord** → [Support Server](https://discord.gg/h6Z69ZPPCz)
---
## 🎯 Quick Links by Use Case
### "I just installed the script"
→ [Getting Started](./getting-started.md) → [Accounts](./accounts.md) → [Scheduler](./schedule.md)
### "I want daily automation"
→ [Scheduler Guide](./schedule.md) → [Humanization](./humanization.md)
### "I need notifications"
→ [Discord Webhooks](./conclusionwebhook.md) or [NTFY](./ntfy.md)
### "I want to use Docker"
→ [Docker Guide](./docker.md)
### "Something's broken"
→ [Diagnostics](./diagnostics.md) → [Security](./security.md)
---
**[← Back to README](../README.md)**
[← Back to Main](../README.md)