Skip to content

docs: sync documentation with actual code implementation - #37

Merged
linletian merged 3 commits into
developfrom
feature/improve-remote-access
May 25, 2026
Merged

docs: sync documentation with actual code implementation#37
linletian merged 3 commits into
developfrom
feature/improve-remote-access

Conversation

@linletian

Copy link
Copy Markdown
Owner

Summary

Sync PRD, API docs, architecture docs, and README with the actual code implementation.

Changes

  • PRD §6 update token auto-generation description to reflect actual behavior (always generates when not provided via )
  • PRD §6 add IPv6 loopback exclusion note ( not recognized as loopback)
  • PRD §6 add rate limiting spec (20 req/min/IP instance auth, 1 req/s CSRF, 20 req/min/IP portal auth)
  • PRD §7 correct WebSocket handshake downgrade description (client-side timeout fallback, not server-side)
  • API.md add reverse proxy status note, instance login endpoint docs, auto-generate token behavior
  • ARCHITECTURE.md clarify reverse proxy is planned but not yet implemented
  • README.md/zh-CN.md update config command help, startup output format, tailscale serve status, reverse proxy status, auth token behavior

linletian added 3 commits May 25, 2026 13:31
- Add mw config regen command to regenerate and persist a strong random token
- Change withAuth middleware to read auth token from config file on every
  request instead of caching it at startup, enabling hot-reload of tokens
- Add y/N confirmation prompt before replacing existing token
- Update app handleLogin to use live config.Load() for token verification
- Add tests for configRegenAuth covering empty config, skip confirmation,
  user abort, and successful regeneration
- Add tests for withAuth to use isolated config files
@linletian
linletian merged commit 8574e26 into develop May 25, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant