Tool descriptions were leaking internal vocabulary (Django superuser,
Postgres bcrypt update, htpasswd in protectionauth.yml, gitea admin
user change-password CLI, trusted_domains list, …) and repeating the
label as a full sentence. Beginners don't care, and even experienced
users don't need the CLI name to know what a button does.
Rewrites every tool description to a single short sentence plain
enough that a first-time installer can read it without context.
Conventions applied across the board:
- One sentence, sentence-case
- Plain English: "Set a new password", "Add a new user",
"Permanently remove a user", "List every user"
- "Leave blank to generate one" only where it's actually useful
(password fields), and matches the field placeholder text
- No CLI names, no schema field names, no internal file paths
- Destructive actions stop saying "permanently" twice (the action
label + the confirm modal already cover that)
- Field placeholders harmonised: "Leave blank for random" /
"Leave blank to generate" → consistently "Leave blank to generate"
Touched files (descriptions only — no logic, no fields removed):
containers/adguard/tools/adguard.tools.json
containers/bookstack/tools/bookstack.tools.json
containers/dashy/tools/dashy.tools.json
containers/focalboard/tools/focalboard.tools.json
containers/gitea/tools/gitea.tools.json
containers/gluetun/tools/gluetun.tools.json
containers/invidious/tools/invidious.tools.json
containers/linkding/tools/linkding.tools.json
containers/nextcloud/tools/nextcloud.tools.json
containers/pihole/tools/pihole.tools.json
containers/traefik/tools/traefik.tools.json
Signed-off-by: librelad <librelad@digitalangels.vip>
178 lines
4.2 KiB
JSON
178 lines
4.2 KiB
JSON
{
|
||
"tools": [
|
||
{
|
||
"id": "reset_password",
|
||
"category": "users",
|
||
"label": "Reset User Password",
|
||
"description": "Set a new password for an existing user. Leave blank to generate one.",
|
||
"icon": "🔑",
|
||
"fields": [
|
||
{
|
||
"name": "username",
|
||
"label": "Username",
|
||
"type": "text",
|
||
"placeholder": "alice",
|
||
"required": true
|
||
},
|
||
{
|
||
"name": "password",
|
||
"label": "New password",
|
||
"type": "password",
|
||
"placeholder": "Leave blank to generate"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "create_account",
|
||
"category": "users",
|
||
"label": "Create User Account",
|
||
"description": "Add a new user. Tick \"Make admin\" for full rights.",
|
||
"icon": "👤",
|
||
"fields": [
|
||
{
|
||
"name": "username",
|
||
"label": "Username",
|
||
"type": "text",
|
||
"placeholder": "alice",
|
||
"required": true
|
||
},
|
||
{
|
||
"name": "display_name",
|
||
"label": "Display name",
|
||
"type": "text",
|
||
"placeholder": "Alice Smith"
|
||
},
|
||
{
|
||
"name": "password",
|
||
"label": "Password",
|
||
"type": "password",
|
||
"placeholder": "Leave blank to generate"
|
||
},
|
||
{
|
||
"name": "admin",
|
||
"label": "Make admin",
|
||
"type": "checkbox",
|
||
"default": false
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "list_users",
|
||
"category": "users",
|
||
"label": "List Users",
|
||
"description": "List every user.",
|
||
"icon": "📋",
|
||
"fields": []
|
||
},
|
||
{
|
||
"id": "delete_user",
|
||
"category": "users",
|
||
"label": "Delete User Account",
|
||
"description": "Permanently remove a user and all their files.",
|
||
"icon": "🗑",
|
||
"destructive": true,
|
||
"confirm": "This cannot be undone.",
|
||
"fields": [
|
||
{
|
||
"name": "username",
|
||
"label": "Username",
|
||
"type": "text",
|
||
"required": true
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "set_admin",
|
||
"category": "users",
|
||
"label": "Set Admin Status",
|
||
"description": "Promote or demote a user.",
|
||
"icon": "👑",
|
||
"fields": [
|
||
{
|
||
"name": "username",
|
||
"label": "Username",
|
||
"type": "text",
|
||
"required": true
|
||
},
|
||
{
|
||
"name": "admin",
|
||
"label": "Make admin",
|
||
"type": "checkbox",
|
||
"default": false
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "toggle_maintenance",
|
||
"category": "maintenance",
|
||
"label": "Toggle Maintenance Mode",
|
||
"description": "Lock users out so you can run upgrades or repairs safely.",
|
||
"icon": "🚧",
|
||
"fields": [
|
||
{
|
||
"name": "enable",
|
||
"label": "Enable maintenance mode",
|
||
"type": "checkbox",
|
||
"default": true
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "rescan_files",
|
||
"category": "maintenance",
|
||
"label": "Rescan Files",
|
||
"description": "Pick up files added or removed outside Nextcloud. Leave blank to scan everyone.",
|
||
"icon": "🔄",
|
||
"fields": [
|
||
{
|
||
"name": "username",
|
||
"label": "Username (blank = all users)",
|
||
"type": "text",
|
||
"placeholder": "blank for all"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "add_trusted_domain",
|
||
"category": "system",
|
||
"label": "Add Trusted Domain",
|
||
"description": "Let Nextcloud answer at a new hostname.",
|
||
"icon": "🌐",
|
||
"fields": [
|
||
{
|
||
"name": "domain",
|
||
"label": "Domain",
|
||
"type": "text",
|
||
"placeholder": "cloud.example.org",
|
||
"required": true
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"id": "system_status",
|
||
"category": "system",
|
||
"label": "System Status",
|
||
"description": "Show version and current state.",
|
||
"icon": "ℹ️",
|
||
"fields": []
|
||
},
|
||
{
|
||
"id": "tail_logs",
|
||
"category": "system",
|
||
"label": "Tail Logs",
|
||
"description": "Show the last few log lines.",
|
||
"icon": "📜",
|
||
"fields": [
|
||
{
|
||
"name": "lines",
|
||
"label": "Lines",
|
||
"type": "number",
|
||
"default": 100,
|
||
"min": 10,
|
||
"max": 1000
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|