https://github.com/initify/bucketx
A powerful, self-hosted cloud storage solution for managing image storage, optimization, and delivery
https://github.com/initify/bucketx
cloud cloudstorage dashboard docker gin go nextjs self-hosted typescript
Last synced: 3 months ago
JSON representation
A powerful, self-hosted cloud storage solution for managing image storage, optimization, and delivery
- Host: GitHub
- URL: https://github.com/initify/bucketx
- Owner: Initify
- Created: 2025-01-09T16:24:25.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-22T08:54:29.000Z (3 months ago)
- Last Synced: 2025-03-30T01:45:47.689Z (3 months ago)
- Topics: cloud, cloudstorage, dashboard, docker, gin, go, nextjs, self-hosted, typescript
- Language: TypeScript
- Homepage:
- Size: 12.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Bucket X
A powerful, self-hosted cloud storage solution for managing image storage, optimization, and delivery
[](https://opensource.org/licenses/MIT)
[](https://goreportcard.com/report/github.com/TeamXSeven/bucketX)
[](https://github.com/TeamXSeven/bucketX)
[](https://teamxseven.github.io/bucketX/)
[](https://github.com/TeamXSeven/bucketX/blob/main/CONTRIBUTING.md)
## ✨ Features
bucketX offers a complete solution for managing your image assets with enterprise-grade features:
- Intelligent Deduplication**: Automatically detects and eliminates duplicate images using perceptual hashing
- Advanced Compression**: Optimizes image sizes without compromising visual quality
- Format Conversion**: Converts images to modern formats like WebP, AVIF, and JPEG XL for optimal delivery
- Dynamic Transformations**: Performs on-the-fly resizing and smart cropping based on content awareness
- Secure Access Control**: Granular permission system with API keys and token authentication
- Performance Optimization**: Built-in CDN integration and caching for blazing-fast delivery
- Usage Analytics**: Track storage, bandwidth, and transformation metrics
- API-First Design**: Comprehensive REST API with excellent documentation
## Dashboard Interface
The dashboard serves as the central interface for managing storage operations. From here, you can:
- **Upload Images & Files** – Easily upload and manage your objects within different buckets.
- **Create & Manage Buckets** – Organize your stored data efficiently by creating and managing buckets.
- **Generate Access Keys** – Create secure access keys for authentication and permission management.
- **View Existing Objects** – Browse through all stored objects and their metadata in a structured view.
- **Manage User Access & Permissions** – Control who can access specific objects and perform operations.
This intuitive interface allows seamless interaction with your storage system, providing a streamlined experience for users.
## Installation
```bash
git clone https://github.com/TeamXSeven/bucketX.git
```
## Usage
```bash
cd bucketX
go mod download
air # also can use 'go run main.go'
```
### Generate Swagger Docs
```bash
swag init -g main.go --parseDependency --parseInternal
```
### Fix go dependencies tree
```bash
go mod tidy
```
### Docker
```bash
docker compose up -d
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to
discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)