Home
VersityGW is a high-performance, Apache-2.0-licensed translation service that exposes an S3-compatible API over POSIX filesystems, ScoutFS, Azure Blob Storage, other S3 services, and custom backends.
Use this wiki to deploy a gateway, configure access and operational services, or extend the project in Go.
| Goal | Start here |
|---|---|
| Run a local filesystem-backed gateway | Quickstart |
| Check supported platforms and prerequisites | System Requirements |
| Install a release | Linux Installation |
| Understand command placement and startup | Workflow |
| Configure global listeners and services | Global Options |
| Configure an S3 client | Example Client Configurations |
| Diagnose a failure | Troubleshooting |
| Backend | Use case |
|---|---|
| POSIX | Transparent filesystem namespace with extended-attribute or sidecar metadata |
| ScoutFS | ScoutFS-specific multipart and archive integration |
| S3 proxy | Translate and proxy requests to another S3 service |
| Azure Blob | Store S3 objects in Azure containers and blobs |
| Plugin | Load an out-of-tree Go backend plugin |
- Access Control / IAM introduces built-in identity backends; Standalone IAM provides the separate AWS-compatible IAM and STS service.
- Bucket Policies, Identity Policies, and Policy Conditions document authorization.
- Static Website Hosting serves public bucket content with index pages, errors, redirects, and CORS.
- WebGUI provides browser-based administration and object management.
- S3 RDMA documents accelerated cuObject and hipObject transfers.
- TLS, Virtual Host Addressing, and Load Balancing
- Metrics, Access Logging, and Event Notifications
- Admin APIs and Health Checks
- Docker and Helm
- AWS S3 Incompatibilities
- Contributing Changes
- Embedding VersityGW
- Adding a Backend
- Writing a Plugin Backend
- Project Testing, Running Tests, and Integration Test Suites
- Debugging and Profiling
The code lives at github.com/versity/versitygw. Use GitHub Discussions for questions and GitHub Issues for bugs and feature requests.
Home · Quickstart · Configuration · Operations · Testing · Developer Guide · GitHub · Discussions · Issues
Apache 2.0 · @versitysoftware · LinkedIn · X · Facebook · Instagram