Redmine AI - Installation, Deinstallation und Konfiguration
Systemanforderungen:
- Ruby Version 3.1+
- Redmine Version 5+
- Datenbanktyp: alle von Redmine unterstützten – MySQL/MariaDB, PostgreSQL, SQLite(nur für Entwicklung/Test), MS SQL
- KI Key/Anbieter
Installation
Schritt 1: Plugin kopieren
-
Kopiere das entpackte Verzeichnis des Plugins in dein Redmine-Verzeichnis unter `plugins/` *
z.B. Linux/macOS (Unix)cp -r /path/to/redmine_ai /path/to/redmine/plugins/
* Stell vorab sicher, dass im Redmine-Installationsverzeichnis ein Ordner `plugins/` vorhanden ist und du dort Schreibrechte besitzt.
Schritt 2: Abhängigkeiten installieren
-
Wechsle ins Hauptverzeichnis(REDMINE_ROOT) deiner Redmine-Installation und installiere die benötigten Gems:
cd /path/to/redmine bundle install
Schritt 3: Plugin-Migration ausführen
-
Führ den Rake‑Task aus, um alle Datenbankänderungen des Plugins zu übernehmen:
cd /path/to/redmine rake redmine:plugins
Schritt 4: Redmine neu starten
-
Start Redmine (den Redmine‑Prozess) neu, damit das Plugin geladen wird. Je nach Setup z. B.:
z.B. bei Passengertouch /path/to/redmine/tmp/restart.txt
z.B. bei Systemdsudo systemctl restart redmine
Nach dem Neustart steht das „Redmine AI Plugin“ im Admin-Bereich zur Verfügung und kann konfiguriert werden. Viel Erfolg!
Konfiguration Vollversion
Schritt 1: KI‑Verbindung erstellen
-
Melde dich als Administrator an.
-
Navigiere zu Administration → KI‑Verbindungen.
-
Klick auf „Neue KI‑Verbindung“.
-
Wähl Anbieter (Service) aus dem Dropdown aus (z. B. OpenAI, Ollama, Azure).
-
Füll die folgenden Felder aus:
- Name der Verbindung (AI service)
- API‑Schlüssel (Key), URL und Modell (falls erforderlich)
-
Setz das Häkchen bei „Aktiv“, um die Verbindung für Projekte verfügbar zu machen.
-
Speicher die Verbindung.
Schritt 2: Plugin‑Einstellungen konfigurieren
-
Gehin den Plugin-Einstellungen (Administration->KI) auf die verschiedenen Kontext-Tabs (z. B. Global, Anhang Kontext, Ticket-Kontext, Ticket Beschreibung Kontext, Ticket Journal Kontext, Textfeld usw.)
Hier kannst du:
- Jeden Kontext aktivieren oder deaktivieren (Häkchen bei „Aktivieren?“)
- Die jeweiligen Felder pro Kontext konfigurieren, inkl.:
- Auswählbar → Das Feld kann manuell in der Abfrage ausgewählt werden
- Vorausgewählt → Das Feld ist automatisch aktiviert, wenn der Kontext verwendet wird
Hinweise:- Die Konfiguration für Anhänge und Journale wirkt sich auch auf den Ticket‑Kontext aus, wenn diese ausgewählt werden.
- Der Textfeld‑Kontext fügt den KI‑Button
zu allen Textfeldern mit Editor hinzu, unabhängig von den Projekteinstellungen.
- Wenn für einen bestimmten Kontext keine Felder ausgewählt sind, wird dort kein KI‑Button angezeigt.
Schritt 3: Berechtigungen für den KI‑Zugriff aktivieren
-
Geh zu Administration → Rollen und RechteAdministration → Rollen und Rechte.
-
Wähl die gewünschte Rolle aus, die Zugriff auf die KI erhalten soll.
-
Scroll zum Abschnitt „AI“ und aktivier die gewünschten Berechtigungen:
- Zugriff auf KI– Grundrecht für die Nutzung der KI‑Funktionen
- Manage AI Chat – Verwaltung und Zurücksetzen des Chatverlaufs
- Access global context
- Zugriff auf Ticket‑Kontext
- Zugriff auf Ticket Beschreibung Kontext
- Zugriff auf Ticket Journal Kontext
- Zugriff auf Ticketabfrage Kontext
- Zugriff auf News Kontext
- Zugriff auf Anhang Kontext
- Zugriff auf Wiki Inhalt Kontext
- Zugriff auf Textfeld Kontext
-
Klick auf „Speichern“, um die Berechtigungen zu übernehmen.
-
Wiederhol die Schritte für alle Rollen, die Zugriff auf bestimmte Kontexte oder die KI-Funktionen erhalten sollen.
Schritt 4: Redmine AI‑Modul in deinem Projekt aktivieren
-
Geh zum gewünschten Projekt → Konfiguration → Module.
-
Aktiviere „AI“ und klick auf „Speichern“.
-
Du siehst nun den KI‑Button
in allen aktivierten undunterstützten Bereichen (z. B. Tickets, Wiki, News).
Schritt 5 (Optional): Vordefinierte Prompts erstellen
-
Geh zu Administration → KI‑Prompts.
-
Klick auf „Neuer KI‑Prompt“, um wiederverwendbare Prompts zu erstellen.
-
Füll die folgenden Felder aus:
- Titel (Pflichtfeld)
- Description(optional)
- Prompt (Pflichtfeld)
-
Wähl im Dropdown-Menü „AI Context Type“ den passenden Kontext aus, z. B. Ticket-Kontext, Ticket Beschreibung Kontext, Ticket Journal Kontext, News Kontext, Wiki Inhalt Kontext usw.
-
Klick auf „Anlegen“, um den Prompt zu erstellen.
Das war’s! Du kannst das Redmine AI Plugin jetzt in deinem Projekt verwenden.
Verwendung des Plugins
-
Öffne ein Ticket in einem Projekt, in dem das Plugin aktiviert ist, und klicke auf den KI-Button
-
Wähle eine KI-Verbindung aus dem Dropdown-Menü aus.*
-
Gib deinen Prompt oder deine Frage in das Textfeld ein, um die Antwort der KI gezielt zu steuern.
-
Klick auf „OK“, um den Prompt an die ausgewählte KI-Verbindung zu senden.
-
Du kannst das Ergebnis über den Kopieren-Link kopieren oder direkt in einen Ticket-Kommentar (oder die Beschreibung) einfügen.
- * Du kannst auch „Prompt generieren“ auswählen, um automatisch einen Prompt mit dem aktuellen Kontext und einer Prompt-Nachricht zum Kopieren zu erstellen.
- Das Beispiel verwendet den Anhang-Kontext, der in den Plugin-Einstellungen aktiviert sein muss, um ihn nutzen zu können. Um Anhänge im Ticket-Kontext zu verwenden, muss der Anhang-Kontext zusätzlich unter Beziehungen im Reiter Ticket-Kontext aktiviert sein.
Konfiguration Light Version
Schritt 1: KI-Verbindung erstellen
-
Melde dich als Administrator an.
-
Navigiere zu Administration → KI‑Verbindungen.
-
Klick auf Neue KI‑Verbindung.
-
Wähl Anbieter (Service) aus dem Dropdown aus (z. B. OpenAI, Ollama, Azure).
-
Füll die folgenden Felder aus:
- Name der Verbindung (AI service)
- API‑Schlüssel (Key), URL und Modell (falls erforderlich)
-
Setz das Häkchen bei „Aktiv“, um die Verbindung für Projekte verfügbar zu machen.
-
Speicher die Verbindung.
Schritt 2: Berechtigungen für den KI‑Zugriff aktivieren
-
Geh zu Administration → Rollen und Rechte.
-
Weise den Rollen im Abschnitt „AI“ das entsprechende Recht „Zugriff auf KI“ zu.
-
Klick auf „Speichern“.
Schritt 3: Redmine AI‑Modul in deinem Projekt aktivieren
-
Geh zum gewünschten Projekt → Konfiguration → Module.
-
Aktiviere „AI“ und klick auf „Speichern“.
-
Du siehsr nun KI‑Button
in unterstützten Bereichen (z. B. Tickets, Wiki, News).
Schritt 4 (Optional): Vordefinierte Prompts erstellen
-
Geh zu Administration → KI‑Prompts.
-
Klick auf „Neuer KI‑Prompt“, um wiederverwendbare Prompts zu erstellen.
-
Füll die folgenden Felder aus:
- Titel (Pflichtfeld)
- Description (optional)
- Prompt (Pflichtfeld)
-
Wähl Sie im Dropdown-Menü „AI Context Type“ den passenden Kontext aus, z. B. Ticket-Kontext, Ticket Beschreibung Kontext, Ticket Journal Kontext, News Kontext, Wiki Inhalt Kontext usw.
-
Klick Sie auf „Anlegen“, um den Prompt zu erstellen.
Das war’s! Du solltest das Redmine AI Plugin jetzt in deinem Projekt verwenden können.
Verwendung des Plugins
-
Öffne ein Ticket in einem Projekt, in dem das Plugin aktiviert ist, und klicke auf den KI-Button
-
Wähle eine KI-Verbindung aus dem Dropdown-Menü aus.*
-
Gib deinen Prompt oder deine Frage in das Textfeld ein, um die Antwort der KI gezielt zu steuern.
-
Klick auf „OK“, um den Prompt an die ausgewählte KI-Verbindung zu senden.
-
Du kannst das Ergebnis über den Kopieren-Link in die Zwischenablage übernommen werden.
- * Du kannst auch „Prompt generieren“ auswählen, um automatisch einen Prompt mit dem aktuellen Kontext und einer Prompt-Nachricht zum Kopieren zu erstellen.
Deinstallation
Schritt 1: Datenbank‑Downgrade (falls Migrationen verwendet wurden)*
-
z.B. Linux/macOS (Unix)cd /path/to/redmine bundle exec rake redmine:plugins:migrate NAME=redmine_ai VERSION=0 RAILS_ENV=production
* Erstelle vorher ein Backup deiner Datenbank
Schritt 2: Plugin‑Verzeichnis entfernen
-
rm -rf path/to/redmine/plugins/redmine_ai
Schritt 3: Redmine neu starten
-
Damit das Plugin vollständig entfernt wird, starte den Redmine‑Prozess neu. Je nach Setup z. B.:
z.B. bei Passengertouch /path/to/redmine/tmp/restart.txt
z.B. bei Systemdsudo systemctl restart redmine
Starte noch heute mit Redmine durch.
Ob persönlich, per E-Mail oder telefonisch. Die Mitarbeitenden unseres Teams freuen sich auf dich und deine Fragen.