Installation
La bibliothèque OIP Core est distribuée sous la forme d'un package npm. Elle peut être installée via les outils npm ou yarn, ou déclarée comme dépendance du projet dans le fichier package.json.
npm install '@fasstech/oip-core'Peer dependencies
L'OIP Core nécessite plusieurs peer dependencies :
Pour utiliser les dépendances @fasstech, vous devez disposer des droits d'accès NPM nécessaires.
Variables d'environnement
CIPHER_IV
[obligatoire] Vecteur d'initialisation utilisé par l'algorithme de chiffrement.
Cette valeur est spécifique à chaque projet.
La longueur doit être de 16 caractères.
Exemple : W05IGQ5qdBnIqAWE
CIPHER_KEY
[obligatoire] Clé utilisée par l'algorithme de chiffrement.
Cette valeur est spécifique à chaque projet.
La longueur doit être de 32 caractères.
Exemple : ayz9VFNtbRQM0yBODcCb1lrUtVVH3D3y
OIP_MONGO_DB_URL
[obligatoire] URL de la base MongoDB.
OIP_WORK_DIR
[obligatoire] Répertoire racine du projet.
ENABLE_DEFAULT_DATA_COLLECTOR
Si spécifié, l'appel à la fonction save de l'entité Project pourra générer un évènement via le data collector. Un évènement sera généré dans l'une des deux conditions décrites ci-dessous :
- Création de l'entité Project ; le type de l'évènement est 'CREATE_PROJECT'.
- Mise à jour du statut de l'entité Project ; le type de l'évènement est 'UPDATE_STATUS'. L'évènement porte l'information du nouveau statut : { metadata: { newStatus } }.
Si activé, des variables d'environnement doivent être ajoutées :
- RABBIT_MQ_HOST
- RABBIT_MQ_USER
- RABBIT_MQ_PASSWORD
- RABBIT_MQ_VHOST
Ces variables d'environnement sont requises par la bibliothèque @fasstech/rabbitmq-helper ; la documentation est disponible ici.