Skip to content

CLI reference

Self-hosted forums are administered from the command line with bluset. Run it inside the container (docker exec -it bluset bluset <command>). This page lists the commands operators use most; run bluset --help (or bluset <group> --help) for the complete, version-accurate list.

Command What it does
bluset install Build the schema and seed roles, permissions, settings, an admin, and a welcome forum. Idempotent (guarded by a table-exists check). Flags include --nointeractive, --skip-admin, --no-plugins, --force.
bluset create-admin -u <user> -e <email> -p <pass> Create/ensure an admin account. Works even after install; no default credentials.
bluset seed-features Seed the feature bundle from FORUM_ENABLED / API_ENABLED / FEATURE_SET. Idempotent; safe to run every boot.
bluset db upgrade Apply database migrations.
bluset upgrade --all Run migrations plus fixtures (bare upgrade needs --all or --fixture to do anything).
bluset reindex Rebuild the full-text search index.
bluset backup-db Dump the database.
bluset makeconfig Generate a bluset.cfg file interactively.
bluset run The Flask development server (not for production — production is served by Gunicorn via the image entrypoint).
bluset celery ... Run Celery worker/beat.
bluset shell An application shell.
Command What it does
bluset users new / update / delete Manage user accounts (group ∈ admin / super_mod / mod / member).
bluset users anonymize <user> Right to erasure. Scrub identity, profile, IPs, MFA, and password; remove API keys, linked identities, notes, and invites; rewrite the user’s name off their content (kept as deleted user); scrub help-desk requester emails. Idempotent.
bluset users export <user> --output <file> Right to portability. Full JSON export of the user’s data (including their soft-deleted content), excluding secret material.
bluset users scrub-ips --days <N> Retention. Null stored login IP addresses for accounts inactive beyond N days (default 90). Supports --dry-run; cron-friendly.

See Data privacy & GDPR for the policy context.

Command What it does
bluset features list Show current feature flags.
bluset features enable-all / disable-all Toggle everything.
bluset features enable-web / disable-web Toggle the web interface.
bluset features enable-api / disable-api Toggle the API interface.

These are runtime overrides of the boot-seeded bundle. Add --no-clear-cache to skip the cache flush.

Command What it does
bluset plugins new / install / uninstall / cleanup / list Manage plugins (enable / disable toggle an installed plugin; cleanup removes orphaned data).
bluset themes new / remove / list Manage themes.
bluset translations new / update / compile Manage translation catalogs.
bluset api generate-all-specs / bluset api list-apis Export OpenAPI specs / list API modules.