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.

Cleanup docs around multi-store/multi-tenant capabilites (#14209)

Damian Legawiec976fb86ca005
diff --git a/docs/developer/core-concepts/architecture.mdx b/docs/developer/core-concepts/architecture.mdx
index c09398f0bb..7a99d9866b 100644
--- a/docs/developer/core-concepts/architecture.mdx
+++ b/docs/developer/core-concepts/architecture.mdx
@@ -121,7 +121,7 @@ Events from both APIs can trigger [Webhooks](/developer/core-concepts/webhooks)
## Multi-Store Architecture
-Spree supports [multiple stores](/developer/multi-store/quickstart) from a single installation. Each Store can have:
+Spree supports running [multiple storefronts](/developer/multi-tenant/quickstart) from a single installation. Each Store can have:
- Its own domain and branding
- Different currencies and locales
diff --git a/docs/developer/core-concepts/markets.mdx b/docs/developer/core-concepts/markets.mdx
index 8771f5e295..a08e65cfc9 100644
--- a/docs/developer/core-concepts/markets.mdx
+++ b/docs/developer/core-concepts/markets.mdx
@@ -305,7 +305,6 @@ spree api delete /markets/market_xxx
## Related Documentation
- [Markets (Store SDK)](/developer/sdk/store/markets) — Listing, resolving, and reading markets from the Store SDK
-- [Stores](/developer/core-concepts/stores) — Multi-store setup and configuration
- [Pricing](/developer/core-concepts/pricing) — Price Lists, Price Rules, and the Pricing Context
- [Addresses](/developer/core-concepts/addresses) — Countries, States, and Zones
- [Localization](/api-reference/store-api/localization) — Locale, currency, and country headers in API requests
diff --git a/docs/developer/core-concepts/staff-roles.mdx b/docs/developer/core-concepts/staff-roles.mdx
index 80b086b295..ebb895c53e 100644
--- a/docs/developer/core-concepts/staff-roles.mdx
+++ b/docs/developer/core-concepts/staff-roles.mdx
@@ -170,6 +170,5 @@ See the [Customize Permissions guide](/developer/customization/permissions) for
- [Custom API Authentication](/developer/how-to/custom-api-authentication) — implement a custom identity-provider strategy (the full guide)
- [Admin API Authentication](/api-reference/admin-api/authentication) — keys, JWTs, scopes, and the refresh-cookie flow
- [Customers](/developer/core-concepts/customers) — Customer accounts and authentication
-- [Stores](/developer/core-concepts/stores) — Multi-store setup
- [Permissions](/developer/customization/permissions) — Roles and authorization
- [Events](/developer/core-concepts/events) — Subscribe to invitation events
diff --git a/docs/developer/core-concepts/stores.mdx b/docs/developer/core-concepts/stores.mdx
index e898df153e..5bc47b7fac 100644
--- a/docs/developer/core-concepts/stores.mdx
+++ b/docs/developer/core-concepts/stores.mdx
@@ -75,12 +75,10 @@ Each store owns its own resources. Products, orders, channels, markets, and taxo
## Running Multiple Storefronts
-If you need one Spree backend to serve **multiple distinct merchant brands** — different domains, different catalogs, different admin teams — there are two patterns:
+If you need one Spree backend to serve **multiple distinct merchant brands** — different domains, different catalogs — there are two patterns:
- **Multiple channels under one store** (recommended for most cases) — model each storefront as a Sales Channel. Products are scoped per-channel via publications, orders carry the channel that originated them, and routing/pricing can differ per channel. This is the supported pattern in core Spree 5.5+.
-- **Multiple stores in one app** — the legacy multi-store pattern, where each store is fully independent (catalog, admin, branding). In Spree 5.5+ this requires the [spree_multi_store](/developer/multi-store/quickstart) extension. Core Spree treats each product as belonging to a single store.
-
-For most multi-brand operations, the channel pattern is simpler and more flexible. Reach for [spree_multi_store](/developer/multi-store/quickstart) only when stores need genuinely independent catalogs, branding, and admin teams.
+- **Multiple isolated stores (tenants) in one app** — full data isolation, only recommended if you're building a SaaS platform or a multi-tenant application. Each store can have different staff members, payment methods, shipping methods, and branding. This is supported by the [Spree Multi Tenant](/developer/multi-tenant/quickstart) extension, which is a separate gem from core Spree.
## Related Documentation
diff --git a/docs/developer/core-concepts/translations.mdx b/docs/developer/core-concepts/translations.mdx
index aabdc91536..6f91596c77 100644
--- a/docs/developer/core-concepts/translations.mdx
+++ b/docs/developer/core-concepts/translations.mdx
@@ -137,5 +137,4 @@ The full list of supported locales is available in the [Spree I18n GitHub reposi
- [Markets](/developer/core-concepts/markets) — Locale and currency configuration per geographic region
- [Localization](/api-reference/store-api/localization) — Locale, currency, and country headers in API requests
- [Slugs](/developer/core-concepts/slugs) — Localized slugs and URL identifiers
-- [Stores](/developer/core-concepts/stores) — Multi-store setup
- [Products](/developer/core-concepts/products) — Product translations
diff --git a/docs/developer/multi-store/quickstart.mdx b/docs/developer/multi-store/quickstart.mdx
deleted file mode 100644
index d29768824a..0000000000
--- a/docs/developer/multi-store/quickstart.mdx
+++ /dev/null
@@ -1,86 +0,0 @@
----
-title: Multi-Store Spree Commerce Quickstart
-sidebarTitle: Quickstart
-description: Enable multiple storefronts on a single Spree app with the spree_multi_store gem, including per-store products, payment methods, taxonomies, and promotions.
----
-
-To enable multiple stores, you will need to add the [spree_multi_store](/developer/multi-store/quickstart) gem to your project via:
-
-<CodeGroup>
-
-```bash Spree CLI (Docker)
-spree bundle add spree_multi_store
-```
-
-```bash Without Spree CLI
-bundle add spree_multi_store
-```
-
-</CodeGroup>
-
-<Info>
-Spree Multi-Store is licensed under the [AGPL v3 License](https://opensource.org/licenses/AGPL-3.0).
-
-If you would like to use it in a commercial application, please [contact us](https://spreecommerce.org/get-started/) to obtain a commercial license.
-</Info>
-
-<Frame type="glass" caption="Spree multi-store setup">
-![](/images/mulit_store_978x2.png)
-</Frame>
-
-## Store resources
-
-Each Store can have its own resources. For example, a Store can have its own Products, Taxonomies, Promotions, etc.
-
-| Resource | Relationship |
-| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [**Order**](/core-concepts/orders) | One Order belongs to one Store |
-| [**Product**](/core-concepts/products) | One Product can be associated with many Store(s), you can pick and choose in which Store(s) each Product will be available |
-| [**Payment Method**](/core-concepts/payments) | One Payment Method can be associated with many Store(s), you can select in which Stores given Payment Method will be available on Checkout |
-| [**Taxonomy**](/core-concepts/products#taxons-and-taxonomies) | One Taxonomy belongs to one Store |
-| [**Promotion**](/core-concepts/promotions) | One Promotion can be associated with multiple Stores |
-| **Store Credit** | One Store Credit belongs to and can be used in one Store
-
-## Current Store
-
-Spree will try to determine the current store based on the current URL. If the URL does not match any of the stores in the database, Spree will fall back to the default store.
-
-All Spree controllers or any other controllers that include [Spree::Core::ControllerHelpers::Store](https://github.com/spree/spree/blob/main/core/lib/spree/core/controller_helpers/store.rb) have access to the `current_store` method which returns the `Store` matching the current URL.
-
-All parts of Spree (API, Admin Panel) have this implemented.
-
-<Info>
-Under the hood `current_store` calls [Spree::Stores::FindCurrent.new(url: url).execute](https://github.com/spree/spree/blob/main/core/app/finders/spree/stores/find_current.rb).
-
-This logic can be easily overwritten by setting
-
-```ruby
-Spree::Dependencies.current_store_finder = 'MyStoreFinderClass'
-```
-
-in `config/initializers/spree.rb` file
-</Info>
-
-## Default Store
-
-If the system cannot find any Store that matches the current URL it will fall back to the Default Store.
-
-You can set the default Store via Rails console:
-
-```ruby
-Spree::Store.find(2).update(default: true)
-```
-
-To get the default store in your code or rails console type:
-
-```ruby
-Spree::Store.default
-```
-
-## Custom Domains
-
-Spree supports managing custom domains for Stores. In the Admin Panel, you can manage custom domains for each Store in the **Settings -> Domains** page.
-
-## Setup multi-store application
-
-[Follow the setup guide](/developer/multi-store/setup) to get started.
diff --git a/docs/developer/multi-store/setup.mdx b/docs/developer/multi-store/setup.mdx
deleted file mode 100644
index b23a248c4e..0000000000
--- a/docs/developer/multi-store/setup.mdx
+++ /dev/null
@@ -1,40 +0,0 @@
----
-title: Multi-Store Setup
-sidebarTitle: Setup
----
-
-## Root domain
-
-You need to set a wildcard `root_domain` on the store to enable multi-store setup
-
-```ruby
-Spree.root_domain = ENV.fetch('SPREE_ROOT_DOMAIN', 'lvh.me')
-```
-
-This will be used to generate the store URLs, eg. `store1.lvh.me`, `store2.lvh.me`, etc.
-
-`store1` part is the unique store `code` identifier, which is auto-generated based on the store name. You can change it in the admin panel in **Settings -> Domains**.
-
-<Info>
- If you later change the `root_domain`, you will need to run:
-
- ```ruby
- Spree::Store.all.each(&:save)
- ```
-
- to update the store URLs.
-</Info>
-
-## Creating new stores
-
-After you restart your application, you will see a new option in the admin panel, under new item menu:
-
-![](/images/new_store_dropdown.png)
-
-You can also create a new store from the rails console:
-
-```ruby
-Spree::Store.create!(name: 'New Store')
-```
-
-This will create a new store with the given name, code and URL.
\ No newline at end of file
diff --git a/docs/developer/multi-tenant/core-concepts.mdx b/docs/developer/multi-tenant/core-concepts.mdx
index 90b2da929d..3df662a749 100644
--- a/docs/developer/multi-tenant/core-concepts.mdx
+++ b/docs/developer/multi-tenant/core-concepts.mdx
@@ -36,7 +36,7 @@ bin/rails g model Spree::NewModel tenant:references name:string --parent SpreeMu
## Tenant selector
-By default the current tenant is selected based on the subdomain or `Spree::CustomDomain`. The selector works in tandem with the default [Spree::Stores::FindCurrent](https://github.com/spree/spree/blob/main/core/app/finders/spree/stores/find_current.rb) finder.
+By default the current tenant is selected based on the subdomain or `Spree::CustomDomain`.
First it finds the current store, and later sets the current tenant based on the store's `tenant_id`.
diff --git a/docs/developer/multi-tenant/installation.mdx b/docs/developer/multi-tenant/installation.mdx
deleted file mode 100644
index 01c605f7f8..0000000000
--- a/docs/developer/multi-tenant/installation.mdx
+++ /dev/null
@@ -1,128 +0,0 @@
----
-title: Spree Multi Tenant Installation
-sidebarTitle: Installation
-description: Install and configure Spree Multi-Tenant to run a SaaS ecommerce platform, including prerequisites, gem setup, license keys, and tenant provisioning.
----
-
-<Warning>
- This installation instructions assume you have a clean Spree Starter installation and you've purchased the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
-
- For migrating existing application from single-tenant to multi-tenant, please contact us at [[email protected]](mailto:[email protected]).
-</Warning>
-
-## Prerequisites
-
-* You need to be on Spree 5.1+, we recommend using [spree_starter](https://github.com/spree/spree_starter) as a base for your application
-* You need to have 2 environment variables set:
- * `KEYGEN_ACCOUNT_ID`
- * `KEYGEN_LICENSE_KEY`
-* We support both PostgreSQL and MySQL databases
-
-<Info>
- Environment variables will be provided to you after purchasing the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
-</Info>
-
-<Warning>
- You will need to add these environment variables to your CI/CD pipeline and production environments.
-</Warning>
-
-## Customer User Class
-
-Please follow [Authentication](/docs/developer/customization/authentication) documentation to create a new user class.
-
-Now we will need to make slight adjustments to the generated user class so it can work in a multi-tenant environment.
-
-If you're using Devise, you will need to remove `:validatable` module. This module is responsible for validating the user's email uniqueness. We need to change it to validate it in the scope of the tenant.
-
-Spree Multi-Tenant gem injects `SpreeMultiTenant::CustomerUserConcern` that handles that instead.
-
-## Admin User Class
-
-For our multi-tenant setup we will need a separate Admin user class. Our standard User class will be only used for customer accounts which will be isolated by tenant.
-Admin user classes will be shared across tenants allowing them to manage multiple tenants from a single admin panel.
-
-Let's create a new model with Devise (unless you already have one):
-
-<CodeGroup>
-
-```bash Spree CLI (Docker)
-spree rails g devise Spree::AdminUser
-```
-
-```bash Without Spree CLI
-bin/rails g devise Spree::AdminUser
-```
-
-</CodeGroup>
-
-Replace the generated Devise code with the following:
-
-```ruby
-class Spree::AdminUser < Spree::Base
- # Include default devise modules. Others available are:
- # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
- devise :database_authenticatable, :registerable,
- :recoverable, :rememberable, :validatable
-
- # Spree modules
- include Spree::UserMethods
-end
-```
-
-If you already have a custom Admin user class, you can add the following code to it:
-
-```ruby
- # Spree modules
- include Spree::UserMethods
-```
-
-This will make sure that the Admin user class works well with Spree ecosystem.
-
-Register new model in `config/initializers/spree.rb`:
-
-```ruby
-Spree.admin_user_class = "Spree::AdminUser"
-```
-
-## Installing gems
-
-1. Add the following code to your `Gemfile`:
-
- ```ruby
- source "https://license:#{ENV['KEYGEN_LICENSE_KEY']}@rubygems.pkg.keygen.sh/#{ENV['KEYGEN_ACCOUNT_ID']}" do
- gem 'spree_enterprise'
- gem 'spree_multi_tenant'
- end
- ```
-
-2. Install gems:
-
- <CodeGroup>
-
- ```bash Spree CLI (Docker)
- spree bundle install
- ```
-
- ```bash Without Spree CLI
- bundle install
- ```
-
- </CodeGroup>
-
-3. Run generators:
-
- <CodeGroup>
-
- ```bash Spree CLI (Docker)
- spree generate spree_enterprise:install && spree generate spree_multi_tenant:install
- ```
-
- ```bash Without Spree CLI
- bin/rails g spree_enterprise:install && bin/rails g spree_multi_tenant:install
- ```
-
- </CodeGroup>
-
- <Info>
- This will copy and run migrations for `spree_enterprise` and `spree_multi_tenant` gems.
- </Info>
diff --git a/docs/developer/multi-tenant/quickstart.mdx b/docs/developer/multi-tenant/quickstart.mdx
index 71256ca70a..521fa754a3 100644
--- a/docs/developer/multi-tenant/quickstart.mdx
+++ b/docs/developer/multi-tenant/quickstart.mdx
@@ -1,20 +1,128 @@
---
-title: Building a Multi-Tenant Spree Application
-sidebarTitle: Quickstart
+title: Spree Multi Tenant Installation
+sidebarTitle: Installation
+description: Install and configure Spree Multi-Tenant to run a SaaS ecommerce platform, including prerequisites, gem setup, license keys, and tenant provisioning.
---
-Spree out of the box is a single-tenant application. You can have multiple stores on the same instance of Spree, but they share the same products, admin user accounts and other resources.
-Multi-Store Spree setup is recommended for running multiple brands or multiple language versions of the same brand on the same instance.
+<Warning>
+ This installation instructions assume you have a clean Spree Starter installation and you've purchased the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
+
+ For migrating existing application from single-tenant to multi-tenant, please contact us at [[email protected]](mailto:[email protected]).
+</Warning>
-If you want to have a true multi-tenant application, you will need to purchase [Enterprise Edition license](https://spreecommerce.org/pricing) which includes `spree_multi_tenant` gem providing full multi-tenant support.
+## Prerequisites
-## Multi-Store vs Multi-Tenant
+* You need to be on Spree 5.1+, we recommend using [spree_starter](https://github.com/spree/spree_starter) as a base for your application
+* You need to have 2 environment variables set:
+ * `KEYGEN_ACCOUNT_ID`
+ * `KEYGEN_LICENSE_KEY`
+* We support both PostgreSQL and MySQL databases
-To sum it up:
+<Info>
+ Environment variables will be provided to you after purchasing the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
+</Info>
-* Multi-Store setup is recommended for running multiple brands or multiple language versions of the same store
-* Multi-Tenant allows you to create a SaaS application with multiple tenants, each of them with their own Spree instance
+<Warning>
+ You will need to add these environment variables to your CI/CD pipeline and production environments.
+</Warning>
-## Setup SaaS application
+## Customer User Class
-[Follow the installation instructions](/developer/multi-tenant/installation) to set up a multi-tenant Spree application.
\ No newline at end of file
+Please follow [Authentication](/developer/customization/authentication) documentation to create a new user class.
+
+Now we will need to make slight adjustments to the generated user class so it can work in a multi-tenant environment.
+
+If you're using Devise, you will need to remove `:validatable` module. This module is responsible for validating the user's email uniqueness. We need to change it to validate it in the scope of the tenant.
+
+Spree Multi-Tenant gem injects `SpreeMultiTenant::CustomerUserConcern` that handles that instead.
+
+## Admin User Class
+
+For our multi-tenant setup we will need a separate Admin user class. Our standard User class will be only used for customer accounts which will be isolated by tenant.
+Admin user classes will be shared across tenants allowing them to manage multiple tenants from a single admin panel.
+
+Let's create a new model with Devise (unless you already have one):
+
+<CodeGroup>
+
+```bash Spree CLI (Docker)
+spree rails g devise Spree::AdminUser
+```
+
+```bash Without Spree CLI
+bin/rails g devise Spree::AdminUser
+```
+
+</CodeGroup>
+
+Replace the generated Devise code with the following:
+
+```ruby
+class Spree::AdminUser < Spree::Base
+ # Include default devise modules. Others available are:
+ # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
+ devise :database_authenticatable, :registerable,
+ :recoverable, :rememberable, :validatable
+
+ # Spree modules
+ include Spree::UserMethods
+end
+```
+
+If you already have a custom Admin user class, you can add the following code to it:
+
+```ruby
+ # Spree modules
+ include Spree::UserMethods
+```
+
+This will make sure that the Admin user class works well with Spree ecosystem.
+
+Register new model in `config/initializers/spree.rb`:
+
+```ruby
+Spree.admin_user_class = "Spree::AdminUser"
+```
+
+## Installing gems
+
+1. Add the following code to your `Gemfile`:
+
+ ```ruby
+ source "https://license:#{ENV['KEYGEN_LICENSE_KEY']}@rubygems.pkg.keygen.sh/#{ENV['KEYGEN_ACCOUNT_ID']}" do
+ gem 'spree_enterprise'
+ gem 'spree_multi_tenant'
+ end
+ ```
+
+2. Install gems:
+
+ <CodeGroup>
+
+ ```bash Spree CLI (Docker)
+ spree bundle install
+ ```
+
+ ```bash Without Spree CLI
+ bundle install
+ ```
+
+ </CodeGroup>
+
+3. Run generators:
+
+ <CodeGroup>
+
+ ```bash Spree CLI (Docker)
+ spree generate spree_enterprise:install && spree generate spree_multi_tenant:install
+ ```
+
+ ```bash Without Spree CLI
+ bin/rails g spree_enterprise:install && bin/rails g spree_multi_tenant:install
+ ```
+
+ </CodeGroup>
+
+ <Info>
+ This will copy and run migrations for `spree_enterprise` and `spree_multi_tenant` gems.
+ </Info>
diff --git a/docs/developer/upgrades/4.2-to-4.3.mdx b/docs/developer/upgrades/4.2-to-4.3.mdx
index f724499abf..55330d4443 100644
--- a/docs/developer/upgrades/4.2-to-4.3.mdx
+++ b/docs/developer/upgrades/4.2-to-4.3.mdx
@@ -30,7 +30,7 @@ These gems were merged into Spree Core in version 4.3. All of their functionalit
### Optional Remove SpreeMultiDomain
-If you used that gem in the past you need to remove it. Multi-Store is now incorporated into Spree core and you cannot use that gem anymore.
+If you used that gem in the past you need to remove it.
1. Remove `spree_multi_domain` from your `Gemfile`
diff --git a/docs/developer/upgrades/5.3-to-5.4.mdx b/docs/developer/upgrades/5.3-to-5.4.mdx
index 2def888cef..2e0cc19b31 100644
--- a/docs/developer/upgrades/5.3-to-5.4.mdx
+++ b/docs/developer/upgrades/5.3-to-5.4.mdx
@@ -256,22 +256,6 @@ Also, add `jsonapi-rspec` gem to your `Gemfile`:
And run `bundle install`
-### (Optional) Install Spree Multi Store
-
-[Multi-store](/developer/multi-store/quickstart) features like multiple store management & custom domains were moved to a separate gem [spree_multi_store](/developer/multi-store/quickstart).
-
-If you rely on these features please run:
-
- ```bash
- bundle add spree_multi_store
- ```
-
-<Info>
-Spree Multi-Store is licensed under the [AGPL v3 License](https://opensource.org/licenses/AGPL-3.0).
-
-If you would like to use it in a commercial application, please [contact us](https://spreecommerce.org/get-started/) to obtain a commercial license.
-</Info>
-
### (Optional) Install Legacy Product Properties extension
Product Properties have been extracted from Spree core to a separate gem `spree_legacy_product_properties`. Product Properties were already deprecated in favor of [Metafields](/developer/core-concepts/metafields) and disabled by default since Spree 5.1.
diff --git a/docs/developer/upgrades/5.4-to-5.5.mdx b/docs/developer/upgrades/5.4-to-5.5.mdx
index 806c7e1e73..8b5ec40148 100644
--- a/docs/developer/upgrades/5.4-to-5.5.mdx
+++ b/docs/developer/upgrades/5.4-to-5.5.mdx
@@ -138,7 +138,7 @@ This is a no-op on the default Database provider (there is no external index to
#### Multi-store catalogs
-If you have products attached to multiple stores via the legacy `spree_products_stores` join, the `populate_publications` task picks **one** "home" store per product and creates publications on every store's default channel. The `spree_products_stores` table is **kept** as legacy compat surface — the upcoming [spree_multi_store](/developer/multi-store/quickstart) extension restores the full `Product has_many :stores` association on top of it.
+If you have products attached to multiple stores via the legacy `spree_products_stores` join, the `populate_publications` task picks **one** "home" store per product and creates publications on every store's default channel. The `spree_products_stores` table is **kept** as legacy compat surface.
For single-store deployments this is invisible; you can move on without touching `spree_products_stores` again.
diff --git a/docs/docs.json b/docs/docs.json
index fb15b47415..17a1222a78 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -130,6 +130,18 @@
{
"source": "/developer/tutorial/store-api",
"destination": "/developer/tutorial/api"
+ },
+ {
+ "source": "/developer/multi-store/quickstart",
+ "destination": "/developer/multi-tenant/quickstart"
+ },
+ {
+ "source": "/developer/multi-store/setup",
+ "destination": "/developer/multi-tenant/quickstart"
+ },
+ {
+ "source": "/developer/multi-tenant/installation",
+ "destination": "/developer/multi-tenant/quickstart"
}
],
"contextual": {
@@ -232,38 +244,24 @@
"developer/storefront/nextjs/customization",
"developer/storefront/nextjs/deployment"
]
- },
- {
- "group": "Custom Frontend",
- "pages": [
- "developer/storefront/custom/quickstart"
- ]
}
]
},
{
"item": "Use Cases",
"icon": "book-open",
- "description": "Multi-store, multi-tenant, and marketplace setups",
+ "description": "Multi-store/multi-tenant, and marketplace setups",
"groups": [
{
- "group": "Multi-Store",
- "pages": [
- "developer/multi-store/quickstart",
- "developer/multi-store/setup"
- ]
- },
- {
- "group": "Multi-Tenant",
+ "group": "Multi-Tenant / Multi-Store",
"pages": [
"developer/multi-tenant/quickstart",
- "developer/multi-tenant/installation",
"developer/multi-tenant/core-concepts",
"developer/multi-tenant/configuration"
]
},
{
- "group": "Multi-Vendor",
+ "group": "Multi-Vendor Marketplace",
"pages": [
"developer/multi-vendor/quickstart",
"developer/multi-vendor/installation"
@@ -843,11 +841,10 @@
"group": "Settings",
"pages": [
"user/settings/store-details",
+ "user/settings/sales-channels",
"user/settings/users",
"user/settings/emails",
"user/settings/policies",
- "user/settings/domains",
- "user/settings/sales-channels",
"user/settings/payments",
"user/settings/markets",
"user/settings/zones",
@@ -951,7 +948,7 @@
},
{
"label": "v5.5.0",
- "href": "https://github.com/spree/spree/releases/tag/v5.4.0"
+ "href": "https://github.com/spree/spree/releases/tag/v5.5.0"
},
{
"label": "Join Discord",
diff --git a/docs/use-case/digital-products/capabilities.mdx b/docs/use-case/digital-products/capabilities.mdx
index a9f0b9b372..669c51f86b 100644
--- a/docs/use-case/digital-products/capabilities.mdx
+++ b/docs/use-case/digital-products/capabilities.mdx
@@ -13,7 +13,7 @@ Spree provides merchants with robust tools to manage digital products alongside
- **Download Access Management** - Define limits for how many times a file can be downloaded and for how long download links remain active. 
- **Multiple Delivery Channels** - Offer download access directly on the confirmation page, in order emails, or via the customer's account area.
- **Digital-Only Checkout** - Assign digital SKUs to a “Digital” shipping category. When only digital items are in the cart, the delivery step is skipped to streamline the checkout flow.
-- \*\*Link Control & Expiry - \*\*Set download permissions and expiry windows. Revoke access manually if needed to prevent abuse or for license changes.
+- **Link Control & Expiry** - Set download permissions and expiry windows. Revoke access manually if needed to prevent abuse or for license changes.
- **Segmentation & Analytics** - Track digital product performance using Spree’s reporting tools. Segment buyers based on purchase behavior or file download activity.
- **Metafield Support** - Use metafields to attach structured metadata to digital products (e.g., license type, access level, product version). These can be queried for automation or integrations.
diff --git a/docs/use-case/overview.mdx b/docs/use-case/overview.mdx
index 1cae931fd6..f5ff3a652d 100644
--- a/docs/use-case/overview.mdx
+++ b/docs/use-case/overview.mdx
@@ -1,27 +1,25 @@
---
title: "Spree Commerce Use Cases"
-description: "Explore Spree Commerce use cases: multi-vendor marketplaces, multi-tenant SaaS, B2B ecommerce, digital products, and ChatGPT Agentic Commerce integration."
+description: "Explore Spree Commerce use cases: multi-vendor marketplaces, multi-tenant SaaS, B2B ecommerce, digital products, and Agentic Commerce integration."
---
-Spree Commerce [Enterprise Edition](https://spreecommerce.org/docs/user/what-is-spree-commerce#community-edition-vs-enterprise-edition) significantly reduces your time to market and lowers the total cost of ownership for ecommerce platforms across a variety of business models, including:
-
-<Card title="Multi-Vendor Marketplace" icon="cart-plus" href="https://spreecommerce.org/docs/use-case/marketplace/capabilities" cta="Learn more">
+<Card title="Multi-Vendor Marketplace" icon="cart-plus" href="/use-case/marketplace/capabilities" cta="Learn more">
A multi-vendor marketplace platform enables multiple third-party vendors to sell products via your storefront, allowing customers to buy from various vendors in one transaction.
</Card>
-<Card title="Multi-Tenant eCommerce" icon="people-roof" href="https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities" cta="Learn more">
+<Card title="Multi-Tenant eCommerce" icon="people-roof" href="/use-case/multi-tenant/multi-tenant-capabilities" cta="Learn more">
Efficiently host and manage thousands of tenant stores, either as a stand-alone SaaS or within a composable micro-service architecture.
</Card>
-<Card title="B2B eCommerce" icon="building" href="https://spreecommerce.org/docs/use-case/b2b/b2b-capabilities" cta="Learn more">
+<Card title="B2B eCommerce" icon="building" href="/use-case/b2b/b2b-capabilities" cta="Learn more">
Streamline and automate your B2B ecommerce operations, enhancing customer relationships and sales efficiency.
</Card>
-<Card title="ChatGPT Integration" icon="people-roof" href="https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities" cta="Learn more">
+<Card title="ChatGPT Integration" icon="people-roof" href="/use-case/chatgpt-integration/chatgpt-instant-checkout" cta="Learn more">
Convert product discovery into instant sales by enabling checkout directly within ChatGPT conversations using the Agentic Commerce Protocol.
</Card>
-<Card title="Digital Products" icon="people-roof" href="https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities" cta="Learn more">
+<Card title="Digital Products" icon="people-roof" href="/use-case/digital-products/capabilities" cta="Learn more">
Sell and deliver digital goods with flexible configuration, automated download management, and access control.
</Card>
@@ -38,11 +36,11 @@ Spree Commerce [Enterprise Edition](https://spreecommerce.org/docs/user/what-is-
Spree Commerce is a flexible, scalable, [open-source ecommerce platform](https://spreecommerce.org/) designed to simplify complex ecommerce scenarios.
-Spree Commerce [Enterprise Edition](https://spreecommerce.org/docs/user/what-is-spree-commerce#community-edition-vs-enterprise-edition) enhances the core Spree functionality, providing businesses with advanced features, premium support, robust hosting options, and accelerated development and launch capabilities.
+Spree Commerce [Enterprise Edition](/user/what-is-spree-commerce#community-edition-vs-enterprise-edition) enhances the core Spree functionality, providing businesses with advanced features, premium support, robust hosting options, and accelerated development and launch capabilities.
### Why Choose Enterprise Edition?
-Spree Commerce [Enterprise Edition](https://spreecommerce.org/docs/user/what-is-spree-commerce#community-edition-vs-enterprise-edition) offers:
+Spree Commerce [Enterprise Edition](/user/what-is-spree-commerce#community-edition-vs-enterprise-edition) offers:
- Faster time-to-market through robust, ready-to-use features
- Lower total cost of ownership compared to custom-built or fragmented solutions
@@ -52,33 +50,33 @@ Spree Commerce [Enterprise Edition](https://spreecommerce.org/docs/user/what-is-
Some of the Use Cases supported by the Enterprise Edition:
-#### [Multi-Vendor Marketplace](https://spreecommerce.org/docs/use-case/marketplace/capabilities)
+#### [Multi-Vendor Marketplace](/use-case/marketplace/capabilities)
- Aggregate product offerings for greater customer choice and convenience
- Facilitate single-order, multi-vendor transactions seamlessly
- Build customer confidence with unified post-purchase support and communication
-Learn more about the full list of [multi-vendor marketplace capabilities](https://spreecommerce.org/docs/use-case/marketplace/capabilities).
+Learn more about the full list of [multi-vendor marketplace capabilities](/use-case/marketplace/capabilities).
-#### [Multi-Tenant eCommerce](https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities)
+#### [Multi-Tenant eCommerce](/use-case/multi-tenant/multi-tenant-capabilities)
- Rapid deployment and customization to your exact use case
- Comprehensive superadmin tools for central management
- Individual tenant dashboards for independent reseller operations
-#### [B2B eCommerce](https://spreecommerce.org/docs/use-case/b2b/b2b-capabilities)
+#### [B2B eCommerce](/use-case/b2b/b2b-capabilities)
- Customizable access controls and visibility tailored for business buyers
- Seamless integrations with ERP, CRM, and inventory management systems
- Flexible business model expansion through dropshipping and multiple warehouses
-#### [ChatGPT Integration](https://spreecommerce.org/docs/use-case/chatgpt-integration/chatgpt-instant-checkout)
+#### [ChatGPT Integration](/use-case/chatgpt-integration/chatgpt-instant-checkout)
- Reach intent-driven buyers directly through ChatGPT product recommendations
- Enable seamless purchases with Stripe-powered Instant Checkout in the conversation
- Maintain full control over fulfillment, returns, and customer relationships
-#### [Digital Products](https://spreecommerce.org/docs/use-case/digital-products/capabilities)
+#### [Digital Products](/use-case/digital-products/capabilities)
- Sell digital goods alongside physical products or standalone
- Automate delivery through email, “My Account”, or instant download
@@ -86,11 +84,11 @@ Learn more about the full list of [multi-vendor marketplace capabilities](https:
### Looking for User Docs?
-Feel free to use detailed Spree Commerce [User Documentation](https://spreecommerce.org/docs/user/what-is-spree-commerce), including getting started guides, feature explainers, and step-by-step how-to instructions for daily eCommerce operations.
+Feel free to use detailed Spree Commerce [User Documentation](/user/what-is-spree-commerce), including getting started guides, feature explainers, and step-by-step how-to instructions for daily eCommerce operations.
### Looking for Developer Documentation?
-If you are a Spree developer, you may find the [**Developer Docs**](https://spreecommerce.org/docs/docs/developer) to be of benefit to you, though we strongly urge you to read through both sets of guides.
+If you are a Spree developer, you may find the [**Developer Docs**](/docs/developer) to be of benefit to you, though we strongly urge you to read through both sets of guides.
BTW Give Spree a [GitHub Star](https://github.com/spree/spree)<Icon icon="star" iconType="solid" color="#FFD43B" />, why don't ya?
diff --git a/docs/user/settings/domains.mdx b/docs/user/settings/domains.mdx
deleted file mode 100644
index 7ec36c8cde..0000000000
--- a/docs/user/settings/domains.mdx
+++ /dev/null
@@ -1,29 +0,0 @@
----
-title: "Domains"
-description: "Learn how to connect custom domains to your Spree store."
----
-
-Connecting a custom domain ensures your store is accessible via a branded, customer-friendly URL, rather than a technical or temporary address. It builds trust with users, strengthens brand identity, and improves discoverability through SEO.
-
-<Note>Custom domain support requires the `spree-multi-store` package. See the [<u>Multi-Store Quickstart</u>](https://spreecommerce.org/docs/developer/multi-store/quickstart) for setup instructions.</Note>
-
-### Add a Custom Domain
-
-Adding custom domains in Spree is made simple with a convenient semi-automated process.
-
-To add a custom domain, navigate to the Domains tab of the Settings menu.
-
-<img src="/images/user/settings/domains/custom_domains.png" />
-
-Then follow these steps:
-
-1. Click ‘Setup Domain’ and a window will appear
-2. Enter the URL and click ‘Proceed’
-3. Continue through the domain verification process (powered by Entri)
-4. Complete verification with your domain provider
-
-Once verified, the domain is automatically connected and enabled for use with your storefront.
-
-The system handles most of the DNS configuration behind the scenes. However, if your domain is managed through a provider that isn’t supported for automated setup, you may be required to complete some manual DNS changes (instructions will be provided as needed).
-
-<Note>Changes to DNS records may take some time to propagate, depending on your domain provider.</Note>
diff --git a/docs/user/settings/users.mdx b/docs/user/settings/users.mdx
index 5ef641a2ec..90b1a7b359 100644
--- a/docs/user/settings/users.mdx
+++ b/docs/user/settings/users.mdx
@@ -78,4 +78,4 @@ Each invitation includes:
Role-based access control is not yet fully implemented in the admin UI. While you can create new role names, they do not affect permission levels.
-However, you can currently create roles and apply permissions to them via code. Please refer to our developer docs for more info: [<u>Customization → Permissions</u>](https://spreecommerce.org/docs/developer/customization/permissions).
\ No newline at end of file
+However, you can currently create roles and apply permissions to them via code. Please refer to our developer docs for more info: [<u>Customization → Permissions</u>](/developer/customization/permissions).
diff --git a/docs/user/user-quickstart-guide.mdx b/docs/user/user-quickstart-guide.mdx
index 507cc27242..def5d922a0 100644
--- a/docs/user/user-quickstart-guide.mdx
+++ b/docs/user/user-quickstart-guide.mdx
@@ -116,7 +116,6 @@ Once you’ve completed the basic setup, you’re ready to explore more advanced
- [**<u>Learn how to manage orders</u>**](https://spreecommerce.org/docs/user/orders/processing-orders) - process payments, fulfill shipments, create and edit orders
- [**<u>Learn how to process returns</u>**](https://spreecommerce.org/docs/user/returns/returns-processing) - configure returns flow, authorize returns, reimburse customers
-- [**<u>Explore multi-store setups</u>**](https://spreecommerce.org/docs/use-case/multi-store/model) - run separate storefronts with unique catalogs, domains, and branding
- [**<u>Launch a B2B storefront</u>**](https://spreecommerce.org/docs/use-case/b2b/b2b-commerce-model) - offer net terms, tiered pricing, company accounts, and purchase flows optimized for wholesale
- [**<u>Build a multi-vendor marketplace</u>**](https://spreecommerce.org/docs/use-case/marketplace/model) - invite third-party vendors to sell through your platform
- [**<u>Create a multi-tenant platform</u>**](https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-model)  power multiple stores or clients from a single backend