agenda admin

Agenda-Administrator

Ein Dashboard für die Agenda

---

Merkmale

• Auftragsstatus, Aktualisierungsintervall beträgt standardmäßig 15 Sekunden
• Suchen Sie nach Jobs nach Namen, einschließlich automatischer Vervollständigung
• Filtern Sie Jobs nach Metadaten und Status
• Jobdetails anzeigen
• Jobs löschen und erneut in die Warteschlange stellen
• Planen Sie einen neuen Job

---

Voraussetzungen

Erforderliche Version von MongoDB: >2.6.0

---

Middleware-Nutzung

Agenda Admin kann mit der mountAgendaAdmin -Funktion als Express-Middleware verwendet werden. Als Argument nimmt es ein Objekt mit den folgenden Feldern:

• publicUrl – die URL, unter der das Frontend bereitgestellt wird
• mountPath – der Pfad, unter dem die Middleware gemountet werden soll (übergeben an app.use() )
• expressApp – die Express-App
• agenda – eine Agenda-Instanz
• options – ein optionales Argument, das Objekt kann die folgenden Eigenschaften haben:
  • itemsPerPage
  • username
  • password

Beispiel:

 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);

---

Docker-Nutzung

Der Docker-Container macht Port 7878 verfügbar

Zu diesem Zeitpunkt unterstützt AgendaAdmin keine Port-Neuzuordnung, daher sollte der Container nur mit Port 7878 verbunden werden

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

Konfiguration der Docker-Umgebung

Name	Beschreibung	erforderlich	Standardwert
CONNECTION_STRING	MongoDB-Verbindungszeichenfolge	Ja
SAMMLUNG	MongoDB-Auflistung von Jobs	NEIN	AgendaJobs
ITEMS_PER_PAGE	Anzahl der Jobs pro Seite	NEIN	20
AGENDA_USERNAME	Zur Authentifizierung verwendeter Benutzername (nur bei Angabe eines Passworts)	NEIN	Administrator
AGENDA_PASSWORD	Wenn kein Passwort angegeben wird, ist keine Authentifizierung erforderlich	NEIN

---

Mitwirken

Abhängigkeiten installieren

yarn install

Läuft

Erstellen Sie im api -Verzeichnis eine .env.development Datei mit den Variablen CONNECTION_STRING und COLLECTION und führen Sie dann yarn dev aus.
Sie können yarn start auch in den api und client -Verzeichnissen ausführen.

Laufende Tests

Erstellen Sie im api -Verzeichnis eine .env.testing Datei mit den Variablen CONNECTION_STRING und COLLECTION und führen Sie dann yarn test aus.

Nachrichten festschreiben

Agenda Admin verwendet das herkömmliche Commit-Format.