luckberg/unraid-docker-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(12-01): update environment and architecture documentation

Browse Source 
- Update README to document docker-socket-proxy architecture instead of direct socket mount
- Clarify TELEGRAM_BOT_TOKEN needs both n8n credential AND env var
- Clarify user ID is hardcoded in IF nodes (no env var needed)
- Add missing commands to usage table (update all, /list)
- Document all 8 workflow files (main + 7 sub-workflows)
- Mark ENV-01, ENV-02, DEBT-01, DEBT-02 as complete in REQUIREMENTS.md
- Verify DEBT-02 is fixed (single --max-time 600 flag, no duplicates)
This commit is contained in:
Lucas Berger
2026-02-08 17:14:15 -05:00
parent 1ef726942a
commit e6e5df8754
2 changed files with 73 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.planning/REQUIREMENTS.md
+8 -8
View File
@@ -62,13 +62,13 @@
### Environment & Config
- [ ] **ENV-01**: Documentation clarifies TELEGRAM_USERID env var necessity (required vs hardcoded)
- [ ] **ENV-02**: Documentation clarifies TELEGRAM_BOT_TOKEN env var necessity (env var vs n8n credential)
- ✓ **ENV-01**: Documentation clarifies TELEGRAM_USERID env var necessity (required vs hardcoded) — Phase 12
- ✓ **ENV-02**: Documentation clarifies TELEGRAM_BOT_TOKEN env var necessity (env var vs n8n credential) — Phase 12
### Technical Debt
- [ ] **DEBT-01**: README documents proxy architecture (not direct docker.sock mounting)
- [ ] **DEBT-02**: Fix duplicate --max-time flags in image pull command
- ✓ **DEBT-01**: README documents proxy architecture (not direct docker.sock mounting) — Phase 12
- ✓ **DEBT-02**: Fix duplicate --max-time flags in image pull command — Verified fixed (single --max-time 600, no duplicates), Phase 12
- [ ] **DEBT-03**: Consolidate duplicated update flow between single and batch paths
## v2+ Requirements (Deferred)
@@ -103,10 +103,10 @@
| BATCH-06 | Phase 11 | Pending |
| BATCH-07 | Phase 11 | Pending |
| UNR-01 | Phase 12 | Pending |
| ENV-01 | Phase 12 | Pending |
| ENV-02 | Phase 12 | Pending |
| DEBT-02 | Phase 12 | Pending |
| DEBT-01 | Phase 13 | Pending |
| ENV-01 | Phase 12 | Complete |
| ENV-02 | Phase 12 | Complete |
| DEBT-02 | Phase 12 | Complete |
| DEBT-01 | Phase 12 | Complete |
**Coverage:**
- v1.2 requirements: 12 total