Skip to content

Commit 5f49403

Browse files
committed
docs(en): add missing User Guide pages, copy images, update EN sidebar; ensure zh/en file parity
1 parent 634ce75 commit 5f49403

12 files changed

+373
-0
lines changed

docs/en/guide/access-token.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "RustFS Access Key Management"
3+
description: "Create, use, and delete RustFS access keys."
4+
---
5+
6+
# Access Keys
7+
8+
RustFS access keys are the core credentials of the RustFS system, used for authentication and authorization. They are essential in API and SDK scenarios. This section explains how to create and delete RustFS access keys.
9+
10+
Prerequisites:
11+
12+
- An available RustFS instance. See the [Installation Guide](/installation/index) to deploy one.
13+
14+
## Create an Access Key
15+
16+
1. Sign in to the RustFS UI console.
17+
2. In the left navigation, select **Access Keys**.
18+
3. On the Access Keys page, click **Add Access Key** in the upper right.
19+
4. Enter the access key **expiration time, name, and description**, then click **Submit**.
20+
5. (Optional but recommended) On the access key detail page, choose **Copy** or **Export** to securely save the credentials for later use.
21+
22+
![access key list page](images/access_token_creation.png)
23+
24+
## Delete an Access Key
25+
26+
1. Sign in to the RustFS UI console.
27+
2. In the left navigation, select **Access Keys**.
28+
3. On the Access Keys page, select the access key to delete.
29+
4. Click **Delete** on the right of the access key, or click **Delete Selected** in the upper right to remove it.
30+
31+
![access key deletion](images/access_token_deletion.png)
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: "RustFS Bucket Management"
3+
description: "Manage RustFS buckets, including creation and deletion."
4+
---
5+
6+
# RustFS Buckets
7+
8+
A bucket is the fundamental container for organizing and managing data in RustFS. Each bucket has a unique name and can contain multiple objects. Buckets provide logical grouping to simplify data management and access. You can operate on buckets via the RustFS UI, `mc` (MinIO Client), or the S3-compatible API (create, delete, upload, download, etc.).
9+
10+
## Create a Bucket
11+
12+
Prerequisites:
13+
14+
- An available RustFS instance. See the [Installation Guide](/installation/index) to deploy one.
15+
16+
## Create a bucket in the RustFS UI
17+
18+
1. Sign in to the RustFS UI console.
19+
2. On the home page, click **Create Bucket** in the upper-left corner.
20+
3. Enter a bucket name and click **Create**.
21+
22+
![bucket creation](./images/bucket-creation-by-ui.png)
23+
24+
### Create a bucket with `mc`
25+
26+
> For `mc` installation and configuration, see the [`mc` Guide](../mc.md).
27+
28+
Use `mc mb` to create a bucket:
29+
30+
```
31+
# create a RustFS bucket
32+
mc mb rustfs/bucket-creation-by-mc
33+
Bucket created successfully `rustfs/bucket-creation-by-mc`.
34+
35+
# confirm the bucket exists
36+
mc ls rustfs/bucket-creation-by-mc
37+
```
38+
39+
### Create a bucket via API
40+
41+
Use the following API to create a bucket:
42+
43+
```
44+
PUT /{bucketName} HTTP/1.1
45+
```
46+
47+
Example:
48+
49+
```
50+
curl --location --request PUT 'http://12.34.56.78:9000/bucket-creation-by-api' \
51+
--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
52+
--header 'X-Amz-Date: 20250801T023519Z' \
53+
--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=c2fb2ba5199a30ebcfa9976d0f35000ba274da3701327957e84ea0f3920288f2'
54+
```
55+
56+
You can confirm in the RustFS UI that the `bucket-creation-by-api` bucket has been created.
57+
58+
## Delete a Bucket
59+
60+
Note: Buckets are critical for storing data. Deleting a bucket may break applications that depend on it. Before deletion, back up any required data and ensure the bucket is no longer needed.
61+
62+
### Delete a bucket in the RustFS UI
63+
64+
1. Sign in to the RustFS UI console.
65+
2. On the home page, select the bucket to delete.
66+
3. Click **Delete** on the far right.
67+
4. In the confirmation dialog, click **Confirm**.
68+
69+
![bucket deletion](./images/bucket-deletion-on-ui.png)
70+
71+
### Delete a bucket with `mc`
72+
73+
For `mc` installation and configuration, see the [`mc` Guide](../mc.md).
74+
75+
Use `mc rb` to delete a bucket:
76+
77+
```
78+
# delete bucket
79+
mc rb rustfs/bucket-creation-by-mc
80+
Removed `rustfs/bucket-creation-by-mc` successfully.
81+
82+
# confirm deletion
83+
mc ls rustfs/bucket-creation-by-mc
84+
mc: <ERROR> Unable to list folder. Bucket `bucket-creation-by-mc` does not exist.
85+
```
86+
87+
### Delete a bucket via API
88+
89+
Use the following API to delete a bucket:
90+
91+
```
92+
DELETE /{bucketName} HTTP/1.1
93+
```
94+
95+
Example:
96+
97+
```
98+
curl --location --request DELETE 'http://12.34.56.78:9000/bucket-creation-by-api' \
99+
--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
100+
--header 'X-Amz-Date: 20250801T024406Z' \
101+
--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=d0f6addf09fffd7eef75191e9d3209bb7188e6b004e9707238fc60ad7033edae'
102+
```
103+
104+
You can confirm in the RustFS UI that the `bucket-creation-by-api` bucket has been deleted.
139 KB
Loading
65.3 KB
Loading
219 KB
Loading
342 KB
Loading
141 KB
Loading
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: "RustFS Object Management"
3+
description: "Manage RustFS objects, including creation and deletion."
4+
---
5+
6+
# RustFS Objects
7+
8+
An object is the basic storage unit in RustFS. It includes data, metadata, and a unique identifier (Object Key). This section uses file upload and deletion to illustrate object management.
9+
10+
> For object-related concepts, see [Core Concepts](/concepts/glossary.md).
11+
12+
## Create an Object
13+
14+
Prerequisites:
15+
16+
- An available RustFS instance. See the [Installation Guide](/installation/index) to deploy one.
17+
18+
[Create a bucket](bucket-create-and-delete.md) first, then upload a file into the bucket to create an object. You can upload via the RustFS UI, `mc`, or the S3-compatible API.
19+
20+
### Upload a file via RustFS UI
21+
22+
1. Sign in to the RustFS UI console.
23+
2. Select the target bucket.
24+
3. On the bucket page, use **New Directory**, **New File**, or **Upload Files/Folders** to create content.
25+
4. To upload from local, click **Upload Files/Folders**, choose local files/folders, then click **Start Upload**.
26+
27+
![object creation from ui](./images/upload_file_from_ui.png)
28+
29+
After the upload completes, click the object to view its details.
30+
31+
![object details info](./images/object_details_info.png)
32+
33+
### Upload a file with `mc`
34+
35+
> For `mc` installation and configuration, see the [`mc` Guide](../mc.md).
36+
37+
Use `mc cp` to upload:
38+
39+
```
40+
# upload file
41+
mc cp 1.txt rustfs/bucket-creation-by-mc
42+
/tmp/1.txt: 13 B / 13 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 61 B/s 0s%
43+
44+
# confirm upload
45+
mc ls rustfs/bucket-creation-by-mc
46+
[2025-08-01 10:01:08 CST] 13B 1.txt
47+
```
48+
49+
You can also verify in the RustFS console.
50+
51+
### Upload a file via API
52+
53+
Use the following API to upload:
54+
55+
```
56+
PUT /{bucketName}/{objectName} HTTP/1.1
57+
```
58+
59+
Example:
60+
61+
```
62+
curl --location --request PUT 'http://12.34.56.78:9000/bucket-creation-by-api/password.txt' \
63+
--header 'Content-Type: text/plain' \
64+
--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
65+
--header 'X-Amz-Date: 20250801T024840Z' \
66+
--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=b7d8dc29ee34dfdf1f3e9e8e069892a8936f478586e7a2c90cf34f5b86d3a2dc' \
67+
--data-binary '@/path/to/password.txt'
68+
```
69+
70+
Verify the upload in the RustFS console.
71+
72+
## Delete an Object
73+
74+
You can delete objects via the UI, `mc`, or API. For example, remove the file created in the steps above.
75+
76+
## Delete a file via RustFS UI
77+
78+
1. Sign in to the RustFS UI console.
79+
2. Select the bucket containing the file.
80+
3. On the bucket page, select the file to delete.
81+
4. Click **Delete Selected** in the upper right, then click **Confirm** in the dialog.
82+
83+
![object deletion from ui](./images/delete_file_from_ui.png)
84+
85+
### Delete a file with `mc`
86+
87+
Use `mc rm` to delete:
88+
89+
```
90+
# delete file
91+
mc rm rustfs/bucket-creation-by-mc/1.txt
92+
Removed `rustfs/bucket-creation-by-mc/1.txt`.
93+
94+
# confirm deletion
95+
mc ls rustfs/bucket-creation-by-mc/1.txt
96+
```
97+
98+
You can confirm the deletion in the RustFS UI.
99+
100+
### Delete a file via API
101+
102+
Use the following API:
103+
104+
```
105+
DELETE /{bucketName}/{objectName} HTTP/1.1
106+
```
107+
108+
Example:
109+
110+
```
111+
curl --location --request DELETE 'http://12.34.56.78:9000/bucket-creation-by-api/password.txt' \
112+
--header 'Content-Type: text/plain' \
113+
--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \
114+
--header 'X-Amz-Date: 20250801T030822Z' \
115+
--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=1ee63bb0b699598602b2fdbd013e355a57bcb9991307a8ad41f6512e8afebf3a'
116+
```
117+
118+
Verify the deletion in the RustFS UI.
189 KB
Loading
173 KB
Loading

0 commit comments

Comments
 (0)