Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .claude/settings.local.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
"Bash(git merge:*)",
"Bash(git branch:*)",
"Bash(rsync:*)",
"Bash(npm run build:*)"
"Bash(npm run build:*)",
"Bash(git pull:*)",
"Bash(git stash:*)"
],
"deny": [],
"ask": []
Expand Down
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
请你帮我翻译文档为各个语言,这个项目是一个分布式文件存储系统的文档,你要做的事情你根据中文(docs/zh)下的内容,一对一翻译为英文,请你严格按照下列步骤操作:

0. 所有翻译都以中文作为源语言。
1. 选择目标语言,比如按照 docs/ 下的顺序,先选中目标为 de,并创建此语言专用特性分支。
1. 选择目标语言,比如按照 docs/ 下的顺序,先选中目标为 de,并创建此语言专用特性分支(切分支前确保主分支是最新的)
2. 获取中文目录文件结构,逐一对比需要翻译的文件,举例:docs/zh/index.md 对比方案是:如果 docs/zh/ 下的同名文件更新时间晚于 docs/de 下的同名文件,则需要翻译,加入 todolist.
3. 开始翻译中文对应的内容为目标语言,如果是外链,代码,则不翻译,并且删除在中文目录下没有的仅在目标语言目录中存在的文件。
4. 图片则直接从中文对应的目录拷贝。
Expand Down
31 changes: 31 additions & 0 deletions docs/en/administration/iam/access-token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "RustFS Access Key Management"
description: "Creation, usage, and deletion of RustFS access keys."
---

# Access Keys

RustFS access keys are the core credentials of the RustFS system, used for identity authentication and operation authorization, and are very useful in API and SDK scenarios. This chapter introduces the creation and deletion of RustFS access keys.

Prerequisites:

- An available RustFS instance. You can refer to the [Installation Guide](../../installation/index.md) for installation.

## Creating Access Keys

1. Log in to the RustFS UI console.
2. In the left navigation bar, select **Access Keys**.
3. On the access keys page, in the upper right corner, click **Add Access Key**.
4. Enter the key's **expiration time, name, and description**, then click **Submit**.
5. (Optional but recommended). On the access key page that appears, select **Copy** or **Export** to save the access key for future use.

![access key list page](images/access_token_creation.png)

## Deleting Access Keys

1. Log in to the RustFS UI console.
2. In the left navigation bar, select **Access Keys**.
3. On the access keys page, select the access key you want to delete.
4. Select the **Delete** button on the right side of the access key or **Delete Selected Items** in the upper right corner to delete the access key.

![access key deletion](images/access_token_deletion.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/en/administration/iam/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "RustFS IAM Management"
description: "Detailed explanation of user/user group/policy/AK&SK and other content in RustFS."
---

This chapter includes the following content:

- User Management
- User Group Management
- Policy Management
- Bucket Policy
- AK/SK
13 changes: 13 additions & 0 deletions docs/en/concepts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "RustFS Architecture Design and Core Concepts Explained"
description: "This article introduces vocabulary frequently used in object storage, helping users quickly understand object storage"
---

This chapter contains the following content:

- [RustFS Introduction](./introduction.md)
- [RustFS Design Architecture](./architecture.md)
- [Mainstream Storage Product Comparison](./comparison.md)
- [Common Terminology](./glossary.md)
- [Core Concepts](./principle/index.md)
- [Usage Limitations](./limit.md)
37 changes: 37 additions & 0 deletions docs/en/concepts/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "What is RustFS?"
description: "RustFS is an object storage solution, an open-source distributed object storage released under the Apache2 license."
---

# What is RustFS?

RustFS is a simple, efficient, and distributed object storage.
At the same time, it is also an efficient, open-source, and free object storage solution. It is 100% compatible with the S3 protocol and is open-source software released under the Apache2 license. RustFS is written in the currently most popular and memory-safe language, Rust.
It is a commercial-friendly distributed object storage product developed and contributed by excellent engineers from around the world. RustFS can replace many object storage products with unfriendly open-source licenses.

RustFS will soon transition from commercial applications to open source and be released globally, helping the world reduce storage costs and improve data security.

## Operating System and CPU Support

You can run RustFS on almost any CPU and operating system, whether it's Linux, Unix, Windows, MacOS, FreeBSD, Docker, or even edge gateways, you can run RustFS.
CPU architecture support: X86, ARM, and many other CPU architectures.

## Features of RustFS

- **S3 Compatible**: 100% compatible with the S3 protocol, excellent compatibility with big data, data lakes, backup software, image processing software, and industrial production software;
- **Distributed**: RustFS is a distributed object storage, so RustFS can meet various requirements;
- **Commercial-friendly**: RustFS is 100% open-source software and is released under the Apache v2.0 license, so RustFS is commercial-friendly;
- **Fast**: The performance of the Rust programming language infinitely approaches the speed of the C language. Therefore, RustFS has very powerful performance;
- **Secure**: RustFS is written in the memory-safe Rust language, so RustFS is 100% secure;
- **Cross-platform**: RustFS works on Windows, macOS, and Linux;
- **Extensible**: RustFS supports custom plugins, so RustFS can meet various requirements;
- **Customizable**: Due to its open-source nature, you can customize various plugins, so RustFS can meet various requirements;
- **Cloud-native**: RustFS supports deployment via Docker and other methods, and can be quickly deployed in cloud-native environments.

## RustFS Values

Help all humanity improve data security and reduce storage costs.

## RustFS Vision

Every individual AI agent in the world can use RustFS to store data.
12 changes: 12 additions & 0 deletions docs/en/concepts/principle/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "RustFS Core Concepts Explained"
description: "Detailed explanation of RustFS core concepts, including erasure coding, stripes, Data Scanner, data self-healing, etc. Allows users to have a deeper understanding of RustFS."
---

This chapter contains the following content:

- [Erasure Coding](./erasure-coding.md)
- Stripes
- Data Scanner
- Data Self-healing
- Stripes
Binary file added docs/en/developer/images/add-rustfs-mcp-succ.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/en/developer/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: RustFS Developer Guide
description: Introduction to using STS/MCP/MinIO Client/SDK/API in RustFS, helping developers use RustFS more efficiently.
---

This chapter shares usage guidance for RustFS in terms of STS, MCP (Model Context Protocol), MinIO Client (`mc` command line), SDK, and API, making it convenient for users to use RustFS efficiently in various scenarios. This document contains the following topics:

- STS
- [MCP Usage Guide](./mcp.md)
- [MinIO Client Usage Guide](./mc.md)
- [SDK Usage Guide](./sdk/index.md)
- API Usage Guide
45 changes: 45 additions & 0 deletions docs/en/developer/sdk/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "RustFS SDK Overview"
description: "Which S3 SDKs can be used with RustFS? This article provides a detailed explanation."
---

# SDK Overview

RustFS is a distributed object storage software that is 100% compatible with the S3 protocol. Users can:

1. Manage RustFS through the Console management interface;
2. Manage RustFS through S3 clients;
3. Implement object storage operations and management on the business side through SDKs.

Currently, the SDKs provided by RustFS include:

- [Java SDK](./java.md)
- [JavaScript SDK](./javascript.md)
- [Python SDK](./python.md)
- [Rust SDK](./rust.md)
- [TypeScript SDK](./typescript.md)

## Terminology Explanation Before Reading

S3 is the name of the first object storage product opened and launched by Amazon. It opened all its protocols and specifications. Later, almost all object storage systems followed the S3 protocols and specifications. Sometimes people call S3 object storage, and sometimes they simply call S3 the object storage protocol.

## 1. SDK Recommendations

Since there are already too many SDKs on the market that have been maintained for many years, such as AWS S3 SDK which has been debugged and optimized for many years. Its performance and errors are almost zero. Therefore, we recommend that you directly use the standard AWS S3 SDK to directly control and communicate with RustFS.

If you have a familiar and trusted SDK from a vendor, you can use it.

Because many Chinese cloud providers have made "modifications" in many places and do not support many of the latest S3 technologies, many object storage products around the world do not recommend the SDKs of many Chinese cloud providers.

## 2. Can MinIO SDKs communicate directly with RustFS?

Yes.

We have conducted comprehensive adaptation and compatibility for MinIO SDKs.

If you are using MinIO SDKs, you can modify the Endpoint, AK, and SK to be directly compatible with RustFS.

## 3. What to do if there are other incompatible SDKs?

If we use an SDK from a cloud provider that does not support the latest S3, MinIO, or RustFS, how should we handle it?
Please replace the SDK as soon as possible and re-match and upgrade on the business side.
64 changes: 34 additions & 30 deletions docs/en/installation/index.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
---
title: "Installation Guide"
description: "RustFS Installation and Deployment Guide"
title: "RustFS Installation Guide"
description: "Installation guide for RustFS on different operating systems and different deployment methods."
---

# Installation Guide
# RustFS Introduction

Welcome to the RustFS installation guide. This section provides comprehensive instructions for installing and deploying RustFS in various environments.
RustFS is `high-performance`, `distributed` object storage software developed using the currently most popular and memory-safe Rust language worldwide. RustFS also has the characteristics of simplicity and efficiency, and is also an efficient, open-source, free object storage solution that can be deployed in local private clouds. RustFS is 100% compatible with the S3 protocol and is open-source software released under the Apache2 license. RustFS is written in the Rust language, currently the most popular and memory-safe language in the world. It is a commercial-friendly distributed object storage product developed and contributed by excellent engineers from around the world. RustFS can replace many object storage products with unfriendly open-source licenses.

## Before You Begin
RustFS will soon transition from commercial applications to open source and be released globally, helping the world reduce storage costs and improve data security.

Please review the following checklists before proceeding with the installation:
## 1. CPUs and Operating Systems We Support

1. [Hardware Checklists](./hard-checklists) - Ensure your hardware meets the requirements
2. [Security Checklists](./security-checklists) - Configure security settings properly
3. [Software Checklists](./software-checklists) - Verify software dependencies
4. [Network Checklists](./network-checklists) - Configure network settings
You can run RustFS on almost any CPU and operating system, whether it's:
- Linux
- Unix
- Windows
- MacOS
- FreeBSD
- Docker
- Even on edge gateways.

## Installation Options
You can run RustFS everywhere. CPU architecture support: X86, ARM, RISC-V, and many other CPU architectures.

Choose the installation method that best fits your environment:
## 2. RustFS Installation Modes

### Quick Start
This chapter includes installation guides for RustFS on different operating systems and different deployment methods. Specifically:

- [Docker Installation](./docker) - Get started quickly with containerized deployment
- [Quick Installation on Linux](./linux/quick-start.md)
- [Installing RustFS on Linux](./linux/index.md)
- [Installing RustFS in Docker Container](./docker/index.md)
- [Installing RustFS on Windows](./windows/index.md)
- [Installing RustFS on macOS](./macos/index.md)

### Operating System Specific
## 3. Features of RustFS

- [Linux Installation](./linux) - Install on Linux systems
- [macOS Installation](./macos/) - Install on macOS systems
- [Windows Installation](./windows/) - Install on Windows systems
- S3 Compatible: 100% compatible with the S3 protocol, excellent compatibility with big data, data lakes, backup software, image processing software, and industrial production software;
- Distributed: RustFS is a distributed object storage, so RustFS can meet various requirements;
- Commercial-friendly: RustFS is 100% open-source software and is released under the Apache v2.0 license, so RustFS is commercial-friendly;
- Fast: The performance of the Rust programming language infinitely approaches the speed of the C language. Therefore, RustFS has very powerful performance;
- Secure: RustFS is written in the memory-safe Rust language, so RustFS is 100% secure;
- Cross-platform: RustFS works on Windows, macOS, and Linux;
- Extensible: RustFS supports custom plugins, so RustFS can meet various requirements;
- Customizable: Due to its open-source nature, you can customize various plugins, so RustFS can meet various requirements;
- Cloud-native: RustFS supports deployment via Docker and other methods, and can be quickly deployed in cloud-native environments.

### Advanced Configuration
## 4. RustFS Values

- [Startup Modes](./mode/) - Configure different startup modes
- [Hardware Selection](./hardware-selection) - Choose appropriate hardware

## Support

For professional guidance, please contact our storage experts:

- Phone: 400-033-5363
- Email: <hello@rustfs.com>

For community support, you can submit issues on GitHub or join our discussion groups. Please note that we do not guarantee response quality or SLA for community support.
Help all humanity improve data security and reduce storage costs.
10 changes: 10 additions & 0 deletions docs/en/management/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "RustFS Optimal Management"
description: "Through optimal management of RustFS buckets/objects/permissions, help users use RustFS more securely and efficiently."
---

This chapter contains the following content:

- [Bucket Management](./bucket/index.md)
- [Object Management](./object/index.md)
- [IAM Management](../administration/iam/index.md)
Loading