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

(-)a/installer/onboarding.pl (-2 / +28 lines)
Lines 2-8 Link Here
2
2
3
# This file is part of Koha.
3
# This file is part of Koha.
4
#
4
#
5
# Copyright (C) 2017 Catalyst IT
5
# Copyright (C) 2017 Alex Buckley Catalyst IT
6
#
6
#
7
# Koha is free software; you can redistribute it and/or modify it
7
# Koha is free software; you can redistribute it and/or modify it
8
# under the terms of the GNU General Public License as published by
8
# under the terms of the GNU General Public License as published by
Lines 76-86 $template->param( 'op' => $op ); Link Here
76
76
77
my $schema = Koha::Database->new()->schema();
77
my $schema = Koha::Database->new()->schema();
78
78
79
if ( $op && $op eq 'finish' )
79
if ( $op && $op eq 'Finish' )
80
{ #If the value of $op equals 'finish' then redirect user to /cgi-bin/koha/mainpage.pl
80
{ #If the value of $op equals 'finish' then redirect user to /cgi-bin/koha/mainpage.pl
81
    print $input->redirect("/cgi-bin/koha/mainpage.pl");
81
    print $input->redirect("/cgi-bin/koha/mainpage.pl");
82
    exit;
82
    exit;
83
}
83
}
84
elsif ( $op && $op eq 'Configure z-targets') {
85
    print $input->redirect("/cgi-bin/koha/admin/z3950servers.pl?op=add&type=zed");
86
    exit;
87
}
84
88
85
my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, );
89
my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, );
86
$template->param(
90
$template->param(
Lines 114-119 $template->param( Link Here
114
    my $itemtypes = Koha::ItemTypes->search();
118
    my $itemtypes = Koha::ItemTypes->search();
115
    $template->param( 'itemtypes' => $itemtypes, );
119
    $template->param( 'itemtypes' => $itemtypes, );
116
120
121
#Select all the ztarget records in the z3950server table and give them to the template
122
    my $existingztargets = $schema->resultset('Z3950server')->count;
123
    $template->param(existingztargets => $existingztargets);
124
125
117
if ( $step && $step == 1 ) {
126
if ( $step && $step == 1 ) {
118
    #store inputted parameters in variables
127
    #store inputted parameters in variables
119
    my $branchcode = $input->param('branchcode');
128
    my $branchcode = $input->param('branchcode');
Lines 600-603 elsif ( $step && $step == 5 ) { Link Here
600
    }
609
    }
601
}
610
}
602
611
612
elsif ( $step && $step == 6 ){
613
    my $service = $input->param('service');
614
    $template->param( service => $service );
615
    my ( $template, $loggedinuser, $cookie ) =
616
        C4::InstallAuth::get_template_and_user(
617
                {
618
                    template_name   => "/onboarding/onboardingstep6.tt",
619
                    query           => $input,
620
                    type            => "intranet",
621
                    authnotrequired => 0,
622
                    flagsrequired   => { parameters => 'manage_circ_rules' },
623
                    debug           => 1,
624
                }
625
        );
626
}
627
628
603
output_html_with_http_headers $input, $cookie, $template->output;
629
output_html_with_http_headers $input, $cookie, $template->output;
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt (-10 / +7 lines)
Lines 1-31 Link Here
1
[% INCLUDE 'doc-head-open.inc' %]
1
[% INCLUDE 'doc-head-open.inc' %]
2
<title>Create Circulation rule</title>
2
<title>Create Circulation rule</title>
3
[% IF ( finish ) %]<meta http-equiv="refresh" content="10; url=/cgi-bin/koha/mainpage.pl">[% END %]
4
[% INCLUDE 'installer-doc-head-close.inc' %]
3
[% INCLUDE 'installer-doc-head-close.inc' %]
5
4
6
<div>
5
<div>
7
    <h1 id="logo"><img alt="Koha" src="[% interface %]/[% theme %]/img/koha.org-logo.gif"/> Welcome to Koha</h1>
6
    <h1 id="logo"><img alt="Koha" src="[% interface %]/[% theme %]/img/koha.org-logo.gif"/> Welcome to Koha</h1>
8
</div>
7
</div>
9
8
10
[% IF (finish) %]
11
<h1>Congratulations you have finished and ready to use Koha</h1>
12
<a href="/cgi-bin/koha/mainpage.pl">Start using Koha</a>
13
14
[% END %]
15
16
<!--Create a circulation rule screen 2-->
9
<!--Create a circulation rule screen 2-->
17
[% IF op == "add_validate" %]
10
[% IF op == "add_validate" %]
18
        <!--New circulation rule created-->
11
        <!--New circulation rule created-->
19
        <form name="finish" method="post" action="onboarding.pl">
12
        <form name="finish" method="post" action="onboarding.pl">
20
            <input type="hidden" name="op" value="finish" />
13
            <input type="hidden" name="step" value="6" />
21
            <h1 align="left"> New circulation rule </h1>
14
            <h1 align="left"> New circulation rule </h1>
22
            <div>
15
            <div>
23
                 <p> Success: circulation rule created!</p>
16
                 <p> Success: circulation rule created!</p>
24
                 <p> To create circulation rule, go to <br>
17
                 <p> To create circulation rule, go to <br>
25
                 More -> Administration -> Circulation and Fine Rules
18
                 More -> Administration -> Circulation and Fine Rules
26
            </div>
19
            </div>
27
                 Next up:
20
            <h2> Next steps:</h2>
28
                 <input type="submit" name="op" value="Finish"/>
21
            Log into Koha:<br>
22
            <input type="submit" name="op" value="Finish"/><br><br>
23
            To learn about other services you can integrate with Koha:<br>
24
            <input type="submit" name="op" value="Learn more"/>
25
            <br><br>
29
        </form>
26
        </form>
30
[% ELSE %]
27
[% ELSE %]
31
<!--Create a circulation rule screen 1-->
28
<!--Create a circulation rule screen 1-->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt (-1 / +114 lines)
Line 0 Link Here
0
- 
1
[% INCLUDE 'doc-head-open.inc' %]
2
<title>Learn about other services</title>
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' %]
5
</head>
6
7
<div>
8
<h1 id="logo"><img alt="Koha" src="[% interface %]/[% theme %]/img/koha.org-logo.gif"/> Other services Koha supports</h1>
9
</div>
10
11
<div id="Services">
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">
20
        <form name="showservice" method="post" action="onboarding.pl">
21
            <input type="hidden" name="op" value="learnservice"/>
22
            <input type="hidden" name="step" value="6"/>
23
            <h1 align="left"> Does your institution use SIP, or LDAP? </h1>
24
            <div>
25
                <input type="radio" name="service" value="LDAP"> LDAP <br>
26
                <input type="radio" name="service" value="SIP"> SIP  <br>
27
            </div>
28
            <input type="submit" class="action" value="Submit">
29
        </form>
30
[% END %]
31
32
</div>
33
[% IF (op == "learnservice") && (service == "LDAP") %]
34
    <h1 align="left"> Setting up LDAP with Koha</h1>
35
    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>
36
    LDAP can be used to log into both the Koha staff interface and OPAC.<br><br>
37
    Follow these steps to set up LDAP with Koha:<br><br>
38
    <b>1. In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:</b><br>
39
    <ul>
40
        <li> /etc/koha/sites/<instance-name>/koha-conf.xml<br></li>
41
        <li> /etc/koha/koha-conf.xml<br></li>
42
    </ul>
43
    <i> cd /etc/koha/sites/kohadev/</i><br><br>
44
    <b>2. Open the koha-conf.xml file as root</b><br>
45
    <i> sudo vi koha-conf.xml</i><br><br>
46
    <b>3. Scroll down to line 295 and change it to:</b><br>
47
    <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
48
    <b>4. Write in the follwing information:</b><br>
49
    <i>&lt;ldapserver id="ldapserver"&gt;</i><br>
50
    <i>&lt;hostname&gt;localhost&lt;/hostname&gt;</i><br>
51
    <i>&lt;base&gt;dc=metavore,dc=com&lt;/base&gt;</i><br>
52
    <i>&lt;user&gt;cn=Manager,dc=metavore,dc=com&lt;/user&gt;</i><br>
53
    <i>&lt;pass&gt;metavore&lt;/pass&gt;</i><br>
54
    <i>&lt;replicate&gt;1&lt;/replicate&gt;</i><br>
55
    <i>&lt;update&gt;1&lt;/update&gt;</i><br>
56
    <i>&lt;auth_by_bind&gt;0&lt;/auth_by_bind&gt;</i><br>
57
    <i>&lt;anonymous_bind&gt;0&lt;/anonymous_bind&gt;</i><br>
58
    <i>&lt;principal_name&gt;%s@my_domain.com&lt;/principal_name&gt;</i><br>
59
    <i>&lt;update_password&gt;1&lt;/update_password&gt;</i><br><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>
75
76
    <h2> Learn about further LDAP configuration</h2>
77
    <a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="_target">LDAP documentation</a>
78
79
[% ELSIF (op == "learnservice") && (service == "SIP") %]
80
    <h1 align="left"> Setting up SIP with Koha</h1>
81
    If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:<br><br>
82
    <b>1. In your Linux terminal (in the Koha root directory) write in:</b><br>
83
    <i>sudo koha-enable-sip <instancename></i><br><br>
84
    <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
85
    In your Koha home directory write in:<br>
86
    <i> cd /etc/koha/sites/<instancename></i><br><br>
87
    <b>3. Edit your SIPconfig.xml file</b><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>
93
    <i>sudo koha-start-sip <instancename></i><br><br>
94
    <h2> Learn how to test SIP at:<h2>
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>
96
    <h2> Important security notice about using SIP </h2>
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.
98
[% END %]
99
100
101
[% IF (existingztargets == 0) %]
102
    <h1> Configure z-targets</h1>
103
    <b>What are z-targets?</b><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>
105
    <b>Login to Koha and configure a z-target</b><br>
106
    <form name="showservice" method="post" action="onboarding.pl">
107
        <input type="submit" name="op" value="Configure z-targets"/><br><br>
108
    </form>
109
[% END %]
110
111
Finish and log into Koha<br>
112
<form name="loginlink" method="post" action="onboarding.pl">
113
    <input type="submit" name="op" value="Finish"/><br><br>
114
</form>

Return to bug 17956