Skip to content

Ops / Sysadmin Guide

This section is for operators who deploy, secure, monitor, and recover BucketReef.

Start here

Situation First page Why
I am installing or taking over the service Sysadmin onboarding A fast path through deployment, secrets, endpoint setup, jobs, backup, and handover evidence.
I want a secured local evaluation quickly Local quickstart Starts backend/frontend only, then creates the first administrator through a one-time web link.
I need a lab or validation deployment Deploy with Docker Compose Manual Compose deployment, scheduler profile and production-like controls.
I need Kubernetes deployment details Deploy with Helm Chart values, images, CronJobs, and multi-replica notes.
I need to know which knob controls behavior Configuration Environment variables, app settings, feature locks, and symptom-to-setting lookup.
I need to publish to real users Production readiness One operator checklist for secrets, database, scheduler, access, audit, and support.
I need to debug an incident or user report Observability Maps user symptoms to operator checks and evidence.

Operator workflows

Workflow Pages
Deploy Local quickstart, Docker Compose, Helm, Configuration
Secure Security, Production readiness, API tokens
Monitor Healthchecks, Observability, Billing, Quota monitoring and history
Recover Backup and restore, Upgrade and compatibility
Integrate backends Compatibility matrix, Ceph RGW, Other S3 implementations

First rollout checklist

  1. Choose the deployment mode and image tag policy.
  2. Configure non-default secrets, CORS, TLS, database persistence, and INTERNAL_CRON_TOKEN.
  3. Configure the first endpoint and verify its healthcheck result.
  4. Decide which workspaces and feature flags are ready for the first users.
  5. Confirm scheduler or CronJob behavior for healthchecks, usage history, billing, and quota monitoring.
  6. Confirm backup, restore, and credential encryption key ownership.
  7. Run the Storage Admin Runbook before announcing the workspace.
  8. Keep User troubleshooting and Observability ready for support handover.