Installation docs could be improved

[sigurasg]

First of all thanks for writing this plugin - it looks like it's exactly what I need for my self-hosted homelab Wiki :). However, as a PHP and MediaWiki n00b, I'm having a little trouble parsing the installation instructions. The installation instructions say "Download and place the file(s) in a directory called AuthManagerOAuth in your extensions/ folder", but they don't say which files. It would be great if the instructions referenced which files, or e.g. gave a couple of command lines like

wget ....zip; unzip *

or some such. I'm sure I'll figure it out with an hour's work or so...

[mohe2015]

@sigurasg I missed this github notification, sorry. I think the text there is automatically created using a template. I tried doing some small improvements to the template settings.

Can't check right now but it should be

cd extensions
git clone https://github.com/mohe2015/AuthManagerOAuth
cd AuthManagerOAuth
composer install --no-dev

# add the following or similar to LocalSettings.php
# wfLoadExtension( 'AuthManagerOAuth' );
# and configure the settings like on the wiki

# Do the database update like on https://www.mediawiki.org/wiki/Manual:Update.php

[mohe2015]

Currently I don't provide prebuilt archives (for security reasons and because it's currently not worth the effort in my opinion) so this could definitely be improved.

[mohe2015]

Instead of the git clone ... you can probably also do

wget https://github.com/mohe2015/AuthManagerOAuth/archive/refs/heads/main.zip
unzip main.zip
mv AuthManagerOAuth-main/ AuthManagerOAuth

[sigurasg]

Thanks - I'll poke at this on the weekend.

On Thu, May 5, 2022 at 6:52 AM Moritz Hedtke @.***> wrote:

Instead of the git clone ... you can probably also do

wget https://github.com/mohe2015/AuthManagerOAuth/archive/refs/heads/main.zip unzip main.zip

— Reply to this email directly, view it on GitHub https://github.com/mohe2015/AuthManagerOAuth/issues/24#issuecomment-1118416497, or unsubscribe https://github.com/notifications/unsubscribe-auth/AALDKF5YR52KQBZ6JVY2FN3VIOR75ANCNFSM5SXNAFGA . You are receiving this because you were mentioned.Message ID: @.***>

[mohe2015]

I've now created built artifacts and attached them to the release of v0.2.0. The steps now should be like on the wiki:

cd extensions
wget https://github.com/mohe2015/AuthManagerOAuth/releases/download/v0.2.0/AuthManagerOAuth.zip
unzip AuthManagerOAuth.zip

# add the following or similar to LocalSettings.php
# wfLoadExtension( 'AuthManagerOAuth' );
# and configure the settings like on the wiki

# Do the database update like on https://www.mediawiki.org/wiki/Manual:Update.php

[mohe2015]

I'll close this for now. Feel free to still answer and I will reopen it then.