From fd08be7be2f8f1ed0242e273e1f0c8e783649dd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=AE=89=E6=AD=A3=E8=B6=85?= Date: Thu, 22 Jan 2026 22:44:28 +0800 Subject: [PATCH] chore: update README. (#1586) --- README.md | 83 +++++++++++++++++++----------------------- README_ZH.md | 101 ++++++++++++++++++++++----------------------------- 2 files changed, 82 insertions(+), 102 deletions(-) diff --git a/README.md b/README.md index afb3f151a..605cbbd87 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![RustFS](https://rustfs.com/images/rustfs-github.png)](https://rustfs.com) +[![RustFS](https://github.com/user-attachments/assets/1b5afcd6-a2c3-47ff-8bc3-ce882b0ddca7)](https://rustfs.com)

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

@@ -14,7 +14,6 @@ rustfs%2Frustfs | Trendshift

-

Getting Started · Docs @@ -46,24 +45,21 @@ Unlike other storage systems, RustFS is released under the permissible Apache 2. - **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. -| Feature | Status | Feature | Status | -| :--- | :--- | :--- | :--- | -| **S3 Core Features** | ✅ Available | **Bitrot Protection** | ✅ Available | -| **Upload / Download** | ✅ Available | **Single Node Mode** | ✅ Available | -| **Versioning** | ✅ Available | **Bucket Replication** | ✅ Available | -| **Logging** | ✅ Available | **Lifecycle Management** | 🚧 Under Testing | -| **Event Notifications** | ✅ Available | **Distributed Mode** | 🚧 Under Testing | -| **K8s Helm Charts** | ✅ Available | **RustFS KMS** | 🚧 Under Testing | - - - +| Feature | Status | Feature | Status | +| :---------------------- | :----------- | :----------------------- | :--------------- | +| **S3 Core Features** | ✅ Available | **Bitrot Protection** | ✅ Available | +| **Upload / Download** | ✅ Available | **Single Node Mode** | ✅ Available | +| **Versioning** | ✅ Available | **Bucket Replication** | ✅ Available | +| **Logging** | ✅ Available | **Lifecycle Management** | 🚧 Under Testing | +| **Event Notifications** | ✅ Available | **Distributed Mode** | 🚧 Under Testing | +| **K8s Helm Charts** | ✅ Available | **RustFS KMS** | 🚧 Under Testing | ## 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 | | @@ -73,16 +69,15 @@ Unlike other storage systems, RustFS is released under the permissible Apache 2. ### 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. | - +| 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 @@ -96,9 +91,9 @@ 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 -```` +```bash +curl -O https://rustfs.com/install_rustfs.sh && bash install_rustfs.sh +``` ### 2\. Docker Quick Start (Option 2) @@ -194,14 +189,14 @@ nix build nix run ``` ------ +--- ### Accessing RustFS -5. **Access the Console**: Open your web browser and navigate to `http://localhost:9001` 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. +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](https://docs.rustfs.com/integration/tls-configured.html). @@ -213,23 +208,23 @@ For detailed documentation, including configuration options, API references, and If you have any questions or need assistance: - - Check the [FAQ](https://github.com/rustfs/rustfs/discussions/categories/q-a) for common issues and solutions. - - Join our [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) to ask questions and share your experiences. - - Open an issue on our [GitHub Issues](https://github.com/rustfs/rustfs/issues) page for bug reports or feature requests. +- Check the [FAQ](https://github.com/rustfs/rustfs/discussions/categories/q-a) for common issues and solutions. +- Join our [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) to ask questions and share your experiences. +- Open an issue on our [GitHub Issues](https://github.com/rustfs/rustfs/issues) page for bug reports or feature requests. ## Links - - [Documentation](https://docs.rustfs.com) - The manual you should read - - [Changelog](https://github.com/rustfs/rustfs/releases) - What we broke and fixed - - [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) - Where the community lives +- [Documentation](https://docs.rustfs.com) - The manual you should read +- [Changelog](https://github.com/rustfs/rustfs/releases) - What we broke and fixed +- [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) - Where the community lives ## Contact - - **Bugs**: [GitHub Issues](https://github.com/rustfs/rustfs/issues) - - **Business**: [hello@rustfs.com](mailto:hello@rustfs.com) - - **Jobs**: [jobs@rustfs.com](mailto:jobs@rustfs.com) - - **General Discussion**: [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) - - **Contributing**: [CONTRIBUTING.md](CONTRIBUTING.md) +- **Bugs**: [GitHub Issues](https://github.com/rustfs/rustfs/issues) +- **Business**: [hello@rustfs.com](mailto:hello@rustfs.com) +- **Jobs**: [jobs@rustfs.com](mailto:jobs@rustfs.com) +- **General Discussion**: [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) +- **Contributing**: [CONTRIBUTING.md](CONTRIBUTING.md) ## Contributors @@ -239,7 +234,6 @@ RustFS is a community-driven project, and we appreciate all contributions. Check Contributors - ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=rustfs/rustfs&type=date&legend=top-left)](https://www.star-history.com/#rustfs/rustfs&type=date&legend=top-left) @@ -249,4 +243,3 @@ RustFS is a community-driven project, and we appreciate all contributions. Check [Apache 2.0](https://opensource.org/licenses/Apache-2.0) **RustFS** is a trademark of RustFS, Inc. All other trademarks are the property of their respective owners. - diff --git a/README_ZH.md b/README_ZH.md index 175e7f2bf..78fbb21c0 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,4 +1,4 @@ -[![RustFS](https://rustfs.com/images/rustfs-github.png)](https://rustfs.com) +[![RustFS](https://github.com/user-attachments/assets/1b5afcd6-a2c3-47ff-8bc3-ce882b0ddca7)](https://rustfs.com.cn)

RustFS 是一个基于 Rust 构建的高性能分布式对象存储系统。

@@ -21,8 +21,6 @@ · 社区讨论

- -

English | 简体中文 | Deutsch | @@ -47,45 +45,40 @@ RustFS 是一个基于 Rust 构建的高性能分布式对象存储系统。Rust - **完全开源**：采用 Apache 2.0 许可证，鼓励社区贡献和商业使用。 - **简单易用**：设计简洁，易于部署和管理。 - -| 功能 | 状态 | 功能 | 状态 | -| :--- | :--- | :--- | :--- | -| **S3 核心功能** | ✅ 可用 | **Bitrot (防数据腐烂)** | ✅ 可用 | -| **上传 / 下载** | ✅ 可用 | **单机模式** | ✅ 可用 | -| **版本控制** | ✅ 可用 | **存储桶复制** | ✅ 可用 | -| **日志功能** | ✅ 可用 | **生命周期管理** | 🚧 测试中 | -| **事件通知** | ✅ 可用 | **分布式模式** | 🚧 测试中 | -| **K8s Helm Chart** | ✅ 可用 | **OPA (策略引擎)** | 🚧 测试中 | - - - +| 功能 | 状态 | 功能 | 状态 | +| :----------------- | :------ | :---------------------- | :-------- | +| **S3 核心功能** | ✅ 可用 | **Bitrot (防数据腐烂)** | ✅ 可用 | +| **上传 / 下载** | ✅ 可用 | **单机模式** | ✅ 可用 | +| **版本控制** | ✅ 可用 | **存储桶复制** | ✅ 可用 | +| **日志功能** | ✅ 可用 | **生命周期管理** | 🚧 测试中 | +| **事件通知** | ✅ 可用 | **分布式模式** | 🚧 测试中 | +| **K8s Helm Chart** | ✅ 可用 | **OPA (策略引擎)** | 🚧 测试中 | ## RustFS vs MinIO 性能对比 **压力测试环境参数：** -| 类型 | 参数 | 备注 | -|---------|-----------|----------------------------------------------------------| -| CPU | 2 核 | Intel Xeon (Sapphire Rapids) Platinum 8475B , 2.7/3.2 GHz | -| 内存 | 4GB |   | -| 网络 | 15Gbps |   | -| 硬盘 | 40GB x 4 | IOPS 3800 / Drive | +| 类型 | 参数 | 备注 | +| ---- | -------- | --------------------------------------------------------- | +| CPU | 2 核 | Intel Xeon (Sapphire Rapids) Platinum 8475B , 2.7/3.2 GHz | +| 内存 | 4GB |   | +| 网络 | 15Gbps |   | +| 硬盘 | 40GB x 4 | IOPS 3800 / Drive | ### RustFS vs 其他对象存储 -| 特性 | RustFS | 其他对象存储 | -| :--- | :--- | :--- | -| **控制台体验** | **功能强大的控制台**
提供全面的管理界面。 | **基础/简陋的控制台**
通常功能过于简单或缺失关键特性。 | -| **语言与安全** | **基于 Rust 开发**
天生的内存安全。 | **基于 Go 或 C 开发**
存在内存 GC 停顿或内存泄漏的潜在风险。 | -| **数据主权** | **无遥测 / 完全合规**
防止未经授权的数据跨境传输。完全符合 GDPR (欧盟/英国)、CCPA (美国) 和 APPI (日本) 等法规。 | **潜在风险**
可能存在法律风险和隐蔽的数据遥测（Telemetry）。 | -| **开源协议** | **宽松的 Apache 2.0**
商业友好，无“毒丸”条款。 | **受限的 AGPL v3**
存在许可证陷阱和知识产权污染的风险。 | -| **兼容性** | **100% S3 兼容**
适用于任何云提供商和客户端，随处运行。 | **兼容性不一**
虽然支持 S3，但可能缺乏对本地云厂商或特定 API 的支持。 | -| **边缘与 IoT** | **强大的边缘支持**
非常适合安全、创新的边缘设备。 | **边缘支持较弱**
对于边缘网关来说通常过于沉重。 | -| **成本** | **稳定且免费**
免费社区支持，稳定的商业定价。 | **高昂成本**
1PiB 的成本可能高达 250,000 美元。 | -| **风险控制** | **企业级风险规避**
清晰的知识产权，商业使用安全无忧。 | **法律风险**
知识产权归属模糊及使用限制风险。 | - +| 特性 | RustFS | 其他对象存储 | +| :------------- | :------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------- | +| **控制台体验** | **功能强大的控制台**
提供全面的管理界面。 | **基础/简陋的控制台**
通常功能过于简单或缺失关键特性。 | +| **语言与安全** | **基于 Rust 开发**
天生的内存安全。 | **基于 Go 或 C 开发**
存在内存 GC 停顿或内存泄漏的潜在风险。 | +| **数据主权** | **无遥测 / 完全合规**
防止未经授权的数据跨境传输。完全符合 GDPR (欧盟/英国)、CCPA (美国) 和 APPI (日本) 等法规。 | **潜在风险**
可能存在法律风险和隐蔽的数据遥测（Telemetry）。 | +| **开源协议** | **宽松的 Apache 2.0**
商业友好，无“毒丸”条款。 | **受限的 AGPL v3**
存在许可证陷阱和知识产权污染的风险。 | +| **兼容性** | **100% S3 兼容**
适用于任何云提供商和客户端，随处运行。 | **兼容性不一**
虽然支持 S3，但可能缺乏对本地云厂商或特定 API 的支持。 | +| **边缘与 IoT** | **强大的边缘支持**
非常适合安全、创新的边缘设备。 | **边缘支持较弱**
对于边缘网关来说通常过于沉重。 | +| **成本** | **稳定且免费**
免费社区支持，稳定的商业定价。 | **高昂成本**
1PiB 的成本可能高达 250,000 美元。 | +| **风险控制** | **企业级风险规避**
清晰的知识产权，商业使用安全无忧。 | **法律风险**
知识产权归属模糊及使用限制风险。 | ## 保持领先 @@ -93,17 +86,15 @@ RustFS 是一个基于 Rust 构建的高性能分布式对象存储系统。Rust - - ## 快速开始 请按照以下步骤快速上手 RustFS： ### 1. 一键安装脚本 (选项 1) - ```bash - curl -O https://rustfs.com/install_rustfs.sh && bash install_rustfs.sh -```` +```bash +curl -O https://rustfs.com/install_rustfs.sh && bash install_rustfs.sh +``` ### 2\. Docker 快速启动 (选项 2) @@ -170,14 +161,14 @@ make help-docker # 显示所有 Docker 相关命令 请按照 [Helm Chart README](https://charts.rustfs.com) 上的说明在 Kubernetes 集群上安装 RustFS。 ------ +--- ### 访问 RustFS -5. **访问控制台**: 打开浏览器并访问 `http://localhost:9000` 进入 RustFS 控制台。 - * 默认账号/密码: `rustfsadmin` / `rustfsadmin` -6. **创建存储桶**: 使用控制台为您​​的对象创建一个新的存储桶 (Bucket)。 -7. **上传对象**: 您可以直接通过控制台上传文件，或使用 S3 兼容的 API/客户端与您的 RustFS 实例进行交互。 +1. **访问控制台**: 打开浏览器并访问 `http://localhost:9000` 进入 RustFS 控制台。 + - 默认账号/密码: `rustfsadmin` / `rustfsadmin` +2. **创建存储桶**: 使用控制台为您​​的对象创建一个新的存储桶 (Bucket)。 +3. **上传对象**: 您可以直接通过控制台上传文件，或使用 S3 兼容的 API/客户端与您的 RustFS 实例进行交互。 **注意**: 如果您希望通过 `https` 访问 RustFS 实例，请参考 [TLS 配置文档](https://docs.rustfs.com/integration/tls-configured.html)。 @@ -189,23 +180,23 @@ make help-docker # 显示所有 Docker 相关命令 如果您有任何问题或需要帮助： - - 查看 [FAQ](https://github.com/rustfs/rustfs/discussions/categories/q-a) 寻找常见问题和解决方案。 - - 加入我们的 [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) 提问并分享您的经验。 - - 在我们的 [GitHub Issues](https://github.com/rustfs/rustfs/issues) 页面提交 Bug 报告或功能请求。 +- 查看 [FAQ](https://github.com/rustfs/rustfs/discussions/categories/q-a) 寻找常见问题和解决方案。 +- 加入我们的 [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) 提问并分享您的经验。 +- 在我们的 [GitHub Issues](https://github.com/rustfs/rustfs/issues) 页面提交 Bug 报告或功能请求。 ## 链接 - - [官方文档](https://docs.rustfs.com) - 必读手册 - - [更新日志](https://github.com/rustfs/rustfs/releases) - 版本变更记录 - - [社区讨论](https://github.com/rustfs/rustfs/discussions) - 社区交流地 +- [官方文档](https://docs.rustfs.com) - 必读手册 +- [更新日志](https://github.com/rustfs/rustfs/releases) - 版本变更记录 +- [社区讨论](https://github.com/rustfs/rustfs/discussions) - 社区交流地 ## 联系方式 - - **Bug 反馈**: [GitHub Issues](https://github.com/rustfs/rustfs/issues) - - **商务合作**: [hello@rustfs.com](mailto:hello@rustfs.com) - - **工作机会**: [jobs@rustfs.com](mailto:jobs@rustfs.com) - - **一般讨论**: [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) - - **贡献指南**: [CONTRIBUTING.md](https://www.google.com/search?q=CONTRIBUTING.md) +- **Bug 反馈**: [GitHub Issues](https://github.com/rustfs/rustfs/issues) +- **商务合作**: [hello@rustfs.com](mailto:hello@rustfs.com) +- **工作机会**: [jobs@rustfs.com](mailto:jobs@rustfs.com) +- **一般讨论**: [GitHub Discussions](https://github.com/rustfs/rustfs/discussions) +- **贡献指南**: [CONTRIBUTING.md](https://www.google.com/search?q=CONTRIBUTING.md) ## 贡献者 @@ -215,16 +206,12 @@ RustFS 是一个社区驱动的项目，我们感谢所有的贡献。请查看 Contributors - - ## Star 历史 [![Star History Chart](https://api.star-history.com/svg?repos=rustfs/rustfs&type=date&legend=top-left)](https://www.star-history.com/#rustfs/rustfs&type=date&legend=top-left) - ## 许可证 [Apache 2.0](https://opensource.org/licenses/Apache-2.0) **RustFS** 是 RustFS, Inc. 的商标。所有其他商标均为其各自所有者的财产。 -