Skip to content

docs: Add a Redis connection page - #784

Merged
developerjamiu merged 5 commits into
serverpod:mainfrom
abdulawalarif:docs/improve-redis-documentation
Sep 7, 2026
Merged

docs: Add a Redis connection page#784
developerjamiu merged 5 commits into
serverpod:mainfrom
abdulawalarif:docs/improve-redis-documentation

Conversation

@abdulawalarif

Copy link
Copy Markdown
Contributor

Summary

  • Add a Redis concept page that mirrors the Postgres connection docs: enable Redis, set host/port/password, start the development Docker instance, and connect a GUI such as RedisInsight.
  • Document the correct passwords.yaml nesting (development.redis, not under database), the 8091 vs 6379 port mapping, and that the default Docker Redis has no username.
  • Link the new page from Configuration, Caching, Server events, Health checks, Running your server, the configuration reference, and the Cloud Redis guide.

Fixes serverpod/serverpod#1848

Test plan

  • Open Concepts → Server fundamentals → Redis and confirm the page renders, including YAML/bash blocks and tables.
  • Click through Related links and inbound links from Configuration, Caching, Server events, Health checks, and the Cloud Redis guide.
  • Confirm there are no em dashes and that in-docs links omit numbered folder prefixes.

@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Sep 7, 2026
Comment thread docs/06-concepts/01-server-fundamentals/05-redis.md Outdated
Comment thread docs/06-concepts/01-server-fundamentals/05-redis.md Outdated
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hey Jamiu, I applied your suggestions.
Redis fallback now says it applies in every run mode except production.

Comment thread docs/06-concepts/01-server-fundamentals/05-redis.md Outdated
Match the Concepts frontmatter pattern so the description starts with a noun phrase.
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hey Jamiu, I updated the Redis page description to the noun-led

@developerjamiu
developerjamiu merged commit ee6c936 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.

Improve redis documentation

2 participants