agenda admin

Administrateur de l'agenda

Un tableau de bord pour l'agenda

---

Caractéristiques

• Statut des tâches, l'intervalle d'actualisation est de 15 secondes par défaut
• Rechercher des emplois par nom, y compris la saisie semi-automatique
• Filtrer les tâches par métadonnées et statut
• Afficher les détails du travail
• Supprimer et remettre des tâches en file d'attente
• Planifier un nouveau travail

---

Conditions préalables

Version requise de MongoDB : >2.6.0

---

Utilisation du middleware

Agenda Admin peut être utilisé comme middleware express, en utilisant la fonction mountAgendaAdmin . En argument, il prend un objet avec les champs suivants :

• publicUrl - l'URL à laquelle le frontend est servi
• mountPath - le chemin sur lequel le middleware doit être monté (passé à app.use() )
• expressApp - l'application express
• agenda - une instance d'agenda
• options - un argument facultatif, l'objet peut avoir les propriétés suivantes :
  • itemsPerPage
  • username
  • password

Exemple:

 const express = require('express');
const Agenda = require('agenda');
const { mountAgendaAdmin } = require('agenda-admin');

const app = express();

// Other express middleware

const agenda = new Agenda({ db: { address: 'mongodb://127.0.0.1/agendaDb' } });

mountAgendaAdmin({
  publicUrl: 'http://localhost:7878/agenda-admin',
  mountPath: '/',
  expressApp: app,
  agenda
});

app.listen(7878);

---

Utilisation de Docker

Le conteneur Docker expose le port 7878

À ce stade, AgendaAdmin ne prend pas en charge le remappage des ports, le conteneur doit donc être connecté au port 7878 uniquement.

 docker run -p 7878:7878 
--env CONNECTION_STRING=mongo://username:password@host/database 
--env COLLECTION=collection lexissolutions/agenda-admin:latest

Configuration de l'environnement Docker

nom	description	requis	valeur par défaut
CONNEXION_STRING	Chaîne de connexion MongoDB	Oui
COLLECTION	Collection de tâches MongoDB	Non	agendaJobs
ITEMS_PER_PAGE	Nombre de travaux par page	Non	20
AGENDA_USERNAME	Nom d'utilisateur utilisé pour l'authentification (uniquement lorsqu'un mot de passe est fourni)	Non	administrateur
AGENDA_PASSWORD	Si aucun mot de passe n'est fourni, aucune authentification ne sera requise	Non

---

Contribuer

Installer les dépendances

yarn install

En cours d'exécution

Dans le répertoire api , créez un fichier .env.development avec les variables CONNECTION_STRING et COLLECTION , puis exécutez yarn dev .
Vous pouvez également exécuter yarn start dans les répertoires api et client .

Exécution de tests

Dans le répertoire api , créez un fichier .env.testing avec les variables CONNECTION_STRING et COLLECTION , puis exécutez yarn test .

Valider les messages

Agenda Admin utilise le format de validation conventionnel.