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.