docs: document server app port configuration and fallback guidance - #540
Merged
Conversation
Greptile SummaryThis PR clarifies development port configuration and improves the accuracy of startup output.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains from the prior review scope.
|
| Filename | Overview |
|---|---|
| .env.example | Documents the Server App port environment variable alongside the existing port settings. |
| CONTRIBUTING.md | Documents all three development ports, fallback behavior, and available overrides. |
| README.md | Adds the Server App server to the architecture overview. |
| dev-server.js | Updates the health-check log to display the dynamically selected API port. |
| kill-ports.js | Adds guidance about fallback ports and custom configuration when a third-party process owns a port. |
Reviews (2): Last reviewed commit: "no-mistakes(document): Update agent guid..." | Re-trigger Greptile
vjku
added a commit
to vjku/FloCafePrivateCloud
that referenced
this pull request
Aug 28, 2026
docs: remove reddit community links (FreeOpenSourcePOS#539) docs: document server app port configuration and fallback guidance (FreeOpenSourcePOS#540)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Changed
3003,SERVER_APP_PORT) acrossREADME.md,AGENTS.md,CONTRIBUTING.md,frontend/README.md, and.env.example.CONTRIBUTING.mdand informational logging inkill-ports.jsexplaining automatic port fallback behavior and custom port configuration.dev-server.jsto dynamically log the API health check URL usinggetServerPort().Risk Assessment
✅ Low: The changes are well-bounded documentation updates and minor log message adjustments clarifying port configuration and fallback behavior.
Testing
Exercised dev tooling script unit tests, server port collision fallback tests, kill-ports process identity and non-Flo process conflict handling, and verified documentation and dev-server logging; all checks passed cleanly.
Evidence: Port Guidance & Conflict Verification Log
=== FloCafe Port Guidance & Conflict Verification === 1. Testing kill-ports.js on free ports: [kill-ports] Port 39123 is free. [kill-ports] Port 39124 is free. [kill-ports] Port 39125 is free. -> Pass 2. Testing kill-ports.js behavior with non-Flo process holding port: [kill-ports] Port 39876: SKIP — PID 8269 (...) is not a Flo process. [kill-ports] Port 39876: no Flo processes found. 1 other process(es) using this port. [kill-ports] Note: Non-Flo process is holding port 39876. FloCafe will attempt fallback ports automatically on startup, or you can configure custom ports (PORT, KDS_PORT, SERVER_APP_PORT) in .env. -> Pass (non-Flo process preserved and helpful guidance emitted) 3. Verifying documentation updates: [x] .env.example contains SERVER_APP_PORT=3003 [x] CONTRIBUTING.md documents ports 3001, 3002, 3003 and fallback guidance [x] README.md includes Server App port 3003 in architecture diagram [x] dev-server.js dynamically uses getServerPort() for health log -> All checks passed successfully!Pipeline
Updates from git push no-mistakes
⏭️ **intent** - skipped
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
✅ **Review** - passed
✅ No issues found.
✅ **Test** - passed
✅ No issues found.
npx ts-node --transpile-only -P tests/tsconfig.json tests/dev-tooling-scripts.test.tsnode tests/run-electron-node-test.cjs tests/server-port-collision.test.tsnode kill-ports.js 3001 3002 3003Port conflict and documentation verification suite checking non-Flo port retention, fallback guidance logging, and documentation consistency✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.