Repository files navigation

RustFS is a high-performance, distributed object storage system built in Rust.

Getting Started ·Docs ·Bug reports ·Discussions

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

RustFS is a high-performance, distributed object storage system built in Rust—one of the most loved programming languages worldwide. RustFS combines the simplicity of MinIO with the memory safety and raw performance of Rust. It offers full S3 compatibility, is completely open-source, and is optimized for data lakes, AI, and big data workloads.

Unlike other storage systems, RustFS is released under the permissible Apache 2.0 license, avoiding the restrictions of AGPL. With Rust as its foundation, RustFS delivers superior speed and secure distributed features for next-generation object storage.

• High Performance: Built with Rust to ensure maximum speed and resource efficiency.
• Distributed Architecture: Scalable and fault-tolerant design suitable for large-scale deployments.
• S3 Compatibility: Seamless integration with existing S3-compatible applications and tools.
• Data Lake Support: Optimized for high-throughput big data and AI workloads.
• Open Source: Licensed under Apache 2.0, encouraging unrestricted community contributions and commercial usage.
• User-Friendly: Designed with simplicity in mind for easy deployment and management.

Stress Test Environment:

To get started with RustFS, follow these steps:

curl -O https://rustfs.com/install_rustfs.sh&& bash install_rustfs.sh

The RustFS container runs as a non-root userrustfs (UID10001). If you run Docker with-v to mount a host directory, please ensure the host directory owner is set to10001, otherwise you will encounter permission denied errors.

# Create data and logs directories mkdir -p data logs# Change the owner of these directories chown -R 10001:10001 data logs# Using latest version docker run -d -p 9000:9000 -p 9001:9001 -v$(pwd)/data:/data -v$(pwd)/logs:/logs rustfs/rustfs:latest# Using specific version docker run -d -p 9000:9000 -p 9001:9001 -v$(pwd)/data:/data -v$(pwd)/logs:/logs rustfs/rustfs:1.0.0.alpha.68

You can also use Docker Compose. Using thedocker-compose.yml file in the root directory:

docker compose --profile observability up -d

NOTE: We recommend reviewing thedocker-compose.yaml file before running. It defines several services including Grafana, Prometheus, and Jaeger, which are helpful for RustFS observability. If you wish to start Redis or Nginx containers, you can specify the corresponding profiles.

For developers who want to build RustFS Docker images from source with multi-architecture support:

# Build multi-architecture images locally./docker-buildx.sh --build-arg RELEASE=latest# Build and push to registry./docker-buildx.sh --push# Build specific version./docker-buildx.sh --release v1.0.0 --push# Build for custom registry./docker-buildx.sh --registry your-registry.com --namespace yourname --push

Thedocker-buildx.sh script supports:-Multi-architecture builds:linux/amd64,linux/arm64-Automatic version detection: Uses git tags or commit hashes-Registry flexibility: Supports Docker Hub, GitHub Container Registry, etc.-Build optimization: Includes caching and parallel builds

You can also use Make targets for convenience:

make docker-buildx# Build locallymake docker-buildx-push# Build and pushmake docker-buildx-version VERSION=v1.0.0# Build specific versionmake help-docker# Show all Docker-related commands

Heads-up (macOS cross-compilation): macOS keeps the defaultulimit -n at 256, socargo zigbuild or./build-rustfs.sh --platform ... may fail withProcessFdQuotaExceeded when targeting Linux. The build script attempts to raise the limit automatically, but if you still see the warning, runulimit -n 4096 (or higher) in your shell before building.

Follow the instructions in theHelm Chart README to install RustFS on a Kubernetes cluster.

5. Access the Console: Open your web browser and navigate tohttp://localhost:9000 to access the RustFS console.
   • Default credentials:rustfsadmin /rustfsadmin
6. Create a Bucket: Use the console to create a new bucket for your objects.
7. Upload Objects: You can upload files directly through the console or use S3-compatible APIs/clients to interact with your RustFS instance.

NOTE: To access the RustFS instance viahttps, please refer to theTLS Configuration Docs.

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

If you have any questions or need assistance:

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

• Documentation - The manual you should read
• Changelog - What we broke and fixed
• GitHub Discussions - Where the community lives

• Bugs:GitHub Issues
• Business:hello@rustfs.com
• Jobs:jobs@rustfs.com
• General Discussion:GitHub Discussions
• Contributing:CONTRIBUTING.md

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

🚀 RustFS is beloved by open-source enthusiasts and enterprise users worldwide, often appearing on the GitHub Trending top charts.

Apache 2.0

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