to select ↑↓ to navigate
Frappe Framework

Frappe Framework

Open in ChatGPT
Ask ChatGPT about this page
Open in Claude
Ask Claude about this page

Administration

Administration

Day-to-day administration of a Frappe site. On managed plans Prilk handles most of this; on self-hosted you'll do it via bench and the desk.

Roles

  • System Manager — full access to all DocTypes and settings. Give sparingly.
  • Administrator — the built-in superuser. Usually not used by humans; treat like root.
  • All — the default role for any user. Permissions added on top.

Configure roles via User → Role Profile and per-DocType Role Permissions Manager.

Common tasks

Task Command / Where
Create a backup bench --site mysite backup --with-files
Restore from backup bench --site mysite restore <sql-file>
Run migrations after an app update bench --site mysite migrate
Clear caches bench --site mysite clear-cache
Create a user Desk → User List → New
Inspect background jobs Desk → RQ Job
Schedule reports Desk → Report → Set "Send to Users"

Logs and diagnostics

  • bench logs — tail web, worker and scheduler logs
  • bench --site mysite show-pending-jobs
  • Error Log DocType for tracebacks

Backups

Built-in bench backup covers the database and (with --with-files) the public/private file directories. On Frappe Cloud and Prilk-managed, backups are automated daily with offsite retention.

Last updated 3 days ago
Was this helpful?
Thanks!