Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Make Meilisearch fully optional for monorepo server development (#14331)

Damian Legawiecfb6238c0be24
diff --git a/CLAUDE.md b/CLAUDE.md
index 8e4d7d9e04..65e818a7d4 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -97,7 +97,7 @@ Day-to-day from the repo root: `pnpm server:dev` (foreground — streams web log
| Gem dependencies (gemspec / Gemfile / starter `Gemfile.lock` drift after a pull) | Nothing — the next `pnpm server:dev` boot self-heals (`bundle check || bundle install` into the `bundle_cache` volume); while running: `cd server && pnpm exec spree bundle install` |
| Compose files / `server/.env` | `pnpm server:dev` (force-recreates web + worker) |
| `server/Dockerfile` / `.ruby-version` / starter update that breaks the image build (frozen-lockfile error) | `pnpm server:build`, then `pnpm server:dev` — the build script swaps the edge PATH lock for a RubyGems-resolved one and the next boot swaps it back |
-| Meilisearch image bump ("database version … is incompatible") | `docker compose -p server rm -sf meilisearch && docker volume rm server_meilisearch_data`, boot, then `cd server && pnpm exec spree rake spree:search:reindex` |
+| Working on the Meilisearch search provider | Off by default (DB provider) — `SPREE_MEILISEARCH=1 pnpm server:dev` chains `scripts/docker-compose.meilisearch.yml` (service + `MEILISEARCH_URL`), then `cd server && pnpm exec spree rake spree:search:reindex` once. Booting without the flag reverts web to DB search and removes the meilisearch container; the index volume stays. Image bump ("database version … is incompatible"): `pnpm server:stop && docker volume rm server_meilisearch_data`, flagged boot, reindex |
| Broken beyond repair | `pnpm server:setup` (full reset — wipes DB + volumes) |
Backend: http://localhost:3000, admin at `/admin`, hosted React Dashboard at `/dashboard` (`[email protected]` / `spree123`). Native no-Docker path: `pnpm server:create`, then `cd server && bin/setup && bin/dev`.
diff --git a/docs/plans/5.4-search-provider.md b/docs/plans/5.4-search-provider.md
index 08e595b9c3..9f94bcb6bf 100644
--- a/docs/plans/5.4-search-provider.md
+++ b/docs/plans/5.4-search-provider.md
@@ -1,10 +1,10 @@
# Search Provider Interface
-**Status:** 5.4 portion shipped (`Spree::SearchProvider::Base/Database/Meilisearch`, PgSearch removed, `add_search_scope` removed); 6.0 metafield faceting pending
+**Status:** 5.4 portion shipped (`Spree::SearchProvider::Base/Database/Meilisearch`, PgSearch removed, `add_search_scope` removed); 6.0 metafield faceting pending. 2026-07-19: spree-starter / create-spree-app no longer provision Meilisearch by default — the Database provider is the out-of-the-box default everywhere; Meilisearch is a documented opt-in — installs: uncomment the compose blocks + set `MEILISEARCH_URL`; monorepo dev server: `SPREE_MEILISEARCH=1 pnpm server:dev` (chains `scripts/docker-compose.meilisearch.yml`); either way run `spree:search:reindex` once on first boot. See decisions.md.
**Target:** Spree 5.4 (provider + DB provider + PgSearch removal + add_search_scope removal + Meilisearch provider ✓), 6.0 (metafield faceting)
**Depends on:** None for 5.4. ProductType (6.0-product-types.md) for metafield faceting in 6.0.
**Author:** Damian + Claude
-**Last updated:** 2026-05-20
+**Last updated:** 2026-07-19
## Summary
diff --git a/docs/plans/decisions.md b/docs/plans/decisions.md
index 05d9d2b7bd..a58295756a 100644
--- a/docs/plans/decisions.md
+++ b/docs/plans/decisions.md
@@ -25,6 +25,26 @@ Also decided: no company row in the legacy Rails admin customer view. Metadata
is exposed by the Admin API v3 customer serializer (React dashboard shows it);
the legacy admin renders customer metadata nowhere and stays that way.
+## 2026-07-19: Database search provider is the out-of-the-box default; Meilisearch becomes opt-in
+
+spree-starter and create-spree-app no longer provision Meilisearch. The Docker
+compose files stop running the `meilisearch` service and stop hardcoding
+`MEILISEARCH_URL`, so `Spree::SearchProvider::Database` — already the core
+default and already the effective default on the native (no-Docker) path — is
+now the default on every install path. One less always-on container (image
+pull, RAM, volume) for the common case; `Spree::SearchProvider::IndexJob` /
+`RemoveJob` never enqueue under the DB provider (`indexing_required?` is
+false), so the default stack also stops paying per-save indexing jobs.
+
+Opt-in stays config-only: commented service/depends_on/env/volume blocks in
+both compose files + `MEILISEARCH_URL`, then `spree:search:reindex`. The
+`meilisearch` gem stays in the starter Gemfile so the prebuilt
+`ghcr.io/spree/spree` image retains the capability — enabling Meilisearch on
+the quick-start compose must not require a custom image build. Docs continue
+to recommend Meilisearch for production-scale catalogs (see
+`5.4-search-provider.md`); this changes what's provisioned by default, not the
+recommendation.
+
## 2026-07-15: Basic Stripe Connect payouts move to OSS; Enterprise repositions on money operations
spree/spree#13323 originally kept "Stripe Connect onboarding, KYC, automatic
diff --git a/package.json b/package.json
index e66cf2695d..a6ace21d58 100644
--- a/package.json
+++ b/package.json
@@ -14,10 +14,10 @@
"server:create": "git clone --depth 1 https://github.com/spree/spree-starter.git server && rm -rf server/.git server/.gitignore && printf 'SPREE_PATH=..\\nSECRET_KEY_BASE=%s\\n' \"$(openssl rand -hex 64)\" > server/.env",
"server:setup": "bash scripts/server-setup.sh",
"server:dashboard": "turbo build --filter=@spree/dashboard && VITE_BASE_PATH=/dashboard/ pnpm --dir packages/dashboard-starter build",
- "server:dev": "SPREE_PATH=$PWD docker compose -f server/docker-compose.dev.yml -f scripts/docker-compose.edge.yml up --force-recreate web",
+ "server:dev": "SPREE_PATH=$PWD docker compose -f server/docker-compose.dev.yml -f scripts/docker-compose.edge.yml ${SPREE_MEILISEARCH:+-f scripts/docker-compose.meilisearch.yml} up --force-recreate --remove-orphans web",
"server:build": "bash scripts/server-build.sh",
"server:restart": "SPREE_PATH=$PWD docker compose -f server/docker-compose.dev.yml -f scripts/docker-compose.edge.yml restart web",
- "server:stop": "SPREE_PATH=$PWD docker compose -f server/docker-compose.dev.yml -f scripts/docker-compose.edge.yml down",
+ "server:stop": "SPREE_PATH=$PWD docker compose -f server/docker-compose.dev.yml -f scripts/docker-compose.edge.yml -f scripts/docker-compose.meilisearch.yml down",
"server:console": "cd server && spree console",
"server:logs": "cd server && spree logs",
"server:seed": "cd server && spree rails db:seed",
diff --git a/packages/cli/src/commands/build.ts b/packages/cli/src/commands/build.ts
index f28cf7b099..410ff80076 100644
--- a/packages/cli/src/commands/build.ts
+++ b/packages/cli/src/commands/build.ts
@@ -76,7 +76,7 @@ async function buildDevImage(flags: { resetBundle?: boolean; yes?: boolean }): P
const s = p.spinner()
s.start('Wiping bundle_cache volume...')
try {
- // `down` without -v preserves postgres/redis/meilisearch/storage volumes.
+ // `down` without -v preserves the postgres/storage volumes.
await dockerCompose(['down'], ctx.projectDir, { stdio: 'ignore' })
const projectName = await resolveComposeProjectName(ctx.projectDir)
const volumeName = `${projectName}_bundle_cache`
diff --git a/packages/cli/src/commands/dev.ts b/packages/cli/src/commands/dev.ts
index d453d53989..e4ccf522c1 100644
--- a/packages/cli/src/commands/dev.ts
+++ b/packages/cli/src/commands/dev.ts
@@ -131,7 +131,7 @@ export function registerDevCommand(program: Command): void {
// Foreground `up`, like `vite dev`: Ctrl+C delivers SIGINT to compose,
// which gracefully stops web + worker. Dependency services (postgres,
- // redis, meilisearch) start via depends_on but stay up afterwards.
+ // mailpit) start via depends_on but stay up afterwards.
// Ignore SIGINT in the CLI itself so compose owns the shutdown and we
// live to print the outro.
const ignoreSigint = () => {}
diff --git a/packages/cli/src/docker.ts b/packages/cli/src/docker.ts
index 9b0e3b4384..a258c12965 100644
--- a/packages/cli/src/docker.ts
+++ b/packages/cli/src/docker.ts
@@ -187,7 +187,7 @@ export interface DockerComposeRunOptions {
// Run a command in a one-off `compose run --rm` container — the twin of
// dockerComposeExec for when the service's long-running container is NOT up.
// Unlike `exec`, `run` builds a fresh container and (in Compose v2) starts the
-// service's depends_on (postgres/redis/meilisearch), honoring their
+// service's depends_on (postgres/mailpit), honoring their
// `condition: service_healthy` healthchecks before the command runs — so it
// works from a fully cold stack. We deliberately omit `--no-deps` (we WANT
// those deps started + health-waited) and `--service-ports` (these callers
diff --git a/packages/create-spree-app/tests/scaffold.test.ts b/packages/create-spree-app/tests/scaffold.test.ts
index 81b056f1cc..9732690246 100644
--- a/packages/create-spree-app/tests/scaffold.test.ts
+++ b/packages/create-spree-app/tests/scaffold.test.ts
@@ -14,7 +14,6 @@ const FAKE_COMPOSE = `x-app: &app
DATABASE_URL: postgres://postgres@postgres:5432/spree_production
REDIS_URL: redis://redis:6379/0
SECRET_KEY_BASE: \${SECRET_KEY_BASE}
- MEILISEARCH_URL: http://meilisearch:7700
services:
postgres:
@@ -142,8 +141,9 @@ describe('scaffold (no-start)', () => {
})
const compose = fs.readFileSync(path.join(projectDir, 'docker-compose.yml'), 'utf-8')
- expect(compose).toContain('ghcr.io/spree/spree')
- expect(compose).toContain('MEILISEARCH_URL')
+ // The quick-start compose is copied verbatim — only the dev compose gets
+ // path adjustments for the wrapper layout.
+ expect(compose).toBe(FAKE_COMPOSE)
})
it('adjusts docker-compose.dev.yml build context to ./backend', async () => {
diff --git a/scripts/docker-compose.meilisearch.yml b/scripts/docker-compose.meilisearch.yml
new file mode 100644
index 0000000000..2a17e88296
--- /dev/null
+++ b/scripts/docker-compose.meilisearch.yml
@@ -0,0 +1,39 @@
+# Optional Meilisearch overlay for monorepo server development. The starter
+# no longer provisions Meilisearch (the Database search provider is the
+# default), so provider work opts in here — this file lives in the monorepo
+# and survives `pnpm server:setup` resets, unlike edits to the server/ clone.
+#
+# The pnpm server:* scripts chain this file when SPREE_MEILISEARCH is set:
+#
+# SPREE_MEILISEARCH=1 pnpm server:dev
+# cd server && pnpm exec spree rake spree:search:reindex # first boot only
+#
+# Dropping the flag on the next `pnpm server:dev` recreates web without
+# MEILISEARCH_URL (back to DB search) and removes the meilisearch container
+# (`--remove-orphans`); the index volume is kept until `docker volume rm
+# server_meilisearch_data`.
+
+services:
+ web:
+ environment:
+ MEILISEARCH_URL: http://meilisearch:7700
+ depends_on:
+ meilisearch:
+ condition: service_healthy
+
+ meilisearch:
+ image: getmeili/meilisearch:latest
+ volumes:
+ - meilisearch_data:/meili_data
+ ports:
+ # Loopback-only: no API key is set in dev, and a 0.0.0.0 publish would
+ # bypass host firewalls on Linux (Docker inserts its NAT rules first).
+ - "127.0.0.1:${SPREE_MEILISEARCH_PORT:-7700}:7700"
+ healthcheck:
+ test: curl -f http://localhost:7700/health || exit 1
+ interval: 5s
+ timeout: 5s
+ retries: 5
+
+volumes:
+ meilisearch_data:
diff --git a/scripts/server-setup.sh b/scripts/server-setup.sh
index a89a3d702b..918e5e96d3 100755
--- a/scripts/server-setup.sh
+++ b/scripts/server-setup.sh
@@ -70,7 +70,9 @@ fi
step "Starting the edge stack"
# Detached on purpose — `pnpm server:dev` runs the stack in the foreground
# (streaming logs, Ctrl+C to stop); setup needs to continue past the boot.
-SPREE_PATH="$ROOT" docker compose -f "$DEV_COMPOSE" -f "$EDGE_OVERLAY" up -d --force-recreate web
+# SPREE_MEILISEARCH opts into the Meilisearch search provider overlay, same
+# as `pnpm server:dev` (safe under set -u: :+ is exempt from nounset).
+SPREE_PATH="$ROOT" docker compose -f "$DEV_COMPOSE" -f "$EDGE_OVERLAY" ${SPREE_MEILISEARCH:+-f scripts/docker-compose.meilisearch.yml} up -d --force-recreate web
step "Waiting for the stack to finish booting"
# The edge web boot runs bundle install + spree:install:migrations +