Version 1.0.0 · Redmine 5.1 und 6 · GPLv2
Dieses Handbuch beschreibt Installation, Konfiguration und täglichen Einsatz des atori-Plugins Externe Beobachter.
Redmine benachrichtigt Beobachter eines Tickets per E-Mail, aber nur, wenn sie ein Redmine-Konto haben. Das Plugin ergänzt jedes Ticket um externe Beobachter: beliebige E-Mail-Adressen, etwa die eines Kunden oder eines Dienstleisters, die dieselben Benachrichtigungen erhalten wie die eingetragenen Beobachter, ohne Konto und ohne Zugriff auf Redmine.
Zentrale Begriffe:
Was das Plugin bewusst nicht tut: Es gibt keinen Zugriff auf Redmine, keine Antwortmöglichkeit per Mail und keine Weiterleitung privater Kommentare. Die Adresse eines Redmine-Benutzers lässt sich nicht als externer Beobachter eintragen; solche Personen sind normale Beobachter.
cd /pfad/zu/redmine
unzip at_watcher-1.0.0.zip -d plugins/
bundle exec rake redmine:plugins:migrate NAME=at_watcher RAILS_ENV=production
# Redmine neu startenAls Administrator einloggen und Administration → Plugins öffnen. Das Plugin Externe Beobachter sollte mit Version 1.0.0 erscheinen.
Ein Redmine-Update ist für das Plugin nur dann unkritisch, wenn die Reihenfolge stimmt. Redmine lädt jedes Plugin beim Start; passt ein Plugin nicht zur neuen Version, startet die ganze Instanz nicht, bis der Plugin-Ordner entfernt ist. Die Daten in den Plugin-Tabellen sind davon nie betroffen.
Regel: Jede Plugin-Version unterstützt die aktuelle und die vorherige Redmine-Linie (derzeit 5.1 und 6). Welche Plugin-Version mit welcher Redmine-Version getestet ist, steht in der Freigabe-Übersicht auf redmine-plugins.atori.de.
Reihenfolge beim Update:
redmine:plugins:migrate, Neustart) und auf der alten Redmine-Version kurz prüfen. Diese Brückenversion läuft auf beiden Redmine-Versionen.bundle exec rake redmine:plugins:migrate RAILS_ENV=production und Neustart.Fallweg, wenn keine Brückenversion existiert (etwa weil die neue Redmine-Version ein neueres Ruby verlangt):
cd /pfad/zu/redmine
mv plugins/at_watcher ../at_watcher.alt # Ordner beiseitelegen, NICHT migrieren
# Redmine aktualisieren
# neue Plugin-Version nach plugins/at_watcher entpacken
bundle exec rake redmine:plugins:migrate NAME=at_watcher RAILS_ENV=production
# Redmine neu startenDie Plugin-Tabellen bleiben dabei unverändert in der Datenbank; die neue Plugin-Version hebt das Schema mit ihren eigenen Migrationen an.
> Nie VERSION=0 als Teil eines Updates. Die Rückwärtsmigration auf > Version 0 löscht die Plugin-Tabellen und damit alle Daten des Plugins. > Sie gehört ausschließlich zur endgültigen Deinstallation (siehe unten).
cd /pfad/zu/redmine
bundle exec rake redmine:plugins:migrate NAME=at_watcher VERSION=0 RAILS_ENV=production
rm -rf plugins/at_watcher
# Redmine neu startenDer Rake-Task entfernt die einzige vom Plugin verwaltete Tabelle (at_watcher_external_watchers). Bestehende Ticketdaten werden nicht angerührt.
Das Plugin ist projektweise aktiv:
Ohne aktives Modul erscheint am Ticket nichts, und bestehende externe Beobachter des Projekts erhalten keine Mails.
Zwei Rechte stehen unter Administration → Rollen und Rechte → Externe Beobachter zur Verfügung:
| Recht | Wirkung | Typische Rolle |
|---|---|---|
| Externe Beobachter sehen | Die Liste der Adressen am Ticket sehen | Mitarbeiter |
| Externe Beobachter verwalten | Adressen hinzufügen und entfernen | Projektleitung |
Verwalten setzt Sehen voraus. Wer keines der Rechte hat, sieht am Ticket keinen Hinweis auf externe Beobachter.
Das Plugin hat keine eigenen Einstellungen. Es folgt der Redmine-Konfiguration unter Administration → Konfiguration → E-Mail-Benachrichtigungen: Externe Beobachter erhalten eine Mail bei Ticket hinzugefügt und bei jedem Ereignis, das dort für Ticketänderungen angehakt ist (Aktualisierung, Kommentar, Status, Zuweisung, Priorität, Zielversion, Dateianhang). Ist dort nichts angehakt, geht auch an externe Beobachter nichts.
Absender, Betreffzeile und Aufbau der Mail entsprechen den normalen Redmine-Benachrichtigungen; am Ende steht der Hinweis, warum die Adresse die Mail erhält, und der Abmeldelink. Links in der Mail führen auf Redmine; ohne Konto funktionieren sie nur in öffentlichen Projekten. Der Inhalt (Beschreibung, Felder, Kommentar) steht vollständig in der Mail.
Im Ticket rechts in der Seitenleiste, unter den Beobachtern, steht der Kasten Externe Beobachter. E-Mail-Adresse und optional einen Namen eingeben, Hinzufügen. Die Adresse erscheint in der Liste; eine Bestätigung geht nicht raus, die erste Mail ist die nächste Änderung am Ticket.
Beim Anlegen eines Tickets lässt sich noch keine Adresse eintragen; das Ticket zuerst speichern, dann die Adresse ergänzen.
In der Liste das Papierkorb-Symbol neben der Adresse wählen und bestätigen. Die Adresse erhält ab sofort keine Mails mehr zu diesem Ticket.
Jede Mail endet mit einem Abmeldelink. Er öffnet eine Seite, die nur die Adresse und die Ticketnummer nennt; nach Abbestellen ist die Adresse vom Ticket entfernt. Eine Anmeldung ist nicht nötig. Der Link gilt nur für diese eine Adresse an diesem einen Ticket.
Der Kasten „Externe Beobachter“ fehlt am Ticket. Modul im Projekt aktiviert? Rolle mit Externe Beobachter sehen? Ohne Recht und ohne eingetragene Adressen bleibt der Kasten weg.
Die Adresse lässt sich nicht eintragen: „gehört zum Redmine-Benutzer“. Für diese Adresse gibt es ein Redmine-Konto. Die Person als normalen Beobachter eintragen, damit ihre eigenen Benachrichtigungs-Einstellungen gelten.
Es kommt keine Mail an. Erstens: Erhält ein interner Beobachter die Mail? Wenn nicht, liegt es an Redmines Mailversand oder an den E-Mail-Benachrichtigungen. Zweitens: War der Kommentar privat? Drittens: log/production.log nach AtWatcherMailer durchsuchen; Zustellfehler stehen dort.
Der Link in der Mail verlangt eine Anmeldung. Das Projekt ist nicht öffentlich. Externe Beobachter haben keinen Zugriff auf Redmine; der Inhalt steht in der Mail selbst.
Support ist für zwölf Monate ab Kaufdatum enthalten und deckt Fehlermeldungen, Konfigurationsfragen und Kompatibilitätsprobleme ab.
E-Mail: support@atori.de Erstreaktion: werktags innerhalb von 48 Stunden.
Bitte in Supportanfragen angeben:
log/production.log, sofern verfügbar