Skip to content
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.

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

docs: config/auth: clarify auth_username, etc #2105

Merged
merged 1 commit into from
Jun 17, 2021

Conversation

half-duplex
Copy link
Member

Description

Add an example for having Sopel authenticate to ZNC, inspired by a user in IRC confused by auth_username not working with auth_method=server.

Also corrects/clarifies/creates a few other things:

  • auth_password: used for server auth too, not just user
  • please click the directives, I don't want to have to remember to update things in two places
  • auth_method=userserv also uses auth_target
  • when is auth_username ignored/required (previously: infinite docloop)

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make quality and make test)
  • I have tested the functionality of the things this change touches

@half-duplex half-duplex added this to the 7.1.1 milestone Jun 10, 2021
@half-duplex
Copy link
Member Author

For 8.0:

<+dgw> Looks like clients that offer separate username & password fields for bouncers, like Colloquy, just concatenate the two together with a : for the PASS command.

I don't think it's worth adding auth_method=bouncer or anything, but can we think of a case where if auth_method==server and auth_username: auth_password=auth_username+":"+auth_password would cause problems?

Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

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

The only thing I don't understand about this patch is the addition of "allowed or" in auth_username's description.

Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

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

Happy to see more/better documentation!

docs/source/configuration.rst Outdated Show resolved Hide resolved
docs/source/configuration.rst Outdated Show resolved Hide resolved
docs/source/configuration.rst Outdated Show resolved Hide resolved
docs/source/configuration.rst Outdated Show resolved Hide resolved
sopel/config/core_section.py Outdated Show resolved Hide resolved
@half-duplex
Copy link
Member Author

dgw, I phrased it badly, but the intent was to remove the implication that "it's allowed, and sometimes it's required" since it's never optional.
Maybe we should log a warning when a username is provided with a method that ignores it?

@dgw dgw requested review from Exirel and dgw June 11, 2021 21:47
Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

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

I had already marked these changes as viewed, so I don't know why there wasn't also a (re-)review to go with that. Oh well, squash away.

@half-duplex half-duplex force-pushed the server-auth-user-doc branch from 0e27bd8 to e792611 Compare June 15, 2021 19:24
@dgw dgw merged commit 2f098dd into sopel-irc:master Jun 17, 2021
dgw pushed a commit that referenced this pull request Jun 17, 2021
Backport of pull request #2105 for 7.1.1 release. Cherry-picked from
original commit: e792611
@half-duplex half-duplex deleted the server-auth-user-doc branch June 17, 2021 08:25
@half-duplex half-duplex restored the server-auth-user-doc branch May 14, 2023 02:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants