Maarch Framework 3/Guide de démarrage rapide/Installer le sample sous linux

De Maarch // Wiki.

Ce guide présente les étapes de configuration de l'application pour un serveur linux. Les différentes étapes sont données en ligne de commande, il est bien entendu possible de les réaliser graphiquement.

Ces étapes doivent se faire avec les droits de super utilisateur (root).

Ce guide présuppose que vous avez une installation fonctionnelle d'Apache, PHP et MySQL, et que les prérequis sont remplis. PHP doit avoir les options suivantes (fichier php.ini):

• error_reporting = E_ALL & ~E_NOTICE
• display_errors = on
• short_open_tag = On
• magic_quotes_gpc = off

Il suppose aussi que la racine du serveur web est /var/www. Si cela ne correspond pas à l'environnement de votre distribution, remplacez /var/www par le bon dossier dans les commandes qui suivent.

Téléchargement du package et installation

On va commencer par télécharger le package depuis sourceforge pour le placer dans le dossier /var/www :

wget http://downloads.sourceforge.net/maarch/MaarchFramework-3.0-sample.zip -O /var/www/MaarchFramework-3.0-sample.zip

Il faut ensuite dézipper l'archive et la renommer (l'url sera plus rapide à taper) :

unzip /var/www/MaarchFramework-3.0-sample.zip -d /var/www
mv /var/www/MaarchFramework-3.0-sample /var/www/maarch_v3

Création des dossiers nécessaires

On a besoin de créer 2 dossier : celui qui contiendra les docsevers (espace de stockage des documents enregistrés dans Maarch) et celui qui contiendra les index générés par Lucène pour la recherche plein texte.

On regroupera tout ça dans le dossier /var/maarch :

mkdir /var/maarch

Commençons par les docservers. Nous allons en créer 4 :

• un pour chaque collection documentaire (documents et factures)
• un second pour chaque collection qui recevra les fichiers injectés dans Maarch par avec l'Autoimport.

mkdir /var/maarch/docservers
mkdir /var/maarch/docservers/{documents,documents_ai,invoices,invoices_ai}

Les index Lucène seront stockés dans le dossier /var/maarch/indexes :

mkdir /var/maarch/indexes

Comme le serveur Apache devra écrire des fichiers dans ces dossiers. Nous allons devoir mettre l'utilisateur Apache comme propriétaire de ces dossiers, et n'autoriser que lui à acceder à ces dossiers. Selon les distributions de Linux, L'utilisateur Apache peut avoir plusieurs noms. Ici, nous prendrons www-data.

chown -R www-data:www-data /var/maarch
chmod -R 700 /var/maarch

Profitons-en pour modifier également les droits sur les différents dossiers temporaires qui sont définis dans l'application :

chown www-data:www-data /var/www/maarch_v3/{tmp,apps/maarch_sample/tmp,modules/physical_archives/tmp_print}
chmod 700 /var/www/maarch_v3/{tmp,apps/maarch_sample/tmp,modules/physical_archives/tmp_print}

Modification de la configuration de l'application

tous ces fichiers se trouvent dans le dossier /var/www/maarch_v3

fichier core/xml/config.xml

Modifiez les balises suivantes :

<CONFIG>
 ...
   <corepath>/var/www/maarch_v3/</corepath>
   <tmppath>/var/www/maarch_v3/tmp/</tmppath>
   <defaultpage>/var/www/maarch_v3/index.php</defaultpage>
   <!-- Dans les tags <coreurl>, vous pouvez renseigner l'URL par laquelle vous
        accèderez à l'application (ex: http://nommachine/maarch_v3/ -->
   <coreurl>http://127.0.0.1/maarch_v3/</coreurl>

fichier apps/maarch_sample/xml/config.xml

Modifiez les balises suivantes :

<CONFIG>
 ...
   <businessapppath>/var/www/maarch_v3/apps/maarch_sample/</businessapppath>
 
   <!-- vous pouvez renseigner l'URL par laquelle vous
        accèderez à l'application (ex: http://nommachine/maarch_v3/apps/maarch_sample/ -->
   <businessappurl>http://127.0.0.1/maarch_v3/apps/maarch_sample/</businessappurl>
 ...
   <!--ne modifiez ces balises que la configuration de
       votre serveur de base de donnée ne correspond pas à ça-->
   <databaseserverport>3306</databaseserverport>
   <databasetype>MYSQL</databasetype>
   <databaseuser>root</databaseuser>
   <databasepassword></databasepassword>
 ...
   <!-- vous pouvez renseigner l'URL par laquelle vous
        accèderez à l'application (ex: http://nommachine/maarch_v3/apps/maarch_sample/ -->
   <css>http://127.0.0.1/maarch_v3/apps/maarch_sample/css/styles.css</css>
 
   <css_ie>http://127.0.0.1/maarch_v3/apps/maarch_sample/css/style_ie.css</css_ie>
 
   <css_ie7>http://127.0.0.1/maarch_v3/apps/maarch_sample/css/style_ie7.css</css_ie7>
 ...
   <tmppath>/var/www/maarch_v3/apps/maarch_sample/tmp/</tmppath>
 ...
</CONFIG>
 ...
<COLLECTION>
   <id>coll_1</id>
 ...
   <path_to_lucene_index>/var/maarch/indexes/coll_1/</path_to_lucene_index>
</COLLECTION>
<COLLECTION>
   <id>coll_2</id>
 ...
   <path_to_lucene_index>/var/maarch/indexes/coll_2/</path_to_lucene_index>
</COLLECTION>

Fichier modules/autofoldering/xml/config.xml

Modifiez les balises suivantes :

<CONFIG>
 ...
   <!--ne modifiez ces balises que la configuration de
       votre serveur de base de donnée ne correspond pas à ça-->
   <databaseserver>127.0.0.1</databaseserver> 
   <databaseserverport>3306</databaseserverport>
   <databasename>maarch_v3</databasename>
   <databasetype>MYSQL</databasetype> 
   <databaseuser>root</databaseuser>
   <databasepassword></databasepassword
 ...
   <MaarchDirectory>/var/www/maarch_v3/</MaarchDirectory> 
 ...
</CONFIG>

Fichier modules/indexing_searching/xml/config.xml

Si vous accédez à l'application avec une adresse autre que http://127.0.0.1/maarch_v3, modifiez le tag suivant avec l'url voulue :

 ...
   <url>http://127.0.0.1/maarch_v3/modules/indexing_searching/index_file.php</url>
 ...

Configuration du module Full Text

Fichier modules/full_text/xml/config_documents.xml

Modifiez les balises suivantes :

<CONFIG>
   <BASE_DIRECTORY>/var/www/maarch_v3/modules/full_text/</BASE_DIRECTORY>
   <INDEX_FILE_DIRECTORY>/var maarch/indexes/coll_1/</INDEX_FILE_DIRECTORY>
 
   <!--ne modifiez ces balises que la configuration de
       votre serveur de base de donnée ne correspond pas à ça-->
   <LOCATION>localhost</LOCATION>
   <DATABASE_PORT>3306</DATABASE_PORT>
   <DATABASE>maarch_v3</DATABASE>
   <DATABASETYPE>MYSQL</DATABASETYPE>
   <USER_NAME>root</USER_NAME>
   <PASSWORD></PASSWORD>	
 ...
   <MAARCH_TOOLS_PATH>/var/www/maarch_v3/apps/maarch_sample/tools/</MAARCH_TOOLS_PATH>
 ...
</CONFIG>

Fichier modules/full_text/xml/config_invoices.xml

Modifiez les balises suivantes :

<CONFIG>
   <BASE_DIRECTORY>/var/www/maarch_v3/modules/full_text/</BASE_DIRECTORY>
   <INDEX_FILE_DIRECTORY>/var maarch/indexes/coll_2/</INDEX_FILE_DIRECTORY>
 
   <!--ne modifiez ces balises que la configuration de
       votre serveur de base de donnée ne correspond pas à ça-->
   <LOCATION>localhost</LOCATION>
   <DATABASE_PORT>3306</DATABASE_PORT>
   <DATABASE>maarch_v3</DATABASE>
   <DATABASETYPE>MYSQL</DATABASETYPE>
   <USER_NAME>root</USER_NAME>
   <PASSWORD></PASSWORD>	
 ...
   <MAARCH_TOOLS_PATH>/var/www/maarch_v3/apps/maarch_sample/tools/</MAARCH_TOOLS_PATH>
 ...
</CONFIG>

Fichier modules/physical_archives/xml/config.xml

Modifiez les balises suivantes :

<CONFIG>
 
 ...
   <path>/var/www/maarch_v3/modules/physical_archive/</path>
 ...

Création de la base de données

Les scripts de création de la base de donnée se trouvent à la racine de l'application, dans le dossier /var/www/maarch_v3.

Les étapes suivantes peuvent se faire graphiquement, par exemple avec phpmyadmin :

Avec PhpMyAdmin

Sous phpmyadmin (accessible via http://127.0.0.1/phpmyadmin), créez une nouvelle base de données nommée "maarch_v3".

N'oubliez pas de positionner l'interclassement à "utf8_unicode_ci" (le dernier de la liste).

Toujours sous phpmyadmin, allez dans la base maarch_v3 et cliquez sur l'onglet "Importer".

• Importez le fichier /var/www/maarch_v3/db_structure_v3.sql, ce qui a pour effet de créer toutes les tables Maarch.
• Importez le fichier /var/www/maarch_v3/db_values_v3.sql pour créer toutes les valeurs par défaut de sample.

En ligne de commande

Connectons nous au serveur mysql :

Si l'utilisateur défini ci-dessus n'a pas de mot de passe :

mysql -u UTILISATEUR

Sinon :

mysql -u UTILISATEUR -p

A l'invite de commande Mysql, entrez :

CREATE DATABASE maarch_v3;
USE maarch_v3;
SOURCE /var/www/maarch_v3/db_structure_v3.sql;
SOURCE /var/www/maarch_v3/db_values_v3.sql;

Mise en place de l'autofoldering et chargement des documents

Téléchargement et installation du package

On va commencer par télécharger le package depuis sourceforge  :

wget http://downloads.sourceforge.net/maarch/MaarchAutoImport-3.0.zip -O /opt/MaarchAutoImport-3.0.zip

Il faut ensuite dézipper l'archive (l'url sera plus rapide à taper) :

mkdir /opt/maarch unzip /opt/maarch/MaarchAutoImport-3.0.zip -d /opt/maarch mv /opt/maarch/MaarchAutoImport-3.0 /opt/maarch/autoimport

Modification de la configuration

On va commencer par se placer dans le dossier de l'AutoImport :

cd /opt/maarch/autoimport

Modifications du fichier maarch_autoimport/config_documents.xml

Modifiez les balises suivantes :

<CONFIG>
   <MAPPING_FILE>/opt/maarch/autoimport/maarch_autoimport/mapping_documents.xml</MAPPING_FILE>
   <MAPPING_ERROR_FILE>/opt/maarch/autoimport/maarch_autoimport/mapping_error_documents.xml</MAPPING_ERROR_FILE>
   <SCAN_IMPORT_DIRECTORY>/opt/maarch/autoimport/incoming/documents/</SCAN_IMPORT_DIRECTORY>
 
   <!--ne modifiez ces balises que la configuration de
       votre serveur de base de donnée ne correspond pas à ça-->
   <LOCATION>127.0.0.1</LOCATION>
   <DATABASE_PORT>3306</DATABASE_PORT>
   <DATABASE>maarch_v3</DATABASE>
   <DATABASETYPE>MYSQL</DATABASETYPE>
   <USER_NAME>root</USER_NAME>
   <PASSWORD></PASSWORD>	
 ...
   <AUTO_IMPORT_DIRECTORY>/opt/maarch/autoimport/</AUTO_IMPORT_DIRECTORY>
 ...

Modifications du fichier maarch_autoimport/config_invoices.xml

Modifiez les balises suivantes :

<CONFIG>
   <MAPPING_FILE>/opt/maarch/autoimport/maarch_autoimport/mapping_invoices.xml</MAPPING_FILE>
   <MAPPING_ERROR_FILE>/opt/maarch/autoimport/maarch_autoimport/mapping_error_invoices.xml</MAPPING_ERROR_FILE>
   <SCAN_IMPORT_DIRECTORY>/opt/maarch/autoimport/incoming/invoices/</SCAN_IMPORT_DIRECTORY>
 
   <!--ne modifiez ces balises que la configuration de
       votre serveur de base de donnée ne correspond pas à ça-->
   <LOCATION>127.0.0.1</LOCATION>
   <DATABASE_PORT>3306</DATABASE_PORT>
   <DATABASE>maarch_v3</DATABASE>
   <DATABASETYPE>MYSQL</DATABASETYPE>
   <USER_NAME>root</USER_NAME>
   <PASSWORD></PASSWORD>
 ...
   <AUTO_IMPORT_DIRECTORY>/opt/maarch/autoimport/</AUTO_IMPORT_DIRECTORY>
 ...

Exécution de l'application

Les documents d'exemple se trouvent dans le dossier samples. Maarch AutoImport va récupérer, pour chaque collection, les fichiers présents dans le dossier incoming pour les enregistrer dans la GED.

On va commencer par y déposer les fichers exemples:

cp -R samples/{documents,invoices} incoming/

Exécutons ensuite les scripts pour injecter les fichiers :

php maarch_autoimport/maarch_auto_import.php  maarch_autoimport/config_documents.xml
php maarch_autoimport/maarch_auto_import.php  maarch_autoimport/config_invoices.xml

Continuer la visite guidée

Vous pouvez maintenant continuer à suivre le guide de démarrage rapide pour avoir un Tour d'horizon rapide des fonctionnalités de Maarch Framework.

Désinstallation

Si vous désirez supprimer ces deux applications, vous devrez supprimer 3 dossiers :

• /var/maarch
• /var/www/maarch_v3
• /opt/maarch

rm -rf /var/maarch /var/www/maarch_v3 /opt/maarch