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.

Updated 'Storefront Settings' user doc (#13340)

jaburghes90d130f3d0e4
diff --git a/docs/images/user/storefront/settings/1-storefront-settings.png b/docs/images/user/storefront/settings/1-storefront-settings.png
new file mode 100644
index 0000000000..11fdd14ae7
Binary files /dev/null and b/docs/images/user/storefront/settings/1-storefront-settings.png differ
diff --git a/docs/images/user/storefront/settings/2-seo-settings.png b/docs/images/user/storefront/settings/2-seo-settings.png
new file mode 100644
index 0000000000..059b17419b
Binary files /dev/null and b/docs/images/user/storefront/settings/2-seo-settings.png differ
diff --git a/docs/images/user/storefront/settings/3-password-protected.png b/docs/images/user/storefront/settings/3-password-protected.png
new file mode 100644
index 0000000000..8ab34d5fa8
Binary files /dev/null and b/docs/images/user/storefront/settings/3-password-protected.png differ
diff --git a/docs/images/user/storefront/settings/4-custom-code.png b/docs/images/user/storefront/settings/4-custom-code.png
new file mode 100644
index 0000000000..ae6745223e
Binary files /dev/null and b/docs/images/user/storefront/settings/4-custom-code.png differ
diff --git a/docs/images/user/storefront/settings/5-favicon.png b/docs/images/user/storefront/settings/5-favicon.png
new file mode 100644
index 0000000000..684b01b793
Binary files /dev/null and b/docs/images/user/storefront/settings/5-favicon.png differ
diff --git a/docs/images/user/storefront/settings/6-preview-image.png b/docs/images/user/storefront/settings/6-preview-image.png
new file mode 100644
index 0000000000..240c5b2d89
Binary files /dev/null and b/docs/images/user/storefront/settings/6-preview-image.png differ
diff --git a/docs/images/user/storefront/settings/7-social-media.png b/docs/images/user/storefront/settings/7-social-media.png
new file mode 100644
index 0000000000..ae24a61778
Binary files /dev/null and b/docs/images/user/storefront/settings/7-social-media.png differ
diff --git a/docs/user/storefront/storefront-settings.mdx b/docs/user/storefront/storefront-settings.mdx
index 7227f867c8..18fa9ae322 100644
--- a/docs/user/storefront/storefront-settings.mdx
+++ b/docs/user/storefront/storefront-settings.mdx
@@ -1,110 +1,104 @@
---
title: "Storefront Settings"
-description: "Storefront settings like a favicon, preview image, custom head/body tags, and social media links"
+description: "Learn how to configure storefront settings like security, favicon, custom head/body tags, and more."
---
-Storefront settings like a favicon, preview image, custom head/body tags, and social media links ensure that your store has a cohesive and professional appearance. 
+Configure your store’s visual identity, search visibility, social presence, and custom code snippets with ease using Spree’s Storefront Settings.
-These elements enhance branding, improve user experience, and optimize how your store is displayed on social media and in search results.
+These settings help you:
-To manage storefront settings, navigate to the Settings tab found under Storefront.
+- Improve branding and recognition (favicon, social links)
+- Control search engine indexing and social sharing previews
+- Add custom code for tracking or personalization
+- Ensure a polished, professional storefront experience
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.1_Storefront_Settings_-_Navigate_To_Tab_pmbxvs.png)
+To access storefront settings, go to **Settings → Storefront** in the admin dashboard.
-The page is subdivided into 5 distinct section. Let’s take a look at each separately in more detail.
+![Spree storefront settings dashboard](/docs/images/user/storefront/settings/1-storefront-settings.png)
-## SEO
-
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.2_Storefront_Settings_-_SEO_acaga5.png)
-
-This is where you can manage SEO settings for your store. The three settings are as follows:
-
-* Site Name - the name that’s displayed in social sharing links, search engines, and browser tabs
-
-* Search Description - a short site description displayed in social sharing links and search engines
+Here you'll see several sections that allow you to configure key storefront settings related to SEO, branding, appearance, and more.
-* Index In Search Engines - checking this box will allow your site to appear in search engines
+## SEO
-Note: You might not want your site indexed in search engines if it’s still under development or undergoing significant updates, as unfinished content or errors could negatively impact your brand perception. 
+![Storefront SEO settings in Spree Commerce](/docs/images/user/storefront/settings/2-seo-settings.png)
-Another scenario would be a member-only platform, in which case you might not want your site indexed to protect exclusive content and ensure that only authorized users can access the information. Preventing indexing helps maintain privacy and exclusivity, aligning with the platform's membership-based model.
+Control how your store appears in search engines and social media previews.
-Outside of scenarios such as these, you likely want to **make sure that this box is checked** when officially going live.
+- **SEO Title** - Appears in social shares, browser tabs, and search results.
+- **Meta Description** - A short summary of your store that shows up in search listings and social previews.
+- **Index in Search Engines** - Toggle this to allow or prevent your store from being indexed.
+ - You may want to disable indexing if:
+ - Your site is still in development
+ - You’re making major content/design changes
+ - You run a member-only platform and want to restrict access
+ - Otherwise, make sure indexing is enabled when going live.
## Security
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.3_Storefront_Settings_-_Security_snwkqf.png)
-
-In the security section, you can choose to make your store password protected and set the password.
-
-To set the password:
-
-1. Check the ‘Password Protected’ box, 
-
-2. Click ‘Update’ at the bottom of the page and the ‘Password’ field will appear
+![Make a store password protected in Spree Commerce](/docs/images/user/storefront/settings/3-password-protected.png)
-3. Set the password and click ‘Update’ again
+Restrict access to your storefront with a password.
-Note:
+To enable password protection:
-A site might be password protected to restrict access during development, ensuring only authorized users can view and test it before it goes live. This is particularly useful for maintaining privacy and preventing unfinished or unpolished content from being publicly visible. 
+1. Check the Password Protected box - this reveals the Password field
+2. Enter your desired password into the field
+3. Click **Update** to save the password
-Password protection is also ideal for member-only platforms or exclusive content, ensuring access is limited to those with the proper credentials.
+This is useful for stores in development or platforms offering exclusive, member-only access.
## Custom Code
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.4_Storefront_Settings_-_Custom_Code_nm5url.png)
+![Add custom code snippets to a store in Spree Commerce](/docs/images/user/storefront/settings/4-custom-code.png)
-Adding custom code to the \<head> tag allows you to integrate scripts, styles, or metadata critical for SEO, analytics, or third-party tools. Placing code after the \<body> tag or before the \</body> tag enables you to add functionality such as tracking scripts or custom JavaScript without interfering with the primary content loading process.
+Add third-party tools or advanced customization by injecting code snippets.
-Simply enter your code into the appropriate box and click ‘Update’ at the bottom of the page.
+- **Head Tag** - Ideal for analytics scripts, SEO metadata, or style overrides.
+- **After \<body\>** or **Before \</body\>** - Great for tracking scripts or additional JavaScript.
+
+Simply enter the code in the appropriate box and click **Update**.
## Images
### Favicon Image
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.5_Storefront_Settings_-_Favicon_vzzj5k.png)
-
-A favicon is a small image that appears in the tab of your web browser when you visit a website. It is usually a tiny square or rectangle with a unique design or logo that represents your website.
+![Add a favicon in Spree Commerce](/docs/images/user/storefront/settings/5-favicon.png)
-A favicon is important because it enhances your brand's recognition, making your site easily identifiable in browser tabs, bookmarks, and search results.
+The small icon shown in browser tabs, bookmarks, and search previews.
-Simply upload your favicon image (rec. size 120x120px) and click ‘Update’ at the bottom of the page.
+- Recommended size: 120×120px
+- Simply upload your image and click **Update**
+- Helps reinforce brand recognition and professionalism.
### Preview Image
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.6_Storefront_Settings_-_Preview_Image_qgqtr6.png)
-
-The preview image will be used when your store is shared on social media or in search engines.
-
-A preview image is important because it visually represents your site when shared on social media or in messaging apps, helping to attract clicks and reinforce your branding.
-
-Simply upload your preview image (rec. size 120x120px) and click ‘Update’ at the bottom of the page.
-
-## Social Media
-
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Storefront%20Settings/7.4.7_Storefront_Settings_-_Social_Media_tkqiuo.png)
-
-The social media section allows you to add all of your social links which will be automatically displayed in your footer with their respective icons.
-
-You can add social links for the following platforms:
+![Add a storefront preview image in Spree Commerce](/docs/images/user/storefront/settings/6-preview-image.png)
-* Instagram
+Displayed when your site is shared on social media or messaging apps.
-* Facebook
+- Recommended size: 1200×600px
+- Upload and click **Update**
+- A compelling preview image can increase clicks and improve brand recall.
-* Twitter
+## Social Media Links
-* Pinterest
+![Add social media links to your Spree Commerce store](/docs/images/user/storefront/settings/7-social-media.png)
-* Tiktok
+Add social handles to your footer, complete with platform-specific icons.
-* Youtube
+Supported platforms:
-* Spotify
+- Instagram
+- Facebook
+- Twitter
+- Pinterest
+- TikTok
+- YouTube
+- Spotify
+- Discord
-## Click Update
+Simply enter your links and click **Update**.
-Once you’re finished configuring your storefront settings, make sure to click the blue ‘Update’ button at the bottom of the page, otherwise your changes will not be saved.
+## Don’t Forget to Click Update
-Congratulations, your store is now optimized for branding, user experience, and visibility!
+Once you’ve made changes to any of the sections above, make sure to click **Update** at the top or bottom of the page to save your changes.