[Bug 32059] New: How to run scripts found under https://perldoc.koha-community.org/
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32059 Bug ID: 32059 Summary: How to run scripts found under https://perldoc.koha-community.org/ Change sponsored?: --- Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: mik@adminkuhn.ch QA Contact: testopia@bugs.koha-community.org Documentation pages like https://perldoc.koha-community.org/misc/migration_tools/bulkmarcimport.html do not give the proper command to run the script. In the example section "Usage" says: $ export KOHA_CONF=/etc/koha.conf $ perl misc/migration_tools/bulkmarcimport.pl -d -commit 1000 -file /home/jmf/koha.mrc -n 3000 When using Debian package installation one way to actually run the program is: As user "root": # export KOHA_CONF=/etc/koha/sites/instancename/koha-conf.xml # export PERL5LIB=/usr/share/koha/lib # /usr/share/koha/bin/migration_tools/bulkmarcimport.pl -b -m marcxml -framework=frameworkname -file TITEL.marcxml -v 2 But it seems the following way is recommended: As user "koha": $ sudo koha-shell -c "/usr/share/koha/bin/migration_tools/bulkmarcimport.pl -b -m marcxml -framework=frameworkname -file TITEL.marcxml -v 2" instancename Better documentation how to run this kind of scripts would be useful. https://perldoc.koha-community.org/ shows many more such scripts. -- 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=32059 --- Comment #1 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I feel like the instructions are not wrong in itself, the instructions work, they just assume that in a package installation you run the 'sudo koha-shell instance' command first, no matter which script you run. Also it depends, if you are not using a package based installation, but using tarball, you'd have to run them under the koha-user without having the koha-shell command option. This might be better for the manual instead of altering all the man pages. -- 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=32059 --- Comment #2 from Michael Kuhn <mik@adminkuhn.ch> --- "...the instructions work, they just assume that in a package installation you run the 'sudo koha-shell instance' command first, no matter which script you run. Also it depends, if you are not using a package based installation, but using tarball, you'd have to run them under the koha-user without having the koha-shell command option." But that's exactly the problem I wanted to submit - the documentation page doesn't say so. So if you're not already knowing what's assumed or how it works you're stuck. -- 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=32059 --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I agree we should document, just thinking that the auto-generated perl-doc might not be the right place. As this is dependent on how you installed Koha, notes in the wiki or manual in a general 'how to' chapter might better. -- 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=32059 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Version|unspecified |master Status|NEW |Needs documenting -- 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=32059 David Liddle <david_liddle@sil.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Documentation| |David Liddle contact| | CC| |david_liddle@sil.org --- Comment #4 from David Liddle <david_liddle@sil.org> --- Hi! This request is pretty old now, but I'm taking it on in my quest to join the Documentation team's efforts. Being a system administrator myself in my regular work, I'm familiar with the content. I think that general guidance for Perl scripts would have a place in the Koha Manual, in the section called 'Cron jobs and daemons': https://koha-community.org/manual/latest/en/html/cron_jobs.html#cron-jobs-an.... This whole section could be refined to better fit how Koha is typically installed and used these days. My thoughts include: - renaming the section 'Scripts, cron jobs, and daemons' - clarifying the ad-hoc and scheduled usage of Perl scripts, that is, through the 'koha-perl' command and in cron jobs - making all references in that section consistent Would that satisfy the original request? -- 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