Bug 41102

Summary: Error 500 on the "About" page when biblioserver Zebra configuration is missing
Product: Koha Reporter: Hammat wele <hammat.wele>
Component: AboutAssignee: Hammat wele <hammat.wele>
Status: Signed Off --- QA Contact: Testopia <testopia>
Severity: normal    
Priority: P5 - low CC: caroline.cyr-la-rose, david, philippe.blouin
Version: Main   
Hardware: All   
OS: All   
GIT URL: Initiative type: ---
Sponsorship status: --- Comma delimited list of Sponsors:
Crowdfunding goal: 0 Patch complexity: ---
Documentation contact: Documentation submission:
Text to go in the release notes:
This fixes the About Koha page when Zebra is not running or not correctly configured in the Koha instance's koha-conf.xml file. Instead of a 500 error when you access the page, there is now a message in the server information tab for Zebra's status, such as "Zebra server seems not to be available. Is it started?".
Version(s) released in:
Circulation function:
Attachments: Bug 41102: Error 500 on the About page when biblioserver Zebra configuration is missing
Bug 41102: Error 500 on the About page when biblioserver Zebra configuration is missing
Bug 41102: Error 500 on the About page when biblioserver Zebra configuration is missing

Description Hammat wele 2025-10-24 19:49:47 UTC
When either the <listen id="biblioserver"> entry or the <server id="biblioserver" listenref="biblioserver"> section is not present in koha-conf.xml, 
the Intranet > About page triggers a 500 Internal Server Error.

To test: 

1. Edit koha-conf.xml and Comment out: <!--<listen id="biblioserver">unix:/path/to/zebradb/bibliosocket</listen>-->
2. Restart Apache: sudo systemctl restart apache2
3. Go to Intranet -> About
   ==> Internal Server Error (500)
4. Now restore the <listen> line and instead comment out the entire <server id="biblioserver" listenref="biblioserver">...</server> block.
5. Repeat step 2, 3 
   ==> Internal Server Error (500)
Comment 1 Hammat wele 2025-10-24 20:04:42 UTC
Created attachment 188435 [details] [review]
Bug 41102: Error 500 on the About page when biblioserver Zebra configuration is missing

When either the <listen id=biblioserver> entry or the <server id=biblioserver listenref=biblioserver> section is not present in koha-conf.xml,
the Intranet > About page triggers a 500 Internal Server Error.

To test:

2. Restart Apache: sudo systemctl restart apache2
3. Go to Intranet -> About
   ==> Internal Server Error (500)
4. Now restore the <listen> line and instead comment out the entire <server id=biblioserver listenref=biblioserver>...</server> block.
5. Repeat step 2, 3
   ==> Internal Server Error (500)
6. Apply the patch
7. Repeat step 2, 3
   ==> There is no Error (500)
8. Uncomment <server id=biblioserver  listenref=biblioserver> </server> and Repeat Step 1
9. Repeat step 2, 3
   ==> There is no Error (500)
Comment 2 David Nind 2025-12-09 00:25:17 UTC Comment hidden (obsolete)
Comment 3 David Nind 2025-12-09 00:27:58 UTC
Created attachment 190318 [details] [review]
Bug 41102: Error 500 on the About page when biblioserver Zebra configuration is missing

When either the <listen id=biblioserver> entry or the
<server id=biblioserver listenref=biblioserver> section
is not present in koha-conf.xml, the Staff interface > About page
triggers a 500 Internal Server Error.

Test plan:
1. Edit koha-conf.xml and Comment out:
   <!--<listen id="biblioserver">unix:/path/to/zebradb/bibliosocket</listen>-->
2. Restart Apache: sudo systemctl restart apache2 (or restart_all)
3. Go to Intranet > About
   ==> Internal Server Error (500)
4. Now restore the <listen> line and instead comment out the entire
   <server id=biblioserver listenref=biblioserver>...</server> block.
   (Note that the commenting around <!-- The stuff below is used to enable SRU...
    interferes with adding a closing comment after </server> -
    close the comment before that section and add a comment around </server>.)
5. Repeat step 2, 3
   ==> Internal Server Error (500)
6. Apply the patch
7. Repeat step 2, 3
   ==> There is no Error (500)
       Note: Zebra status: Error message from Zebra: 10004
8. Uncomment <server id=biblioserver  listenref=biblioserver> </server>
   and Repeat Step 1
9. Repeat step 2, 3
   ==> There is no Error (500)
       Note: Zebra status: Zebra server seems not to be available. Is it started?

Signed-off-by: David Nind <david@davidnind.com>
Comment 4 David Nind 2025-12-09 00:35:54 UTC
I amended the commit message as the first step was missing (although it was in the comment). I also updated step 4, as this caused issues 8-)

Possibly requiring a change somewhere else, but the message on the about page when the <server id=biblioserver listenref=biblioserver> is commented out is: Zebra status: Error message from Zebra: 10004

Is it possible to add a human-readable message, rather than a code?

I also changed it from an enhancement to normal, as it is something that isn't working as it should.

(Also, my sign-off was incorrect, so I updated it and reattached the patch.)