Files
rustfs/README.md
安正超 a4d49a500f feat: Enhanced Docker Build System with Advanced Version Selection (#186)
* feat: enhance Docker build system with advanced version selection

## New Features
- Add force_rebuild parameter for Docker workflow manual triggers
- Improve version pattern matching with better regex validation
- Add comprehensive Docker Build Guide documentation
- Enhanced logging and error reporting for build process
- Support for prerelease version detection (alpha, beta, rc)

## Improvements
- Better version pattern validation for releases and dev builds
- More detailed build logs with context and warnings
- Clear documentation for all Docker image variants and use cases
- Updated README with Docker version examples and guide reference

## Documentation
- New comprehensive Docker Build Guide (docs/DOCKER_BUILD_GUIDE.md)
- Updated README with version-specific Docker examples
- Workflow dependency diagram and troubleshooting guide
- Complete reference for all supported version patterns

This enhancement provides a robust, well-documented Docker build system
that supports flexible version selection while maintaining deterministic
build behavior without fallback mechanisms.

* fix: simplify dev version regex pattern in docker workflow

* fix: simplify version number regex pattern in docker workflow

* feat: remove docs directory
2025-07-12 11:31:00 +08:00

7.3 KiB
Raw Blame History

RustFS

RustFS is a high-performance distributed object storage software built using Rust

CI Build and Push Docker Images GitHub commit activity Github Last Commit Featured|HelloGitHub

Getting Started · Docs · Bug reports · Discussions

English | 简体中文 | Deutsch | Español | français | 日本語 | 한국어 | Português | Русский

RustFS is a high-performance distributed object storage software built using Rust, one of the most popular languages worldwide. Along with MinIO, it shares a range of advantages such as simplicity, S3 compatibility, open-source nature, support for data lakes, AI, and big data. Furthermore, it has a better and more user-friendly open-source license in comparison to other storage systems, being constructed under the Apache license. As Rust serves as its foundation, RustFS provides faster speed and safer distributed features for high-performance object storage.

⚠️ RustFS is under rapid development. Do NOT use in production environments!

Features

  • High Performance: Built with Rust, ensuring speed and efficiency.
  • Distributed Architecture: Scalable and fault-tolerant design for large-scale deployments.
  • S3 Compatibility: Seamless integration with existing S3-compatible applications.
  • Data Lake Support: Optimized for big data and AI workloads.
  • Open Source: Licensed under Apache 2.0, encouraging community contributions and transparency.
  • User-Friendly: Designed with simplicity in mind, making it easy to deploy and manage.

RustFS vs MinIO

Stress test server parameters

Type parameter Remark
CPU 2 Core Intel Xeon(Sapphire Rapids) Platinum 8475B , 2.7/3.2 GHz
Memory 4GB  
Network 15Gbp  
Driver 40GB x 4 IOPS 3800 / Driver

https://github.com/user-attachments/assets/2e4979b5-260c-4f2c-ac12-c87fd558072a

RustFS vs Other object storage

RustFS Other object storage
Powerful Console Simple and useless Console
Developed based on Rust language, memory is safer Developed in Go or C, with potential issues like memory GC/leaks
Does not report logs to third-party countries Reporting logs to other third countries may violate national security laws
Licensed under Apache, more business-friendly AGPL V3 License and other License, polluted open source and License traps, infringement of intellectual property rights
Comprehensive S3 support, works with domestic and international cloud providers Full support for S3, but no local cloud vendor support
Rust-based development, strong support for secure and innovative devices Poor support for edge gateways and secure innovative devices
Stable commercial prices, free community support High pricing, with costs up to $250,000 for 1PiB
No risk Intellectual property risks and risks of prohibited uses

Quickstart

To get started with RustFS, follow these steps:

  1. One-click installation script (Option 1)

    curl -O  https://rustfs.com/install_rustfs.sh && bash install_rustfs.sh
    
  2. Docker Quick Start (Option 2)

 # Latest stable release
 docker run -d -p 9000:9000 -v /data:/data rustfs/rustfs:latest

 # Development version (main branch)
 docker run -d -p 9000:9000 -v /data:/data rustfs/rustfs:main-latest

 # Specific version
 docker run -d -p 9000:9000 -v /data:/data rustfs/rustfs:v1.0.0

💡 Docker Build Options: RustFS supports flexible Docker image versions. See our Docker Build Guide for advanced usage and manual build instructions.

  1. Access the Console: Open your web browser and navigate to http://localhost:9000 to access the RustFS console, default username and password is rustfsadmin .
  2. Create a Bucket: Use the console to create a new bucket for your objects.
  3. Upload Objects: You can upload files directly through the console or use S3-compatible APIs to interact with your RustFS instance.

Documentation

For detailed documentation, including configuration options, API references, and advanced usage, please visit our Documentation.

Getting Help

If you have any questions or need assistance, you can:

  • Check the FAQ for common issues and solutions.
  • Join our GitHub Discussions to ask questions and share your experiences.
  • Open an issue on our GitHub Issues page for bug reports or feature requests.

Contact

Contributors

RustFS is a community-driven project, and we appreciate all contributions. Check out the Contributors page to see the amazing people who have helped make RustFS better.

License

Apache 2.0

RustFS is a trademark of RustFS, Inc. All other trademarks are the property of their respective owners.