docs: document Next.js session caching configuration #4388
Closed
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Shridhad
requested changes
Jan 30, 2026
| <Admonition type="tip" title="Optional: Enable session caching for better performance"> | ||
| Add `NEON_AUTH_COOKIE_SECRET` to enable local session data caching, which reduces Auth Server API calls by 95-99%. Session data is cached with a 5-minute TTL and validated using signed cookies. The secret must be at least 32 characters long. | ||
|
|
||
| This feature is opt-in and fully backward compatible. Without this variable, the SDK will continue to validate sessions with the Auth Server on every request. |
Contributor
There was a problem hiding this comment.
It is not opt-in, you must provide the NEON_AUTH_COOKIE_SECRET
| ```bash | ||
| NEON_AUTH_BASE_URL=https://ep-xxx.neonauth.us-east-1.aws.neon.tech/neondb/auth | ||
|
|
||
| # Optional: Enable session caching (recommended for production) |
| NEON_AUTH_BASE_URL=https://ep-xxx.neonauth.us-east-1.aws.neon.tech/neondb/auth | ||
|
|
||
| # Optional: Enable session caching (recommended for production) | ||
| NEON_AUTH_COOKIE_SECRET=your-secret-key-at-least-32-characters-long |
Contributor
There was a problem hiding this comment.
Lets add how to generate this secret with openssl
openssl rand -base64 32At some point we should have this secret into environment variables from neon console itself
| <Admonition type="tip" title="Optional: Enable session caching for better performance"> | ||
| Add `NEON_AUTH_COOKIE_SECRET` to enable local session data caching, which reduces Auth Server API calls by 95-99%. Session data is cached with a 5-minute TTL and validated using signed cookies. The secret must be at least 32 characters long. | ||
|
|
||
| This feature is opt-in and fully backward compatible. Without this variable, the SDK will continue to validate sessions with the Auth Server on every request. |
| NEON_AUTH_BASE_URL=https://ep-xxx.neonauth.us-east-1.aws.neon.tech/neondb/auth | ||
|
|
||
| # Optional: Enable session caching (recommended for production) | ||
| NEON_AUTH_COOKIE_SECRET=your-secret-key-at-least-32-characters-long |
Add documentation for the optional NEON_AUTH_COOKIE_SECRET environment variable that enables local session data caching in Next.js applications. This feature reduces Auth Server API calls by 95-99% with a 5-minute cache TTL. Updated both Next.js quickstart guides: - Next.js with UI Components guide - Next.js with API methods guide The session caching feature is opt-in, fully backward compatible, and recommended for production environments. Related: neondatabase/neon-js#35
Enhanced the neon-js SDK documentation sync workflow rules based on learnings from documenting PR #35 (session caching feature). Key improvements: - Added Documentation Scope Decision Tree to distinguish between client SDK, Next.js server-side, and framework-specific changes - Added complete guidance for updating Next.js quickstart guides - Expanded user-facing changes checklist to include server-side features - Enhanced summary template to categorize changes by documentation type - Updated execution checklist with scope determination and frontmatter updates These changes ensure the workflow accurately handles both client-side SDK API changes and framework-specific server-side features.
Organize Cursor configuration by moving the changelog generator rules file into the .cursor/rules/ directory for better structure.
Created comprehensive rules for syncing documentation from the neondatabase-labs/mcp-server-neon repository to the website docs. Key features: - Documentation scope decision tree (tools vs setup vs client-specific) - Guidance for updating 3 reference docs and 7 client-specific guides - Detailed update patterns for MCP tools list - Security-first approach for powerful MCP capabilities - Client-specific setup variations (Claude, Cursor, VS Code, etc.) - Complete workflow from PR review to documentation updates This enables systematic documentation updates when new MCP tools, setup improvements, or client integrations are added to the server.
Made the mcp-tools.md shared component pattern explicit and prominent: - Added important admonition about single source of truth - Updated Important Notes section with shared component guidance - Enhanced execution checklist with DO NOT duplicate warning - Clarified example workflow to show automatic propagation This ensures the tools list is only updated in one location and automatically propagates to all guides via the <MCPTools /> component.
Added Step 6 to check and update the source repository's README when syncing MCP server documentation. Key additions: - Guidance on when to update the source repo README - Process for opening PRs to neondatabase-labs/mcp-server-neon - README sync section in Important Notes - Updated execution checklist with README verification - Enhanced example workflows showing README checks - Updated summary template to track README status This ensures the source repo's README stays in sync with website docs, providing consistent documentation for developers accessing the repo directly.
danieltprice
force-pushed
the
docs/document-session-caching
branch
from
bb8bad4 to
b0c82b8
Compare
Collaborator
Author
|
Thank you. These comments have all been addressed in the docs. |
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.
Add documentation for the optional NEON_AUTH_COOKIE_SECRET environment variable that enables local session data caching in Next.js applications. This feature reduces Auth Server API calls by 95-99% with a 5-minute cache TTL.
Updated both Next.js quickstart guides:
The session caching feature is opt-in, fully backward compatible, and recommended for production environments.
Related: neondatabase/neon-js#35
(This PR also adds some docs rules files)