Files
tool-evaluator/docs/handbook/administration.en.md
T
opencode 8f2fd89847
Build & Push Docker Image / build (push) Successful in 2m49s
feat(import): bulk tool import (CSV/JSON/YAML) for admins; NetBox-style help button
- Add POST /admin/tools/import with format auto-detect, CSV delimiters
  (comma/semicolon/tab), per-row validation via CreateToolBody, bulk insert,
  audit log entries per imported tool; gated by new 'tool-import' feature
  flag (premium/enterprise; admins always pass)
- Add tool-import-dialog UI (format tabs, delimiter select, textarea, file
  upload, result/error list) behind hasFeature('tool-import')
- Replace FieldHelp question marks and bare GuideHelp links with a NetBox-style
  'Hilfe/Help' outline button (HelpCircle + text) in form headers only
- Sync locales to 482 keys per language (de/en), update handbook docs
  (administration import section, index/plaene feature tables), regenerate
  API client + zod schemas, add yaml dependency
2026-08-04 23:09:11 +02:00

3.3 KiB

title, order
title order
Administration 13

Administration

The Admin area (/admin) is exclusively accessible to admins. Without the admin role, access is denied.

At the top right, the Redundancy dashboard button leads to the automatic duplicate detection (see Redundancy).

"Users" tab

Management of local accounts.

  • Add user: username (required), password (at least 6 characters), email (optional), role (User/Admin), plan (Free/Premium/Enterprise).
  • Edit user: set role, plan and (for local accounts) a new password. For OIDC accounts, password management is offered in the identity provider (e.g. Keycloak).
  • Delete user: permanently removes the account (not for your own account).

API reference: POST /users, PATCH /users/{id}, DELETE /users/{id}.

"Tools" tab

Central access to the tool catalog.

  • Search for tools.

  • View, edit or move individual tools to the trash.

  • Bulk action: select multiple tools and move them to the trash (confirmation dialog; soft-deleted tools are removed from all public views and can be restored or permanently deleted).

  • Import (premium): via the Import button at the top right, multiple tools can be created at once. The format is detected automatically (CSV, JSON or YAML); for CSV the delimiter can be chosen (auto-detect, comma, semicolon or tab). Data can be pasted directly into the form or uploaded as a file.

    Supported fields: name (required), description, category, websiteUrl, iconUrl, features, tags (features/tags are |-separated lists).

    CSV example:

    name;description;category;features;tags
    Grafana;Observability and dashboard platform;Monitoring;Dashboards|Alerts;devops
    Prometheus;Time-series database;Monitoring;Metrics;devops
    

    JSON example:

    [
      { "name": "Grafana", "category": "Monitoring", "features": ["Dashboards"] },
      { "name": "Prometheus", "category": "Monitoring" }
    ]
    

    YAML example:

    - name: Grafana
      category: Monitoring
      features:
        - Dashboards
    - name: Prometheus
      category: Monitoring
    

    During import, individual faulty rows are skipped and listed with their row number; correct rows are still created. Every import produces audit-log entries.

"Audit log" tab

Chronological log of all creation, change and deletion operations (max. 100 entries): action, entity + ID, timestamp, executing person and changed fields.

API reference: GET /audit-logs.

"System" tab

Version information of the running instance:

  • Version (e.g. v0.8.1),
  • Commit (7-digit SHA, linked to the repository),
  • Build date,
  • Trash retention ("N days" or "Forever").

On the detail page of a tool you can manage links as an admin (own/"manual" as well as automatically detected ones):

  • Link tool: dialog with tool ID, relationship type (Similar / Replaces / Superseded by) and optional notes.
  • Relationship types are displayed as badges on the detail page.
  • Manual links can be removed again via the trash icon.