Configuration
Every OpenBucket setting — standalone environment variables and the forRoot module options — with defaults, requirements, and notes.
OpenBucketService API
The injectable in-process facade for uploading, reading, listing, and deleting objects, managing buckets, and minting presigned URLs.
S3 compatibility
The matrix of supported S3 operations — buckets, objects, multipart, versioning, tagging, ACL, policy, CORS, lifecycle, object-lock, presign — plus known limitations.
CLI reference
The dependency-free openbucket CLI — every command, argument, flag, and exit code for scripting a running instance.
Admin API
The JSON admin API under mountPath/api/admin — the JWT auth flow, the typed api-client, and every endpoint group.
NestJS module reference
The full reference for @openbucket/nestjs —