Skip to content

docs: update README.md instructions #41

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
merged 1 commit into from
Apr 25, 2025
Merged

docs: update README.md instructions #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
70 changes: 44 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,64 @@
[![tests](https://github.com/ddev/ddev-redis/actions/workflows/tests.yml/badge.svg)](https://github.com/ddev/ddev-redis/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2025.svg)
[![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com)
[![tests](https://github.com/ddev/ddev-redis/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-redis/actions/workflows/tests.yml?query=branch%3Amain)
[![last commit](https://img.shields.io/github/last-commit/ddev/ddev-redis)](https://github.com/ddev/ddev-redis/commits)
[![release](https://img.shields.io/github/v/release/ddev/ddev-redis)](https://github.com/ddev/ddev-redis/releases/latest)

## What is this?
## DDEV Redis

This repository allows you to quickly install Redis into a [DDEV](https://ddev.readthedocs.io) project using the instructions below.
## Overview

## Installation
[Redis](https://redis.io/) is an in-memory key–value database, used as a distributed cache and message broker, with optional durability.

This add-on integrates Redis into your [DDEV](https://ddev.com/) project with Redis persistence enabled by default.

For DDEV v1.23.5 or above run
## Installation

```sh
```bash
ddev add-on get ddev/ddev-redis
ddev restart
```

For earlier versions of DDEV run
After installation, make sure to commit the `.ddev` directory to version control.

```sh
ddev get ddev/ddev-redis
```
## Usage

Then restart your project
| Command | Description |
| ------- | ----------- |
| `ddev redis-cli` | Run `redis-cli` inside the Redis container |
| `ddev redis` | Alias for `ddev redis-cli` |
| `ddev redis-flush` | Flush all cache inside the Redis container |
| `ddev describe` | View service status and used ports for Redis |
| `ddev logs -s redis` | Check Redis logs |

```sh
ddev restart
```
Redis is available inside Docker containers with `redis:6379`.

## Redis Credentials

| Field | Value |
|----------|-----------------------|
| Username | `redis` |
| Password | `` (empty by default) |

With DDEV v1.23.5+ you can choose a different Redis tag, the command below creates a `.ddev/.env.redis` file that you can commit:
## Advanced Customization

1. `ddev dotenv set .ddev/.env.redis --redis-docker-image=redis:6`
2. `ddev restart`
To change the used Docker image:

## Explanation
```bash
ddev dotenv set .ddev/.env.redis --redis-docker-image=redis:7
ddev add-on get ddev/ddev-redis
ddev restart
```

This Redis recipe for [DDEV](https://ddev.readthedocs.io) installs a [`.ddev/docker-compose.redis.yaml`](docker-compose.redis.yaml) using the `redis` Docker image.
Make sure to commit the `.ddev/.env.redis` file to version control.

Persistence is disabled by default (see [redis.conf](./redis/redis.conf)), follow the config instructions to enable it, or switch to https://github.com/ddev/ddev-redis-7 where it is enabled by default.
All customization options (use with caution):

## Interacting with Redis
| Variable | Flag | Default |
| -------- | ---- | ------- |
| `REDIS_DOCKER_IMAGE` | `--redis-docker-image` | `redis:7` |

* The Redis instance will listen on TCP port 6379 (the Redis default).
* Configure your application to access Redis on the host:port `redis:6379`.
* To reach the Redis CLI interface, run `ddev redis-cli` to begin a session. You can also run Redis CLI commands directly on the command-line, e.g., `ddev redis-cli INFO`.
## Credits

**Contributed and maintained by [@hussainweb](https://github.com/hussainweb) based on the original [ddev-contrib recipe](https://github.com/ddev/ddev-contrib/tree/master/docker-compose-services/redis) by [@gormus](https://github.com/gormus)**
**Contributed by [@hussainweb](https://github.com/hussainweb) based on the original [ddev-contrib recipe](https://github.com/ddev/ddev-contrib/tree/master/docker-compose-services/redis) by [@gormus](https://github.com/gormus)**

**Co-maintained by [@stasadev](https://github.com/stasadev)**
**Maintained by the [DDEV team](https://ddev.com/support-ddev/)**