PyPI 官网下载 | iparapheur-utils.beta-0.0.1.post55709.tar.gz

# Introduction C'est principalement une librairie écrite en Python permettant la communication avec le i-Parapheur en version 4.2+, au travers de l'API REST ou via webservice SOAP. Elle offre des commandes accessibles depuis un shell standard, pour faciliter certaines opérations d'exploitation. # Installation Sur une distribution Ubuntu 18.04 LTS : * une instance i-Parapheur accessible en v4.4.0 ou plus * un environnement Python fonctionnel ! * ajout de l'outil ` pip ` depuis un terminal BASH : ```bash sudo bash curl https://bootstrap.pypa.io/get-pip.py | python ``` * installation du paquet python `iparapheur-utils`, depuis un terminal BASH : ```bash sudo pip install iparapheur-utils ``` Support CentOS / RHEL : * Version 6 : Cette version n'est plus supportée, en cause une version de python trop ancienne (2.6) * Version 7 : Cette version requiert l'installation de paquets supplémentaires : `yum install libffi-devel gcc openssl-devel` # Usage Ces commandes sont actuellement disponibles : - [`ph-init`](#ph-init) - [`ph-check`](#ph-check) - [`ph-echo`](#ph-echo) - [`ph-recupArchives`](#ph-recuparchives) - [`ph-export`](#ph-export) - [`ph-import`](#ph-import) - [`ph-rename`](#ph-rename) - [`ph-removeldap`](#ph-removeldap) - [`ph-pushdoc`](#ph-pushdoc) - [`ph-ipclean`](#ph-ipclean) - [`ph-ldapsearch`](#ph-ldapsearch) > Remarques : Elles sont conçues pour être exécutées en environnement bash standard: ligne de commande, ou script BASH. Aucune qualification à ce stade pour l'usage de ces commandes dans un interpréteur Python. ## `ph-init` Cette commande permet la génération d'un fichier de configuration "par défaut", qu'il faut bien sûr adapter au serveur. Exemple d'utilisation : ```bash usage: ph-init [-h] [-p P] [-c {recuparchives,export,import}] Génère un fichier de configuration par défaut dans le répertoire courant Arguments: -h, --help Affiche ce message et quitte -p P Chemin du fichier de configuration -c {recuparchives,export,import} Commande pour laquelle générer le fichier de configuration ``` Le lancement de la commande génère un fichier `iparapheur-utils.cfg`, lu par défaut lors de l'appel des autres fonctions ## `ph-check` Lance le script de check d'installation. Pas de pré-requis particulier. ## `ph-echo` Lance la fonction `echo` vers le i-Parapheur désigné dans le fichier de configuration. Exemple d'utilisation : ```bash ph-echo -h --- usage: ph-echo [-h] [-s S] [-c C] [-u U] [-p P] Lance un echo via webservice sur un iParapheur Arguments: -h, --help Affiche ce message et quitte -s S URL du serveur iParapheur -c C Fichier de configuration -u U Utilisateur -p P Mot de passe ``` ## `ph-recupArchives` Lance la fonction de récupération ou/et de purge des archives. Il est vivement conseillé d'utiliser la commande `ph-init -c recuparchives` afin de générer un squelette de fichier de configuration complet. Exemple d'utilisation : ```bash ph-recupArchives -h --- usage: ph-recupArchives [-h] [-s S] [-c C] [-u U] [-p P] [-f F] [-ps PS] [-r {true,false}] [-pu {true,false}] [-d {true,false}] [-t T] [-st ST] [-w W] Lance une récupération / purge des archives Arguments: -h, --help Affiche ce message et quitte -s S URL du serveur iParapheur -c C Fichier de configuration -u U Utilisateur -p P Mot de passe -f F Répertoire de destination -ps PS Taille des pages à récupérer -r {true,false} Chemins réduis des téléchargements -pu {true,false} Active la purge les données -d {true,false} Télécharge les données -t T Filtre sur type -st ST Filtre sur sous-type -w W Délai de conservation des données ``` ## `ph-export` Lance la fonction d'exporation de la configuration du parapheur vers un dossier. Il est vivement conseillé d'utiliser la commande `ph-init -c export` afin de générer un squelette de fichier de configuration complet. **ATTENTION** : Seule la **configuration** du parapheur est exportée. Comprendre qu'aucun dossier, archive, statistique ou historique n'est conservé. Exemple d'utilisation : ```bash usage: ph-export [-h] [-s S] [-c C] [-u U] [-p P] [-i I] [-dh DH] [-dp DP] [-du DU] [-dpw DPW] [-dd DD] Exporte la configuration du parapheur ciblé vers un dossier Arguments: -h, --help Affiche ce message et quitte -s S URL du serveur iParapheur -c C Fichier de configuration -u U Utilisateur administrateur -p P Mot de passe -i I Répertoire de destination -dh DH IP du serveur mysql -dp DP Port du serveur mysql -du DU Utilisateur alfresco de mysql -dpw DPW Mot de passe utilisateur alfresco de mysql -dd DD Nom de la base mysql ``` ## `ph-import` Lance la fonction d'importation de la configuration du parapheur à partir d'un dossier. Il est vivement conseillé d'utiliser la commande `ph-init -c import` afin de générer un squelette de fichier de configuration complet. **ATTENTION** : Seule la **configuration** du parapheur est importée. Comprendre qu'aucun dossier, archive, statistique ou historique n'est conservé. Exemple d'utilisation : ```bash usage: ph-import [-h] [-s S] [-c C] [-u U] [-p P] [-i I] [-dh DH] [-dp DP] [-du DU] [-dpw DPW] [-dd DD] Importe la configuration ciblée dans un parapheur vierge Arguments: -h, --help Affiche ce message et quitte -s S URL du serveur iParapheur -c C Fichier de configuration -u U Utilisateur administrateur -p P Mot de passe -i I Répertoire à importer -dh DH IP du serveur mysql -dp DP Port du serveur mysql -du DU Utilisateur alfresco de mysql -dpw DPW Mot de passe utilisateur alfresco de mysql -dd DD Nom de la base mysql ``` ## `ph-rename` Cette commande permet de changer l'URL d'accès au i-Parapheur Exemple d'utilisation : ```bash usage: ph-rename [-h] -n N Change l'URL d'accès du i-Parapheur Arguments: -h, --help Affiche ce message et quitte -n N Nouvelle URL du serveur iParapheur ``` Le lancement de la commande modifie l'URL d'accès au i-Parapheur mais ne change pas la configuration du certificat serveur. Il est important de suivre la procédure de changement de certificat serveur donnée après le lancement de la commande. ```bash ATTENTION ! Le certificat configuré dans le fichier /etc/nginx/conf.d/parapheur_ssl.conf ne correspond potentiellement plus avec le nouveau nom du parapheur. Il convient de remplacer ce certificat (localisé dans le dossier /etc/nginx/ssl/) pour que le parapheur soit totalement fonctionnel. Propriétés à modifier dans le fichier de configuration /etc/nginx/conf.d/parapheur_ssl.conf : - ssl_certficiate /etc/nginx/ssl/test.pem; # Partie publique - ssl_certficiate_key /etc/nginx/ssl/test.key; # Partie privée Une fois les modifications de certificat effectuées, relancer le service NginX : service nginx restart ``` ## `ph-removeldap` Cette commande permet de supprimer les utilisateurs synchronisés avec un LDAP n'ayant aucun bureau liés. Exemple d'utilisation : ```bash usage: ph-removeldap [-h] Supprime les utilisateurs synchronisés LDAP n'ayant aucune liaison avec un bureau Arguments: -h, --help Affiche ce message et quitte ``` ## `ph-pushdoc` Lance la fonction d'importation de dossier via le connecteur générique Pushdoc. Il est vivement conseillé d'utiliser la commande ` ph-init -c pushdoc ` afin de générer un squelette de fichier de configuration complet. **ATTENTION** : Des pré-requis sont nécéssaires avant l'utilisation de cette commande : - Un jar pushdoc en dernière version dans le même dossier que ce script - Tout le néc