Skip to content

redis: Add docs for externalizing Redis with Docker Compose deployments - #2149

Merged
marcleblanc2 merged 1 commit into
mainfrom
external-redis-docker-compose
Nov 11, 2026
Merged

marcleblanc2 merged 1 commit into
mainfrom
external-redis-docker-compose

Conversation

@marcleblanc2

@marcleblanc2 marcleblanc2 commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Updates Using your own Redis server: adds a Docker Compose section and removes the deprecated single-container section.

Merge after sourcegraph/deploy-sourcegraph-docker#1482, which adds the example this page links to. Until then, the link check fails on that URL.

Test plan

…container

Document REDIS_CACHE_ENDPOINT and REDIS_STORE_ENDPOINT, the services that
need them on Docker Compose, and the deploy-sourcegraph-docker
external-redis example. Remove the deprecated single-container section.

Amp-Thread-ID: https://ampcode.com/threads/T-5e703d95-d3ee-4486-9b11-630a3ae8b3e2
Co-authored-by: Amp <amp@ampcode.com>
@vercel

vercel Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Nov 11, 2026 4:05am UTC

Request Review

@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor
Page Before After Diff
/self-hosted/external-services/redis prod preview −11 +21

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

❌ This PR introduces 1 broken link(s)

Outbound

Your PR includes links to pages or anchors that do not exist.

docs/self-hosted/external-services/redis.mdx

  • line 28
    • Link: https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/main/docker-compose/examples/external-redis/docker-compose.override.yaml
    • Problem: External link returns HTTP 404

Reproduce locally with pnpm check links --check-anchors --check-self-links (see dev/check-links.mjs).

Adding a redirect in src/data/redirects.ts does not satisfy this check, because it’s a workaround instead of a fix.

@marcleblanc2 marcleblanc2 changed the title self-hosted/external-services/redis: Add Docker Compose, drop single-container redis: Add docs for externalizing Redis with Docker Compose deployments Nov 11, 2026
@marcleblanc2
marcleblanc2 marked this pull request as ready for review November 11, 2026 04:10
@marcleblanc2
marcleblanc2 requested a review from a team November 11, 2026 04:10
@marcleblanc2
marcleblanc2 enabled auto-merge (squash) November 11, 2026 04:10
@marcleblanc2
marcleblanc2 merged commit 45d23e4 into main Nov 11, 2026
12 of 13 checks passed
@marcleblanc2
marcleblanc2 deleted the external-redis-docker-compose branch November 11, 2026 04:12
marcleblanc2 added a commit to sourcegraph/deploy-sourcegraph-docker that referenced this pull request Nov 11, 2026
Adds an example override for using external Redis with Docker Compose.
It sets `REDIS_CACHE_ENDPOINT` and `REDIS_STORE_ENDPOINT` on every
service that uses Redis and disables the built-in Redis containers.

Docs: sourcegraph/docs#2149

### Checklist

- [x] All images have a valid tag and SHA256 sum (no images changed)

### Test plan

Ran the full stack with this override against an external Redis (one
instance with a password). All services were healthy, connected to it,
and logged no Redis errors. Sign-in, cloning, and search worked. `docker
compose up -d --remove-orphans` removed the built-in Redis containers
from an existing deployment.

Co-authored-by: Amp <amp@ampcode.com>
aditiabhang added a commit that referenced this pull request Nov 12, 2026
## Summary
- Set `DOCS_LATEST_VERSION` to 8.2
- Add Sourcegraph 8.1 (`https://8.1.sourcegraph.com`) to the version
selector

The 8.1 docs are archived on [`docs-legacy-versions`
`v8_1`](https://github.com/sourcegraph/docs-legacy-versions/tree/v8_1),
cut from `45d23e43` (#2149), the last `main` commit before 8.2.0 was
published (2026-11-11T19:48:25Z). #2150 merged after that and is not in
the archive.

These PRs document 8.2 behavior and are reverted on `v8_1`:
- #2139 and #2141: Agentic Batch Changes handover and Threads page
(sourcegraph/sourcegraph#18298 to #18300 are on `8.2.x`)
- #2127: Agentic Batch Changes sharing (sourcegraph/sourcegraph#18196 is
on `8.2.x` only)
- #2098: Agentic Batch Changes connectors (sourcegraph/sourcegraph#16905
is not on `8.1.x`)
- #2149: Redis with Docker Compose (links
sourcegraph/deploy-sourcegraph-docker#1482, merged after 8.2.0)

## Merge timing
Merge after `8.1.sourcegraph.com` serves the `v8_1` branch, so the
selector link does not fail. DNS already points it at Vercel, but HTTPS
does not connect yet: the domain still needs mapping on the
`docs-legacy-versions` Vercel project.

## Test plan
- `npx tsc --noEmit`
- `v8_1`: the link check reports no findings beyond those already on
`45d23e43`

Co-authored-by: Amp <amp@ampcode.com>

This branch was successfully deployed

1 active deployment
Preview — 5e7be735 Deployed Nov 11, 2026 by vercel[bot]
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.

2 participants