Bug 31365 - Plugin link location needs extra documentation so indicate where it may be found
Summary: Plugin link location needs extra documentation so indicate where it may be found
Status: Needs documenting
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor (vote)
Assignee: Bugs List
QA Contact: Testopia
Depends on:
Reported: 2022-08-15 21:42 UTC by wajasu
Modified: 2023-06-17 11:23 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Note You need to log in before you can comment on or make changes to this bug.
Description wajasu 2022-08-15 21:42:51 UTC
5:25 < wajasu> my librarian looked under home->tools for Plugins, but its under Home->Administration->Plugins in 22.05
15:25 < wajasu> https://koha-community.org/manual/22.05/en/html/plugins.html#set-up
15:43 < tuxayo> wajasu: indeed! That's worthy of opening a ticket with the category "Documentation"
15:43 < tuxayo> https://bugs.koha-community.org/bugzilla3/enter_bug.cgi?product=Koha
15:52 < caroline_crazycatlady> Just so you know, it appears under tools after you have at least one plugin installed.
15:55 < tuxayo> ah :o
15:55 < caroline_crazycatlady> It's still weird because it used to be under tools even with zero plugins, hence the confusion
15:58 < wajasu> well maybe one can add (located under Administration prior to a plugin being installed)  :)
16:00 < caroline_crazycatlady> Sure, the whole thing should probably be rewritten... I don't think you need to change the conf file anymore either

I had enabled the koha-conf.xml  <enable_plugins>1</enable_plugins>  and
systemctl restart memcached koha-common apache2

So now Plugins shows under Home->Administration.

Maybe that can be noted in the docs https://koha-community.org/manual/22.05/en/html/plugins.html#set-up
After I enabled the plugins in koha-conf.xml, my librarian couldn't find the plugins link, since the docs said it was in Tools.  Plus the crazycatlady mentioned it migrates to tools once a plugin is installed.  It might also be worth mentioning the need to restart memcached, koha-common (i.e. koha-plack --restart <instance>) and apache2, fothe plugin to show up after it's installed, if that is the case.
Comment 1 David Cook 2022-08-16 00:01:55 UTC
The docs probably do need an update.

Caroline's advice is overkill though, and your description of the plugin migrating to tools after a plugin is installed is inaccurate. Once a "tool plugin" is installed, it will appear in the Tools menu. Same for a "report plugin" in Reports I believe. Administration will still be the place to manage plugins regardless.

As for workflows:

When you update koha-conf.xml, you need to clear the memcached and typically restart the Starman server so that it clears its own local cached copy of koha-conf.xml too. (In future, that restart should be done using Bug 21366.)

When you upload a plugin for the first time, you shouldn't need to do anything to get it to appear. However, if you upgrade a plugin, you will need to restart Starman so that it loads the latest version of the plugin. (I have speculated on a way for that restart to be done automatically and gracefully at Bug 30897.)