Repository: rustfs/rustfs

Stars: 26041

README.md

![RustFS](https://rustfs.com)

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

<a href="https://docs.rustfs.com/installation/">Getting Started</a>
· <a href="https://docs.rustfs.com/">Docs</a>
· <a href="https://github.com/rustfs/rustfs/issues">Bug reports</a>
· <a href="https://github.com/rustfs/rustfs/discussions">Discussions</a>

English | <a href="https://github.com/rustfs/rustfs/blob/main/README_ZH.md">简体中文</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=de">Deutsch</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=es">Español</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=fr">français</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=ja">日本語</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=ko">한국어</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=pt">Portuguese</a> |
<a href="https://readme-i18n.com/rustfs/rustfs?lang=ru">Русский</a>

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.

Feature & Status

- 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.
- OpenStack Swift API: Native support for Swift protocol with Keystone authentication.
- OpenStack Keystone Integration: Native support for OpenStack Keystone authentication with X-Auth-Token headers.
- 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.

RustFS vs MinIO Performance

Stress Test Environment:

| Type | Parameter | Remark |
| ------- | --------- | -------------------------------------------------------- |
| CPU | 2 Core | Intel Xeon (Sapphire Rapids) Platinum 8475B, 2.7/3.2 GHz |
| Memory | 4GB | |
| Network | 15Gbps | |
| Drive | 40GB x 4 | IOPS 3800 / Drive |

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

RustFS vs Other Object Storage

| Feature | RustFS | Other Object Storage |
| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
| Console Experience | Powerful Console Comprehensive management interface. | Basic / Limited Console Often overly simple or lacking critical features. |
| Language & Safety | Rust-based Memory safety by design. | Go or C-based Potential for memory GC pauses or leaks. |
| Data Sovereignty | No Telemetry / Full Compliance Guards against unauthorized cross-border data egress. Compliant with GDPR (EU/UK), CCPA (US), and APPI (Japan). | Potential Risk Possible legal exposure and unwanted data telemetry. |
| Licensing | Permissive Apache 2.0 Business-friendly, no "poison pill" clauses. | Restrictive AGPL v3 Risk of license traps and intellectual property pollution. |
| Compatibility | 100% S3 Compatible Works with any cloud provider or client, anywhere. | Variable Compatibility May lack support for local cloud vendors or specific APIs. |
| Edge & IoT | Strong Edge Support Ideal for secure, innovative edge devices. | Weak Edge Support Often too heavy for edge gateways. |
| Risk Profile | Enterprise Risk Mitigation Clear IP rights and safe for commercial use. | Legal Risks Intellectual property ambiguity and usage restrictions. |

Staying ahead

Star RustFS on GitHub and be instantly notified of new releases.

Quickstart

To get started with RustFS, follow these steps:

1. One-click Installation (Option 1)

bash

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

2. Docker Quick Start (Option 2)

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

bash

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.76

If you use podman instead of docker, you can install the RustFS with the below command

bash

podman run -d -p 9000:9000 -p 9001:9001 -v $(pwd)/data:/data -v $(pwd)/logs:/logs rustfs/rustfs:latest

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

bash

docker compose --profile observability up -d

Similarly, you can run the command with podman

bash

podman compose --profile observability up -d

NOTE: We recommend reviewing the docker-compose.yml 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.

3\. Build from Source (Option 3) - Advanced Users

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

bash

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

The docker-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:

bash

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

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

4\. Build with Helm Chart (Option 4) - Cloud Native

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

5\. Nix Flake (Option 5)

If you have Nix with flakes enabled:

bash

Run directly without installing

nix run github:rustfs/rustfs
Build the binary

nix build github:rustfs/rustfs
./result/bin/rustfs --help
Or from a local checkout

nix build
nix run

6\. X-CMD (Option 6)

If you are an x-cmd user:

bash

Run directly without installing

x rustfs
Download the binary and install it to the global environment

x env use rustfs
rustfs --help

---

Accessing RustFS

1. Access the Console: Open your web browser and navigate to http://localhost:9001 to access the RustFS console.
- Default credentials: rustfsadmin / 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/clients to interact with your RustFS instance.

NOTE: To access the RustFS instance via https, please refer to the TLS Configuration Docs.

OIDC Roles Claim (Microsoft Entra ID)

RustFS supports mapping an OIDC claim containing role values into the existing
authorization pipeline. The roles_claim setting is optional: when unset or
empty, only the groups claim contributes to authorization (same as older
RustFS releases). For Microsoft Entra ID app roles, set roles_claim=roles so
both console admin checks and bucket IAM policies can evaluate those roles.

Example environment configuration (opt-in roles claim):

bash

RUSTFS_IDENTITY_OPENID_ENABLE=on
RUSTFS_IDENTITY_OPENID_CONFIG_URL="https://login.microsoftonline.com/<tenant-id>/v2.0/.well-known/openid-configuration"
RUSTFS_IDENTITY_OPENID_CLIENT_ID="<client-id>"
RUSTFS_IDENTITY_OPENID_CLIENT_SECRET="<client-secret>"
RUSTFS_IDENTITY_OPENID_SCOPES="openid,profile,email"
RUSTFS_IDENTITY_OPENID_GROUPS_CLAIM="groups"
RUSTFS_IDENTITY_OPENID_ROLES_CLAIM="roles"

Policy condition example (evaluate app roles directly with jwt:roles; when
roles_claim is configured, RustFS also merges those values into jwt:groups
for backward compatibility with older policies):

json

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["admin:*"],
      "Resource": ["arn:aws:s3:::*"],
      "Condition": {
        "ForAnyValue:StringEquals": {
          "jwt:roles": ["RustFS.ConsoleAdmin"]
        }
      }
    }
  ]
}

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:

- 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.

Links

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

Contact

- Bugs: GitHub Issues
- Business: [email protected]
- Jobs: [email protected]
- General Discussion: GitHub Discussions
- Contributing: CONTRIBUTING.md

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.

Star History

![Star History Chart](https://www.star-history.com/#rustfs/rustfs&type=date&legend=top-left)

License

Apache 2.0

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

Repository: rustfs/rustfs

Stars: 26041

README.md Copy Chapter

Feature & Status Copy Chapter

RustFS vs MinIO Performance Copy Chapter

RustFS vs Other Object Storage Copy Section

Staying ahead Copy Chapter

Quickstart Copy Chapter

1. One-click Installation (Option 1) Copy Section

2. Docker Quick Start (Option 2) Copy Section

Create data and logs directories

Change the owner of these directories

Using latest version

Using specific version

3\. Build from Source (Option 3) - Advanced Users Copy Section

Build multi-architecture images locally

Build and push to registry

Build specific version

Build for custom registry

4\. Build with Helm Chart (Option 4) - Cloud Native Copy Section

5\. Nix Flake (Option 5) Copy Section

Run directly without installing

Build the binary

Or from a local checkout

6\. X-CMD (Option 6) Copy Section

Run directly without installing

Download the binary and install it to the global environment

Accessing RustFS Copy Section

OIDC Roles Claim (Microsoft Entra ID) Copy Section

Documentation Copy Chapter

Getting Help Copy Chapter

Links Copy Chapter

Contact Copy Chapter

Contributors Copy Chapter

Star History Copy Chapter

License Copy Chapter

README.md

Feature & Status

RustFS vs MinIO Performance

RustFS vs Other Object Storage

Staying ahead

Quickstart

1. One-click Installation (Option 1)

2. Docker Quick Start (Option 2)

3\. Build from Source (Option 3) - Advanced Users

4\. Build with Helm Chart (Option 4) - Cloud Native

5\. Nix Flake (Option 5)

6\. X-CMD (Option 6)

Accessing RustFS

OIDC Roles Claim (Microsoft Entra ID)

Documentation

Getting Help

Links

Contact

Contributors

Star History

License