Skip to content

Add an explanation for URI with -u in redis-cli --help#12751

Merged
oranagra merged 4 commits intoredis:unstablefrom
lowgiant:#12746-cli-u
Nov 19, 2023
Merged

Add an explanation for URI with -u in redis-cli --help#12751
oranagra merged 4 commits intoredis:unstablefrom
lowgiant:#12746-cli-u

Conversation

@lowgiant
Copy link
Contributor

@lowgiant lowgiant commented Nov 10, 2023

Add documentation of the URI format in the --help output of redis-cli and redis-benchmark.

In particular, it's good for users to know that they need to specify "default" as the username when authenticating without a username. Other details of the URI format are described too, like scheme and dbnum.

It used to be possible to connect to Redis using an URL with an empty username, like redis-cli -u redis://:PASSWORD@localhost:6379/0. This was broken in 6.2 (#8048), and there was a discussion about it #9186. Now, users need to specify "default" as the username and it's better to document it.

Refer to #12746 for more details.

@zuiderkwast zuiderkwast added state:to-be-merged The PR should be merged soon, even if not yet ready, this is used so that it won't be forgotten class:text docs and typos labels Nov 13, 2023
@zuiderkwast zuiderkwast changed the title Add an explanation for redis cli -u uri help Add an explanation for URI with -u in redis-cli --help Nov 13, 2023
Copy link
Contributor

@zuiderkwast zuiderkwast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now, thanks!

@redis/redis-committers, this is --help output only, safe to merge.

@lowgiant Regarding 80 characters width, Redis source code does not follow this in general, but for the terminal output I think it is nice to follow it, when we don't know the user's terminal size. (I hope you and others agree.)

@lowgiant
Copy link
Contributor Author

@zuiderkwast I agree too. It was more organized, and I learned a lot. Thank you.

@zuiderkwast
Copy link
Contributor

@oranagra please merge.

@lowgiant
Copy link
Contributor Author

Hi @soloestoy

Could you please look at this when you have sometime?

@oranagra oranagra merged commit a1f91ff into redis:unstable Nov 19, 2023
zuiderkwast added a commit to redis/redis-doc that referenced this pull request Nov 22, 2023
It's good for users to know that they need to specify "default" as the username when authenticating without a username. Other details of the URI format are described too, like scheme and dbnum.

Related to redis/redis#12751

Co-authored-by: Viktor Söderqvist <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

class:text docs and typos state:to-be-merged The PR should be merged soon, even if not yet ready, this is used so that it won't be forgotten

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] redis-cli no longer supports implicit default username in connection URL

4 participants