docs: update README, About, Privacy and Disclaimer for CF Worker #11

Merged
starkSV merged 1 commit from feat/cf-worker-proxy into main 2026-05-18 12:58:47 +05:30
starkSV commented 2026-05-18 12:58:37 +05:30 (Migrated from github.com)
  • README: add cloudflare-worker/ to project structure, update How It Works diagram to show CF Worker hop, add CF Worker setup instructions under Running Locally, and fix Deployment section (Worker is an outbound proxy, not the backend host)
  • About: mention CF Worker distributes requests across Cloudflare edge
  • Privacy: add Cloudflare as a third-party service, update date
  • Disclaimer: update date

Summary by CodeRabbit

  • Documentation

    • Updated README with expanded project architecture including optional Cloudflare Worker component for production deployments
    • Enhanced "How It Works" section with detailed request flow and rate-limiting mitigation information
  • Updates

    • Updated About page to clarify request routing through Cloudflare Worker
    • Updated Privacy Policy with Cloudflare Worker third-party service details
    • Updated Disclaimer and Privacy Policy dates

Review Change Stack

- README: add cloudflare-worker/ to project structure, update How It Works diagram to show CF Worker hop, add CF Worker setup instructions under Running Locally, and fix Deployment section (Worker is an outbound proxy, not the backend host) - About: mention CF Worker distributes requests across Cloudflare edge - Privacy: add Cloudflare as a third-party service, update date - Disclaimer: update date <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated README with expanded project architecture including optional Cloudflare Worker component for production deployments * Enhanced "How It Works" section with detailed request flow and rate-limiting mitigation information * **Updates** * Updated About page to clarify request routing through Cloudflare Worker * Updated Privacy Policy with Cloudflare Worker third-party service details * Updated Disclaimer and Privacy Policy dates <!-- review_stack_entry_start --> [![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/starkSV/windows-iso-downloader/pull/11?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
coderabbitai[bot] commented 2026-05-18 12:58:48 +05:30 (Migrated from github.com)

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 46553479-5135-4e9f-856c-8df2c136e2a4

📥 Commits

Reviewing files that changed from the base of the PR and between ea83c22f9f and 58d66fe06d.

📒 Files selected for processing (4)
  • README.md
  • frontend/src/pages/AboutPage.tsx
  • frontend/src/pages/DisclaimerPage.tsx
  • frontend/src/pages/PrivacyPolicyPage.tsx

📝 Walkthrough

Walkthrough

This PR updates documentation across the README and frontend pages to explain an optional Cloudflare Worker that routes outbound Microsoft API requests for rate-limit distribution. Changes include architecture diagrams, deployment guidance, environment variable documentation, and privacy/behavior disclosures for end users.

Changes

Cloudflare Worker documentation integration

Layer / File(s) Summary
Project README architecture and setup documentation
README.md
README sections now document the optional cloudflare-worker/ directory, explain Worker routing via environment variables (CF_WORKER_URL, CF_WORKER_SECRET), detail local deployment steps, and clarify that the Go backend must run on a long-running VPS while the Worker acts only as an outbound proxy.
Frontend pages: behavior explanation and privacy disclosure
frontend/src/pages/AboutPage.tsx, frontend/src/pages/PrivacyPolicyPage.tsx, frontend/src/pages/DisclaimerPage.tsx
AboutPage updates explanatory text to describe Cloudflare Worker routing for avoiding rate limits; PrivacyPolicyPage replaces Microsoft CDN disclosure with Worker routing details and Cloudflare privacy policy link, clarifying no user data is stored; all pages update "Last updated" date to May 18, 2026.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 A Worker hops through clouds so bright,
Requests take edge routes, spreading load just right,
No links are tied to one poor server's fate,
Cross Cloudflare's network, bypassing rate!
Privacy promised, timestamps all aligned—
One feature, one docs suite, harmonized.

Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/cf-worker-proxy

Comment @coderabbitai help to get the list of available commands and usage tips.

<!-- This is an auto-generated comment: summarize by coderabbit.ai --> <!-- This is an auto-generated comment: failure by coderabbit.ai --> > [!CAUTION] > ## Review failed > > The pull request is closed. <!-- end of auto-generated comment: failure by coderabbit.ai --> <details> <summary>ℹ️ Recent review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro Plus **Run ID**: `46553479-5135-4e9f-856c-8df2c136e2a4` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between ea83c22f9f4a9cdb70780e185d2f9e28dba45f29 and 58d66fe06ddc6cdf5483b8bb77172c2734f3039c. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `README.md` * `frontend/src/pages/AboutPage.tsx` * `frontend/src/pages/DisclaimerPage.tsx` * `frontend/src/pages/PrivacyPolicyPage.tsx` </details> </details> --- <!-- walkthrough_start --> <details> <summary>📝 Walkthrough</summary> ## Walkthrough This PR updates documentation across the README and frontend pages to explain an optional Cloudflare Worker that routes outbound Microsoft API requests for rate-limit distribution. Changes include architecture diagrams, deployment guidance, environment variable documentation, and privacy/behavior disclosures for end users. ## Changes **Cloudflare Worker documentation integration** |Layer / File(s)|Summary| |---|---| |**Project README architecture and setup documentation** <br> `README.md`|README sections now document the optional `cloudflare-worker/` directory, explain Worker routing via environment variables (`CF_WORKER_URL`, `CF_WORKER_SECRET`), detail local deployment steps, and clarify that the Go backend must run on a long-running VPS while the Worker acts only as an outbound proxy.| |**Frontend pages: behavior explanation and privacy disclosure** <br> `frontend/src/pages/AboutPage.tsx`, `frontend/src/pages/PrivacyPolicyPage.tsx`, `frontend/src/pages/DisclaimerPage.tsx`|AboutPage updates explanatory text to describe Cloudflare Worker routing for avoiding rate limits; PrivacyPolicyPage replaces Microsoft CDN disclosure with Worker routing details and Cloudflare privacy policy link, clarifying no user data is stored; all pages update "Last updated" date to May 18, 2026.| ## Estimated code review effort 🎯 1 (Trivial) | ⏱️ ~4 minutes ## Poem > 🐰 A Worker hops through clouds so bright, > Requests take edge routes, spreading load just right, > No links are tied to one poor server's fate, > Cross Cloudflare's network, bypassing rate! > Privacy promised, timestamps all aligned— > One feature, one docs suite, harmonized. ✨ </details> <!-- walkthrough_end --> <!-- finishing_touch_checkbox_start --> <details> <summary>✨ Finishing Touches</summary> <details> <summary>📝 Generate docstrings</summary> - [ ] <!-- {"checkboxId": "7962f53c-55bc-4827-bfbf-6a18da830691"} --> Create stacked PR - [ ] <!-- {"checkboxId": "3e1879ae-f29b-4d0d-8e06-d12b7ba33d98"} --> Commit on current branch </details> <details> <summary>🧪 Generate unit tests (beta)</summary> - [ ] <!-- {"checkboxId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "radioGroupId": "utg-output-choice-group-unknown_comment_id"} --> Create PR with unit tests - [ ] <!-- {"checkboxId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "radioGroupId": "utg-output-choice-group-unknown_comment_id"} --> Commit unit tests in branch `feat/cf-worker-proxy` </details> </details> <!-- finishing_touch_checkbox_end --> <!-- tips_start --> --- <sub>Comment `@coderabbitai help` to get the list of available commands and usage tips.</sub> <!-- tips_end --> <!-- internal state start --> <!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEYDEZyAAUASpETZWaCrKPR1AGxJda+Boi5sblpqEkgbAFEAQQARAFkIgBpIKIF8PGSrCkk0BnlMehikBg9tNj4AM3w+AGEAMUgAdWqAa0pISAMAOUcBSi4ARgGOgwBVGwAZLlhcXG4AgHoFonVYbAENJmYFxFxnFoBlADUFgHd4DF9TxDAkQiuMD3w0JQoF7mwPDwWhkdHEfr2PYUQ5HEYHdIUBhhARUDAMWBcCokagLBgVMCnVqUMC8fAAD3kgCTCGDOUi4SCwzAIrjMbRYToHPa4bABfjcMgjGoUFE0ejULgAJgADIKAGxgYUAVjAAwAHNBhQB2DiCuUcADMSoAWkYYtIGNluOJ8BgOAYoJFYgkuC96CV0rQKqUeZjsW9IAQeBR8CIxECKNgxNgeQBuSBBEI0SAAIgAEvhTpAAJIU5ogxAxyC0eBoIhUZie/D2WCJ9CQGpPbBOl1hdNtPil7jhu0Vqs15x1932Egs7goDC7QNieCm5DYS7tGM2CcYC5ESATPxoL6yGPhpgUHn+/XcJ6yNgYCkAkemotA0Ke2BdkHtVCYfh4NIT+h4wnJDD4Cm4a+U3JtS5IFLXYNAtFJn04SBDxNLAf2oK8wkrR1nU7JpuxzId4AEPBpEgHkAEdsGkXBkFyH1EGQH9EPbFCeUgOhSFAqAshyPJbVoegkOrWiwjQUir3gChaFxZxcHkAEKAkeBoXQQDI0vKjs1CJjICKRASjKQF5OjRSoxIUCLTAQwDBMKAyHofAKhwAhiDIZQ+QUVh2C4Xh+GEURxCkGR5CYV4VDUTRtF0IyTPAKA4FQe8sDQPBCFIcgqAcrZoK4KgkwcJwXEpHzFGUVR1C0HR9CMULTAMK14giDRmFoc0Y3qgwLBSZNbIS0J6AyuksssxhYEwUhECMUZgnayAAAMKoSaraDG7M/EcdhqFHWDix5Z0PNk+j8W4Ao6G9X0NucBF1A8kNeMAgiiN2SBnUTDQYF/QAcAiyA7/SZYcWR5QBcAh7U8sE/JMLhKatcIffBjWWldxodbjazdW83lmrZuFNdh0CeDAiEQeAlAQm6fSPczZPoABxYsBH/cz7rgMJHoTJNUzQjMfpPGC8JIPdclwxTeBIKT0mQbHmD3eAKngPbbqTHM8wLSBzh/ctmGqMIlD2eAvA6khCLIGSAAoeRWXZ2gBCjluSHaKABSA4hiaAbvnSheAuXBkmRXAEUgA4AGlRkgDwkBdm7ew97GiHITiYi6SBxgmABKYn0A40isBIbbSgwJazx68GYJXDx5B9PB50fXBn0AuJpPIyyKUu4jKNgQuiFgcsuI7Oj63aKS0HojApIJ6DIAkZxcwELxKOLNAJHwHG8Mvf3mHUedqaemcMDnTHF2XVcWY85bICIel+PIJNHoAeQh00Vy4VueKZhtIH10QWEPJR6CqPg8VoIMYNjn7R78Fo2YDTZDUBvJQe58AHjRgUdmhFBJ7QpgwAC9AyASEHs4RAyR5bNyINgHG1IwhehYOoBChZ37ZngWIMANkK6GnwIgauEZEB5n0g9Wmu59zQR3n9dmUkTZ423M/cye0AR9k9CoLwCchxkCIFRQceNTjOHXguOC35fxkz/EgomzBWQ1wnPwaKF5LjOHoEcKwBwH6fmPJQKQFAx6IFjlghAkjFI31rHfO8yBnbCIso8fIycS5l1fD6QkBlzCWCiB4GgiVlrjzxkoDSMSxz8CsqnFGFAHLVB4Osf2DAe7iHENIIwUAuiowfr4BgC0jyZwwGAU0+der9TCBccak0qo1TGrHIwEwLi4QRE02qkAADU4oFiygGEYCIux4B0iSrlXh4skwkAqO/SCS5TgGHqjGYpZUKgExoJcHYUJ3gsMQAsVI6RcBWBYRoEi+I6oNSalEFq8V7IiMcF1eQPV+mYyKQYGmkA6ZlhIViZmv0YKAEwCZAaT07UGqPIGg+IKSKPHCNPktpIDHx4M4GWaBuDNxRQOCSDldhLQ3qowJ6Ry6V3oYw2uuxSJ0ULg5H8jdm7dzcahDufAvQYVwCAnCnoqArOkugOhFE2zIXcQxMIyYrDJ35FPGeiUwjz0XpjZeYReb81ZHLaoOZyV9QpP7DALRGW0zldQ8W9AvSKQkrYn6hKeRKykPyC6HNSjQnoNgnsFtLwkGFn1bGyAzwmsAWkwS+RAKuJonDZlxc+h9X5hQMJjUIlRPsrE88ulRAuhqSG1J21qiZI/jk0V7BF5/JKajbpvTkA/NIIMoZYoxmCkmdM2Ze1fJhB5FJEgSyVnFq4HEOg8BHCbIaoZMARg9mmgObQI5DATkDQWGpDSMzKDXMYnch52ynkvLsiqjqHznBfKsg2v5Y012lA3RQLdJBZraW5k9CYfEKRPtoD9PSFDECc1kHtFpulig3vKAoQmR58YsEgAAKmg1EJ2HhIAAE5kginFLB88sG4hoHkPKVDooxSwfuqU/gVE+BPBWAwZIpRZCXOSFktgewozd0TZPUcfBAO/h2qQFA9a+q/NoKmp5GaknyNtb+BJeaYIFq2ukkt2TR7lqPJWwaYFSnkAMj08gfGBlcCGQMMZEyDBTPEJ2+08ze2LPooOjJXB1kTu2VOmd+zzKLuXdIBYLEh55CsPgXJsh723MQPchzabmqtTecezKZ7Gm/NU8NPSNquPZG8/IFG/nsU8aYOByCilHqvuuh+r9l4L1vx9IWeD2REMocgGhsU55sO4blPh8UmrAURSEiJDJ4kbHSWkNwtmAMLw0HrvBKIVhkywKuiRBrNKGEVApKhZle1WXpCbi3WNXLuxnk5TyKF9FaA8fILgUFgCYFAw8CDfiYa9prUoDrQhxZdskH207VLPA/PSVkOGEhK4GGJ1oKNtRN5767GVsgT8TD2jMf4HwB4TwXh+wuGa+6WQ+ajlZPnZIP5UCsz3vU+QSh1IgL2rQquC2wDAQcsmA4p97ZjwMdbOb1d9s1EjgnDC662D0B5L+scWF1bqHkOQsntKFvelYmlqgI5oQhvI8j9AQ91YqEF2JIT6bon5uzRJ3NOLpMpNk8WvaWSPiKbyRWwpqnq2G4yXQd4ZbzfKbEvYeAYdqBnR0wJgc41Z3gYXYgY53GPNedyAFz7Pmbl3LGpputsXG16YGFKQz7bTOjW7Qs/t1nVnDtHeOrZOzjKmR7hZKyMUbKvKPY5FKs90onqynIBQfl8qBSKiFIvEUvEBLL3FQ9aehFHh8L2bQGtG8wieEg+wdeC5NO8qPqgzfCrBWMgAbQAN4xjhKQZMtAYwcA300gA+lKAQGopQkCQyQZUAAWDUwoYyJBjDtH8u/pzREqtNe/MZSUZK0yQXfV/hQH9zJf9/9BQH9OpT0X8Xo/Rjx+Vv4zpwU94hsKkqkZsHw7RF5L5EMc5IZEMxoYY24SB4YGwFhZocxtwCAspdYWkMC2YvQxpfd51SCE4xpEFkFSDY4NBP9u0AAhcfFoGoFgPcVOIXF/J4U4GMAAX0SHX03xIG3xfzkIPyVGFDFAGGFAGA1EFFoDlGFD/wfyf1gBfzaQ/3AOBFwBAI4ClAGCAMuEsLFDAK/ynxfyBQZjTFaEQB+mywOQpFQA/TllWHLCxXMmoUICJklgoVxULApQuyu02hwKwMlVhi2wRiBA5gTjSQKHrjCAwF6Hux5y1mmx7G1nhBIB+0Ww8H+ztEolTgpBhXpGLlLCTEUm5TwkuWLlQG8J9C+D2i7h7j7lNAHiHmyAkW5mLD5QFWjEuSCSmzri4If14P4MEOFi8HxFEL33EKkJkP31+QUL3yUM0LQCVCvzQDQDUIEAqDvwMOoCML3xMJqk/2/wsN6V3yQ0AJjGAJeI4HUPeIgJcBfyiCTk2jPgvgzg8Gvk23bm7EfmSh8RuhNx9C/j+l/knwEDxzPBfHaHHyhkDDXg6MHDgL+kwQHGBgNQXHAU4TRlwXwVKITixTYKJlQUEkGLRmGJHgZ11jGnqAP0aFPhsC9giBsAPxjjGmSC5LqB5L5IFKFIOAiBqEiGgE6XNkuy8QJI+izSIQXmB2iOLCIHGMoW/GLFF3m00G4Nyj4IAWWOELWLEjEMTC2NkKaT2J2NIAPw1AEG0LlDlClCvwuLlA1E/0MOMLfymgeLMNEksPlCv1sNoEjKQ0cL+LXD3w4UgQHmpJCFpL8LRT2h9W7jWl6QKNhMnE1jET2FHkISNVk1yU8HkC6jNTxmew8T4D4nZFzg8GSBgReCEF0WyKAQgSgQg0UQoGUXPEungXLAxiIDAFxJHLMQsQZMAlOGcVVRmXVRUV/FaKISfCpWCQJFkGLhF2Z3F3G0mwYDzkQHmJjEWMtKENWPWJjE2OkMdN2J332MPw1CGDP10LlFyAqAGEDJuJf0YNcwDyXSDzOQuTwECzuUePMMsJUJjPgqlHAOcL30aFWE41pnphQGRQ8J+n1XyKR2unRIwGx1/HqIzkoJym4HkEJVK2yiJUoHEA3m7ixT9XzDxXZQgiSMIKbLaKLnJWLG1TRmNLpTnlXOYqIGSGdXwCkkNS1WyCyUejDXNRTCsCtRW2LDtRsUoB3nA2hA7MAgwMxgWDaA5mLjtWZADTRgpRUtk3HLQAW3aEFCvyAkhAvLNKUAtKQStLvNtI2PtKfJdPkNfOCoPydETzFDOJWRPzQAAufz32AsOVAvczOWvU0jvUj2C1gojK+I1A1EQryoKqcOixfwBU5xA3aERQpHyzfQjGzM/XQUu2aU90bQaxw0gDw1qwIwfkJUq3VmQxazFE4M8pIG8oENvJEP8ofMCu2LkOdKUL/LlCQ3jNoCVCQzFCVAqHituJjCSv90D1OU8xS1D18382guyvDJ/yKsKvIF33ypQtKr3wBVqsKwauK2jAwj/QA1gi4xYXhK/HaEJReCHlKJtSNI6q6rq0vOvJ8smptKTJmokKCvmtCqUKQwqDlDWqlBWXlGFAYB2qApc2SsOpXRDx83DwCyyvxByuuruo4DFGKs+PpqVDFEes+WMI9S5iS1pg62Egtmd3tT608OxSoA4vxXPCJ0NCwmoilRSPvnjQ3kPPFUYRPNmIZQ7I4k2lqMoDBJ4tvje1Dw+wyzDUMo6isqvHghaPQnwFwisSBGVihzh2oG7iyXh2eHoDssfhdQsuS3YyZxVvFzZyjip3nAWAqoyr1SEgPKyRx0Fl3lNBGoWPNKWPhvvO5zHWYCkIAF1jAwpi8Ddu8ItK8izIJVZh8u15l/4J9EzZ44sGLu158ApF99AgA --> <!-- internal state end -->
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: shekhar/windows-iso-downloader#11
No description provided.