LightZirconite/Microsoft-Rewards-Script
1
0
Fork 0
mirror of https://github.com/TheNetsky/Microsoft-Rewards-Script.git synced 2026-01-23 08:21:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#451)

Browse Source 
Update Nix instructions for v3, minor tidy-ups.
This commit is contained in:
Michael Cammarata
2026-01-15 13:55:55 -05:00
committed by GitHub
parent 00bf632ac7
commit b0c01fd433
1 changed files with 13 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -6,7 +6,7 @@
- [Quick Setup](#quick-setup) - [Quick Setup](#quick-setup)
- [Nix Setup](#nix-setup) - [Nix Setup](#nix-setup)
- [Configuration Options](#configuration-options) - [Configuration Options](#configuration-options)
- [Account Configuration](#account-configuration) - [Account Setup](#account-setup)
- [Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
- [Disclaimer](#disclaimer) - [Disclaimer](#disclaimer)
@@ -48,35 +48,24 @@ docker compose up -d
``` ```
> [!CAUTION] > [!CAUTION]
> Set `headless` to `true` in the `config.json` when using docker. > Set `headless` to `true` in the `src/config.json` when using Docker.
> Additional docker-specific scheduling options are in the `compose.yaml` > Additional docker-specific scheduling options are in the `compose.yaml`
> [!NOTE] > [!TIP]
> When headless, monitor logs with `docker logs microsoft-rewards-script` (for example, to view 2FA codes), or enable a webhook service > When headeless, monitor logs with `docker logs microsoft-rewards-script` (for example, to view passwordless codes), or enable a webhook service in the `src/config.json`.
--- ---
## Nix Setup ## Nix Setup
If using Nix: If using Nix: `bash scripts/nix/run.sh`
1. Run the pre-build step first:
```bash
npm run pre-build
```
2. Then start the script:
```bash
./run.sh
```
This will launch the script headlessly using `xvfb-run`.
--- ---
## Configuration Reference ## Configuration Reference
> [!NOTE] Edit `src/config.json` to customize behavior. Below are all currently available options.
> Edit `src/config.json` to customize behavior. Below are all currently available options.
> [!WARNING]
> Rebuild the script after all changes. > Rebuild the script after all changes.
### Core ### Core
@@ -161,10 +150,12 @@ This will launch the script headlessly using `xvfb-run`.
--- ---
## Account Configuration ## Account Setup
Edit `src/accounts.json`.
> [!WARNING] > [!WARNING]
> Edit `src/accounts.json`. The file is a **flat array** of accounts, not `{ "accounts": [ ... ] }`. > The file is a **flat array** of accounts, not `{ "accounts": [ ... ] }`.
> Rebuild the script after all changes. > Rebuild the script after all changes.
```json ```json
@@ -219,7 +210,7 @@ This will launch the script headlessly using `xvfb-run`.
--- ---
## Troubleshooting ## Troubleshooting
> [!NOTE] > [!TIP]
> Most login issues can be fixed by deleting your /sessions folder, and redeploying the script > Most login issues can be fixed by deleting your /sessions folder, and redeploying the script
--- ---