# HugBucket

## Docs

- [Introduction](https://mintlify.wiki/sachnun/hugbucket/introduction.md): Multi-protocol gateway for Hugging Face Storage Buckets — expose your HF datasets and model files via S3 or FTP.
- [Quick Start](https://mintlify.wiki/sachnun/hugbucket/quickstart.md): Get HugBucket running in minutes with Docker
- [Docker Deployment](https://mintlify.wiki/sachnun/hugbucket/deployment/docker.md): Deploy HugBucket using Docker
- [Environment Variables](https://mintlify.wiki/sachnun/hugbucket/deployment/environment-variables.md): Full reference for all HugBucket configuration environment variables
- [S3 Protocol](https://mintlify.wiki/sachnun/hugbucket/protocols/s3.md): Using HugBucket as an S3-compatible gateway
- [FTP Protocol](https://mintlify.wiki/sachnun/hugbucket/protocols/ftp.md): Using HugBucket as an FTP gateway
- [Architecture overview](https://mintlify.wiki/sachnun/hugbucket/architecture/overview.md): How HugBucket translates S3/FTP operations into Hugging Face Xet storage
- [Xet storage](https://mintlify.wiki/sachnun/hugbucket/architecture/xet-storage.md): How HugBucket implements the Xet content-addressable storage protocol
- [Bridge layer](https://mintlify.wiki/sachnun/hugbucket/architecture/bridge.md): The HFStorageBackend that maps storage operations to HF Hub and Xet CAS
- [Development Setup](https://mintlify.wiki/sachnun/hugbucket/development/setup.md): Set up a local HugBucket development environment
- [Configuration Reference](https://mintlify.wiki/sachnun/hugbucket/development/configuration.md): All configuration options for HugBucket via the Config dataclass
- [Testing](https://mintlify.wiki/sachnun/hugbucket/development/testing.md): Running and writing tests for HugBucket

## OpenAPI Specs

- [openapi](https://mintlify.wiki/sachnun/hugbucket/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.