From fdc714cd5d2a61083c48822ee05b3c2c2f36ff00 Mon Sep 17 00:00:00 2001 From: Alex Buckley Date: Sun, 5 Feb 2017 18:12:26 +1300 Subject: [PATCH] Bug 17956 - Added further LDAP configuration information. Tidied up the formatting of the onboardingstep6.tt Checked all links work as intented --- installer/onboarding.pl | 5 + .../prog/en/modules/onboarding/onboardingstep5.tt | 11 +- .../prog/en/modules/onboarding/onboardingstep6.tt | 123 ++++++++++++++------- 3 files changed, 91 insertions(+), 48 deletions(-) diff --git a/installer/onboarding.pl b/installer/onboarding.pl index b10db5c..3a66dc3 100755 --- a/installer/onboarding.pl +++ b/installer/onboarding.pl @@ -91,6 +91,11 @@ if ( $op && $op eq 'Finish' ) print $input->redirect("/cgi-bin/koha/mainpage.pl"); exit; } +elsif ( $op && $op eq 'Configure z-targets') +{ + print $input->redirect("/cgi-bin/koha/admin/z3950servers.pl?op=add&type=zed"); + exit; +} my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, ); $template->param( diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt index 1105516..85cf988 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt @@ -23,14 +23,13 @@

To create circulation rule, go to
More -> Administration -> Circulation and Fine Rules - -

Next steps

- To learn more about the services you can use with Koha click here:
+

Next steps:

+ Log into Koha:
+

+ To learn about other services you can integrate with Koha:


- To login to Koha:
- - + [% ELSE %]

Create a new circulation rule

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt index cd848b4..40103c4 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt @@ -1,17 +1,26 @@ [% INCLUDE 'doc-head-open.inc' %] Learn about LDAP service -[% IF ( finish ) %][% END %] +[% IF ( Finish ) %][% END %] [% INCLUDE 'installer-doc-head-close.inc' %] +
-

Koha Welcome to Koha

+

Koha Other services Koha supports

+
[% IF op == "Learn more" %] + Koha supports the integration of different library services with it.
+

LDAP user authentication

+ LDAP (Lightweight Directory Access Protocol) can be used to authenticate (login/logout) users. If your organisation has an existing authenication system this can be integrated with the Koha ILS, and so when users enter their credentials into Koha their username and password as compared against the user records in your existing user database to find a match.
+

SIP communication protocol between self checkout machines and server

+ SIP (Session Initiation Protocol) is a communication protocol used between ACS (Automated Circulation System in this case the Koha server) and SC (Self Checkout machines). If your library/institution has self checkout machines to checkin/checkout items then you will need to configure Koha to use SIP.

+
+
-

Are you using SIP or LDAP?

+

Does your institution use SIP, or LDAP?

LDAP
SIP
@@ -19,56 +28,86 @@ [% END %] - -[% IF (op == "learnservice") && (service == "LDAP") %] - -

Important information regarding setting up LDAP service

-

What is LDAP?

- LDAP (Lightweight Directory Access Protocol) ican be used as a method to authenticate users. Effectively it can be used to send users inputted credentials to a database where they are compared against all user records and if theres a match the user if successfully logged in. -
+
+ [% IF (op == "learnservice") && (service == "LDAP") %] +

Setting up LDAP with Koha

If your organisation has an existing database of user records that are used for authentication then setting up the LDAP service with Koha is a good idea because all user records would be stored in a single central location.
- LDAP can be used to log into both the Koha staff interface and OPAC.<
+ LDAP can be used to log into both the Koha staff interface and OPAC.

+ Follow these steps to set up LDAP with Koha:

+ 1. In your Linux terminal navigate to the direcotry containing the koha-conf.xml file. This will be either:
+ + cd /etc/koha/sites/kohadev/

+ 2. Open the koha-conf.xml file as root
+ sudo vi koha-conf.xml

+ 3. Scroll down to line 295 and change it to:
+ <useldapserver>1</useldapserver>

+ 4. Write in the follwing information:
+ <ldapserver id="ldapserver">
+ <hostname>localhost</hostname>
+ <base>dc=metavore,dc=com</base>
+ <user>cn=Manager,dc=metavore,dc=com</user>
+ <pass>metavore</pass>
+ <replicate>1</replicate>
+ <update>1</update>
+ <auth_by_bind>0</auth_by_bind>
+ <anonymous_bind>0</anonymous_bind>
+ <principal_name>%s@my_domain.com</principal_name>
+ <update_password>1</update_password>
+
+ 5. The following fields to write in (called maping fields) are optional. What they do is link the Koha database columns with the columns in your organisations user database.
+ e.g. the database column firstname is matched with the LDAP element givename
+ <mapping>
+ <firstname is="givenname" ></firstname>
+ <surname is="sn" ></surname>
+ <address is="postaladdress" ></address>
+ <city is="l" >Athens, OH</city>
+ <zipcode is="postalcode" ></zipcode>
+ <branchcode is="branch" >MAIN</branchcode>
+ <userid is="uid" ></userid>
+ <password is="userpassword" ></password>
+ <email is="mail" ></email>
+ <categorycode is="employeetype" >PT</categorycode>
+ <phone is="telephonenumber"></phone>
+ </mapping>
-

Learn how to set up LDAP at:

- LDAP in the manual +

Learn about further LDAP configuration

+ LDAP documentation -[% ELSIF (op == "learnservice") && (service == "SIP") %] -

Important information regarding setting up SIP server

- SIP (Session Initiation Protocol) is a communication protocol used between ACS (Automated Circulation System in this case the Koha server) and SC (Self Checkout machines). By setting up SIP with Koha you will be able to utilise your existing library infrastructure with the Koha ILS. - If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps: - 1. In your Linux terminal (in the Koha root directory) write in: + [% ELSIF (op == "learnservice") && (service == "SIP") %] +

Setting up SIP with Koha

+ If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:

+ 1. In your Linux terminal (in the Koha root directory) write in:
sudo koha-enable-sip

- 2. Edit your SIPconfig.xml file.
- 2.1. Edit the port value in the service sections at the top of the SIPconfig.xml file, making sure that the two port values have the same IP address but different port numbers.
- 2.2. Enter an account. This account must have the same username and password as an account you have created in the Koha staff interface. Also make sure that the account is set to having 'circulate' permissions only.
- 2.3. Enter an institution . As with acount this institution's ID must match the branchcode of a library created in the Koha staff interface

- 3. In your Linux terminal start SIP by writing in:
+ 2. Navigate to the directory containing SIPConfig.xml
+ In your Koha home directory write in:
+ cd /etc/koha/sites/

+ 3. Edit your SIPconfig.xml file
+ sudo vi SIPconfig.xml

+ 3.1. Edit the port values in the service sections at the top of the SIPconfig.xml file, making sure that the two port values have the same IP address but different port numbers.

+ 3.2. Enter an account. This account must have the same username and password as an account you have created in the Koha staff interface. Also make sure that the account is set to having 'circulate' permissions only.

+ 3.3. Enter an institution. As with account this institution's ID must match the branchcode of a library created in the Koha staff interface

+ 4. In your Linux terminal start SIP by writing in:
sudo koha-start-sip

-

Learn how to test SIP at:

Evergreen SIP support

Important security notice about using SIP

To ensure your SIP traffic (the request and response messages sent between you and the SIP server) are secure you must use a stunnel or VPN. -[% END %] - + [% END %] -[% IF (existingztargets > 1) %] -

Configure the z39.50 servers you installed in the web installer

- z-targets are simply the servers you will query when looking for a specific MARC record (bibliographic record). These servers are run by other libraries and institutions around the world, for example the Library of Congress. - Click here:
- Visit the z-target configuration page -[% ELSE %] -

Create z-targets

+[% IF (existingztargets == 0) %] +

Configure z-targets

What are z-targets?
- Z-targets are simply the servers you can choose to query when looking for a specific MARC record (bibliographic record). These servers are run by other libraries and institutions around the world, for example the Library of Congress.

- The benefit of setting up z-targets is that when cataloging a new bibliographic item you will be able to search and import the bibliographic information for that bibliographic record from the z39.50 servers (if the item exists in their database) thereby speeding up the cataloging process. -

- To create a z-target go to:
- Administration -> Z39.50/SRU servers -> New Z39.50 server
- - To learn what z-target servers are avaliable for you to use in your Koha instance go to:
- IRSpy Z39.50 target directory

- By using this site you can simply copy the server name, hostname, port number and database name across to the Koha administrative form to create a z-target. + Z-targets (also known as z39.50 servers) speed up the library cataloging process because you can query these servers for a specific MARC record (bibliographic record) and then import the record if a match is found saving you having to manually enter the bibliographic information. These servers are run by other libraries and institutions around the world, for example the Library of Congress.

+ Login to Koha and configure a z-target
+
+

+
[% END %] +Finish and log into Koha +

+ -- 2.1.4