Page MenuHomePhabricator

Installation instructions of OAuthAuthentication are useless
Closed, ResolvedPublic

Event Timeline

Also doesn't mention what one needs to do with the target wiki (oauth provider) or how to use the callback url/prefix, which it's supposed to be specifying. Or what in the world is going on with that, either.

I'm not sure the specified configuration variables are actually correct anymore, either.

Probably not really worth doing before T110460: Update OAuthAuthentication to use AuthManager is done.

Should the extension be useable? Or is it broken?

It won't work properly with MediaWiki 1.27+. Whether that means it does not cooperate well with other authentication extensions, or does not work at all, I'm not sure - probably the former.

I have a nearly-finished patch to update the extension. Do you plan on using it somewhere?

Yes, here: https://timeless-skin.wmflabs.org/wiki/Main_Page

It's a testing wiki I'm setting up so users can screw around with Timeless directly, and it'd be great if they didn't need to make new accounts for this (especially as privacy on labs is apparently a can of worms).

(And since it is a testing wiki, it'd probably be as decent a place as any to test this, too.)

Installation instructions were likely useless because they were incomplete.
They did non mentioned the need to install php-curl, the need to run update.php and where to point the "callback URL" on the OAuth site.
Based on my own research and experience, I added a few lines of instructions, hopefully explaining enough for any user to make the extension work

Why is php-curl needed? I'd imagine it uses MediaWiki's request wrapper, which should work fine without curl.

Why is php-curl needed? I'd imagine it uses MediaWiki's request wrapper, which should work fine without curl.

When I first installed the extension, it kept giving me a generic error: by looking at the logging I found out the problem was related to curl, when I installed php-curl the problem disappeared.
I haven't investigated beyond solving the issue because of time constraints, so I cannot explain the deep reason for this dependency.
Maybe this link https://github.com/gvoss/php-mediawiki-jiki/issues/5 can be helpful

Dear @Reedy I see this task is currently unassigned and open for quite some time now.
As I already worked a bit to improve documentation, does it make sense that I claim it and and work with the userbase to update the instructions to a satisfactory level for admin and users as well?

I am sorry I am fairly new to the whole system, so I am not 100% sure if I am allowed to do this and what standards should I met.
I am willing to help nonetheless as I am working to make this extension work anyway for my own project, so I would put my experience at other users' service, if this can help.

Dear @Reedy I see this task is currently unassigned and open for quite some time now.
As I already worked a bit to improve documentation, does it make sense that I claim it and and work with the userbase to update the instructions to a satisfactory level for admin and users as well?

I am sorry I am fairly new to the whole system, so I am not 100% sure if I am allowed to do this and what standards should I met.
I am willing to help nonetheless as I am working to make this extension work anyway for my own project, so I would put my experience at other users' service, if this can help.

Feel free :)

Any help appreciated

Feel free :)
Any help appreciated

Thanks, I'll do my best

I updated the documentation here https://www.mediawiki.org/wiki/Extension:OAuthAuthentication and proposed a small change to https://github.com/wikimedia/mediawiki-extensions-OAuthAuthentication/pull/1

I kindly ask all the involved parties to review the changes and comment on them: I will proceed closing the task after receiving your input.

Change 508102 had a related patch set uploaded (by Luca Mauri; owner: Luca Mauri):
[mediawiki/extensions/OAuthAuthentication@master] Introduction to the extension and link to homepage

https://gerrit.wikimedia.org/r/508102

Change 508102 had a related patch set uploaded (by Luca Mauri; owner: Luca Mauri):
[mediawiki/extensions/OAuthAuthentication@master] Introduction to the extension and link to homepage

https://gerrit.wikimedia.org/r/508102

My bad that I did not realize that also the documentation must be maintained on Gerrit and not GitHub

Change 508102 merged by jenkins-bot:
[mediawiki/extensions/OAuthAuthentication@master] Introduction to the extension and link to homepage

https://gerrit.wikimedia.org/r/508102

As I haven't received any comments or complains and the modification to README.md has been merged, I believe it is safe to close the task.
I have been able to successfully run OAuth and OAuthAuthentication on my MediaWiki installation and I hope my experience will help others as well with the improvement made to the documentation.

When I first installed the extension, it kept giving me a generic error: by looking at the logging I found out the problem was related to curl, when I installed php-curl the problem disappeared.
I haven't investigated beyond solving the issue because of time constraints, so I cannot explain the deep reason for this dependency.
Maybe this link https://github.com/gvoss/php-mediawiki-jiki/issues/5 can be helpful

That error seems to be caused by the JIKI extension (which should probably also document the dependency). That said, OAuthAuthentication uses oauthclient-php which does use curl. Filed T222550: oauthclient-php should not depend on curl about that.

Thanks for fixing the docs, Luca!