BucketReef - S3-compatible object storage management¶
BucketReef is an open-source web application for managing S3-compatible object storage with IAM-aligned workflows.
Project status: Beta. Suitable for evaluation and controlled deployments.
Start from what you need to do¶
| I need to... | Start with | Why |
|---|---|---|
| Use storage, upload files, download files, or recover versions | User Guide / Start Here | It explains the workspace selector, account context, and the difference between Portal and Browser. |
| Work in a simple self-service storage area | Portal overview | Portal is the end-user workspace for Storage Spaces, simple sharing, access keys, usage, and preferences. |
| Manage buckets, IAM, topics, and account-level tools | Manager overview | Manager keeps S3 and IAM operations account-scoped and explicit. |
| Operate the platform, users, endpoints, settings, audit, or billing | Storage admin runbook | It connects Admin, Manager, Browser, Portal, and Ops checks into one handover path. |
| Administer Ceph RGW cluster resources | Ceph Admin overview | Ceph Admin is separate from Manager because it acts at cluster scope. |
| Deploy, secure, or troubleshoot the application | Ops / Sysadmin onboarding | It routes operators to deployment, configuration, security, scheduler, backup, and troubleshooting pages. |
| Evaluate a clean local installation | Local quickstart | It starts backend/frontend and guides the one-time first-administrator setup. |
| Make a first contribution | Developer / First Contribution | It points to architecture, local setup, validation, and documentation rules. |
Documentation by audience¶
- User Guide: concrete workflows for storage administrators and storage users.
- Ops / Sysadmin Guide: installation, deployment, security, and day-2 operations.
- Developer Guide: high-level architecture and core principles.
Product surfaces¶
- Admin (
/admin): platform governance, endpoints, users, settings. - Manager (
/manager): account-scoped bucket and IAM operations. - Portal (
/portal): explicit self-service workspace backed by RGW IAM. - Browser (
/browser): object-level operations. - Ceph Admin (
/ceph-admin): Ceph RGW cluster-level administration (optional).
Quick links¶
- Start quickly as a user: User Guide / Start Here
- Choose a daily workflow: Common tasks for storage users
- Choose an admin workflow: Common tasks for storage administrators
- Prepare a team handover: Storage admin runbook
- Understand terms and search better: Glossary and Search Tips
- Start as an operator: Ops / Sysadmin onboarding
- Evaluate locally: Ops / Local quickstart
- Deploy quickly with containers: Ops / Deploy with Docker Compose
- Prepare production-like rollout: Ops / Production readiness
- Understand architecture: Developer / Architecture Overview