[Bug 31180] New: Provide a koha-conf.xml (etc.) checker.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 Bug ID: 31180 Summary: Provide a koha-conf.xml (etc.) checker. Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: System Administration Assignee: koha-bugs@lists.koha-community.org Reporter: egpetridis@yahoo.com QA Contact: testopia@bugs.koha-community.org CC: gmcharlt@gmail.com I feel that a checker should be provided that checks the various configuration files -koha-conf.xml is a prime suspect- and notify the library admin of missing stanzas or invalid values. For example, missing information on fonts to be used, or reference to non-existent (or non-accessible) files and/or folders. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 --- Comment #1 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- We already have some checks in place and the results show on the system information tab on the About Koha page. The fonts section missing could be another to add. Maybe we could change this bug report to cover that. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |RESOLVED CC| |dcook@prosentient.com.au Resolution|--- |INVALID --- Comment #2 from David Cook <dcook@prosentient.com.au> --- Closing this one for now since it's too broad. Feel free to re-open and re-name -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|INVALID |--- Status|CLOSED |REOPENED See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=31059 -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=34064 Summary|Provide a koha-conf.xml |Create an audit script for |(etc.) checker. |koha-conf.xml --- Comment #3 from David Cook <dcook@prosentient.com.au> --- Like bug 34064, it could be good to have an audit script that compares the current koha-conf.xml against an authoritative version. Comparing the koha-conf.xml file is significantly harder to comparing the database and kohastructure.sql, but it's not impossible. The "authoritative version" we have is a template which contains a lot of placeholders for values, so directly comparing vlaues could be tricky. Analyzing values in a meaningful way would also require a lot more work. But... missing keys are quite easy to find. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=28911 --- Comment #4 from David Cook <dcook@prosentient.com.au> --- Locally, for a few years, when a new version of Koha comes out, I create/refactor a script called something like "fixup_kohaconf_2311.pl", which compares a Koha instance (created via Debian package) against /etc/koha/koha-conf-site.xml.in I think that I mentioned it previously to Jonathan on bug 28911. In fact, it looks like I shared an example script there. It's not a very maintainable script by 1 person. If we were to include a fixup script like that... we'd need to change our development process. But there is a precedent for that. ./etc/koha-conf.xml and ./debian/templates/koha-conf-site.xml.in are comparable to kohastructure.sql We'd want something like ./installer/data/mysql/updatedatabase.pl but for koha-conf.xml. So any dev that added something to koha-conf.xml would need to add an entry into "updateconfig.pl" or equivalent. (Honestly, that could make testing easier for koha-conf.xml changes as well.) -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=26790 -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@gmail.com, | |martin.renvoize@ptfs-europe | |.com, | |paul.derscheid@lmscloud.de --- Comment #5 from David Cook <dcook@prosentient.com.au> --- If we use a fixup script in an automated fashion, we'll need to definitely determine the permissions of the koha-conf.xml file. As I mentioned on bug 31059, I've noticed in some cases koha-conf.xml owned by the Koha instance and in some cases owned by root. This is important because if it's owned by root, it means running "koha-shell kohadev -c "perl updateconfig.pl" isn't going to work. Maybe we just assume that we need to use root to update the config files, and keep that in mind for a /usr/sbin/koha-upgrade-config script (which would invoke the real updateconfig.pl script in the right context). -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|Create an audit script for |Create an audit and/or |koha-conf.xml |fixup script for | |koha-conf.xml -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 --- Comment #6 from David Cook <dcook@prosentient.com.au> --- Note one thing about the fixup script I've attached previously on bug 28911 The XML generated by XML::LibXML has slightly different whitespace to what we have. I'd love to change the whitespace in our template files to align with the output of XML::LibXML to make it easier to do diffs using "vimdiff" for instance. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 Andrew Fuerste-Henry <andrew@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |andrew@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=32791 -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 Victor Grousset/tuxayo <victor@tuxayo.net> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |victor@tuxayo.net -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 --- Comment #7 from Manos PETRIDIS <egpetridis@yahoo.com> --- Might I note that in my original post I suggested that the script need not fix koha-conf.xml, it would be sufficient that it points out omissions and errors (files/folders not existing or not acessible). In that case the script/fix would not need to be able to write and modify the conf file, only to read it. The ability to amend the config files would be a welcome -but not critical- addition. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31180 --- Comment #8 from David Cook <dcook@prosentient.com.au> --- (In reply to Manos PETRIDIS from comment #7)
Might I note that in my original post I suggested that the script need not fix koha-conf.xml, it would be sufficient that it points out omissions and errors (files/folders not existing or not acessible). In that case the script/fix would not need to be able to write and modify the conf file, only to read it. The ability to amend the config files would be a welcome -but not critical- addition.
Good point. With the Debian packages, we could add a "/usr/sbin/koha-conf-checker" or something which compares a site's koha-conf.xml against the koha-conf.xml.in template... Could potentially even add some automation in the koha-common.postinst to do the check after an upgrade so a sysadmin could see which instances need manual updating... -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org