User Manual
awaBerry | Agentic-Projekt bearbeiten / erstellen
Ein awaBerry Agentic API-Projekt bearbeiten — Geräteziele aktualisieren, API-Schlüssel und Zugriffsberechtigungen anpassen sowie Ausführungsparameter ändern.
Agentic Projekt bearbeiten / erstellen
Zusammenfassung
Konfigurieren Sie ein Projekt für programmatischen Zugriff – Geräte-Zugriff als Dienst über die API – oder gewähren Sie Benutzern direkten Zugriff auf Geräte (geteiltes Gerät). Definieren Sie, welche Geräte zugänglich sind, legen Sie Sicherheitsanmeldeinformationen fest und steuern Sie die genauen gewährten Berechtigungen.
Seiten-Zugriff
Sie können auf diese Seite zugreifen, indem Sie zu Folgendem navigieren: /agentic
Seiten-Funktionalitäten
Diese Seite bietet die folgenden Funktionalitäten und interaktiven Elemente:
- Projekt-Schlüssel und -Geheimnis: Dies sind eindeutige Identifikatoren für Ihr Projekt. Bei neuen Projekten zeigt Platzhaltertext an, dass diese Schlüssel beim Speichern generiert werden. Bei bestehenden Projekten werden der tatsächliche Projekt-Schlüssel und das Projekt-Geheimnis angezeigt und können kopiert werden. Es gibt auch eine Schaltfläche, um einen E-Mail-Entwurf mit diesen Anmeldeinformationen für eine einfache Weitergabe zu erstellen.
- Name und Beschreibung:
- Projektname: Ein Textfeld, in das Sie den Namen Ihres Projekts eingeben. Es erfordert mindestens 3 Zeichen.
- Projektbeschreibung: Ein Textfeld zur Angabe einer detaillierten Beschreibung Ihres Projekts, das bis zu 5 Textzeilen zulässt.
- Geräte auswählen: In diesem Abschnitt können Sie auswählen, auf welche Ihrer registrierten Geräte das Projekt zugreifen kann.
- Kontrollkästchen "Alle Geräte auswählen": Wählt schnell alle verfügbaren Geräte aus oder hebt die Auswahl auf.
- Individuelle Geräte-Kontrollkästchen: Jedes registrierte Gerät wird mit einem eigenen Kontrollkästchen aufgeführt, sodass Sie bestimmte Geräte auswählen können.
- Berechtigungen festlegen: Dieser entscheidende Abschnitt bestimmt, welche Aktionen Ihr Projekt auf den ausgewählten Geräten ausführen kann. Sie müssen zwischen zwei primären Zugriffsmodi wählen:
Zugriff über Benutzerverbindungen zulassen (awaBerry Anywhere)
Dieser Modus ermöglicht den direkten Geräte-Zugriff über awaBerry Anywhere. Benutzer können sich mit einem Standardkonto ('awaberry') über das Terminal mit Geräten verbinden. Durch die Aktivierung dieses Modus können Sie auch weitere Optionen aktivieren:
- Starten / Stoppen von Remote Desktop zulassen: Benutzer mit gemeinsam genutztem Geräte-Zugriff können Remote Desktop (VNC / RDP-basiert) Verbindungen selbst starten oder stoppen.
- Starten / Stoppen von Web-To-Local-Ports zulassen: Benutzer können Web-To-Local-Port-Verbindungen starten oder stoppen. Dies ist schreibgeschützt; sie können keine neuen Port-Konfigurationen hinzufügen.
Zugriff über programmatischen Zugriff zulassen (awabBerry agentic API)
Dieser Modus ist für Projekte gedacht, die über die awaBerry agentic API mit Geräten interagieren. Wenn "Administratorberechtigungen zulassen" aktiviert ist, wird das Projekt auf Linux-Systemen als Root-Benutzer ausgeführt, was für Aufgaben wie die Systemkonfiguration empfohlen wird. Andernfalls wird es als Standardbenutzer 'awaberry' (Home-Verzeichnis '/home/awaberry') ausgeführt, was für den Dateizugriff oder die Ausführung von Anwendungen empfohlen wird.
- Administratorberechtigungen zulassen: Gewährt dem Projekt Root-Privilegien auf Linux-basierten Systemen.
- Ordnerzugriff:
- Zugriff auf alle Ordner zulassen: Gewährt uneingeschränkten Dateisystemzugriff.
- Zugriff auf folgende Ordner beschränken: Beschränkt den Zugriff auf bestimmte Ordner, die Sie definieren. Wenn ausgewählt, können Sie:
- In Ordner schreiben: Ermöglicht dem Projekt, Daten in die angegebenen Ordner zu schreiben.
- Unterordner erstellen und in diese schreiben: Ermöglicht dem Projekt, neue Unterordner zu erstellen und in diese innerhalb der erlaubten Pfade zu schreiben.
- Feld und Schaltfläche "Ordner hinzufügen": Geben Sie absolute Pfade ein (z. B.
/home/awaberry/data/), um bestimmte Ordner zur erlaubten Liste hinzuzufügen.
- Befehlsausführung:
- Alle Befehle zulassen: Gewährt die Berechtigung, beliebige Befehle auf dem Gerät auszuführen.
- Auf folgende Befehle beschränken: Beschränkt die Befehlsausführung auf eine bestimmte Liste von Befehlen, die Sie definieren.
- Feld und Schaltfläche "Befehl hinzufügen": Geben Sie spezifische Befehlsnamen ein, um sie zur erlaubten Liste hinzuzufügen.
- Konfiguration der Upload/Download-Berechtigungen: Schaltflächen unten rechts im Berechtigungsbereich:
- AgentProject aus Datei hochladen: Ermöglicht das Laden von Projektberechtigungs-Einstellungen aus einer JSON-Datei.
- AgentProject JSON herunterladen: Speichert die aktuelle Projektberechtigungs-Konfiguration als JSON-Datei auf Ihrem Gerät.
- Senden-Schaltfläche: Am unteren Rand der Seite entweder "Projekt erstellen" (für neue Projekte) oder "Projekt aktualisieren" (für bestehende Projekte), um Ihre Konfigurationen zu speichern.
Szenario-Ausführungen
Mögliche Nutzungsschritte auf dieser Seite:
Hier sind Beispiele, wie Sie diese Seite erfolgreich nutzen könnten:
- Neues Projekt mit grundlegendem API-Zugriff erstellen:
Konfigurieren Sie ein Projekt für programmatischen Zugriff, das mit einem Ihrer Geräte mit Standardbenutzerberechtigungen und vollem Ordner-/Befehlszugriff interagieren kann.
- Navigieren Sie zur Seite "Agentic Projekt bearbeiten / erstellen".
- Stellen Sie sicher, dass oben "Neues Projekt erstellen" angezeigt wird.
- Wählen Sie den Abschnitt "Zugriff über programmatischen Zugriff zulassen (awabBerry agentic API)".
- Geben Sie einen eindeutigen Namen (z. B. "MeinAutomatisierungsprojekt") in das Feld "Projektnamen eingeben" ein.
- Geben Sie eine Beschreibung (z. B. "Automatisiert tägliche Berichte für meinen Server") in das Feld "Projektbeschreibung eingeben" ein.
- Wählen Sie im Abschnitt "Geräte auswählen" das Kontrollkästchen neben mindestens einem Gerät aus, das dieses Projekt steuern soll.
- Lassen Sie das Kontrollkästchen "Administratorberechtigungen zulassen" für den Standardbenutzerzugriff deaktiviert.
- Stellen Sie sicher, dass die Kontrollkästchen "Zugriff auf alle Ordner zulassen" und "Alle Befehle zulassen" für breiten Zugriff aktiviert sind.
- Klicken Sie auf die Schaltfläche "Projekt erstellen".
- Beobachten Sie eine Erfolgsmeldung wie "Projekt erstellt – Projekt-Schlüssel und -Geheimnis anzeigen" und notieren Sie sich den neu generierten Projekt-Schlüssel und das Projekt-Geheimnis.
- Bestehendes Projekt bearbeiten, um Terminal-Zugriff mit Remote Desktop-Berechtigung zu aktivieren:
Ändern Sie ein bestehendes Projekt, um direkte Benutzerverbindungen zu ermöglichen und Remote Desktop-Funktionen zu aktivieren.
- Navigieren Sie zur Seite "Agentic Projekt bearbeiten / erstellen" für ein bestehendes Projekt.
- Stellen Sie sicher, dass oben "Bestehendes Projekt bearbeiten" angezeigt wird.
- Überprüfen Sie, ob der bestehende Projekt-Schlüssel und das Projekt-Geheimnis angezeigt werden.
- Wählen Sie den Abschnitt "Zugriff über Benutzerverbindungen zulassen (awaBerry Anywhere)" aus, indem Sie auf dessen Kopfzeile klicken.
- Aktivieren Sie das Kontrollkästchen neben "Starten / Stoppen von Remote Desktop zulassen".
- Klicken Sie auf die Schaltfläche "Projekt aktualisieren".
- Beobachten Sie eine Erfolgsmeldung wie "Projekt aktualisiert."
- Begrenzten Ordnerzugriff für ein API-Projekt konfigurieren:
Beschränken Sie ein API-fähiges Projekt so, dass es nur auf bestimmte Verzeichnisse auf einem Gerät zugreifen kann.
- Navigieren Sie zur Seite "Agentic Projekt bearbeiten / erstellen" für ein bestehendes Projekt mit API-Zugriff.
- Stellen Sie sicher, dass "Zugriff über programmatischen Zugriff zulassen (awabBerry agentic API)" ausgewählt ist.
- Deaktivieren Sie im Berechtigungsbereich "Zugriff auf alle Ordner zulassen".
- Geben Sie im nun sichtbaren Abschnitt "Zugriff auf folgende Ordner beschränken" einen gültigen absoluten Ordnerpfad (z. B.
/home/awaberry/data/) in das Feld "Ordner hinzufügen" ein. - Klicken Sie auf die Schaltfläche "Hinzufügen" neben dem Ordner-Eingabefeld.
- Aktivieren Sie optional "In Ordner schreiben" und "Unterordner erstellen und in diese schreiben", je nach Ihren Anforderungen.
- Klicken Sie auf die Schaltfläche "Projekt aktualisieren".
- Beobachten Sie eine Erfolgsmeldung wie "Projekt aktualisiert."
Mögliche Fehler, die auf dieser Seite auftreten können:
Das Verständnis potenzieller Fehler hilft bei der Fehlerbehebung:
- Fehler: "Bitte wählen Sie mindestens ein Gerät aus."
Warum es passiert: Sie haben versucht, ein Projekt zu speichern, ohne es mit Geräten zu verknüpfen. Jedes Projekt benötigt mindestens ein Gerät, um zu funktionieren.
- Fehler: "Bitte fügen Sie mindestens einen erlaubten Ordner hinzu."
Warum es passiert: Sie haben sich entschieden, den Ordnerzugriff für ein API-Projekt zu beschränken, aber keine Ordner in der Liste angegeben. Das Projekt benötigt explizite Ordnerpfade, auf die zugegriffen werden kann, wenn der Zugriff eingeschränkt ist.
- Fehler: "Bitte fügen Sie mindestens einen erlaubten Befehl hinzu."
Warum es passiert: Ähnlich wie beim Ordnerzugriff müssen Sie, wenn Sie Befehle für ein API-Projekt einschränken möchten, eine Liste erlaubter Befehle angeben. Das Projekt kann keine Befehle ausführen, wenn keine expliziten Berechtigungen erteilt werden.
- Fehler: "Ungültiger Ordnerpfad."
Warum es passiert: Beim Hinzufügen eines Ordners zur erlaubten Liste entsprach der eingegebene Pfad nicht dem erforderlichen Format (z. B. muss es ein absoluter Pfad sein, der mit einem Schrägstrich beginnt und endet, wie
/home/user/data/). - Fehler: "Fehler beim Erstellen des Projekts – bitte versuchen Sie es erneut." oder "Fehler beim Aktualisieren des Projekts – bitte versuchen Sie es erneut."
Warum es passiert: Dies sind allgemeine Fehler, die normalerweise auf ein Problem mit der Serverkommunikation oder Ihrer Internetverbindung während des Speichervorgangs hinweisen. Überprüfen Sie Ihr Netzwerk und versuchen Sie es erneut.
- Fehler: "Berechtigungen aus der bereitgestellten Datei konnten nicht gelesen werden."
Warum es passiert: Bei Verwendung der Option "AgentProject aus Datei hochladen" war die ausgewählte Datei entweder nicht im gültigen JSON-Format oder ihr Inhalt entsprach nicht der erwarteten Struktur für Projektberechtigungs-Konfigurationen.
