Koha/debian/docs
Tomas Cohen Arazi c6f091cc23 Bug 10733: Memcached on package installs
This patch makes the koha-create script adjust the koha-conf.xml file
with the proper string substitutions to enable the use of memcached
for the created Koha instance.

It adds three option switches that control this:

 --use-memcached (defaults to "no")
 --memcached-servers "host1:port1,..." (defaults to '127.0.0.1:11211')
 --memcached-prefix "desired_namespace prefix" (defaults to 'koha_')

It respects the current schema configuration schema, where configuration
values are pondered like this:

hardcoded < koha-sites.conf < koha-create option switches

koha-sites.conf is read for USE_MEMCACHED, MEMCACHED_SERVERS and
MEMCACHED_PREFIX.

Note: the docs discourage setting user's own namespace prefix.

Using memcached is off as the default. The relevant configuration
variables will remain empty if the user doesn't pass --use-memcached
to the command. It matches the current behaviour.

To test:
- Apply the patch
- Build your own packages and install them on a test server
a) Create a new instance without using the new switches like:
 $ koha-create --create-db memctest
 - Check that /etc/koha/sites/memctest/koha-conf.xml contains:
   * Empty <memcached_servers> tag.
   * Empty <memcached_namespace> tag.

b) Play with the possible combination of option switches
(Note that the code defaults to empty and will remain like that if
--use-memcached is not used, so less tests...)

 $ koha-create --create-db --use-memcached memctest
 $ koha-create --create-db --use-memcached --memcached-servers "anything:xxx" memctest
 $ koha-create --create-db --use-memcached --memcached-servers "anything:xxx" --memcached-prefix "something" memctest
 $ koha-create --create-db --use-memcached --memcached-prefix "something" memctest

 - Check the koha-conf.xml and /etc/apache2/sites-enabled/memctest
   file reflect the chosen options.

c) Run
 $ koha-create --help
 - It should advertise this addition accordingly.

d) Run
 $ man koha-create
 - Man page for koha-create should provide good information on the new
   switches behaviour

Sponsored-by: Universidad Nacional de Cordoba
Signed-off-by: Mark Tompsett <mtompset@hotmail.com>
Signed-off-by: Robin Sheat <robin@catalyst.net.nz>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
2013-10-30 03:27:51 +00:00
..
koha-common.xml Bug 9250 - Followup to add koha-*-sip commands to koha-common.xml 2013-05-01 22:03:13 -04:00
koha-create-dirs.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-create.xml Bug 10733: Memcached on package installs 2013-10-30 03:27:51 +00:00
koha-disable.xml Bug 10104 - make koha-disable more robust 2013-05-01 21:58:38 -04:00
koha-dump-defaults.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-dump.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-email-disable.xml Bug 10150 - koha-email-disable error handling 2013-05-02 15:04:57 -07:00
koha-email-enable.xml Bug 10157 - koha-email-enable error handling 2013-05-15 08:13:17 -04:00
koha-enable-sip.xml Bug 9250 - [SIGNED-OFF] provide commands to manage the SIP server 2013-05-01 22:03:13 -04:00
koha-enable.xml Bug 10101 - make koha-enable more robust 2013-05-01 22:00:13 -04:00
koha-foreach.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-list.xml Bug 10622: (follow-up) uppercase "SIP" in documentation and help text 2013-09-21 17:47:54 +00:00
koha-mysql.xml Bug 9247 - Add two more usage examples to the manpage for koha-mysql 2013-08-28 13:43:00 +00:00
koha-rebuild-zebra.xml Bug 10379 - Followup: add koha-rebuild-zebra -q to the man page 2013-06-26 08:56:05 -07:00
koha-remove.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-reset-passwd.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-restart-zebra.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-restore.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-run-backups.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-shell.xml Bug 8878 - a command to provide a shell with the koha environment 2012-12-20 08:01:46 -05:00
koha-start-sip.xml Bug 9250 - [SIGNED-OFF] provide commands to manage the SIP server 2013-05-01 22:03:13 -04:00
koha-start-zebra.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-stop-sip.xml Bug 9250 - [SIGNED-OFF] provide commands to manage the SIP server 2013-05-01 22:03:13 -04:00
koha-stop-zebra.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-translate.xml Bug 10041 - Provide a koha-translate script to aid package users on installing translations 2013-05-01 22:02:16 -04:00
koha-upgrade-schema.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
koha-upgrade-to-3.4.xml Bug 10042 - Minor typo ("Communnity") in packages docs 2013-04-18 08:36:11 -04:00
LEEME.Debian Bug 7197 - add a Spanish readme file to the packages 2011-12-14 15:38:04 +01:00