Introduction to the Koha installation process

This is the Koha installation manual.

The Koha installation process uses 2 tools:

  • Installeur Web

  • Outil d’intégration

Cette documentation décrira ces deux outils.

Qu’est-ce que l’installeur Web Koha ?

L’installeur Web installe les tables de base de données qui stockent toutes les données avec lesquelles vous travaillez dans Koha, par exemple les sites de bibliothèque, les adhérents et les exemplaires.

L’installeur Web débute avec un écran de connexion vous permettant d’entrer les informations d’identification du compte de l’administrateur de la base de données.

The installer will then create the tables and fill the tables with data. The next step in the process is to set up a few mandatory first use settings, via the onboarding tool.

What is the Koha onboarding tool?

L’outil d’intégration s’assure que vous ayez au moins une bibliothèque, une catégorie d’adhérent, un adhérent, un type de document et une règle de circulation avant que vous ne commenciez à utiliser Koha.

Si vous installez des jeux de données pour bibliothèque, catégorie d’adhérent, et/ou type de document alors les écrans pour les créer seront ignorés.

Vous aurez cependant toujours à créer un adhérent (pour vous connecter à l’interface professionnelle suite à l’installation via l’outil d’intégration) et une règle de circulation.

Installeur Web

Connexion au Web installeur

Web installer login

Cet écran de connexion est le premier écran qui apparaît lors de l’installation de Koha.

image1152

Connexion au Web installeur

  1. Nom de la version de Koha : Cela s’affichera quel que soit le numéro de version de Koha que vous installez.

  2. Identifiant  : C’est l’identifiant de l’administrateur de la base de données qui est koha_kohadev par défaut.

  3. Mot de passe  : C’est le mot de passe de l’administrateur de la base de données qui est password par défaut.

  4. Se connecter  : Sélectionnez ce bouton pour vous connecter.

Sélecteur de langue

Installer start screen

Ceci est le premier écran de l’installeur Web.

image1166

Écran de démarrage de l’installeur Web

  1. Menu déroulant du Sélecteur de langue  : Ceci spécifie la langue dans laquelle vous voulez que Koha soit.

Note

Installer d’autres langues potentiellement utilisées par l’installeur (DE ou FR, par exemple) permettra l’utilisation de ces langues par la suite.

  1. Cliquez sur le bouton Passer à l’étape suivante pour charger l’étape suivante de l’installeur Web.

Installer perl modules installed

Cet écran vous prévient que l’installeur a toutes les dépendances dont il a besoin, pour créer la base de données dans l’écran suivant.

image1167

Modules Perl installés

Cliquez sur le bouton Passer à l’étape suivante pour charger l’étape suivante du programme de l’installateur Web.

Paramètres de la base de données

Cet écran vous informe sur les paramètres de la base de données et vous demande de les confirmer en cliquant sur le bouton Passer à l’étape suivante.

Note

Pour la majorité des utilisateurs, ces paramètres devraient être corrects, sinon, contactez le support de votre prestataire.

image1168

Paramètres de la base de données

  1. Database settings: Check these database settings are correct.

  2. Cliquez sur le bouton Passer à l’étape suivante pour confirmer les paramètres de la base de données.


Connection established

Après avoir cliqué sur le bouton Suivant, la connexion à la base de données est confirmée :

image1169

Connexion à la base de données établie

  1. Message de connexion établie : Cela vous informe que la base de données a été correctement créée.

  2. Cliquez sur le bouton Passer à l’étape suivante pour charger l’étape suivante

Note

Si vous rencontrez des difficultés de connexion à la base de données, l’installeur ne se lancera pas. Vérifiez les informations de connexion dans votre fichier koha-conf.xml, et vérifiez que les autorisations et les informations d’identification sur la base de données elle-même sont correctes.

Prêt à remplir les tables avec des données

Cet écran vous informe que tout est configuré pour que vous puissiez créer les tables de la base de données dans l’écran suivant.

image1170

Tables de la base de données créées

Cliquez sur le bouton Passer à l’étape suivante pour charger l’étape suivante

Note

Cette étape peut prendre du temps. S’il vous plaît, soyez patient.

Tables de la base de données créées

image1171

Tables de la base de données créées

Cliquez sur le bouton Passer à l’étape suivante

Prêt pour les configurations de base

Cet écran permet d’installer les configurations de base nécessaires pour utiliser Koha.

image1172

Prêt pour les configurations de base

Cliquez sur le bouton Passer à l’étape suivante

Sélectionner le format MARC

Vous devez choisir votre format MARC (format dans lequel vous souhaitez que les données bibliographiques (catalogue) soient stockées dans la base de données) sur cet écran :

image1173

Sélectionner le format MARC

  1. Unimarc : Ceci est fréquemment utilisé dans les pays européens (à l’exception du Royaume-Uni) tels que l’Italie.

  2. MARC21 : Sélectionné par défaut, car il est plus couramment utilisé globalement que UNIMARC.

  3. Cliquez sur le bouton Passer à l’étape suivante pour confirmer votre choix

Configuration MARC21 et UNIMARC

Note

Dans l’écran précédent, vous avez choisi MARC21 ou UNIMARC comme votre format MARC. Cette page décrit les deux formats.

Configuration MARC21

image1174

Configuration MARC21

  1. Default MARC21 standard authority types: An authority type is a template of an authority record (stores the search fields used to search an institutions catalog for an item). This option will install sample authority types.

  2. Default MARC21 bibliographic framework: Following on from the MARC21 selection in the previous screen selecting this checkbox (and the Import button) will actually setup the MARC21 bibliographic framework as the desired MARC flavour.

  3. Règles de concordance sélectionnées pour les notices bibliographiques MARC21 : Les règles de concordance MARC21 sont utilisées pour trouver toutes les informations relatives aux notices bibliographiques spécifiques en utilisant la recherche sur les types d’autorité.

  4. “FA”, a “fast add” minimal MARC21 framework suitable for ILL, or on the fly cataloging: The FA MARC framework displays fewer fields, and allows for faster cataloguing on the fly. Select this checkbox to install this minimal framework.

  5. Exemples de grilles de catalogage MARC21 pour certains types de supports bibliographiques courants : Ceci installe le modèle que vous utiliserez pour créer des documents.

  6. Valeurs autorisées du système Koha par défaut : Ceci installe les valeurs autorisées obligatoires dont chaque installation Koha a besoin.

  7. Systèmes de classification par défaut et règles de remplissage : Ceci insérera plusieurs systèmes de classification communs aux bibliothèques telles que la classification décimale Dewey.

  8. Defines default message transports for email and SMS: This provides the option to the user of being able to change how the library contacts them. They can choose from the following: email address, printed message, SMS, or phone call. Notices will not work without these.

  9. Attributs adhérent : Ceci n’installe aucune donnée, et il doit être enlevé.

  10. Exemples de périodicités pour les abonnements : Pour les documents qui arrivent régulièrement et de manière prévisible (par exemple les magazines mensuels), l’installation en amont d’exemples de périodicités est utile car il vous permet de les sélectionner dès la création du document.

  11. Exemple de notifications : Insère des exemples de notifications dans la base de données, ainsi vous n’avez plus qu’à les personnaliser avant de les utiliser. Il peut être très long de les créer manuellement et cela risque de produire des erreurs.

  12. Defines default messages for the enhanced messaging configuration: The enhanced messaging configuration lets the user choose what messages they receive from the institution. Selecting this will insert sample message types for the due, predue, and advance notice message types.

  13. Defines default message transports for sending item due messages and advance notice messages through email and SMS: This inserts the SMS and email transport types. Mandatory if you want to send notices by email or SMS.

  14. Sample numbering patterns for subscriptions: This option will install sample numbering patterns, saving you having to manually insert them for magazines and other periodicals.

  15. Certaines valeurs autorisées basiques pour la localisation, le statut des exemplaires, etc. Vous pouvez les modifier n’importe quand après l’installation : Ceci installe les valeurs autorisées qui filtrent la saisie des utilisateurs afin de s’assurer que cela corresponde au critère spécifique avant que la bibliothèque ou les autres objets soient créés.

  16. CSV profiles: Using Koha you can export items. The CSV profile defines how you want to export the item(s). CSV/tab exports will not work without these.

  17. Valeurs codées conformes au statut Z39.71-2006 pour la réservation des exemplaires : Non requis pour utiliser Koha. Un statut de réservation dit à l’usager si la bibliothèque possède l’exemplaire et où il est localisé. En le sélectionnant, vous installez les valeurs codées des exemplaires dans les statuts de réservations.

  18. MARC code list for relators: Not required to use Koha. A relator is a person who was involved in the development of the item (e.g. author). Selecting this will insert sample relator records into the database.

  19. Some basic currencies with USA dollar as default for ACQ module: Install US dollar, Great British Pound, Canadian Dollar and Euro currencies. Set the US dollar as the default acquisition currency. Not installing these will mean that a currency will need to be defined before acquisitions can be used.

  20. Useful patron attribute types: Not required to use Koha. Patrons have a barcode which identifies them. By clicking this checkbox you are making sure that this patron barcode is displayed on the patron summary screen.

  21. Sample patron types and categories: Not required to use Koha. Selecting this will install sample patron categories into the database. This will mean the create patron category step in the onboarding tool is skipped.

  22. ** Exemple de données d’étiquette et de carte d’adhérent: ** Non requis pour utiliser Koha, mais recommandé pour la plupart des nouvelles installations. En sélectionnant cette option, vous installerez des exemples de données pour les étiquettes et les cartes d’adhérents, ce qui facilitera la création d’étiquettes et de cartes d’adhérents dans le futur.

  23. Exemple de jours fériés : dimanche, lundi, jour de l’an Non obligatoire. En cochant, les jours fériés (comme Noël) seront intégrés dans la base de données.

  24. A set of default item types: Not required for Koha. Selecting this will insert sample item type data into the database, meaning the create item type step in the onboarding tool will be skipped.

  25. Sample libraries: Not required for Koha. Selecting this will insert sample libraries into the database. Developers will often want this for demo or development purposes. Selecting this means the create library step in the onboarding tool will be skipped.

  26. ** Exemples de nouveaux documents: ** Non requis pour Koha. En sélectionnant cette option, vous insérerez des exemples de nouveaux documents dans la base de données qui seront affichés à l’OPAC (Online Public Access Catalog) et à l’interface professionnelle.

  27. ** Exemples d’adhérents: ** Non requis pour Koha. Les adhérents sont ceux qui utilisent le système de gestion de la bibliothèque Koha, par exemple: les lecteurs et le personnel de la bibliothèque. En sélectionnant cette option, vous insérez un certain nombre d’exemples d’adhérents dans la base de données. Les développeurs le veulent souvent à des fins de démonstration ou de développement.

  28. ** Exemples de citations : ** Non requis pour Koha. Les citations du jour peuvent être affichées aux lecteurs de la bibliothèque sur l’interface OPAC (Online Public Access Catalog). En sélectionnant cetteoption, vous installerez quelques exemples de citations liées à la bibliothèque

  29. Permet d’accéder aux serveurs pour chercher et télécharger des informations bibliographiques : Pas obligatoire mais recommandé pour la plupart des nouvelles installations. En cochant, Koha sera configuré pour permettre l’accès à une sélection de cibles Z39.50, qui permettront la recherche de serveurs de données MARC21 à importer dans l’instance Koha. Cela évite d’importer manuellement toutes les notices et peut accélérer notablement le processus.

  30. Cliquer sur le bouton Importer afin d’installer les données par défaut et celles qui ont été sélectionnées.

UNIMARC setup

There are only two data values in the UNIMARC advanced setup which are unique:

  • Authority structure for UNIMARC in English

  • Grille bibliographique par défaut en anglais

Note

Optional values are the same for both UNIMARC and MARC21, therefore their definition will not be repeated.

image1175

UNIMARC setup

  1. Authority structure for UNIMARC in English: Authority records store the search terms used to find items in the database. Unlike MARC21, when using UNIMARC the authority structure needs to be compatible with UNIMARC. Selecting this option makes it compatible.

  2. Default UNIMARC bibliographic framework in English: In the previous screen you clicked to use the UNIMARC flavour, now by selecting this option you are confirming you want to use that framework.

  3. Cliquez sur le bouton * Importer * pour installer les exemples de données

Données sélectionnées ajoutées

After you have clicked the Import button in either the MARC21 or UNIMARC setup screen this screen will appear. It shows you if the selected/default data values were successfully inserted into the database.

image1176

Données sélectionnées ajoutées

  1. Données optionnelles ajoutées : Les données optionnelles que vous avez éventuellement sélectionnées s’afficheront ici. Si vous n’avez rien sélectionné, cette fenêtre ne s’affichera pas.

  2. MySQL data added: These data values will always be installed and consequently displayed on this screen.

  3. Données obligatoires ajoutées : Même remarque que précédemment.

  4. ** Message d’installation: ** Indique si la base de données Koha a été créée avec succès afin que vous puissiez utiliser l’outil de configuration.

  5. Cliquez sur le bouton Configurer quelques-unes des options de base de Koha pour accéder à un écran de redirection, qui à son tour vous conduira à l’outil de configuration.

Redirige vers l’outil de configuration

Si vous attendez environ 10 secondes, cet écran devrait vous rediriger vers l’écran de démarrage de l’outil de configuration.

image1177

Redirige vers l’outil de configuration

Note

Si, après avoir attendu, vous n’êtes pas redirigé, sélectionnez le lien pointé par la flèche dans la capture d’écran ci-dessus.

Outil d’intégration

Créer un site

Le programme d’installation vous invitera à créer la première bibliothèque ou branche si les exemples de bibliothèques n’ont pas été installées.

Un site dans Koha est la représentation vituelle d’un lieu « physique ». Plus de sites peuvent être ajoutées plus tard en allant dans Administration -> Sites et groupes.

image1153

Créer un site

  1. ** Code du site : ** code composé de 10 lettres maximum.

  2. ** Nom: ** Nom officiel du site, tel qu’il est communément connu.

  3. Create more libraries: If more libraries are required, or changes need to be made to this freshly created library, go to Administration -> Libraries and groups

  4. Cliquez sur le bouton Valider pour créer un site.

Par exemple :

image1154

Créer un exemple de site

** Code de site : ** L’expression régulière qui filtre les entrées acceptables pour le code de site n’accepte que jusqu’à 10 lettres.

Créer une catégorie d’adhérent

Tous les adhérents dans Koha doivent avoir une catégorie. Les comptes individuels des adhérents peuvent partager des caractéristiques communes, telles que les règles de circulation, la fréquence des avis, les cessions autorisées, et bien plus encore. Koha nécessite au moins une catégorie d’adhérents afin d’ajouter des adhérents.

Une catégorie d’adhérent est requise :

  • Code catégorie

  • Description

  • Message de retard demandé

  • Type de catégorie

  • Défaut

  • Durée d’inscription : en mois ou jusqu’à une date précise

image1155

Créer une catégorie d’adhérent

  1. Library creation message: Indicates whether the library was created successfully.

  2. ** Code de la catégorie : ** code composé de 10 lettres maximum.

  3. ** Description: ** Phrase décrivant la catégorie d’adhérent.

  4. Overdue notice required dropdown button: Set by default to “no”. This specifies if you want the patron category to receive overdue notices.

  5. Category type: This makes the category created a staff member.

  6. Default privacy: Set by default to “default”. The Default privacy controls the amount of time that the reading history of the patron is stored for.

  7. Enrolment period - in months: This is the number of months that the patrons created from this patron category are enrolled for.

  8. Enrolment period - until date: Select a date from the interactive datepicker calendar icon which appears when you click on this input box. The date you choose will be the enrolment end date for patrons created from this patron category.

  9. Path to create patron category: More patron categories can be created or altered by going to Administration -> Patron categories.

  10. Click the Submit button to create the patron category.

Par exemple :

image1156

Créer un adhérent

A superlibrarian patron user is required to log into the Koha staff interface, once the onboarding process has been completed.

Note

It is very important to document the username and password created here as they are the account credentials required to login as an administrator (superlibrarian) of Koha.

You will need to input/select:

  • Nom de famille

  • First name

  • Numéro de carte

  • Site

  • Catégorie adhérent

  • Nom d’utilisateur

  • Mot de passe

    image1157

    Créer un adhérent

  1. Message création catégorie d’adhérents : Indique si la catégorie d’adhérents a bien été créée.

  2. Nom : Nom, ou quelque chose de descriptif

  3. Prénom : Prénom, ou quelque chose de descriptif

  4. Card number: This number must be unique

  5. Library dropdown box: If a library has been created using this onboarding tool, it will be the only option. Otherwise select a random library from the sample libraries installed by the web installer.

  6. Patron category dropdown box: If a patron category was created using this onboarding tool, it will be the only option. Otherwise select the Staff patron category.

  7. Superlibrarian permission: This non-editable setting allows access to all librarian and web based Koha administration tasks in the staff interface. This user is the most powerful user in any Koha, so protect the credentials well.

  8. Identifiant : L’identifiant pour se connecter à l’interface professionnelle et à l’opac.

  9. Mot de passe: Un mot de passe est constitué de lettres, de chiffres et d’espaces et doit compter plus de 8 caractères.

  10. Confirmez le mot de passe : Répétez le mot de passe.

  11. Cliquer sur « Soumettre » pour créer le compte utilisateur.

  12. Path to create patron: Patron’s can be created or altered by going to Patrons -> New patron

  13. Assign patron permissions: After creating a patron go More -> Set permissions to assign permissions.

Par exemple :

image1158

Créer un exemple d’adhérent

Create an item type

Cette page s’affichera si vous n’avez pas intégré le lot de types d’exemplaires dans l’installeur web.

As with the patron category the item type is basically a template which you use to make multiple items with common characteristics.

Vous devez saisir :

  • Code du type de document

  • Description

    image1159

    Créer un type de document

  1. Message de création de compte administrateur : Indique si le compte administrateur a bien été créé.

  2. Item type code: Code consisting of up to 10 letters

  3. Description : Description du type d’exemplaire.

  4. Path to create item type: Item types can be created or altered by going to Administrator->Item types

  5. Cliquez sur Soumettre pour créer le type d’exemplaire.

Par exemple :

image1160

Crée un exemple de type d’exemplaire

Note

The regular expression filtering item type code input will only accept letters.

Create a circulation rule

This screen will always be displayed no matter what sample data you installed with the web installer.

Here you are creating a rule which applies the pre-defined organisational decisions of your library as to what restrictions you place on patrons borrowing items.

image1161

Create circulation rule

Note

Numbers are the only valid input for all input fields in this form.

  1. Message création de type d’exemplaire : Indique si le type d’exemplaire a bien été créé.

  2. Library branch dropdown box: This is the library (or libraries) you want to apply the circulation rule to. By default it is set to all, however you can select a singular library to apply the rule to from the dropdown box.

  3. Patron categories dropdown box: This is the patron categories you want to apply the circulation rule to. As with library branch it is set to all by default but more options are avaliable.

  4. Item type dropdown box: This is the item types that you want the circulation rule to apply to. Again more options are avaliable than the default selected all option.

  5. Current checkouts allowed: This is the number of items allowed from the selected library, for selected patron categories and of the selected item type. Set to 50 by default.

  6. Loan period: Number of days or hours that an item is allowed out for. Set to 14 by default.

  7. Units dropdown box: Set by default to aays, the unit selecting in this field is applied to the numerical values written into loan period and renewals period

  8. Renewals allowed: Number of times a item can be renewed. Set to 10 by default.

  9. Renewals period: Number of days or hours that a renewal lasts for. Set to 14 by default.

  10. On shelf holds allowed dropdown box: If items can be held whilst they are on the shelf.

  11. Path to create circulation rule: Circulation rules can be created or altered by going to Administration -> Circulation and fines rules

  12. Click the submit button to create the circulation rule.

Outil d’intégration complet

This page tells you if the circulation rule was created successfully, and that the Koha installation is complete

image1162

  1. Web installer message: Indicates if the web installation is complete

  2. Circulation rule creation message: Indicates if the circulation rule was created successfully.

  3. Start using Koha: Click to login to Koha using the Koha administrator account you created using the onboarding tool.

Login to access staff interface

You have now finished using the onboarding tool and can log into the staff interface using the patron account credentials you created in the onboarding tool

image1163

Écran de connexion

  1. Username: Enter the username you created for the patron

  2. Password: Enter the password you created

  3. Library: This is the library staff interface you want to log into. The options are either: my library or the library you installed/created. Leaving the default selected option of my library is fine to log in with first time.

  4. Click the login button to access the staff interface

Par exemple :

image1164

Login example

Staff interface

The staff interface should now appear

image1165

Staff interface

Voir aussi

Pour plus d’informations sur l’utilisation de l’interface professionnelle, aller sur https://koha-community.org/documentation/

Advanced configurations

VirtualHost overrides

Koha allows for the override of some system settings at a VirtualHost level.

OPAC_BRANCH_DEFAULT

The OPAC_BRANCH_DEFAULT directive can be used to specify the default branch for anonymous users of the OPAC.

SetEnv OPAC_BRANCH_DEFAULT "CPL"
RequestHeader add X-Koha-SetEnv "OPAC_BRANCH_DEFAULT CPL"

Note: This override affects which News and HTML Customisation blocks a user will see prior to logging in to the OPAC.