View | Details | Raw Unified | Return to bug 17956
Collapse All | Expand All

(-)a/installer/onboarding.pl (+5 lines)
Lines 91-96 if ( $op && $op eq 'Finish' ) Link Here
91
    print $input->redirect("/cgi-bin/koha/mainpage.pl");
91
    print $input->redirect("/cgi-bin/koha/mainpage.pl");
92
    exit;
92
    exit;
93
}
93
}
94
elsif ( $op && $op eq 'Configure z-targets')
95
{
96
    print $input->redirect("/cgi-bin/koha/admin/z3950servers.pl?op=add&type=zed");
97
    exit;
98
}
94
99
95
my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, );
100
my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, );
96
$template->param(
101
$template->param(
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt (-6 / +5 lines)
Lines 23-36 Link Here
23
                 <p> To create circulation rule, go to <br>
23
                 <p> To create circulation rule, go to <br>
24
                 More -> Administration -> Circulation and Fine Rules
24
                 More -> Administration -> Circulation and Fine Rules
25
            </div>
25
            </div>
26
26
            <h2> Next steps:</h2>
27
            <h2> Next steps </h2>
27
            Log into Koha:<br>
28
            To learn more about the services you can use with Koha click here:<br>
28
            <input type="submit" name="op" value="Finish"/><br><br>
29
            To learn about other services you can integrate with Koha:<br>
29
            <input type="submit" name="op" value="Learn more"/>
30
            <input type="submit" name="op" value="Learn more"/>
30
            <br><br>
31
            <br><br>
31
            To login to Koha:<br>
32
       </form>
32
            <input type="submit" name="op" value="Finish"/>
33
        </form>
34
[% ELSE %]
33
[% ELSE %]
35
<!--Create a circulation rule screen 1-->
34
<!--Create a circulation rule screen 1-->
36
       <h1 align="left"> Create a new circulation rule </h1>
35
       <h1 align="left"> Create a new circulation rule </h1>
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt (-43 / +81 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'doc-head-open.inc' %]
1
[% INCLUDE 'doc-head-open.inc' %]
2
<title>Learn about LDAP service</title>
2
<title>Learn about LDAP service</title>
3
[% IF ( finish ) %]<meta http-equiv="refresh" content="10; url=/cgi-bin/koha/admin/z3950servers.pl?op=add&type=zed">[% END %]
3
[% IF ( Finish ) %]<meta http-equiv="refresh" content="10; url=/cgi-bin/koha/admin/z3950servers.pl?op=add&type=zed">[% END %]
4
[% INCLUDE 'installer-doc-head-close.inc' %]
4
[% INCLUDE 'installer-doc-head-close.inc' %]
5
</head>
5
6
6
<div>
7
<div>
7
    <h1 id="logo"><img alt="Koha" src="[% interface %]/[% theme %]/img/koha.org-logo.gif"/> Welcome to Koha</h1>
8
    <h1 id="logo"><img alt="Koha" src="[% interface %]/[% theme %]/img/koha.org-logo.gif"/> Other services Koha supports</h1>
8
</div>
9
</div>
9
10
11
<div id="Services">
10
[% IF op == "Learn more" %]
12
[% IF op == "Learn more" %]
13
    Koha supports the integration of different library services with it.<br>
14
    <h2 align="left"> LDAP user authentication</h2>
15
    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.<br>
16
    <h2 align="left">SIP communication protocol between self checkout machines and server</h2>
17
    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.<br><br>
18
</div>
19
<div id="checkbox">
11
    <form name="showservice" method="post" action="onboarding.pl">
20
    <form name="showservice" method="post" action="onboarding.pl">
12
        <input type="hidden" name="op" value="learnservice"/>
21
        <input type="hidden" name="op" value="learnservice"/>
13
        <input type="hidden" name="step" value="6"/>
22
        <input type="hidden" name="step" value="6"/>
14
        <h1 align="left"> Are you using SIP or LDAP?</h1>
23
        <h1 align="left"> Does your institution use SIP, or LDAP? </h1>
15
        <div>
24
        <div>
16
            <input type="radio" name="service" value="LDAP"> LDAP <br>
25
            <input type="radio" name="service" value="LDAP"> LDAP <br>
17
            <input type="radio" name="service" value="SIP"> SIP  <br>
26
            <input type="radio" name="service" value="SIP"> SIP  <br>
Lines 19-74 Link Here
19
        <input type="submit" class="action" value="Submit">
28
        <input type="submit" class="action" value="Submit">
20
    </form>
29
    </form>
21
[% END %]
30
[% END %]
22
31
</div>
23
[% IF (op == "learnservice") && (service == "LDAP") %]
32
    [% IF (op == "learnservice") && (service == "LDAP") %]
24
33
       <h1 align="left"> Setting up LDAP with Koha</h1>
25
       <h1 align="left"> Important information regarding setting up LDAP service </h1>
26
       <h2 align="left"> What is LDAP? </h2>
27
       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.
28
       <br>
29
       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.<br>
34
       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.<br>
30
       LDAP can be used to log into both the Koha staff interface and OPAC.<<br>
35
       LDAP can be used to log into both the Koha staff interface and OPAC.<br><br>
36
       Follow these steps to set up LDAP with Koha:<br><br>
37
       <b>1. In your Linux terminal navigate to the direcotry containing the koha-conf.xml file. This will be either:</b><br>
38
       <ul>
39
            <li> /etc/koha/sites/<instance-name>/koha-conf.xml<br></li>
40
            <li> /etc/koha/koha-conf.xml<br></li>
41
       </ul>
42
       <i> cd /etc/koha/sites/kohadev/</i><br><br>
43
       <b>2. Open the koha-conf.xml file as root</b><br>
44
       <i> sudo vi koha-conf.xml</i><br><br>
45
       <b>3. Scroll down to line 295 and change it to:</b><br>
46
       <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
47
       <b>4. Write in the follwing information:</b><br>
48
       <i>&lt;ldapserver id="ldapserver"&gt;</i><br>
49
       <i>&lt;hostname&gt;localhost&lt;/hostname&gt;</i><br>
50
       <i>&lt;base&gt;dc=metavore,dc=com&lt;/base&gt;</i><br>
51
       <i>&lt;user&gt;cn=Manager,dc=metavore,dc=com&lt;/user&gt;</i><br>
52
       <i>&lt;pass&gt;metavore&lt;/pass&gt;</i><br>
53
       <i>&lt;replicate&gt;1&lt;/replicate&gt;</i><br>
54
       <i>&lt;update&gt;1&lt;/update&gt;</i><br>
55
       <i>&lt;auth_by_bind&gt;0&lt;/auth_by_bind&gt;</i><br>
56
       <i>&lt;anonymous_bind&gt;0&lt;/anonymous_bind&gt;</i><br>
57
       <i>&lt;principal_name&gt;%s@my_domain.com&lt;/principal_name&gt;</i><br>
58
       <i>&lt;update_password&gt;1&lt;/update_password&gt;</i><br>
59
       <br>
60
       <b>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.</b><br>
61
       e.g. the database column firstname is matched with the LDAP element givename<br>
62
       <i>&lt;mapping&gt;</i><br>
63
       <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
64
       <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
65
       <i>&lt;address      is="postaladdress"  &gt;&lt;/address&gt;</i><br>
66
       <i>&lt;city         is="l"              &gt;Athens, OH&lt;/city&gt;</i><br>
67
       <i>&lt;zipcode      is="postalcode"     &gt;&lt;/zipcode&gt;</i><br>
68
       <i>&lt;branchcode   is="branch"         &gt;MAIN&lt;/branchcode&gt;</i><br>
69
       <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
70
       <i>&lt;password     is="userpassword"   &gt;&lt;/password&gt;</i><br>
71
       <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
72
       <i>&lt;categorycode is="employeetype"   &gt;PT&lt;/categorycode&gt;</i><br>
73
       <i>&lt;phone        is="telephonenumber"&gt;&lt;/phone&gt;</i><br>
74
       <i>&lt;/mapping&gt;</i><br>
31
75
32
       <h2> Learn how to set up LDAP at:</h2>
76
       <h2> Learn about further LDAP configuration</h2>
33
       <a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="_target">LDAP in the manual</a>
77
       <a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="_target">LDAP documentation</a>
34
78
35
[% ELSIF (op == "learnservice") && (service == "SIP") %]
79
    [% ELSIF (op == "learnservice") && (service == "SIP") %]
36
       <h2 align="left"> Important information regarding setting up SIP server</h2>
80
       <h1 align="left"> Setting up SIP with Koha</h1>
37
       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.
81
       If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:<br><br>
38
       If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:
82
       <b>1. In your Linux terminal (in the Koha root directory) write in:</b><br>
39
       1. In your Linux terminal (in the Koha root directory) write in:
40
       <i>sudo koha-enable-sip <instancename></i><br><br>
83
       <i>sudo koha-enable-sip <instancename></i><br><br>
41
       2. Edit your SIPconfig.xml file.<br>
84
       <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
42
       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.<br>
85
       In your Koha home directory write in:<br>
43
       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.<br>
86
       <i> cd /etc/koha/sites/<instancename></i><br><br>
44
       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<br><br>
87
       <b>3. Edit your SIPconfig.xml file</b><br>
45
       3. In your Linux terminal start SIP by writing in:<br>
88
       <i>sudo vi SIPconfig.xml</i><br><br>
89
       <b>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.</b><br><br>
90
       <b>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.</b><br><br>
91
       <b>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</b><br><br>
92
       <b>4. In your Linux terminal start SIP by writing in:</b><br>
46
       <i>sudo koha-start-sip <instancename></i><br><br>
93
       <i>sudo koha-start-sip <instancename></i><br><br>
47
48
       <h2> Learn how to test SIP at:<h2>
94
       <h2> Learn how to test SIP at:<h2>
49
       <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="_target"> Evergreen SIP support</a><br><br>
95
       <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="_target"> Evergreen SIP support</a><br><br>
50
       <h2> Important security notice about using SIP </h2>
96
       <h2> Important security notice about using SIP </h2>
51
       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.
97
       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.
52
98
53
[% END %]
99
    [% END %]
54
55
100
56
[% IF (existingztargets > 1) %]
101
[% IF (existingztargets == 0) %]
57
    <h1> Configure the z39.50 servers you installed in the web installer</h1>
102
    <h1> Configure z-targets</h1>
58
    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.
59
    Click here:<br>
60
    <input type="submit" value="Finish"> Visit the z-target configuration page</input>
61
[% ELSE %]
62
    <h1> Create z-targets</h1>
63
    <b>What are z-targets?</b><br>
103
    <b>What are z-targets?</b><br>
64
    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.<br><br>
104
    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.<br><br>
65
    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.
105
    <b>Login to Koha and configure a z-target</b><br>
66
    <br><br>
106
    <form name="showservice" method="post" action="onboarding.pl">
67
    <b>To create a z-target go to:</b><br>
107
        <input type="submit" name="op" value="Configure z-targets"/><br><br>
68
    Administration -> Z39.50/SRU servers -> New Z39.50 server<br>
108
    </form>
69
70
    To learn what z-target servers are avaliable for you to use in your Koha instance go to:<br>
71
    <a href="http://irspy.indexdata.com/find.html" target="_target"> IRSpy Z39.50 target directory </a><br><br>
72
    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. 
73
[% END %]
109
[% END %]
74
110
75
- 
111
Finish and log into Koha
112
<input type="submit" name="op" value="Finish"/><br><br>
113

Return to bug 17956