ddev/ddev-redis

Redis service for DDEV

---

DDEV is an open-source tool for running local web development environments for PHP, Python and Node.js, ready in minutes. Its powerful, flexible per-project environment configurations can be extended, version controlled, and shared. DDEV allows development teams to adopt a consistent Docker workflow without the complexities of bespoke configuration.

Documentation

To check out live examples, docs, contributor live training, guides and more visit ddev.com and ddev.readthedocs.io

Questions

If you need help, our friendly community provides great support.

Wonderful Sponsors

DDEV is an Apache License 2.0 open-source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider sponsoring DDEV development.

Contributing

See “How can I contribute to DDEV?” in the FAQ, and the Contributing page.

Get Started

1. Check System Requirements: macOS (Intel and Apple Silicon), Windows 10/11, WSL2, Linux, Gitpod, and GitHub Codespaces.
2. Install a Docker provider and DDEV.
3. Try a CMS Quick Start Guide.

Additionally, https://ddev.com/get-started/ provides an up-to-date getting-started guide.

Highlighted Features

• Quickly create local web development environments based on code repositories, with minimal configuration.
• Import a database to any of your local environments.
• Import upload files to match the project (e.g. Drupal sites/default/files or WordPress wp-content/uploads).
• Customizable integration with hosting platforms like Platform.sh, Pantheon, Acquia and others.
• Run commands within the Docker environment using ddev exec.
• View logs from the web and database containers.
• Use ddev ssh to explore the Linux environment inside the container.
• List running projects with ddev list.
• Snapshot databases with ddev snapshot.
• Temporarily share your development website with others using ddev share.
• Create custom commands as simple shell scripts.
• Enjoy effortless, trusted HTTPS support.
• Extend and customize environments as much (or as little!) as you need to.

Run ddev to see all the commands.

ddev-redis's Issues

Figure out how to specify redis version

This is a great question. I'm a n00b on redis though, so need to understand more about

• Why people use other than latest stable
• How they would configure it.

redis/scripts/setup-drupal-settings.sh creates settings.php incorrectly if it is not alreay present

Ran into an issue today setting up a ddev environment for drupal with redis. If the ddev get ddev/ddev-redis command is issued before the ddev start command the setup-drupal-settings.sh file ends up creating a settings.php file with only its configuration in there. The ddev start command then appends the standard settings.ddev.php stuff in there as well. However, the drupal site will fail to install because the settings.php file created by the redis script was done so without copying the default.settings.php or even adding in the php open tag, so drupal fails to install as it cannot find a valid database connection string since the settings.php without the opening php tags won't properly load in settings.ddev php.

Proposed fix would be to adjust the script to check for the existence of settings.php and if it does not exist then create it by copying default.settings.php before appending the redis settings to the file.

Provide Drupal or other settings for redis

On Twitter you mentioned the idea of providing Drupal settings.

It would be possible for the post_install_actions to do something that reached out of .ddev.

For example,

post_install_actions:
-  if [ ${DDEV_PROJECT_TYPE} = "drupal9" ] then echo "some config" > $DDEV_APPROOT/$DDEV_DOCROOT/sites/default/settings.redis.php; fi
- echo "Sample Drupal redis configuration has been placed in sites/default/settings.redis.php if you want to include it from settings.php"

Maybe that's worth a try?

Respect the disable_settings_management flag for settings.redis.php

Thanks for adding the settings for redis! that is a great way to get bootstrapped up with reasonable defaults.

Though sometimes it's nice to leave those up to the project! Let's respect the disable_settings_management flag and not add the settings.redis.php if that configuration is enabled.

Fatal error, can't open config file '/usr/local/etc/redis/redis.conf': No such file or directory

❯ ddev logs -s redis
1:C 04 Jan 2023 06:36:54.695 # Fatal error, can't open config file '/usr/local/etc/redis/redis.conf': No such file or directory

This just started happening I'm using on macOS 13.1 with and M1

ddev version v1.21.4
colima version 0.5.2
git commit: 6b5b6fe0540e708f0c9d6e8919fab292c671fc72

runtime: docker
arch: aarch64
client: v20.10.13
server: v20.10.20

limactl version 0.14.2

Move to drud org as official redis recipe

Could we go ahead and move this repo to the drud org and make it the official redis recipe? You would remain a maintainer.

I think you should be able to do that in the settings (and I have to accept it of course).