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

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt (-20 / +20 lines)
Lines 13-29 Link Here
13
    Koha supports the integration of different library services with it.<br>
13
    Koha supports the integration of different library services with it.<br>
14
    <h2 align="left"> LDAP user authentication</h2>
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>
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>
16
    <h2 align="left">SIP2 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>
17
    SIP2 (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>
18
    </div>
19
    <div id="checkbox">
19
    <div id="checkbox">
20
        <form name="showservice" method="post" action="onboarding.pl">
20
        <form name="showservice" method="post" action="onboarding.pl">
21
            <input type="hidden" name="op" value="learnservice"/>
21
            <input type="hidden" name="op" value="learnservice"/>
22
            <input type="hidden" name="step" value="6"/>
22
            <input type="hidden" name="step" value="6"/>
23
            <h1 align="left"> Does your institution use SIP, or LDAP? </h1>
23
            <h1 align="left"> Does your institution use SIP2, or LDAP? </h1>
24
            <div>
24
            <div>
25
                <input type="radio" name="service" value="LDAP"> LDAP <br>
25
                <input type="radio" name="service" value="LDAP"> LDAP <br>
26
                <input type="radio" name="service" value="SIP"> SIP  <br>
26
                <input type="radio" name="service" value="SIP"> SIP2  <br>
27
            </div>
27
            </div>
28
            <input type="submit" class="action" value="Submit">
28
            <input type="submit" class="action" value="Submit">
29
        </form>
29
        </form>
Lines 32-51 Link Here
32
</div>
32
</div>
33
[% IF (op == "learnservice") && (service == "LDAP") %]
33
[% IF (op == "learnservice") && (service == "LDAP") %]
34
    <h1 align="left"> Setting up LDAP with Koha</h1>
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>
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>
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>
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>
38
    <ol>
39
    <li>In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:</li>
39
    <ul>
40
    <ul>
40
        <li> /etc/koha/sites/<instance-name>/koha-conf.xml<br></li>
41
        <li> /etc/koha/sites/<instance-name>/koha-conf.xml<br></li>
41
        <li> /etc/koha/koha-conf.xml<br></li>
42
        <li> /etc/koha/koha-conf.xml<br></li>
42
    </ul>
43
    </ul>
43
    <i> cd /etc/koha/sites/kohadev/</i><br><br>
44
    <i> cd /etc/koha/sites/kohadev/</i><br><br>
44
    <b>2. Open the koha-conf.xml file as root</b><br>
45
    <li>Open the koha-conf.xml file as root</li>
45
    <i> sudo vi koha-conf.xml</i><br><br>
46
    <i> sudo vi koha-conf.xml</i><br><br>
46
    <b>3. Scroll down to line 295 and change it to:</b><br>
47
    <li>Scroll down to line 295 and change it to:</li>
47
    <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
48
    <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
48
    <b>4. Write in the follwing information:</b><br>
49
    <li>Write in the follwing information:</li>
49
    <i>&lt;ldapserver id="ldapserver"&gt;</i><br>
50
    <i>&lt;ldapserver id="ldapserver"&gt;</i><br>
50
    <i>&lt;hostname&gt;localhost&lt;/hostname&gt;</i><br>
51
    <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;base&gt;dc=metavore,dc=com&lt;/base&gt;</i><br>
Lines 57-64 Link Here
57
    <i>&lt;anonymous_bind&gt;0&lt;/anonymous_bind&gt;</i><br>
58
    <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;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
    <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
    <li>The following fields to write in (called mapping fields) are optional. What they do is link the Koha database columns with the columns in your organisations user database.</li>
61
  e.g. the database column firstname is matched with the LDAP element givename<br>
62
  e.g. the database column firstname is matched with the LDAP element givenname<br>
62
    <i>&lt;mapping&gt;</i><br>
63
    <i>&lt;mapping&gt;</i><br>
63
    <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
64
    <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;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
Lines 72-84 Link Here
72
    <i>&lt;categorycode is="employeetype"   &gt;PT&lt;/categorycode&gt;</i><br>
73
    <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;phone        is="telephonenumber"&gt;&lt;/phone&gt;</i><br>
74
    <i>&lt;/mapping&gt;</i><br>
75
    <i>&lt;/mapping&gt;</i><br>
75
76
</ol>
76
    <h2> Learn about further LDAP configuration</h2>
77
    <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
    <a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="_target">LDAP documentation</a>
78
79
79
[% ELSIF (op == "learnservice") && (service == "SIP") %]
80
[% ELSIF (op == "learnservice") && (service == "SIP") %]
80
    <h1 align="left"> Setting up SIP with Koha</h1>
81
    <h1 align="left"> Setting up SIP2 with Koha</h1>
81
    If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:<br><br>
82
    If you installed Koha using debain packages then setting up SIP2 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
    <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
    <i>sudo koha-enable-sip <instancename></i><br><br>
84
    <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
85
    <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
Lines 89-100 Link Here
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.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.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>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
    <b>4. In your Linux terminal start SIP2 by writing in:</b><br>
93
    <i>sudo koha-start-sip <instancename></i><br><br>
94
    <i>sudo koha-start-sip <instancename></i><br><br>
94
    <h2> Learn how to test SIP at:<h2>
95
    <h2> Learn how to test SIP2 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
    <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="_target"> Evergreen SIP2 support</a><br><br>
96
    <h2> Important security notice about using SIP </h2>
97
    <h2> Important security notice about using SIP2 </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
  To ensure your SIP2 traffic (the request and response messages sent between you and the SIP2 server) are secure you must use a stunnel or VPN.
98
[% END %]
99
[% END %]
99
100
100
101
101
- 

Return to bug 17956