Skip to content

Fix Redis setup documentation: correct service name and add environment variable configuration #2071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rittou merged 2 commits into from
Jan 9, 2026
Merged

Fix Redis setup documentation: correct service name and add environment variable configuration #2071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
511ab2c
Initial plan
Copilot Jan 9, 2026
6d0d1cd
Address review comments: fix redis service name, add auth to ping, ad…
Copilot Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions products/sales-agent/best-practices/app-deployment/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,20 @@ For easier integration with serverless deployments like AWS Amplify, consider us

These providers offer public endpoints that work seamlessly with AWS Amplify without VPC configuration.

### Configure Redis environment variables

After setting up Redis (ElastiCache or a serverless provider), configure these environment variables in AWS Amplify:

```bash
REDIS_CACHE=true
REDIS_HOST=your-redis-endpoint.cache.amazonaws.com # Or your provider's endpoint
REDIS_PORT=6379
REDIS_PASSWORD=your_redis_password
REDIS_TLS=true # Recommended for production
```

Add these variables in the AWS Amplify Console under "Environment variables" in your app settings, or include them in your `.env.template` file.

## Deploy

- Login to the AWS Amplify Hosting Console.
Expand Down
22 changes: 20 additions & 2 deletions products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,17 @@ Key settings to consider:
Enable and start the Redis service:

```bash
sudo systemctl enable redis
sudo systemctl start redis
sudo systemctl enable redis-server
sudo systemctl start redis-server
```

Verify Redis is running:

```bash
# If you configured a password with requirepass
redis-cli -a your_secure_password ping

# If no password is set
redis-cli ping
```

Expand All @@ -75,6 +79,20 @@ Alternatively, you can use managed Redis services such as:

These services provide connection details (host, port, password) that you configure in your `.env` file.

### Configure Redis environment variables

Add these Redis environment variables to your `.env` file:

```bash
REDIS_CACHE=true
REDIS_HOST=127.0.0.1 # For local installation, or your managed service endpoint
REDIS_PORT=6379
REDIS_PASSWORD=your_secure_password # If configured with requirepass
REDIS_TLS=false # Set to true for managed services that require TLS
```

For managed Redis services like Upstash, use the connection details provided by the service (host, port, password, and set `REDIS_TLS=true` for secure connections).

## Build code

- Please follow instructions here to [set up all necessary things and build the code](../../installation.md#setup-app-server)
Expand Down