Problem/Motivation

The README "Redis backend" section mentions setting up host and port for Redis:

Redis backend

  1. Install Redis PECL extension by following instructions provided for your operating system or install Predis PHP package via composer. It's sufficient to install one or the other.
  2. Install Drupal Redis module
  3. Configure Redis module. Crawler Rate Limit requires only minimum Redis configuration (host and port). It's not necessary to configure cache, locking or any other Redis backend.
    // Example Redis configuration.
$settings['redis.connection']['host'] = '127.0.0.1';
$settings['redis.connection']['port'] = '6379';

I wasn't sure if extra configuration was needed for Crawler Rate Limit, when in fact the default Redis set up worked well, out of the box ...

Steps to reproduce

Checking the README, and being slightly in doubt if Crawler Rate Limit needs extra Redis settings configuration, like host and port ...

Proposed resolution

Is it too much to add something like this last in the "Redis backend" section?

The default set up for Drupal Redis module, including Redis vector database and Redis PHP extension, works well with Crawler Rate Limit out of the box, and no configuration is normally needed.

I have an MR pending, which might help users with limited Redis knowledge.

Remaining tasks

User interface changes

API changes

Data model changes

Issue fork crawler_rate_limit-3550333

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

ressa created an issue. See original summary.

ressa’s picture

ressa
he/him
commented
Issue summary: View changes
ressa’s picture

ressa
he/him
commented
Issue summary: View changes
vaish’s picture

vaish commented

You say "I wasn't sure if extra configuration was needed for Crawler Rate Limit..." but in the Step 3 it's already mentioned that:

Crawler Rate Limit requires only minimum Redis configuration (host and port). It's not necessary to configure cache, locking or any other Redis backend.

Maybe we could extend Step 3 so it reads:

Configure Redis module. Crawler Rate Limit requires only minimum Redis configuration (host and port). It's not necessary to configure cache, locking or any other Redis backend. If you already use Redis module, default Redis setup will work well with Crawler Rate Limit out of the box. For additional details consult Redis module's documentation.

Let me know what you think?

ressa opened merge request !12

ressa’s picture

ressa
he/him
commented
Status: Active » Needs review

Thanks for being open to an update @vaish.

Thinking more about this -- if Drupal Redis is already installed and running, then a user will probably not need to read those three steps, and can just skip them altogether, right? That way a new user can get started using the module faster.

It will also make it less daunting to set up this module, since it may look like it's mostly for advanced users, when it's not that difficult.

So maybe we can make it clear to the user from the very top of the "Redis backend" section, that Crawler Rate Limit probably works well with Drupal Redis without further configuration, if Drupal Redis is already installed and working well?

I have created a first proposal, which can of course be revised, what do you think?

vaish’s picture

vaish commented

Thanks for opening the MR, @ressa. I tweaked your text a bit. Please check it out.

ressa’s picture

ressa
he/him
commented
Status: Needs review » Reviewed & tested by the community

Great adjustment @vaish, that looks perfect now.

vaish’s picture

vaish commented
Status: Reviewed & tested by the community » Fixed

Thanks, @ressa.

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.