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.

Improve documentation to include Valkey as Redis alternative

Damian Legawiec53f539d2466f
diff --git a/docs/developer/contributing/developing-spree.mdx b/docs/developer/contributing/developing-spree.mdx
index 185f9677d2..0e68dda5e5 100644
--- a/docs/developer/contributing/developing-spree.mdx
+++ b/docs/developer/contributing/developing-spree.mdx
@@ -163,8 +163,6 @@ cd core
bundle exec rspec spec/models/spree/state_spec.rb:7
```
-If a large number of tests fail when you run rspec for the first time, confirm that you have Redis installed and running. You can use the command `brew services info redis` to check if Redis is running. If it is not running, start Redis with `brew services start redis`.
-
### Running integration tests on MacOS (only applicable for Admin Panel/Storefront)
We use chromedriver to run integration tests. To install it please use this command:
diff --git a/docs/developer/deployment/aws.mdx b/docs/developer/deployment/aws.mdx
index 36582a0b74..2acc910f35 100644
--- a/docs/developer/deployment/aws.mdx
+++ b/docs/developer/deployment/aws.mdx
@@ -16,7 +16,7 @@ To fully run your Spree application on AWS, you will need the following services
|---------|-------------|
| [AWS ECS Fargate](https://aws.amazon.com/fargate/) | Amazon Elastic Container Service (ECS) is a fully managed container orchestration service that allows you to run and scale containerized applications without managing the underlying infrastructure. |
| [AWS RDS](https://aws.amazon.com/rds/) | Amazon Relational Database Service makes it easy to set up, operate, and scale a relational database in the cloud. Spree works great with multiple databases: [Amazon Aurora both MySQL and PostgreSQL variants](https://aws.amazon.com/rds/aurora/), [RDS PostgreSQL](https://aws.amazon.com/rds/postgresql/), [RDS MySQL](https://aws.amazon.com/rds/mysql/) and [RDS MariaDB](https://aws.amazon.com/rds/mariadb/) |
-| [AWS ElastiCache Redis](https://aws.amazon.com/elasticache/redis/?nc=sn&loc=2&dn=1) | You will need 2 instances of Redis: one for the [Active Job background queue](https://guides.rubyonrails.org/active_job_basics.html) and one for the [Spree cache](/developer/deployment/caching). |
+| [AWS ElastiCache](https://aws.amazon.com/elasticache/redis/?nc=sn&loc=2&dn=1) | You will need 2 instances of Valkey or Redis: one for the [Active Job background queue](https://guides.rubyonrails.org/active_job_basics.html) and one for the [Spree cache](/developer/deployment/caching). |
| [AWS S3](https://aws.amazon.com/s3/) | Object storage service to store and read your uploaded files such as Product images, etc. [More information](/developer/deployment/assets#aws-s3). |
| [AWS CloudFront](https://aws.amazon.com/cloudfront/) | Fast content delivery network CDN to speed up your asset images/stylesheets/javascript delivery. This will greatly enhance your application responsiveness. |
| [AWS Route 53](https://aws.amazon.com/route53/) | Domain name system (DNS) service to manage your domain names and DNS records. |
diff --git a/docs/developer/deployment/caching.mdx b/docs/developer/deployment/caching.mdx
index 7c44ddbecb..158b826c31 100644
--- a/docs/developer/deployment/caching.mdx
+++ b/docs/developer/deployment/caching.mdx
@@ -8,15 +8,15 @@ icon: "database"
Caching is a great way to improve the performance of your Spree application. In all modern web applications, usually the most time consuming operations are database queries and rendering templates. Caching allows you to store the results of these operations in memory and serve them from there.
-We recommend using a distributed cache storage engine such as Memcached or Redis. Spree Starter uses Redis by default.
+We recommend using a distributed cache storage engine such as Memcached, Valkey or Redis. Spree Starter uses Redis by default.
-## Setting up Redis as a cache storage engine
+## Setting up Redis (or Valkey) as a cache storage engine
<Info>
If you're using Spree Starter, you don't need to do anything as it's already pre-configured for you.
</Info>
-Firstly add `solid_cache` to your project
+Firstly add `redis` gem to your project
```bash
bundle add redis
diff --git a/docs/developer/deployment/docker.mdx b/docs/developer/deployment/docker.mdx
index 7783029836..6e65e73915 100644
--- a/docs/developer/deployment/docker.mdx
+++ b/docs/developer/deployment/docker.mdx
@@ -8,7 +8,7 @@ Spree (when using Spree Starter template) comes with a Dockerfile that can be us
You can find the Dockerfile in the [Dockerfile](https://github.com/spree/spree_starter/blob/main/Dockerfile) file in the root of the project or in the Spree Starter repository.
-This Dockerfile is pre-configured to run Spree with PostgreSQL database and Redis. That's the only external dependency you need to have installed on your machine to be able to run Spree.
+This Dockerfile is pre-configured to run Spree with PostgreSQL database and Redis 7.0+ (or Valkey). That's the only external dependency you need to have installed on your machine to be able to run Spree.
You can later use that image to run your application in a containerized environment eg. AWS ECS, AWS Fargate, Azure Container Instances, etc.
@@ -29,7 +29,7 @@ You will need to supply the following environment variables to run the container
| Variable | Description | Example |
| --- | --- | --- |
| `DATABASE_URL` | Database URL, this could be your AWS RDS instance or any other PostgreSQL instance | `postgres://user:pass@localhost:5432/spree` |
-| `REDIS_URL` | Redis URL, used for background jobs processing,this could be your AWS ElastiCache instance or any other Redis instance | `redis://localhost:6379/0` |
+| `REDIS_URL` | Redis/Valkey URL, used for background jobs processing,this could be your AWS ElastiCache instance or any other Redis/Valkey instance | `redis://localhost:6379/0` |
| `SECRET_KEY_BASE` | You can generate this by running `bin/rails secret` | `2fad5c0b79d25e4765d3018d8c740f8c3a665f0e5c...` |
This is the bare minimum you need to run Spree Starter. [Learn more about environment variables](/developer/deployment/environment_variables).
diff --git a/docs/developer/deployment/environment_variables.mdx b/docs/developer/deployment/environment_variables.mdx
index 5ba1c5e9e9..03cbc9ab2e 100644
--- a/docs/developer/deployment/environment_variables.mdx
+++ b/docs/developer/deployment/environment_variables.mdx
@@ -12,7 +12,7 @@ This variables are required to run Spree Starter.
| Variable | Description | Example |
| --- | --- | --- |
| `DATABASE_URL` | Database URL, this could be your AWS RDS instance or any other PostgreSQL instance | `postgres://user:pass@localhost:5432/spree` |
-| `REDIS_URL` | Redis URL, used for background jobs processing,this could be your AWS ElastiCache instance or any other Redis instance | `redis://localhost:6379/0` |
+| `REDIS_URL` | Redis/Valkey URL, used for background jobs processing,this could be your AWS ElastiCache instance or any other Redis/Valkey instance | `redis://localhost:6379/0` |
| `SECRET_KEY_BASE` | You can generate this by running `bin/rails secret` | `2fad5c0b79d25e4765d3018d8c740f8c3a665f0e5c...` |
## Optional environment variables
@@ -27,7 +27,7 @@ There are also some other environment variables that you can set to customize yo
| `RAILS_ENV` | Rails environment (production, development, test) | `production` | `staging` |
| `RAILS_LOG_LEVEL` | Log level, you can switch it to `debug` to see more detailed logs | `info` | `debug` |
| `RAILS_MAX_THREADS` | Web server (Puma) threads | `3` | `5` |
-| `REDIS_CACHE_URL` | Redis URL, used for caching, this could be your AWS ElastiCache instance or any other Redis instance (optional, if not provided will use file based cache) | | `redis://localhost:6379/1` |
+| `REDIS_CACHE_URL` | Redis/Valkey URL, used for caching, this could be your AWS ElastiCache instance or any other Redis/Valkey instance (optional, if not provided will use file based cache) | | `redis://localhost:6379/1` |
| `SCREENSHOT_API_TOKEN` | [Screenshot API token](https://screenshotapi.net/) (optional, used for screenshot generation) | | `1234132512341234` |
| `SENDGRID_API_KEY` | [SendGrid API key](https://docs.sendgrid.com/api-reference/api-keys) (optional, if not provided will not send transactional emails) | | `SG.1234567890` |
| `SENDGRID_DOMAIN` | The domain you want to use for sending emails that was verified in SendGrid | | `mystore.com` |
diff --git a/docs/developer/multi-vendor/installation.mdx b/docs/developer/multi-vendor/installation.mdx
index 0f5721bbd2..08902e34e2 100644
--- a/docs/developer/multi-vendor/installation.mdx
+++ b/docs/developer/multi-vendor/installation.mdx
@@ -15,7 +15,7 @@ description: Learn how to setup a multi-vendor marketplace with Spree
* `KEYGEN_ACCOUNT_ID`
* `KEYGEN_LICENSE_KEY`
* We support both PostgreSQL and MySQL databases
-* Redis for background jobs
+* Redis/Valkey for background jobs
<Info>
Environment variables will be provided to you after purchasing the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).