Skip to content

docs: Add scalability and optimization guidance - #779

Merged
developerjamiu merged 4 commits into
serverpod:mainfrom
abdulawalarif:docs/1718-scalability-optimization
Sep 7, 2026
Merged

docs: Add scalability and optimization guidance#779
developerjamiu merged 4 commits into
serverpod:mainfrom
abdulawalarif:docs/1718-scalability-optimization

Conversation

@abdulawalarif

Copy link
Copy Markdown
Contributor

Summary

  • Adds an Operations concept page on scaling Serverpod beyond a single process: server roles, Isolate.run for CPU work, Postgres indexes and query shape, connection pool sizing, Redis for shared cache and events, JWT auth, and streaming tradeoffs.
  • States current limits honestly (no first-class read replicas or Serverpod-owned Postgres tuning), and points to database interceptors or an external proxy where needed.
  • Links the page from the Operations overview and Hosting elsewhere (server roles).

Closes serverpod/serverpod#1718.

Test plan

  • Open Next → Concepts → Operations → Scalability.
  • Confirm the page appears in the Operations sidebar after Exception monitoring.
  • Follow inbound links from Operations overview and Hosting elsewhere → Server roles.
  • Spot-check outbound links: server roles, indexing, pagination, connection pool, database interceptors, JWT token manager, caching, server events, streaming, configuration reference.
  • Skim for em dashes and marketing wording against STYLE_GUIDE.md.

Document how to scale Serverpod beyond a single process, covering roles, isolates, Postgres, Redis, JWT, and streaming tradeoffs.
Comment thread docs/06-concepts/07-operations/06-scalability.md Outdated
@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Sep 7, 2026
Comment thread docs/06-concepts/07-operations/06-scalability.md Outdated
Comment thread docs/06-concepts/07-operations/06-scalability.md Outdated
Comment thread docs/06-concepts/07-operations/06-scalability.md Outdated
Comment thread docs/06-concepts/07-operations/06-scalability.md Outdated
Correct MessageScope/Redis behavior, unlimited pool wording, and cheat-sheet defaults.
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Addressed the suggestions, Jamiu.
Please take another look.

Comment thread docs/06-concepts/07-operations/06-scalability.md Outdated
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hey Jamiu, updated the frontmatter description to the noun-led

@developerjamiu
developerjamiu merged commit 49e8e7c into serverpod:main Sep 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation page on scalability and optimization

2 participants