Help & Administration

Technical overview and the most important fld CLI commands. All commands accept --env/-e production|development|testing (default: production) and -h for help.

Server & database

  • fld dash start|stop|status — Run and stop the dashboard (Flask in development and production, optional: Gunicorn in production)
  • fld dash generate-secret-key — Print a value for FLSHBD_SECRET_KEY, which keeps sessions valid across restarts
  • fld db init|migrate|backup|restore — Create the DB, import static demo data, back up and restore it.
  • fld db config get|set|list — Dashboard title and admin messages info/important shown on the login page

Users, groups, sites & access

  • fld user|group|site|site-group list|add|modify|delete — Manage entities; -v shows details (e.g. site URLs), --sort-order orders the sidebar
  • fld access list|grant|revoke — Which user group may see which site group
  • Template sites use a partial from web/templates/partials/ (--template info_site.html); iframe sites need a --url

Environment variables

  • FLSHBD_SECRET_KEY — Stable session-cookie signing key
  • FLSHBD_COOKIE_DOMAIN — E.g., .example.com, needed to share the session with subdomains
  • FLSHBD_SESSION_LIFETIME — Session inactivity timeout in seconds (default: 1800)
  • FLSHBD_PAM_ENABLED & FLSHBD_PAM_SERVICE — System (PAM) login instead of DB-stored passwords
  • All FLSHBD_* vars can also be set in .env in the data dir (auto-created on first start; needs pip install flshbd[dotenv])

Documentation (Markdown)

  • Project root: README.md (usage & setup), CHANGELOG.md, AGENTS.md (dev notes)
  • docs/nginx_auth.md — Protecting subdomain services with Nginx auth_request (incl. demo page)
  • docs/pamconfig.md — PAM setup; docs/validation.md — validation notes
  • Source & issues: codeberg.org/rokor/flshbd