Serveur REST qui fourmi le contenu d'un annuaire EOLE
William Petit 1021956ecc Mise à jour documentation + modif du port par défaut 3 years ago
dicos Mise à jour documentation + modif du port par défaut 3 years ago
init Ajout documentation et refactoring 3 years ago
src/ldap2rest-1.0 Mise à jour documentation + modif du port par défaut 3 years ago
tmpl Ajout documentation et refactoring 3 years ago
.gitignore initialisation du projet 3 years ago
Makefile initialisation du projet 3 years ago
README.md Mise à jour documentation + modif du port par défaut 3 years ago
apps.mk initialisation du projet 3 years ago
eole.mk initialisation du projet 3 years ago
ldap2rest.mk initialisation du projet 3 years ago

README.md

eole-ldap2rest

Installation du service

Via le dépôt Cadoles

  1. Ajouter le dépôt Cadoles dans les sourceslist bash wget -O - http://depot.cadol.es/cadoles.gpg.key|apt-key add - echo "deb http://depot.cadol.es/orange ./" > /etc/apt/sources.list.d/cadoles.list
  2. Installer les paquets eole-ldap2rest et ldap2rest-apps bash Query-Auto apt-eole install eole-ldap2rest ldap2rest-apps
  3. Se connecter à l’interface GenConfig https://[ip_serveur]:7000/genconfig avec le compte administrateur
  4. Dans la section “Applications Web”, passer “Activer ldap2rest” à oui. Enregistrer.
  5. Une nouvelle section est ldap2rest dans l’interface GenConfig, vous pouvez y personnaliser l’installation de ldap2rest, notamment les identifiants du serveur LDAP à utiliser.
  6. Puis dans la console bash reconfigure
  7. A la fin de la procédure, le service ldap2rest devrait être disponible à l’adresse https://[ip_serveur]/ldap2rest/structures

Directement à partir des paquets Debian

  1. Télécharger/transférer les paquets eole-ldap2rest.deb et ldap2rest-apps.deb sur le serveur
  2. Dans la console, dans le répertoire où sont présents les 2 paquets, faire bash dpkg -i eole-ldap2rest*.deb dpkg -i ldap2rest-apps*.deb
  3. Continuer à l’étape 3 de l’installation via le dépôt Cadoles

Mettre à jour le service

Dans une console

Query-Auto # Au besoin, un passage dans l'iterface GenConfig peut être nécessaire après cette étape
reconfigure

Répertoires et fichiers notables

Répertoire Description
/etc/ldap2rest Fichiers de configuration
/var/run/ldap2rest Fichiers d’exécution (PID, Sockets Unix…)
/usr/share/eole/nodejs/ldap2rest Fichiers applicatifs
/var/log/ldap2rest Fichiers de journalisation

Configuration

La configuration du service est stockée dans le répertoire /etc/ldap2rest. Les modifications de cette configuration se font via l’interface GenConfig (https://[ip_serveur]:7000/genconfig).

** /!\ ** Les modifications manuelles seront supprimées à chaque reconfigure.

Création d’un nouveau client

La création d’un nouveau client se fait via la ligne de commande.

  1. Lancer l’utilitaire interactif et renseigner les différentes informations demandées bash /usr/share/eole/nodejs/ldap2rest/bin/add-client Exemple de sortie ``` ? Vous aller créer un nouveau client pour ldap2rest. Voulez vous continuer ? Yes ? Quel est le nom du client associé à cette clé ? (sera utilisé pour générer le nom de fichier) test-service ? Choisissez les structures visibles par le client: orange

Nouvelle clé créée (/etc/ldap2rest/clients/test-service.json)

-> Client: test-service -> Clé API: 186e0daa-7f05-49b2-8d22-043bb590c1 -> Structures visibles: orange

2. Redémarrer le service `ldap2rest-apps`

/etc/init.d/ldap2rest-apps restart


## API

Voir la [documentation de l'application](./src/ldap2rest-1.0/README.md), section *Description de l'API*.

## Tester l'API

Exemple, avec l'utilitaire `curl`:

```bash
 curl -H "X-API-KEY:[clé_api]" -v https://[ip_serveur]/ldap2rest/structures