Sonstiges ‣ Werkzeugbibliotheken

Überblick

Chioro bietet die Möglichkeit Werkzeuge einzubinden, die in einem Git-Projekt liegen. Eine Vorlage ist hier zu finden. Das Anlegen und Testen eines oder mehrerer Werkzeuge ist im dortigen Readme beschrieben.

Die chioro-toolbox mit den Standard-Werkzeugen ist immer vorhanden. Auf dem Tab Werkzeuge sind in der oberen Hälfte die momentan eingehängten Bibliotheken aufgelistet.

Library

  1. Auf den Tab Werkzeuge klicken um eine Liste der eingehängten Bibliotheken zu sehen.
  2. Der Name der Bibliothek: Dieser Name muss mit dem Namen in der Datei package.json im git Repository übereinstimmen.
  3. Hier kann die Bibliothek aktualisiert oder gelöscht werden. Da die Bibliotheken nur bei einem Neustart des Chioro-Servers automatisch geladen werden, muss nach einer Änderung der Werkzeuge in Git die Aktualisierung hier manuell angestossen werden.

Neue Bibliothek einhängen

Nach Klicken auf das Plus-Zeichen öffnet sich folgendes Fenster:

Library

  1. Der Name der Bibliothek muss exakt dem Feld name in der package.json des Git-Repositories entsprechen. Er ist kein frei wählbarer Anzeigename.
  2. Unter dem Alias kann die Bibliothek in Regeln verwendet werden. Der Alias muss ein gültiger JavaScript-Bezeichner sein, z. B. my_tools oder mt, ohne Leerzeichen oder Bindestriche.
  3. Die URL des Git-Repositories, z. B. git+https://github.com/organisation/toolbox.git.
  4. Für private GitHub-Repositories die passende Authentifizierungskonfiguration auswählen. Bei öffentlichen Repositories kann das Feld leer bleiben.
  5. Auf Speichern klicken. Chioro lädt die Bibliothek und ihre Werkzeuge.

Private GitHub-Repositorys

Zum Laden einer privaten Toolbox genügt ein Fine-grained Personal Access Token, der auf das betreffende Repository beschränkt ist und folgende Repository-Berechtigungen hat:

Berechtigung Zugriff
Contents Read-only (contents:read)
Metadata Read-only (metadata:read)

Schreibrechte sind für das Laden und Aktualisieren einer Toolbox nicht erforderlich.

  1. In den GitHub-Einstellungen für Fine-grained Tokens einen Token anlegen. Den Eigentümer des Repositorys als Resource owner auswählen und unter Repository access → Only select repositories das Toolbox-Repository auswählen. Die oben genannten Berechtigungen setzen.
  2. In Chioro unter Administration eine Konfiguration vom Typ GitHub Personal Access Token anlegen, einen Namen vergeben und den Token eintragen. Ein Benutzername ist dafür nicht erforderlich.
  3. Diese Konfiguration in der Werkzeugbibliothek unter Authentifizierungskonfiguration auswählen.
  4. Als Bibliothek-URL die HTTPS-Adresse verwenden, z. B. git+https://github.com/organisation/toolbox.git. Chioro liest den Token aus der ausgewählten Admin-Konfiguration; in der Werkzeugbibliothek wird kein Token eingetragen.
  5. Die Bibliothek speichern. Um eine bestehende Bibliothek erneut zu laden, das Refresh-Symbol Bibliothek neu verknüpfen verwenden.

Eine Anleitung zum Erstellen und Verwalten der Tokens bietet die GitHub-Dokumentation.

Erscheint Cannot load module, den Bibliotheksnamen mit dem Feld name in der package.json vergleichen. Beispielsweise muss für "name": "my-toolbox" auch in Chioro der Name my-toolbox eingetragen werden; der Alias kann unabhängig davon mt lauten.

Verwenden des Werkzeugs in einer Regel

Voraussetzung in diesem Beispiel: Name der Bibliothek my_tools mit Alias mt, es gibt ein Werkzeug namens happyFunktion :

Library

Wie zu sehen, wird zunächst das Alias genannt, gefolgt von einem Punkt und dem eigentlichen Aufruf der Funktion. Nach Speichern & Preview kann, wie gewohnt, das Ergebnis der Regel überprüft werden. Die Tools sind natürlich auch in der Werkzeugliste unter Hilfsmittel zu finden und können per “Drag & Drop” in den Regeleditor gezogen werden.