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

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt (-139 / +139 lines)
Lines 50-66 Link Here
50
50
51
    <h3> Steps to setup Koha with LDAP</h3>
51
    <h3> Steps to setup Koha with LDAP</h3>
52
    <ol>
52
    <ol>
53
        <li>1. In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:</li><br>
53
        <li>In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:</li><br>
54
        <ul>
54
        <ul>
55
            <li> /etc/koha/sites/&lt;instance-name&gt;/koha-conf.xml<br></li>
55
            <li> /etc/koha/sites/&lt;instance-name&gt;/koha-conf.xml<br></li>
56
            <li> /etc/koha/koha-conf.xml<br></li>
56
            <li> /etc/koha/koha-conf.xml<br></li>
57
        </ul>
57
        </ul>
58
        <i>e.g. cd /etc/koha/sites/kohadev/</i><br><br>
58
        <i>e.g. cd /etc/koha/sites/kohadev/</i><br><br>
59
        <b>2. Open the koha-conf.xml file as root</b><br>
59
        <li>Open the koha-conf.xml file as root</li><br>
60
        <i> sudo vi koha-conf.xml</i><br><br>
60
        <i> sudo vi koha-conf.xml</i><br><br>
61
        <b>3. Scroll down to the line containing "&lt;useldapserver&gt;0&lt;/useldapserver&gt;" and change it to:</b><br>
61
        <li>Scroll down to the line containing "&lt;useldapserver&gt;0&lt;/useldapserver&gt;" and change it to:</li><br>
62
        <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
62
        <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
63
        <b>4. Write in the following information:</b><br>
63
        <li>Write in the following information:</li><br>
64
        <i>&lt;ldapserver id="&lt;ldapservername&gt;"&gt;</i><br>
64
        <i>&lt;ldapserver id="&lt;ldapservername&gt;"&gt;</i><br>
65
        <i>&lt;hostname&gt;&lt;hostname&gt;&lt;/hostname&gt;</i><br>
65
        <i>&lt;hostname&gt;&lt;hostname&gt;&lt;/hostname&gt;</i><br>
66
        <i>&lt;base&gt;dc=&lt;domaincontroller&gt;,dc=&lt;domaincontroller&gt;&lt;/base&gt;</i><br>
66
        <i>&lt;base&gt;dc=&lt;domaincontroller&gt;,dc=&lt;domaincontroller&gt;&lt;/base&gt;</i><br>
Lines 72-87 Link Here
72
        <i>&lt;anonymous_bind&gt;&lt;either0or1&gt;&lt;/anonymous_bind&gt;</i><br>
72
        <i>&lt;anonymous_bind&gt;&lt;either0or1&gt;&lt;/anonymous_bind&gt;</i><br>
73
        <i>&lt;principal_name&gt;&lt;principalname&gt;&lt;/principal_name&gt;</i><br>
73
        <i>&lt;principal_name&gt;&lt;principalname&gt;&lt;/principal_name&gt;</i><br>
74
        <i>&lt;update_password&gt;&lt;either0or1&gt;&lt;/update_password&gt;</i><br><br>
74
        <i>&lt;update_password&gt;&lt;either0or1&gt;&lt;/update_password&gt;</i><br><br>
75
        <div class="infoDiv"><b>Note:</b> The values in these fields will need to be changed to the appropriate value for your organisation.
75
        <div class="infoDiv"><b>Note:</b> The values in these fields (above) will need to be changed to the appropriate value for your organisation.
76
        Hostname can be either an alphanumeric string or an IP address. If the hostname is an IP address then you can choose to explicitly specify the port number or you can leave it as the default. </div><br>
76
        Hostname can be either an alphanumeric string or an IP address. If the hostname is an IP address then you can choose to explicitly specify the port number or you can leave it as the default. </div><br>
77
77
78
        <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>
78
        <li>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.</li><br>
79
  e.g. the database column firstname is matched with the LDAP element givename<br>
79
        e.g. the database column firstname is matched with the LDAP element givename<br>
80
        <i>&lt;mapping&gt;</i><br>
80
        <i>&lt;mapping&gt;</i><br>
81
        <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
81
        <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
82
        <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
82
        <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
83
        <i>&lt;address      is="postaladdress"  &gt;&lt;/address&gt;</i><br>
83
        <i>&lt;address      is="postaladdress"  &gt;&lt;/address&gt;</i><br>
84
        <i>&lt;city         is="l"              &gt;Athens, OH&lt;/city&gt;</i><br>
84
        <i>&lt;city         is="l"              &gt;Athens, OH&lt;/city&gt;</i> &lt;!--All users by default will have the city value of Athens, OH--&gt;<br>
85
        <i>&lt;zipcode      is="postalcode"     &gt;&lt;/zipcode&gt;</i><br>
85
        <i>&lt;zipcode      is="postalcode"     &gt;&lt;/zipcode&gt;</i><br>
86
        <i>&lt;branchcode   is="branch"         &gt;MAIN&lt;/branchcode&gt;</i><br>
86
        <i>&lt;branchcode   is="branch"         &gt;MAIN&lt;/branchcode&gt;</i><br>
87
        <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
87
        <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
Lines 94-237 Link Here
94
        <div class="infoDiv"> <b>Note:</b> The columns on the left (above) are columns existing in the LDAP server, the values in the middle are columns existing in the Koha database. Whilst any values outside the closing brackets on the right (i.e. Athens, OH) are the default values for these fields when a user is created. <br><br>
94
        <div class="infoDiv"> <b>Note:</b> The columns on the left (above) are columns existing in the LDAP server, the values in the middle are columns existing in the Koha database. Whilst any values outside the closing brackets on the right (i.e. Athens, OH) are the default values for these fields when a user is created. <br><br>
95
        Where a LDAP column does not have a equivalent Koha column it is recommended you write in "1" for the Koha column value, although this is totally arbitrary.</div><br>
95
        Where a LDAP column does not have a equivalent Koha column it is recommended you write in "1" for the Koha column value, although this is totally arbitrary.</div><br>
96
        <h3> Example LDAP configurations </h3>
96
        <h3> Example LDAP configurations </h3>
97
        <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><!-- see C4::Auth_with_ldap for extra configs you must add if you want to turn this on -->
97
        <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i>&lt;!-- see C4::Auth_with_ldap for extra configs you must add if you want to turn this on --&gt;<br>
98
        <i>&lt;ldapserver id="ldapserver" listenref="ldapserver"&gt;</i><br>
98
        <i>&lt;ldapserver id="ldapserver" listenref="ldapserver"&gt;</i><br>
99
           <i>&lt;hostname&gt;ldaps://ldap.example.co.nz.au&lt;/hostname&gt;</i><br>
99
        <i>&lt;hostname&gt;ldaps://ldap.example.co.nz.au&lt;/hostname&gt;</i><br>
100
           <i>&lt;base&gt;ou=employees,dc=compnaya,dc=com,dc=au&lt;/base&gt;</i><br>
100
        <i>&lt;base&gt;ou=employees,dc=compnaya,dc=com,dc=au&lt;/base&gt;</i><br>
101
           <i>&lt;user&gt;&lt;/user&gt;</i><br> <!-- DN, if not anonymous -->
101
        <i>&lt;user&gt;&lt;/user&gt;</i><br>
102
           <i>&lt;pass&gt;&lt;/pass&gt;</i><br> <!-- password, if not anonymous -->
102
        <i>&lt;pass&gt;&lt;/pass&gt;</i><br>
103
           <i>&lt;auth_by_bind&gt;1&lt;/auth_by_bind&gt;</i><br>
103
        <i>&lt;auth_by_bind&gt;1&lt;/auth_by_bind&gt;</i><br>
104
           <i>&lt;replicate&gt;1&lt;/replicate&gt;</i><br> <!-- add new users from LDAP to Koha database -->
104
        <i>&lt;replicate&gt;1&lt;/replicate&gt;</i> &lt;!-- add new users from LDAP to Koha database --&gt;<br>
105
           <i>&lt;update&gt;0&lt;/update&gt;</i><br> <!-- update existing users in Koha database -->
105
        <i>&lt;update&gt;0&lt;/update&gt;</i> &lt;!-- update existing users in Koha database --&gt;<br>
106
           <i>&lt;principal_name&gt;ou=employees,dc=companya,dc=com,dc=au&lt;/principal_name&gt; </i><br>
106
        <i>&lt;principal_name&gt;ou=employees,dc=companya,dc=com,dc=au&lt;/principal_name&gt; </i><br>
107
           <i>&lt;mapping&gt;</i><br>
107
        <i>&lt;mapping&gt;</i><br>
108
            <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
108
        <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
109
            <i>&lt;cardnumber   is="uid"            &gt;&lt;/cardnumber&gt;</i><br>
109
        <i>&lt;cardnumber   is="uid"            &gt;&lt;/cardnumber&gt;</i><br>
110
            <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
110
        <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
111
            <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
111
        <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
112
            <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
112
        <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
113
            <i>&lt;categorycode is="1"&gt;EM&lt;/categorycode&gt;</i><br>
113
        <i>&lt;categorycode is="1"&gt;EM&lt;/categorycode&gt;</i><br>
114
            <i>&lt;branchcode   is="1"&gt;SYD&lt;/branchcode&gt;</i><br>
114
        <i>&lt;branchcode   is="1"&gt;SYD&lt;/branchcode&gt;</i><br>
115
           <i>&lt;/mapping&gt;</i><br>
115
        <i>&lt;/mapping&gt;</i><br>
116
         <i>&lt;/ldapserver&gt;</i><br>
116
        <i>&lt;/ldapserver&gt;</i><br>
117
117
118
        <h2> Learn more about LDAP configurations at:<br>
118
        <h2> Learn more about LDAP configurations at:<br>
119
        <b><a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="blank">LDAP documentation</a></b></h2>
119
        <b><a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="blank">LDAP documentation</a></b></h2>
120
120
    </ol>
121
        <h1> Setting up SIP with Koha</h1>
121
122
        If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:<br><br>
122
    <h1> Setting up SIP with Koha</h1>
123
        <b>1. In your Linux terminal write in:</b><br>
123
    If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:<br><br>
124
        <i>sudo koha-enable-sip &lt;instancename&gt;</i><br><br>
124
    <b>1. In your Linux terminal write in:</b><br>
125
        <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
125
    <i>sudo koha-enable-sip &lt;instancename&gt;</i><br><br>
126
        In your Koha home directory write in:<br>
126
    <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
127
        <i> cd /etc/koha/sites/&lt;instancename&gt;</i><br><br>
127
    In your Koha home directory write in:<br>
128
        <b>3. Edit your SIPconfig.xml file</b><br>
128
    <i> cd /etc/koha/sites/&lt;instancename&gt;</i><br><br>
129
        <i>sudo vi SIPconfig.xml</i><br><br>
129
    <b>3. Edit your SIPconfig.xml file</b><br>
130
        <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>
130
    <i>sudo vi SIPconfig.xml</i><br><br>
131
        <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>
131
    <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>
132
        <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>
132
    <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>
133
        <b>4. In your Linux terminal start SIP by writing in:</b><br>
133
    <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>
134
        <i>sudo koha-start-sip &lt;instancename&gt;</i><br><br>
134
    <b>4. In your Linux terminal start SIP by writing in:</b><br>
135
        <h2> Learn how to test SIP at:
135
    <i>sudo koha-start-sip &lt;instancename&gt;</i><br><br>
136
        <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="blank"> Evergreen SIP support</a></h2><br>
136
    <h2> Learn how to test SIP at:
137
        <h2> Important security notice about using SIP </h2>
137
    <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="blank"> Evergreen SIP support</a></h2><br>
138
        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.
138
    <h2> Important security notice about using SIP </h2>
139
    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.
139
140
140
[% ELSIF (op == "learnservice") && (LDAP == "LDAP")  %]
141
[% ELSIF (op == "learnservice") && (LDAP == "LDAP")  %]
141
        <h1> Setting up LDAP with Koha</h1>
142
    <h1> Setting up LDAP with Koha</h1>
142
        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>
143
    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>
143
        LDAP can be used to log into both the Koha staff interface and OPAC.<br><br>
144
    LDAP can be used to log into both the Koha staff interface and OPAC.<br><br>
144
        Follow these steps to set up LDAP with Koha:<br><br>
145
    Follow these steps to set up LDAP with Koha:<br><br>
145
        <ol>
146
    <ol>
146
            <li>In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:</li>
147
       <li>In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:</li>
147
            <ul>
148
       <ul>
148
                <li> /etc/koha/sites/&lt;instance-name&gt;/koha-conf.xml<br></li>
149
            <li> /etc/koha/sites/&lt;instance-name&gt;/koha-conf.xml<br></li>
149
                <li> /etc/koha/koha-conf.xml<br></li>
150
            <li> /etc/koha/koha-conf.xml<br></li>
150
            </ul>
151
       </ul>
151
            <i> cd /etc/koha/sites/kohadev/</i><br><br>
152
       <i> cd /etc/koha/sites/kohadev/</i><br><br>
152
            <li>Open the koha-conf.xml file as root</li>
153
       <li>Open the koha-conf.xml file as root</li>
153
            <i> sudo vi koha-conf.xml</i><br><br>
154
       <i> sudo vi koha-conf.xml</i><br><br>
154
            <li>3. Scroll down to the line "&lt;useldapserver&gt;0&lt;/useldapserver&gt;" and change it to:</li><br>
155
       <li>Scroll down to the line "&lt;useldapserver&gt;0&lt;/useldapserver&gt;" and change it to:</li><br>
155
            <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
156
       <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><br>
156
            <li>4. Write in the following information:</li><br>
157
       <li>Write in the following information:</li><br>
157
            <i>&lt;ldapserver id="&lt;ldapservername&gt;"&gt;</i><br>
158
       <i>&lt;ldapserver id="&lt;ldapservername&gt;"&gt;</i><br>
158
            <i>&lt;hostname&gt;&lt;hostname&gt;&lt;/hostname&gt;</i><br>
159
       <i>&lt;hostname&gt;&lt;hostname&gt;&lt;/hostname&gt;</i><br>
159
            <i>&lt;base&gt;dc=&lt;domaincontroller&gt;,dc=&lt;domaincontroller&gt;&lt;/base&gt;</i><br>
160
       <i>&lt;base&gt;dc=&lt;domaincontroller&gt;,dc=&lt;domaincontroller&gt;&lt;/base&gt;</i><br>
160
            <i>&lt;user&gt;cn=&lt;username&gt;,dc=&lt;domaincontroller&gt;,dc=&lt;domaincontroller&gt;&lt;/user&gt;</i><br>
161
       <i>&lt;user&gt;cn=&lt;username&gt;,dc=&lt;domaincontroller&gt;,dc=&lt;domaincontroller&gt;&lt;/user&gt;</i><br>
161
            <i>&lt;pass&gt;&lt;password&gt;&lt;/pass&gt;</i><br>
162
       <i>&lt;pass&gt;&lt;password&gt;&lt;/pass&gt;</i><br>
162
            <i>&lt;replicate&gt;&lt;either0or1&gt;&lt;/replicate&gt;</i><br>
163
       <i>&lt;replicate&gt;&lt;either0or1&gt;&lt;/replicate&gt;</i><br>
163
            <i>&lt;update&gt;&lt;either0or1&gt;&lt;/update&gt;</i><br>
164
       <i>&lt;update&gt;&lt;either0or1&gt;&lt;/update&gt;</i><br>
164
            <i>&lt;auth_by_bind&gt;&lt;either0or1&gt;&lt;/auth_by_bind&gt;</i><br>
165
       <i>&lt;auth_by_bind&gt;&lt;either0or1&gt;&lt;/auth_by_bind&gt;</i><br>
165
            <i>&lt;anonymous_bind&gt;&lt;either0or1&gt;&lt;/anonymous_bind&gt;</i><br>
166
       <i>&lt;anonymous_bind&gt;&lt;either0or1&gt;&lt;/anonymous_bind&gt;</i><br>
166
            <i>&lt;principal_name&gt;&lt;princiapname&gt;&lt;/principal_name&gt;</i><br>
167
       <i>&lt;principal_name&gt;&lt;princiapname&gt;&lt;/principal_name&gt;</i><br>
167
            <i>&lt;update_password&gt;&lt;either0or1&gt;&lt;/update_password&gt;</i><br><br>
168
       <i>&lt;update_password&gt;&lt;either0or1&gt;&lt;/update_password&gt;</i><br><br>
168
169
169
            <div class="infoDiv"><b>Note:</b> The values in these fields will need to be changed to the appropriate value for your organi    sation.Hostname can be either an alphanumeric string or an IP address. If the hostname is an IP address then you can choose to explicitly specify the port number or you can leave it as the default. </div><br>
170
       <div class="infoDiv"><b>Note:</b> The values in these fields will need to be changed to the appropriate value for your organisation.Hostname can be either an alphanumeric string or an IP address. If the hostname is an IP address then you can choose to explicitly specify the port number or you can leave it as the default. </div><br>
170
            <li>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.</li><br>
171
       <li>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.</li><br>
171
            e.g. the database column firstname is matched with the LDAP element givename<br>
172
       e.g. the database column firstname is matched with the LDAP element givename<br>
172
            <i>&lt;mapping&gt;</i><br>
173
       <i>&lt;mapping&gt;</i><br>
173
            <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
174
       <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
174
            <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
175
       <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
175
            <i>&lt;address      is="postaladdress"  &gt;&lt;/address&gt;</i><br>
176
       <i>&lt;address      is="postaladdress"  &gt;&lt;/address&gt;</i><br>
176
            <i>&lt;city         is="l"              &gt;Athens, OH&lt;/city&gt;</i><br>
177
       <i>&lt;city         is="l"              &gt;Athens, OH&lt;/city&gt;</i>&lt;!--All users by default will have the city va    lue of Athens, OH--&gt;<br>
177
            <i>&lt;zipcode      is="postalcode"     &gt;&lt;/zipcode&gt;</i><br>
178
       <i>&lt;zipcode      is="postalcode"     &gt;&lt;/zipcode&gt;</i><br>
178
            <i>&lt;branchcode   is="branch"         &gt;MAIN&lt;/branchcode&gt;</i><br>
179
       <i>&lt;branchcode   is="branch"         &gt;MAIN&lt;/branchcode&gt;</i><br>
179
            <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
180
       <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
180
            <i>&lt;password     is="userpassword"   &gt;&lt;/password&gt;</i><br>
181
       <i>&lt;password     is="userpassword"   &gt;&lt;/password&gt;</i><br>
181
            <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
182
       <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
182
            <i>&lt;categorycode is="employeetype"   &gt;PT&lt;/categorycode&gt;</i><br>
183
       <i>&lt;categorycode is="employeetype"   &gt;PT&lt;/categorycode&gt;</i><br>
183
            <i>&lt;phone        is="telephonenumber"&gt;&lt;/phone&gt;</i><br>
184
       <i>&lt;phone        is="telephonenumber"&gt;&lt;/phone&gt;</i><br>
184
            <i>&lt;/mapping&gt;</i><br>
185
       <i>&lt;/mapping&gt;</i><br>
185
            <i>&lt;ldapserver&gt;</i><br>
186
       <i>&lt;ldapserver&gt;</i><br><br>
186
187
187
            <div class="infoDiv"> <b>Note:</b> The columns on the left (above) are columns existing in the LDAP server, the values in the     middle are columns existing in the Koha database. Whilst any values outside the closing brackets on the right (i.e. Athens, OH) are the default values for these fields when a user is created. <br><br>
188
       <div class="infoDiv"> <b>Note:</b> The columns on the left (above) are columns existing in the LDAP server, the values in the     middle are columns existing in the Koha database. Whilst any values outside the closing brackets on the right (i.e. Athens, OH) are the default values for these fields when a user is created. <br><br>
188
            Where a LDAP column does not have a equivalent Koha column it is recommended you write in "1" for the Koha column value, although this is totally arbitrary.</div><br>
189
       Where a LDAP column does not have a equivalent Koha column it is recommended you write in "1" for the Koha column value, although this is totally arbitrary.</div><br>
189
190
190
            <h3> Example LDAP configurations </h3>
191
       <h3> Example LDAP configurations </h3>
191
            <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i><br><!-- see C4::Auth_with_ldap for extra configs you must add if you want     to turn this on -->
192
       <i>&lt;useldapserver&gt;1&lt;/useldapserver&gt;</i>&lt;see C4::Auth_with_ldap for extra configs you must add if you want     to turn this on --&gt;<br>
192
            <i>&lt;ldapserver id="ldapserver" listenref="ldapserver"&gt;</i><br>
193
       <i>&lt;ldapserver id="ldapserver" listenref="ldapserver"&gt;</i><br>
193
            <i>&lt;hostname&gt;ldaps://ldap.example.co.nz.au&lt;/hostname&gt;</i><br>
194
       <i>&lt;hostname&gt;ldaps://ldap.example.co.nz.au&lt;/hostname&gt;</i><br>
194
            <i>&lt;base&gt;ou=employees,dc=compnaya,dc=com,dc=au&lt;/base&gt;</i><br>
195
       <i>&lt;base&gt;ou=employees,dc=compnaya,dc=com,dc=au&lt;/base&gt;</i><br>
195
            <i>&lt;user&gt;&lt;/user&gt;</i><br> <!-- DN, if not anonymous -->
196
       <i>&lt;user&gt;&lt;/user&gt;</i><br>
196
            <i>&lt;pass&gt;&lt;/pass&gt;</i><br> <!-- password, if not anonymous -->
197
       <i>&lt;pass&gt;&lt;/pass&gt;</i><br>
197
            <i>&lt;auth_by_bind&gt;1&lt;/auth_by_bind&gt;</i><br>
198
       <i>&lt;auth_by_bind&gt;1&lt;/auth_by_bind&gt;</i><br>
198
            <i>&lt;replicate&gt;1&lt;/replicate&gt;</i><br> <!-- add new users from LDAP to Koha database -->
199
       <i>&lt;replicate&gt;1&lt;/replicate&gt;</i> &lt;!-- add new users from LDAP to Koha database --&gt;<br>
199
            <i>&lt;update&gt;0&lt;/update&gt;</i><br> <!-- update existing users in Koha database -->
200
       <i>&lt;update&gt;0&lt;/update&gt;</i> &lt;!-- update existing users in Koha database --&gt;<br>
200
            <i>&lt;principal_name&gt;ou=employees,dc=companya,dc=com,dc=au&lt;/principal_name&gt; </i><br>
201
       <i>&lt;principal_name&gt;ou=employees,dc=companya,dc=com,dc=au&lt;/principal_name&gt; </i><br>
201
            <i>&lt;mapping&gt;</i><br>
202
       <i>&lt;mapping&gt;</i><br>
202
            <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
203
       <i>&lt;userid       is="uid"            &gt;&lt;/userid&gt;</i><br>
203
            <i>&lt;cardnumber   is="uid"            &gt;&lt;/cardnumber&gt;</i><br>
204
       <i>&lt;cardnumber   is="uid"            &gt;&lt;/cardnumber&gt;</i><br>
204
            <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
205
       <i>&lt;email        is="mail"           &gt;&lt;/email&gt;</i><br>
205
            <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
206
       <i>&lt;surname      is="sn"             &gt;&lt;/surname&gt;</i><br>
206
            <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
207
       <i>&lt;firstname    is="givenname"      &gt;&lt;/firstname&gt;</i><br>
207
            <i>&lt;categorycode is="1"&gt;EM&lt;/categorycode&gt;</i><br>
208
       <i>&lt;categorycode is="1"&gt;EM&lt;/categorycode&gt;</i><br>
208
            <i>&lt;branchcode   is="1"&gt;SYD&lt;/branchcode&gt;</i><br>
209
       <i>&lt;branchcode   is="1"&gt;SYD&lt;/branchcode&gt;</i><br>
209
            <i>&lt;/mapping&gt;</i><br>
210
       <i>&lt;/mapping&gt;</i><br>
210
            <i>&lt;/ldapserver&gt;</i><br>
211
       <i>&lt;/ldapserver&gt;</i><br>
211
212
212
        </ol>
213
       </ol>
213
        <h2> Learn more about LDAP configurations at:<br>
214
       <h2> Learn more about LDAP configurations at:<br>
214
        <b><a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="_blank">LDAP documentation</a></b></h2>
215
       <b><a href="https://perldoc.koha-community.org/C4/Auth_with_ldap.html" target="_blank">LDAP documentation</a></b></h2>
215
216
216
[% ELSIF (op == "learnservice") && (SIP == "SIP")  %]
217
[% ELSIF (op == "learnservice") && (SIP == "SIP")  %]
217
        <h1> Setting up SIP2 with Koha</h1>
218
       <h1> Setting up SIP2 with Koha</h1>
218
        If you installed Koha using debain packages then setting up SIP2 is easy, simply follow these steps:<br><br>
219
       If you installed Koha using debain packages then setting up SIP2 is easy, simply follow these steps:<br><br>
219
        <b>1. In your Linux terminal write in:</b><br>
220
       <b>1. In your Linux terminal write in:</b><br>
220
        <i>sudo koha-enable-sip &lt;instancename&gt;</i><br><br>
221
       <i>sudo koha-enable-sip &lt;instancename&gt;</i><br><br>
221
        <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
222
       <b> 2. Navigate to the directory containing SIPConfig.xml</b><br>
222
        In your Koha home directory write in:<br>
223
       In your Koha home directory write in:<br>
223
        <i> cd /etc/koha/sites/&lt;instancename&gt;</i><br><br>
224
       <i> cd /etc/koha/sites/&lt;instancename&gt;</i><br><br>
224
        <b>3. Edit your SIPconfig.xml file</b><br>
225
       <b>3. Edit your SIPconfig.xml file</b><br>
225
        <i>sudo vi SIPconfig.xml</i><br><br>
226
       <i>sudo vi SIPconfig.xml</i><br><br>
226
        <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>
227
       <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>
227
        <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>
228
       <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>
228
        <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>
229
       <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>
229
        <b>4. In your Linux terminal start SIP2 by writing in:</b><br>
230
       <b>4. In your Linux terminal start SIP2 by writing in:</b><br>
230
        <i>sudo koha-start-sip &lt;instancename&gt;</i><br><br>
231
       <i>sudo koha-start-sip &lt;instancename&gt;</i><br><br>
231
        <h2> Learn how to test SIP at:
232
       <h2> Learn how to test SIP at:
232
        <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="_blank"> Evergreen SIP support</a></h2><br><br>
233
       <a href="https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:sip_support#patron_information" target="_blank"> Evergreen SIP support</a></h2><br><br>
233
        <h2> Important security notice about using SIP2 </h2>
234
       <h2> Important security notice about using SIP2 </h2>
234
        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.
235
       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.
235
[% END %]
236
[% END %]
236
237
237
[% IF (existingztargets == 0) %]
238
[% IF (existingztargets == 0) %]
238
- 

Return to bug 17956