# 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)
> 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éssaire pour faire fonctionner push
没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
收起资源包目录
iparapheur-utils.beta-0.0.1.post53733.tar.gz (39个子文件)
iparapheur-utils.beta-0.0.1.post53733
MANIFEST.in 68B
PKG-INFO 13KB
parapheur
core.py 10KB
parapheur
Client.py 12KB
__init__.py 4KB
pprint.py 3KB
JSONHelper.py 3KB
Webservice.py 8KB
__init__.py 400B
configs
recuparchives.cfg 253B
import.cfg 206B
ipclean.cfg 40B
export.cfg 206B
pushdoc.cfg 163B
script.cfg 82B
script.cfg 82B
files
private.pem 2KB
public.pem 2KB
scripts
export_data.py 11KB
change_name.py 3KB
checkInstallationIP.py 36KB
ipclean.py 582B
__init__.py 667B
javascript
removeNode.js 98B
remove_ldap.py 946B
recupArchives.py 11KB
script
ipclean.sh 4KB
import_data.py 19KB
pushdoc.py 7KB
iparapheur_utils.beta.egg-info
PKG-INFO 13KB
requires.txt 49B
SOURCES.txt 1KB
entry_points.txt 442B
top_level.txt 10B
dependency_links.txt 1B
setup.cfg 38B
setup.py 1KB
CHANGELOG.md 4KB
README.md 10KB
共 39 条
- 1
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0