From a1855aa32eba71d8a36cc785ac9bc700fb455dda Mon Sep 17 00:00:00 2001 From: Alex Buckley Date: Wed, 8 Feb 2017 14:48:58 +1300 Subject: [PATCH] Bug 17956 - Fixed the indentation of onboardingstep6.tt. Ensured SIP2 was written in the joint SIP and LDAP information screen --- .../prog/en/modules/onboarding/onboardingstep6.tt | 277 +++++++++++---------- 1 file changed, 139 insertions(+), 138 deletions(-) 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 9d28bf1..e617b37 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt @@ -50,17 +50,17 @@

Steps to setup Koha with LDAP

    -
  1. 1. In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:

  2. +
  3. In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:

  4. e.g. cd /etc/koha/sites/kohadev/

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

  6. sudo vi koha-conf.xml

    - 3. Scroll down to the line containing "<useldapserver>0</useldapserver>" and change it to:
    +
  7. Scroll down to the line containing "<useldapserver>0</useldapserver>" and change it to:

  8. <useldapserver>1</useldapserver>

    - 4. Write in the following information:
    +
  9. Write in the following information:

  10. <ldapserver id="<ldapservername>">
    <hostname><hostname></hostname>
    <base>dc=<domaincontroller>,dc=<domaincontroller></base>
    @@ -72,16 +72,16 @@ <anonymous_bind><either0or1></anonymous_bind>
    <principal_name><principalname></principal_name>
    <update_password><either0or1></update_password>

    -
    Note: The values in these fields will need to be changed to the appropriate value for your organisation. +
    Note: The values in these fields (above) 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.

    - 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
    +
  11. 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.

  12. + 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>
    + <city is="l" >Athens, OH</city> <!--All users by default will have the city value of Athens, OH-->
    <zipcode is="postalcode" ></zipcode>
    <branchcode is="branch" >MAIN</branchcode>
    <userid is="uid" ></userid>
    @@ -94,144 +94,145 @@
    Note: 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.

    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.

    Example LDAP configurations

    - <useldapserver>1</useldapserver>
    + <useldapserver>1</useldapserver><!-- see C4::Auth_with_ldap for extra configs you must add if you want to turn this on -->
    <ldapserver id="ldapserver" listenref="ldapserver">
    - <hostname>ldaps://ldap.example.co.nz.au</hostname>
    - <base>ou=employees,dc=compnaya,dc=com,dc=au</base>
    - <user></user>
    - <pass></pass>
    - <auth_by_bind>1</auth_by_bind>
    - <replicate>1</replicate>
    - <update>0</update>
    - <principal_name>ou=employees,dc=companya,dc=com,dc=au</principal_name>
    - <mapping>
    - <userid is="uid" ></userid>
    - <cardnumber is="uid" ></cardnumber>
    - <email is="mail" ></email>
    - <surname is="sn" ></surname>
    - <firstname is="givenname" ></firstname>
    - <categorycode is="1">EM</categorycode>
    - <branchcode is="1">SYD</branchcode>
    - </mapping>
    - </ldapserver>
    + <hostname>ldaps://ldap.example.co.nz.au</hostname>
    + <base>ou=employees,dc=compnaya,dc=com,dc=au</base>
    + <user></user>
    + <pass></pass>
    + <auth_by_bind>1</auth_by_bind>
    + <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
    + <update>0</update> <!-- update existing users in Koha database -->
    + <principal_name>ou=employees,dc=companya,dc=com,dc=au</principal_name>
    + <mapping>
    + <userid is="uid" ></userid>
    + <cardnumber is="uid" ></cardnumber>
    + <email is="mail" ></email>
    + <surname is="sn" ></surname>
    + <firstname is="givenname" ></firstname>
    + <categorycode is="1">EM</categorycode>
    + <branchcode is="1">SYD</branchcode>
    + </mapping>
    + </ldapserver>

    Learn more about LDAP configurations at:
    LDAP documentation

    - -

    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 write in:
    - sudo koha-enable-sip <instancename>

    - 2. Navigate to the directory containing SIPConfig.xml
    - In your Koha home directory write in:
    - cd /etc/koha/sites/<instancename>

    - 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 <instancename>

    -

    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. +
+ +

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 write in:
+ sudo koha-enable-sip <instancename>

+ 2. Navigate to the directory containing SIPConfig.xml
+ In your Koha home directory write in:
+ cd /etc/koha/sites/<instancename>

+ 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 <instancename>

+

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. [% ELSIF (op == "learnservice") && (LDAP == "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.

- Follow these steps to set up LDAP with Koha:

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

    -
  3. Open the koha-conf.xml file as root
  4. - sudo vi koha-conf.xml

    -
  5. 3. Scroll down to the line "<useldapserver>0</useldapserver>" and change it to:

  6. - <useldapserver>1</useldapserver>

    -
  7. 4. Write in the following information:

  8. - <ldapserver id="<ldapservername>">
    - <hostname><hostname></hostname>
    - <base>dc=<domaincontroller>,dc=<domaincontroller></base>
    - <user>cn=<username>,dc=<domaincontroller>,dc=<domaincontroller></user>
    - <pass><password></pass>
    - <replicate><either0or1></replicate>
    - <update><either0or1></update>
    - <auth_by_bind><either0or1></auth_by_bind>
    - <anonymous_bind><either0or1></anonymous_bind>
    - <principal_name><princiapname></principal_name>
    - <update_password><either0or1></update_password>

    - -
    Note: 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.

    -
  9. 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.

  10. - 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>
    - <ldapserver>
    - -
    Note: 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.

    - 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.

    - -

    Example LDAP configurations

    - <useldapserver>1</useldapserver>
    - <ldapserver id="ldapserver" listenref="ldapserver">
    - <hostname>ldaps://ldap.example.co.nz.au</hostname>
    - <base>ou=employees,dc=compnaya,dc=com,dc=au</base>
    - <user></user>
    - <pass></pass>
    - <auth_by_bind>1</auth_by_bind>
    - <replicate>1</replicate>
    - <update>0</update>
    - <principal_name>ou=employees,dc=companya,dc=com,dc=au</principal_name>
    - <mapping>
    - <userid is="uid" ></userid>
    - <cardnumber is="uid" ></cardnumber>
    - <email is="mail" ></email>
    - <surname is="sn" ></surname>
    - <firstname is="givenname" ></firstname>
    - <categorycode is="1">EM</categorycode>
    - <branchcode is="1">SYD</branchcode>
    - </mapping>
    - </ldapserver>
    - -
-

Learn more about LDAP configurations at:
- LDAP documentation

+

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.

+ Follow these steps to set up LDAP with Koha:

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

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

    +
  5. Scroll down to the line "<useldapserver>0</useldapserver>" and change it to:

  6. + <useldapserver>1</useldapserver>

    +
  7. Write in the following information:

  8. + <ldapserver id="<ldapservername>">
    + <hostname><hostname></hostname>
    + <base>dc=<domaincontroller>,dc=<domaincontroller></base>
    + <user>cn=<username>,dc=<domaincontroller>,dc=<domaincontroller></user>
    + <pass><password></pass>
    + <replicate><either0or1></replicate>
    + <update><either0or1></update>
    + <auth_by_bind><either0or1></auth_by_bind>
    + <anonymous_bind><either0or1></anonymous_bind>
    + <principal_name><princiapname></principal_name>
    + <update_password><either0or1></update_password>

    + +
    Note: 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.

    +
  9. 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.

  10. + 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><!--All users by default will have the city va lue of Athens, OH-->
    + <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>
    + <ldapserver>

    + +
    Note: 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.

    + 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.

    + +

    Example LDAP configurations

    + <useldapserver>1</useldapserver><see C4::Auth_with_ldap for extra configs you must add if you want to turn this on -->
    + <ldapserver id="ldapserver" listenref="ldapserver">
    + <hostname>ldaps://ldap.example.co.nz.au</hostname>
    + <base>ou=employees,dc=compnaya,dc=com,dc=au</base>
    + <user></user>
    + <pass></pass>
    + <auth_by_bind>1</auth_by_bind>
    + <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
    + <update>0</update> <!-- update existing users in Koha database -->
    + <principal_name>ou=employees,dc=companya,dc=com,dc=au</principal_name>
    + <mapping>
    + <userid is="uid" ></userid>
    + <cardnumber is="uid" ></cardnumber>
    + <email is="mail" ></email>
    + <surname is="sn" ></surname>
    + <firstname is="givenname" ></firstname>
    + <categorycode is="1">EM</categorycode>
    + <branchcode is="1">SYD</branchcode>
    + </mapping>
    + </ldapserver>
    + +
+

Learn more about LDAP configurations at:
+ LDAP documentation

[% ELSIF (op == "learnservice") && (SIP == "SIP") %] -

Setting up SIP2 with Koha

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

- 1. In your Linux terminal write in:
- sudo koha-enable-sip <instancename>

- 2. Navigate to the directory containing SIPConfig.xml
- In your Koha home directory write in:
- cd /etc/koha/sites/<instancename>

- 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 SIP2 by writing in:
- sudo koha-start-sip <instancename>

-

Learn how to test SIP at: - Evergreen SIP support



-

Important security notice about using SIP2

- 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. +

Setting up SIP2 with Koha

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

+ 1. In your Linux terminal write in:
+ sudo koha-enable-sip <instancename>

+ 2. Navigate to the directory containing SIPConfig.xml
+ In your Koha home directory write in:
+ cd /etc/koha/sites/<instancename>

+ 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 SIP2 by writing in:
+ sudo koha-start-sip <instancename>

+

Learn how to test SIP at: + Evergreen SIP support



+

Important security notice about using SIP2

+ 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. [% END %] [% IF (existingztargets == 0) %] -- 2.1.4