feat(design): cyan accent, dialog overflow fixes, unified delete buttons, nav polish
This commit is contained in:
@@ -0,0 +1,104 @@
|
||||
|
||||
# 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](/docs/handbook/redundanz)).
|
||||
|
||||
## "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`](/docs/reference/endpoints/users#createUser),
|
||||
[`PATCH /users/{id}`](/docs/reference/endpoints/users#updateUser),
|
||||
[`DELETE /users/{id}`](/docs/reference/endpoints/users#deleteUser).
|
||||
|
||||
## "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:**
|
||||
|
||||
```csv
|
||||
name;description;category;features;tags
|
||||
Grafana;Observability and dashboard platform;Monitoring;Dashboards|Alerts;devops
|
||||
Prometheus;Time-series database;Monitoring;Metrics;devops
|
||||
```
|
||||
|
||||
**JSON example:**
|
||||
|
||||
```json
|
||||
[
|
||||
{ "name": "Grafana", "category": "Monitoring", "features": ["Dashboards"] },
|
||||
{ "name": "Prometheus", "category": "Monitoring" }
|
||||
]
|
||||
```
|
||||
|
||||
**YAML example:**
|
||||
|
||||
```yaml
|
||||
- name: Grafana
|
||||
category: Monitoring
|
||||
features:
|
||||
- Dashboards
|
||||
- name: Prometheus
|
||||
category: Monitoring
|
||||
```
|
||||
|
||||
A larger, ready-to-import example file is located at
|
||||
`docs/examples/import-tools.yaml` (24 common enterprise tools).
|
||||
|
||||
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`](/docs/reference/endpoints/audit#listAuditLogs).
|
||||
|
||||
## "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").
|
||||
|
||||
## Tool links (Admin)
|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user