CanastaWiki / Canasta

MediaWiki Docker image for Canasta, an all-in-one MediaWiki stack for easy deployment and management of enterprise-ready MediaWiki on production environments.
https://www.canasta.wiki
MIT License
36 stars 27 forks source link

Add instructions for if symlinking fails for newly-added extensions/skins #398

Open hexmode opened 2 months ago

hexmode commented 2 months ago

At https://canasta.wiki/extensions-and-skins/#installing-additional-extensions the following is incorrect:

To install a non-Canasta extension, simply place it in the ./extensions directory and add a wfLoadExtension call to ./config/LocalSettings.php, e.g.:

wfLoadExtension( 'MyCustomExtension' );

The wfLoadExtension call should read:


wfLoadExtension( 'MyCustomExtension', "$IP/user-extensions/MyCustomExtension/extension.json" );
yaronkoren commented 2 months ago

Well, the directions are "correct" - though whether or not they actually work is a different story. Adding an extension directory to the user-extensions/ directory is meant to cause a symlink to it in the extensions/ directory to automatically be created - so that you can then call wfLoadExtension() directly on that. If it didn't happen in your case, that's a bug.

hexmode commented 1 month ago

With the symlink dependency that may not happen sometimes, it would be good to add a troubleshooting section.

yaronkoren commented 1 month ago

That's a fair point - right now the documentation just assumes that it will always work. I suppose the best course of action to give to the user, if the symlinking fails, is to "symlink it yourself", i.e go to the extensions/ directory and call "ln -s ...".

Now I'm curious: did you try adding a new extension, and did the symlinking fail for you?